SDK Local Storage #3

- Implement set storage action.
- Fix storage listeners and notifiers.

Author: BirjuVachhani

lib/src/api/models/action/action.dart

@@ -29,7 +29,10 @@ enum ActionType {
   callFunction,
 
   /// Call an API.
-  callApi;
+  callApi,
+
+  /// Update data in local storage.
+  setStorage;
 
   /// Displayable string representation of the [ActionType].
   String get prettify {
@@ -50,6 +53,8 @@ enum ActionType {
         return 'Call Function';
       case ActionType.callApi:
         return 'Call API';
+      case ActionType.setStorage:
+        return 'Set Storage';
     }
   }
 }
@@ -105,6 +110,8 @@ abstract class ActionModel with SerializableMixin {
         return CallFunctionAction.fromJson(json);
       case ActionType.callApi:
         return ApiCallAction.fromJson(json);
+      case ActionType.setStorage:
+        return SetStorageAction.fromJson(json);
     }
   }
 
@@ -123,3 +130,38 @@ abstract class ActionModel with SerializableMixin {
   /// @returns The result of calling the visit method on the visitor.
   R? accept<R>(ActionVisitor<R> visitor);
 }
+
+/// A base action class that represents an action that can be performed to
+/// modify some data in some way depending on the data type.
+abstract class DataOperationActionModel extends ActionModel {
+  /// New value to be set.
+  final String newValue;
+
+  /// Whether to toggle the value. This is used for boolean type variable.
+  final bool toggled;
+
+  /// Operation to be performed on the list type variable.
+  final ListOperation listOperation;
+
+  /// Index of the value to be updated/removed/inserted.
+  /// Can be a discrete value or a variable refered by '${}' syntax.
+  /// Used for list type variable.
+  final String index;
+
+  /// Operation to be performed on the map type variable.
+  final MapOperation mapOperation;
+
+  /// Key of the value to be updated/removed/inserted in the map.
+  final String mapKey;
+
+  /// Creates a [DataOperationActionModel] with the given data.
+  DataOperationActionModel({
+    required super.type,
+    this.newValue = '',
+    this.toggled = false,
+    this.listOperation = ListOperation.replace,
+    this.index = '0',
+    this.mapOperation = MapOperation.replace,
+    this.mapKey = 'key',
+  });
+}

lib/src/api/models/action/api_call_action.g.dart

@@ -0,0 +1,106 @@
+// Copyright (c) 2022, Codelessly.
+// All rights reserved. Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE.md file.
+
+import 'package:equatable/equatable.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+import '../../mixins.dart';
+import '../models.dart';
+
+part 'set_storage_action.g.dart';
+
+/// Represents an operation to perform on a data in storage.
+enum StorageOperation {
+  /// Remove the data from storage.
+  remove,
+
+  /// Add or update the data in storage.
+  addOrUpdate;
+
+  /// Displayable string representation of the [StorageOperation].
+  String get label => switch (this) {
+        StorageOperation.addOrUpdate => 'Add/Update',
+        StorageOperation.remove => 'Remove',
+      };
+}
+
+/// An action that sets value of a variable.
+@JsonSerializable()
+class SetStorageAction extends DataOperationActionModel
+    with EquatableMixin, SerializableMixin {
+  /// Key of the data in storage.
+  final String key;
+
+  /// Operation to perform on the data.
+  final StorageOperation operation;
+
+  /// Type of the variable.
+  /// This is used to convert the value to the correct type.
+  final VariableType variableType;
+
+  /// Creates a new [SetValueAction].
+  SetStorageAction({
+    this.key = 'key',
+    this.operation = StorageOperation.addOrUpdate,
+    this.variableType = VariableType.text,
+    super.newValue = '',
+    super.toggled = false,
+    super.listOperation = ListOperation.replace,
+    super.index = '0',
+    super.mapOperation = MapOperation.replace,
+    super.mapKey = 'key',
+  }) : super(type: ActionType.setStorage);
+
+  /// Duplicates this [SetStorageAction] with given data overrides.
+  SetStorageAction copyWith({
+    String? key,
+    StorageOperation? operation,
+    VariableType? variableType,
+    String? value,
+    bool? toggled,
+    ListOperation? listOperation,
+    String? index,
+    MapOperation? mapOperation,
+    String? mapKey,
+  }) {
+    final String? sanitizedValue = value == null
+        ? null
+        : sanitizeValueForVariableType(
+            value, variableType ?? this.variableType);
+    return SetStorageAction(
+      key: key ?? this.key,
+      operation: operation ?? this.operation,
+      variableType: variableType ?? this.variableType,
+      newValue: sanitizedValue ?? newValue,
+      toggled: toggled ?? this.toggled,
+      listOperation: listOperation ?? this.listOperation,
+      index: index ?? this.index,
+      mapOperation: mapOperation ?? this.mapOperation,
+      mapKey: mapKey ?? this.mapKey,
+    );
+  }
+
+  @override
+  List<Object?> get props => [
+        key,
+        operation,
+        variableType,
+        newValue,
+        toggled,
+        listOperation,
+        index,
+        mapOperation,
+        mapKey,
+      ];
+
+  /// Creates a new [SetStorageAction] instance from a JSON data.
+  factory SetStorageAction.fromJson(Map json) =>
+      _$SetStorageActionFromJson(json);
+
+  @override
+  Map toJson() => _$SetStorageActionToJson(this);
+
+  @override
+  R? accept<R>(ActionVisitor<R> visitor) => visitor.visitSetStorageAction(this);
+}

