feat!: 2.0.0-beta1 Modularization, Melos Support & Localization Refactor (#167)

* Refactor JSON serialization and deserialization across models

- Updated `TextAnswerFormat` to handle nullable `maxLines` and set default `answerType`.
- Enhanced `TextChoice` with equality operator and hash code implementation.
- Simplified JSON serialization for `TextChoice`, `AudioContent`, `ImageContent`, `LottieContent`, `MarkdownContent`, `SectionContent`, `TextContent`, `VideoContent`, and `TimeAnswerFormat`.
- Improved `StepResult` to include explicit JSON serialization and updated equality checks.
- Adjusted `SurveyResult` to include list equality checks.
- Updated `CustomDateTimeConverter` to preserve timezone during serialization.
- Changed `pubspec.yaml` to update Dart SDK and dependencies.
- Modified test cases to use UTC for `startTime` and `endTime` for consistency.

* feat: add monorepo

* refactor: modularize audio and video features into separate packages and update dependencies.

* feat: Introduce `survey_kit_lottie` package to add Lottie animation support and update content model.

* feat: Migrate to Flutter's `gen_l10n` for internationalization, replacing custom JSON-based localization.

* feat: Add CI workflow, localization generation updates, and video/audio plugin improvements

* feat: Add GitHub Actions workflow for publishing to pub.dev and extend CI triggers to include the develop branch.

* refactor: simplify Melos script definitions by replacing `run` and `exec.concurrency` with direct `exec` commands.

* chore: Resolve root dependencies in CI and remove explicit Melos SDK path configuration.

* ci: Add debug environment step to CI workflow and remove extraneous blank lines from melos.yaml.

* feat: Update CI analyze and test commands, ignore `invalid_dependency` linter rule, and specify `intl` dependency version.

* feat: Decouple answer formats and content models from their views by removing `createView`/`createWidget` methods and introducing a new registry pattern with `SurveyKitPlugin` for external integrations.

* docs: remove example code blocks from SurveyController documentation.

* feat: Refactor task and navigation logic with `SurveyFlow` and `SurveyDefinition`, deprecate `NavigableTask`, and introduce Lottie, video, and audio packages.

* refactor: Make `MultipleChoiceAnswerFormat` and `SingleChoiceAnswerFormat` generic with `TextChoice` and update their usage.

* feat: Introduce a `center` property for `ContentWidget` vertical alignment, update package dependencies, remove `path_provider_foundation` from the macOS example, and clarify `initalStep` migration notes.

* feat: introduce `NavigationTarget` for conditional navigation rules, remove `FlowTask`, and fix `QuestionAnswer` validation initialization.

* feat: Allow steps without answer formats to be valid by default and make the example's next button reactive.

* refactor!: Rename answer format properties, update SurveyController callbacks with a `proceed` parameter, and simplify `StepView` button logic.

* feat: update survey welcome and completion texts and apply extensive custom theming to the app and SurveyKit UI.

* feat: Update example app theme to a vibrant cyan color scheme, enhance `SelectionListTile` styling, and increase `SurveyAppBar` height.

* refactor: Add AnswerMixin import to MultipleChoiceAutoCompleteAnswerView.

* chore: Update package dependencies and apply consistent code formatting across various files.

Author: Numoy

.fvmrc

@@ -0,0 +1,3 @@
+{
+  "flutter": "3.41.4"
+}

.github/workflows/.github-actions.yml

@@ -0,0 +1,98 @@
+name: Publish to pub.dev
+
+on:
+  release:
+    types: [published]
+
+concurrency:
+  group: publish-${{ github.event.release.tag_name }}
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    if: ${{ !github.event.release.draft }}
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+
+      - name: Install Melos
+        run: dart pub global activate melos
+
+      - name: Resolve Root Dependencies
+        run: flutter pub get
+
+      - name: Bootstrap Workspace
+        run: melos bootstrap
+
+      - name: Analyze
+        run: melos run analyze
+
+      - name: Test
+        run: melos run test
+
+      - name: Verify release tag matches package versions
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          TAG_VERSION="${RELEASE_TAG#v}"
+          for package in \
+            packages/survey_kit \
+            packages/survey_kit_audio \
+            packages/survey_kit_lottie \
+            packages/survey_kit_video
+          do
+            PACKAGE_VERSION="$(sed -n 's/^version: //p' "$package/pubspec.yaml")"
+            if [ "$PACKAGE_VERSION" != "$TAG_VERSION" ]; then
+              echo "Tag version ($TAG_VERSION) does not match $package version ($PACKAGE_VERSION)."
+              exit 1
+            fi
+          done
+
+      - name: Publish packages
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          TAG_VERSION="${RELEASE_TAG#v}"
+
+          is_already_published() {
+            package_name="$1"
+            curl -fsSL "https://pub.dev/api/packages/$package_name" | grep -Eq "\"version\"[[:space:]]*:[[:space:]]*\"$TAG_VERSION\""
+          }
+
+          publish_package() {
+            package_path="$1"
+            package_name="$2"
+
+            if is_already_published "$package_name"; then
+              echo "$package_name $TAG_VERSION is already on pub.dev, skipping."
+              return 0
+            fi
+
+            for attempt in 1 2 3; do
+              echo "Publishing $package_name (attempt $attempt)..."
+              if (cd "$package_path" && flutter pub publish --force); then
+                echo "$package_name published."
+                return 0
+              fi
+
+              if [ "$attempt" -lt 3 ]; then
+                echo "Retrying $package_name in 60s..."
+                sleep 60
+              fi
+            done
+
+            echo "Failed to publish $package_name after 3 attempts."
+            return 1
+          }
+
+          publish_package packages/survey_kit survey_kit
+          publish_package packages/survey_kit_audio survey_kit_audio
+          publish_package packages/survey_kit_lottie survey_kit_lottie
+          publish_package packages/survey_kit_video survey_kit_video

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: subosito/flutter-action@v2
+        with:
+          channel: 'stable'
+
+      - name: Install Melos
+        run: dart pub global activate melos
+
+      - name: Resolve Root Dependencies
+        run: flutter pub get
+
+      - name: Bootstrap Workspace
+        run: melos bootstrap
+
+      - name: Analyze
+        run: melos exec -- flutter analyze .
+
+      - name: Run Tests
+        run: melos exec --dir-exists="test" -- flutter test

.github/workflows/survey_kit_ci.yml

@@ -24,16 +24,24 @@
 # Flutter/Dart/Pub related
 **/doc/api/
 **/ios/Flutter/.last_build_id
+**/ios/Flutter/ephemeral/
+**/macos/Flutter/ephemeral/
+**/linux/flutter/ephemeral/
+**/windows/flutter/ephemeral/
 .dart_tool/
 .flutter-plugins
 .flutter-plugins-dependencies
 .packages
 .pub-cache/
 .pub/
 /build/
+**/build/
+**/.gradle/
+**/local.properties
 
 # Web related
 lib/generated_plugin_registrant.dart
+**/GeneratedPluginRegistrant.java
 
 # Symbolication related
 app.*.symbols
@@ -45,4 +53,4 @@ app.*.map.json
 /android/app/debug
 /android/app/profile
 /android/app/release
-/example/linux/flutter/emphemeral/.plugin_symlinks
+**/linux/flutter/ephemeral/.plugin_symlinks

.gitignore

@@ -1,3 +1,82 @@
+# 2.0.0-beta1
+
+## Required Adjustments (1.x -> 2.0.0-beta1)
+
+1. Update dependencies to `survey_kit: 2.0.0-beta1`, and add media plugins only
+   if needed: `survey_kit_audio`, `survey_kit_video`, `survey_kit_lottie`.
+2. **BREAKING**: Rename `Task.initalStep` to `Task.initialStep`.
+3. Update imports for any media plugin package you use.
+4. Register media plugins through `SurveyKit(registries: [...])`.
+5. Migrate custom `AnswerFormat`/`Content` rendering from model methods to
+   `answerViewBuilders` and `contentWidgetBuilders` (or custom `SurveyKitPlugin`).
+6. If you deserialize from JSON, register converters for custom and plugin
+   types with `AnswerFormat.registerFromJson` and `Content.registerFromJson`.
+7. Ensure localization delegates include `SurveyKitLocalizations.delegate` and
+   Flutter localization delegates.
+8. Prefer `SurveyDefinition.fromJson` over `Task.fromJson`
+   (`Task` remains as a deprecated alias).
+
+Full migration guide: [MIGRATION.md](MIGRATION.md)
+
+## Highlights
+
+- **BREAKING**: `ConditionalNavigationRule.resultToStepIdentifierMapper` now
+  returns `NavigationTarget` instead of `String?`. Replace `'step_id'` with
+  `NavigateToStep('step_id')`, `null` with `NavigateToNextInList()`, and use
+  the new `FinishSurvey()` to end the survey early from a rule.
+- **BREAKING**: Removed model-level `createView`/`createWidget` coupling and
+  moved rendering to registry builders.
+- **BREAKING**: Renamed `Task.initalStep` to `Task.initialStep`.
+- **BREAKING**: Split media integrations into dedicated packages:
+  `survey_kit_audio`, `survey_kit_video`, `survey_kit_lottie`.
+- **FEATURE**: Added `SurveyFlow` as the unified task model for linear and
+  branching surveys.
+- **FEATURE**: Added `SurveyDefinition` as the canonical survey definition base
+  type.
+- **DEPRECATION**: `OrderedTask` and `NavigableTask` are now legacy wrappers
+  around `SurveyFlow`.
+- **REMOVED**: `FlowTask` — introduced and immediately deprecated in this
+  version, removed before release. Use `SurveyFlow` directly.
+- **DEPRECATION**: `Task` is now a legacy alias for `SurveyDefinition`.
+- **FEATURE**: Added `SurveyKitRegistry`/`SurveyKitPlugin` and `registries`,
+  `answerViewBuilders`, `contentWidgetBuilders`.
+- **FEATURE**: Migrated localization generation to Flutter `gen_l10n` with
+  `.arb` resources.
+- **FIX**: Improved JSON serialization/deserialization consistency, including
+  `TimeResult` generation and UTC DateTime handling.
+- **TEST**: Improved test stability with deterministic setup.
+- **CHORE**: Migrated to Melos monorepo workflow and added CI/publish
+  automation.
+- **DOCS**: Updated API docs for the registry architecture.
+
+## Navigation/Controller Hardening
+
+1. **FIX**: Hardened survey navigation transitions to avoid loading-route traps
+   on empty/completed flows.
+2. **FIX**: Stabilized navigation rule serialization/deserialization for JSON
+   surveys (`type` handling + legacy compatibility).
+3. **FIX**: Survey result emission is now deterministic and ordered by task step
+   sequence.
+4. **FIX**: Tightened state update propagation and cleaned dead/duplicate view
+   artifacts in provider/view wiring.
+5. **BREAKING**: Renamed `Task.initalStep` to `Task.initialStep`.
+6. **FEATURE**: `SurveyController` now supports context-free imperative
+   navigation when attached to `SurveyKit` (`next`, `stepBack`, `closeSurvey`).
+7. **BREAKING**: `SurveyController.closeSurvey` no longer accepts a
+   `BuildContext` parameter. The context is resolved internally via the
+   navigator key. If you supply an `onCloseSurvey` callback, remove the
+   `BuildContext` argument from its signature:
+   `Function(StepResult?) onCloseSurvey`.
+8. **FIX**: `QuestionAnswer.isValid` now initialises to `false` for mandatory
+   steps instead of always `true`. Previously, the Next button on a mandatory
+   step was enabled before the user had selected any answer.
+9. **FIX**: `AnswerMixin.initValidation` added — call it in `initState` to sync
+   a pre-filled or default answer into the validation state on first render.
+   `SingleChoiceAnswerView` already calls this.
+10. **FIX**: `ContentWidget` now correctly respects `center: false` —
+    `mainAxisAlignment` was hardcoded to `center` regardless of the parameter.
+
+
 # 1.0.3
 
 - CHORE: Removed depracted lint `package_api_docs`