v6.26.0

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,12 @@
+## [6.26.0] - 2025-04-16
+
+* Added: `JourneyState` class to help manage `NavigationHubLayout.journey`
+* Added: `JourneyHelper` class to help manage JourneyState's
+* Added: `makeJourneyWidget` method to `MetroService` class
+* Added: `parentOption` to constants
+* Added: `syncToStorage` method to NySession class. This will sync the session data to storage
+* Added: `syncFromStorage` method to NySession class. This will sync the session data from storage
+
 ## [6.25.1] - 2025-04-09
 
 * Fix `NyStorage.read` method

lib/helpers/ny_session.dart

@@ -1,3 +1,4 @@
+import '/local_storage/local_storage.dart';
 import 'backpack.dart';
 
 /// Create a new session
@@ -52,4 +53,24 @@ class NySession {
     }
     return sessionData;
   }
+
+  /// Sync to Storage
+  Future syncToStorage() async {
+    Map<String, dynamic>? sessionData = data();
+    if (sessionData == null) {
+      return;
+    }
+    await NyStorage.saveJson("${name}_session", sessionData);
+  }
+
+  /// Sync from Storage
+  Future syncFromStorage() async {
+    final sessionData = await NyStorage.readJson("${name}_session");
+    if (sessionData == null) {
+      return;
+    }
+    for (MapEntry key in sessionData.entries) {
+      add(key.key, key.value);
+    }
+  }
 }

lib/metro/constants/strings.dart

@@ -14,6 +14,7 @@ const String bottomNavFlag = 'bottom-nav';
 // options
 const String postmanCollectionOption = 'postman';
 const String commandCategoryOption = 'category';
+const String parentOption = 'parent';
 
 // folders
 const String yamlPath = 'pubspec.yaml';

lib/metro/metro_service.dart

@@ -556,6 +556,31 @@ final Map<Type, dynamic> modelDecoders = {${reg.allMatches(file).map((e) => e.gr
     });
   }
 
+  /// Creates a new Journey Widget.
+  static makeJourneyWidget(String className, String value,
+      {String folderPath = widgetsFolder,
+      bool forceCreate = false,
+      String? creationPath}) async {
+    String name = className.replaceAll(RegExp(r'(_?widget)'), "");
+
+    // create missing directories in the project
+    await _makeDirectory(folderPath);
+    await createDirectoriesFromCreationPath(creationPath, folderPath);
+
+    // create file path
+    String filePath = createPathForDartFile(
+        folderPath: folderPath,
+        className: name,
+        prefix: 'widget',
+        creationPath: creationPath);
+
+    await _checkIfFileExists(filePath, shouldForceCreate: forceCreate);
+    await _createNewFile(filePath, value, onSuccess: () {
+      MetroConsole.writeInGreen(
+          '[Journey Widget] ${name.snakeCase} created 🎉');
+    });
+  }
+
   /// Creates a new State Managed Widget.
   static makeStateManagedWidget(String className, String value,
       {String folderPath = widgetsFolder,

lib/widgets/navigation_hub/journey_helper.dart

@@ -0,0 +1,69 @@
+import '/helpers/backpack.dart';
+import '/widgets/navigation_hub/navigation_hub.dart';
+
+/// A helper class for journey navigation
+class JourneyHelper {
+  final String navigationHubState;
+
+  /// Create a new journey helper for the given navigation hub state
+  JourneyHelper(this.navigationHubState);
+
+  /// Get the current step index (0-based)
+  int getCurrentStep() {
+    final currentData =
+        Backpack.instance.read('${navigationHubState}_current_tab');
+    return (currentData is int) ? currentData : 0;
+  }
+
+  /// Get the total number of steps
+  int getTotalSteps() {
+    final totalPagesData =
+        Backpack.instance.read('${navigationHubState}_total_pages');
+    return (totalPagesData is int) ? totalPagesData : 0;
+  }
+
+  /// Check if this is the first step
+  bool isFirstStep() {
+    return getCurrentStep() == 0;
+  }
+
+  /// Check if this is the last step
+  bool isLastStep() {
+    final currentStep = getCurrentStep();
+    final totalSteps = getTotalSteps();
+    return currentStep >= totalSteps - 1;
+  }
+
+  /// Get the completion percentage (0.0 to 1.0)
+  double getCompletionPercentage() {
+    final currentStep = getCurrentStep();
+    final totalSteps = getTotalSteps();
+
+    if (totalSteps == 0) return 0.0;
+    return (currentStep + 1) / totalSteps;
+  }
+
+  /// Navigate to the next step, returns false if already at the last step
+  Future<bool> nextStep() async {
+    final actions = NavigationHubStateActions(navigationHubState);
+    return await actions.nextPage();
+  }
+
+  /// Navigate to the previous step, returns false if already at the first step
+  Future<bool> previousStep() async {
+    final actions = NavigationHubStateActions(navigationHubState);
+    return await actions.previousPage();
+  }
+
+  /// Jump to a specific step by index
+  void goToStep(int stepIndex) {
+    final actions = NavigationHubStateActions(navigationHubState);
+    actions.currentTabIndex(stepIndex);
+  }
+
+  /// Reset the current step
+  void resetCurrentStep() {
+    final actions = NavigationHubStateActions(navigationHubState);
+    actions.resetTabIndex(getCurrentStep());
+  }
+}