lib/src/api/models/action/call_function_action.g.dart

@@ -82,43 +82,20 @@ enum MapOperation {
 
 /// An action that sets value of a variable.
 @JsonSerializable()
-class SetVariableAction extends ActionModel
+class SetVariableAction extends DataOperationActionModel
     with EquatableMixin, SerializableMixin {
   /// Variable whose value is to be set.
   final VariableData variable;
 
-  /// Value that the variable needs to be updated with.
-  final String newValue;
-
-  /// Whether to toggle the value of the variable instead of setting it
-  /// if the variable is a boolean.
-  final bool toggled;
-
-  /// Operation to be performed on the list type variable.
-  final ListOperation listOperation;
-
-  /// Index of the value to be updated/removed/inserted.
-  /// Can be a discrete value or a variable refered by '${}' syntax.
-  /// Used for list type variable.
-  final String index;
-
-  /// Operation to be performed on the map type variable.
-  final MapOperation mapOperation;
-
-  /// Key of the map to be updated/removed.
-  /// Can be a discrete value or a variable refered by '${}' syntax.
-  /// Used for map type variable.
-  final String key;
-
   /// Creates a new [SetValueAction].
   SetVariableAction({
     required this.variable,
-    required this.newValue,
-    this.toggled = false,
-    this.listOperation = ListOperation.replace,
-    this.index = '0',
-    this.mapOperation = MapOperation.replace,
-    this.key = 'key',
+    required super.newValue,
+    super.toggled = false,
+    super.listOperation = ListOperation.replace,
+    super.index = '0',
+    super.mapOperation = MapOperation.replace,
+    super.mapKey = 'key',
   }) : super(type: ActionType.setVariable);
 
   @override
@@ -132,7 +109,7 @@ class SetVariableAction extends ActionModel
     ListOperation? listOperation,
     String? index,
     MapOperation? mapOperation,
-    String? key,
+    String? mapKey,
   }) =>
       SetVariableAction(
         variable: variable ?? this.variable,
@@ -141,7 +118,7 @@ class SetVariableAction extends ActionModel
         listOperation: listOperation ?? this.listOperation,
         index: index ?? this.index,
         mapOperation: mapOperation ?? this.mapOperation,
-        key: key ?? this.key,
+        mapKey: mapKey ?? this.mapKey,
       );
 
   /// Creates a new [SetVariableAction] instance from a JSON data.