@applicaster/zapp-react-native-utils 13.0.0-rc.99 → 14.0.0-alpha.1216545755

package/actionsExecutor/ActionExecutorContext.tsx

@@ -5,13 +5,17 @@ import {
   actionExecutor as _actionExecutor,
   ActionResult,
 } from "./ActionExecutor";
-import { batchSaveToLocalStorage } from "../zappFrameworkUtils/localStorageHelper";
-import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import {
+  batchRemoveAllFromNamespaceForStorage,
+  batchSave,
+} from "../zappFrameworkUtils/localStorageHelper";
+import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
+
 import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
 import { showConfirmationDialog } from "../alertUtils";
 import { createCloudEvent, sendCloudEvent } from "../cloudEventsUtils";
 import { createLogger } from "../logger";
-import { StorageMultiSelectProvider } from "@applicaster/zapp-react-native-bridge/ZappStorage/StorageMultiSelectProvider";
 import { ACTIVE_LAYOUT_ID_STORAGE_KEY } from "@applicaster/quick-brick-core/App/remoteContextReloader/consts";
 import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
 import { loadPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
@@ -20,12 +24,19 @@ import {
   resolveObjectValues,
 } from "../appUtils/contextKeysManager/contextResolver";
 import { useNavigation } from "../reactHooks";
-import { get } from "lodash";
 
 import {
   useContentTypes,
   usePickFromState,
 } from "@applicaster/zapp-react-native-redux/hooks";
+import { useSubscriberFor } from "../reactHooks/useSubscriberFor";
+import { APP_EVENTS } from "../appUtils/events";
+import {
+  localStorageToggleFlag,
+  sessionStorageToggleFlag,
+} from "./StorageActions";
+
+import { screenSetVariable, screenToggleFlag } from "./ScreenActions";
 
 export const { log_error, log_info, log_debug } = createLogger({
   subsystem: "ActionExecutorContext",
@@ -77,7 +88,15 @@ function findParentComponent(
 const prepareDefaultActions = (actionExecutor) => {
   actionExecutor.registerAction("localStorageSet", async (action) => {
     const namespaces = action.options.content;
-    await batchSaveToLocalStorage(namespaces);
+    await batchSave(namespaces, localStorage);
+    // TODO: Add support for ownershipKey and ownershipNamespace
+
+    return ActionResult.Success;
+  });
+
+  actionExecutor.registerAction("sessionStorageSet", async (action) => {
+    const namespaces = action.options.content;
+    await batchSave(namespaces, sessionStorage);
     // TODO: Add support for ownershipKey and ownershipNamespace
 
     return ActionResult.Success;
@@ -134,15 +153,13 @@ const prepareDefaultActions = (actionExecutor) => {
   actionExecutor.registerAction("confirmDialog", async (action) => {
     log_info("handleAction: confirmDialog event");
 
-    const confirmationPromise = new Promise<ActionResult>((resolve) => {
+    return new Promise<ActionResult>((resolve) => {
       showConfirmationDialog({
         ...action.options,
         confirmCompletion: () => resolve(ActionResult.Success),
         cancelCompletion: () => resolve(ActionResult.Cancel),
       });
     });
-
-    return confirmationPromise;
   });
 
   actionExecutor.registerAction("sendCloudEvent", async (action, context) => {
@@ -151,10 +168,15 @@ const prepareDefaultActions = (actionExecutor) => {
 
       const entry = context?.entry || {};
       const entryResolver = new EntryResolver(entry);
+      const screenData = context?.screenStateStore.getState().data || {};
+      const screenResolver = new EntryResolver(screenData || {});
 
       const data =
         options?.data && options.inflateData
-          ? await resolveObjectValues(options.data, { entry: entryResolver })
+          ? await resolveObjectValues(options.data, {
+              entry: entryResolver,
+              screen: screenResolver,
+            })
           : options?.data || entry;
 
       const cloudEvent = await createCloudEvent({
@@ -189,73 +211,56 @@ const prepareDefaultActions = (actionExecutor) => {
   });
 
   actionExecutor.registerAction(
-    "localStorageToggleFlag",
+    "sessionStorageToggleFlag",
     async (
       action: ActionType,
       context?: Record<string, any>
     ): Promise<ActionResult> => {
-      if (!context) {
-        log_error(
-          "handleAction: localStorageToggleFlag action missing context"
-        );
-
-        return ActionResult.Error;
-      }
-
-      const entry = context?.entry as ZappEntry;
-
-      if (!entry) {
-        log_error(
-          "handleAction: localStorageToggleFlag action missing entry. Entry is required to get the tag."
-        );
-
-        return ActionResult.Error;
-      }
-
-      const tag = action.options?.selector
-        ? get(entry, action.options.selector)
-        : (entry.extensions?.tag ?? entry.id);
-
-      const keyNamespace = action.options?.key;
-
-      if (keyNamespace && tag) {
-        const multiSelectProvider =
-          StorageMultiSelectProvider.getProvider(keyNamespace);
-
-        const selectedItems = await multiSelectProvider.getSelectedAsync();
-        const isTagInSelectedItems = selectedItems.includes(tag);
-
-        log_info(
-          `handleAction: localStorageToggleFlag event will ${
-            isTagInSelectedItems ? "remove" : "add"
-          } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
-        );
-
-        if (selectedItems.includes(tag)) {
-          await multiSelectProvider.removeItem(tag);
-        } else {
-          const maxItems = action.options?.max_items;
+      return await sessionStorageToggleFlag(context, action);
+    }
+  );
 
-          if (maxItems && selectedItems.length >= maxItems) {
-            log_info(
-              `handleAction: localStorageToggleFlag event reached max items limit: ${maxItems}, cannot add tag: ${tag}`
-            );
+  actionExecutor.registerAction(
+    "localStorageToggleFlag",
+    async (
+      action: ActionType,
+      context?: Record<string, any>
+    ): Promise<ActionResult> => {
+      return await localStorageToggleFlag(context, action);
+    }
+  );
 
-            return ActionResult.Cancel;
-          }
+  actionExecutor.registerAction(
+    "screenSetVariable",
+    async (
+      action: ActionType,
+      context?: Record<string, any>
+    ): Promise<ActionResult> => {
+      const route = context?.screenRoute;
+      const { key, value } = action.options;
+      screenSetVariable(route, key, value);
 
-          await multiSelectProvider.addItem(tag);
-        }
-      } else {
-        log_error(
-          "handleAction: localStorageToggleFlag event missing keyNamespace or tag",
-          { keyNamespace, tag }
-        );
+      return Promise.resolve(ActionResult.Success);
+    }
+  );
 
-        return ActionResult.Error;
-      }
+  actionExecutor.registerAction(
+    "screenToggleFlag",
+    async (
+      action: ActionType,
+      context?: Record<string, any>
+    ): Promise<ActionResult> => {
+      const screenRoute = context?.screenRoute;
+      const screenStateStore = context?.screenStateStore;
+
+      await screenToggleFlag(
+        screenRoute,
+        screenStateStore,
+        { entry: context?.entry, options: action.options },
+        action
+      );
 
-      return ActionResult.Success;
+      return Promise.resolve(ActionResult.Success);
     }
   );
 };
@@ -281,9 +286,24 @@ export function withActionExecutor(Component) {
       };
     }, []);
 
+    useSubscriberFor(APP_EVENTS.onLogout, () => {
+      log_debug(
+        "User profile: onLogout event received, clearing user profile data"
+      );
+
+      const userAccountKey = "user_account";
+      void batchRemoveAllFromNamespaceForStorage(userAccountKey, localStorage);
+
+      void batchRemoveAllFromNamespaceForStorage(
+        userAccountKey,
+        sessionStorage
+      );
+    });
+
     useEffect(() => {
       return _actionExecutor.registerAction(
         "navigateToScreen",
+
         async (action: ActionType, context?: Record<string, any>) => {
           const screenType = action.options?.typeMapping;
 

package/actionsExecutor/ScreenActions.ts

@@ -0,0 +1,92 @@
+// import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+
+import { log_error, log_info } from "./ActionExecutorContext";
+import { ActionResult } from "./ActionExecutor";
+import { get } from "lodash";
+
+import { onMaxTagsReached } from "./StorageActions";
+import { ScreenMultiSelectProvider } from "../storage/ScreenStateMultiSelectProvider";
+
+export const screenSetVariable = (
+  _screenRoute: string,
+  _key: string,
+  _value: string
+) => {};
+
+export const screenToggleFlag = async (
+  screenRoute: string,
+  screenStateStore: ScreenStateStore,
+  context: Record<string, any>,
+  action: ActionType
+) => {
+  if (!context) {
+    log_error("handleAction: screenToggleFlag action missing context");
+
+    return ActionResult.Error;
+  }
+
+  const entry = context?.entry as ZappEntry;
+
+  if (!entry) {
+    log_error(
+      "handleAction: screenToggleFlag action missing entry. Entry is required to get the tag."
+    );
+
+    return ActionResult.Error;
+  }
+
+  const tag = action.options?.selector
+    ? get(entry, action.options.selector)
+    : (entry.extensions?.tag ?? entry.id);
+
+  const keyNamespace = action.options?.key;
+
+  if (keyNamespace && tag) {
+    const multiSelectProvider = ScreenMultiSelectProvider.getProvider(
+      keyNamespace,
+      screenRoute,
+      screenStateStore
+    );
+
+    const selectedItems = await multiSelectProvider.getSelectedAsync();
+    const isTagInSelectedItems = selectedItems.includes(tag);
+
+    log_info(
+      `handleAction: screenToggleFlag event will ${
+        isTagInSelectedItems ? "remove" : "add"
+      } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
+    );
+
+    if (selectedItems.includes(tag)) {
+      await multiSelectProvider.removeItem(tag);
+    } else {
+      const maxItems = action.options?.max_items;
+
+      if (maxItems && selectedItems.length >= maxItems) {
+        log_info(
+          `handleAction: screenToggleFlag event reached max items limit: ${maxItems}, cannot add tag: ${tag}`
+        );
+
+        await onMaxTagsReached({
+          selectedItems,
+          maxItems,
+          tag,
+          keyNamespace,
+        });
+
+        return ActionResult.Cancel;
+      }
+
+      await multiSelectProvider.addItem(tag);
+    }
+  } else {
+    log_error(
+      "handleAction: screenToggleFlag event missing keyNamespace or tag",
+      { keyNamespace, tag }
+    );
+
+    return ActionResult.Error;
+  }
+
+  return ActionResult.Success;
+};

package/actionsExecutor/StorageActions.ts

@@ -0,0 +1,110 @@
+import { ActionResult } from "./ActionExecutor";
+import { get } from "lodash";
+import { StorageMultiSelectProvider } from "@applicaster/zapp-react-native-utils/storage/StorageMultiSelectProvider";
+import { log_error, log_info } from "./ActionExecutorContext";
+import { postEvent } from "../reactHooks/useSubscriberFor";
+import { TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT } from "./consts";
+import { StorageType } from "../appUtils/contextKeysManager/consts";
+
+// send all data just in case (like for message string formatting)
+// Type is not exported for now
+type MaxTagsReachedEvent = {
+  selectedItems: string[];
+  maxItems: number;
+  tag: string;
+  keyNamespace: string;
+};
+
+export async function onMaxTagsReached(data: MaxTagsReachedEvent) {
+  postEvent(TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT, [data]);
+}
+
+export async function storageToggleFlag(
+  context: Record<string, any>,
+  action: ActionType,
+  storageType: StorageType
+) {
+  if (!context) {
+    log_error("handleAction: localStorageToggleFlag action missing context");
+
+    return ActionResult.Error;
+  }
+
+  const entry = context?.entry as ZappEntry;
+
+  if (!entry) {
+    log_error(
+      "handleAction: localStorageToggleFlag action missing entry. Entry is required to get the tag."
+    );
+
+    return ActionResult.Error;
+  }
+
+  const tag = action.options?.selector
+    ? get(entry, action.options.selector)
+    : (entry.extensions?.tag ?? entry.id);
+
+  const keyNamespace = action.options?.key;
+
+  if (keyNamespace && tag) {
+    const multiSelectProvider = StorageMultiSelectProvider.getProvider(
+      keyNamespace,
+      storageType
+    );
+
+    const selectedItems = await multiSelectProvider.getSelectedAsync();
+    const isTagInSelectedItems = selectedItems.includes(tag);
+
+    log_info(
+      `handleAction: localStorageToggleFlag event will ${
+        isTagInSelectedItems ? "remove" : "add"
+      } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
+    );
+
+    if (selectedItems.includes(tag)) {
+      await multiSelectProvider.removeItem(tag);
+    } else {
+      const maxItems = action.options?.max_items;
+
+      if (maxItems && selectedItems.length >= maxItems) {
+        log_info(
+          `handleAction: localStorageToggleFlag event reached max items limit: ${maxItems}, cannot add tag: ${tag}`
+        );
+
+        await onMaxTagsReached({
+          selectedItems,
+          maxItems,
+          tag,
+          keyNamespace,
+        });
+
+        return ActionResult.Cancel;
+      }
+
+      await multiSelectProvider.addItem(tag);
+    }
+  } else {
+    log_error(
+      "handleAction: localStorageToggleFlag event missing keyNamespace or tag",
+      { keyNamespace, tag }
+    );
+
+    return ActionResult.Error;
+  }
+
+  return ActionResult.Success;
+}
+
+export async function sessionStorageToggleFlag(
+  context: Record<string, any>,
+  action: ActionType
+) {
+  return storageToggleFlag(context, action, StorageType.session);
+}
+
+export async function localStorageToggleFlag(
+  context: Record<string, any>,
+  action: ActionType
+) {
+  return storageToggleFlag(context, action, StorageType.local);
+}

package/actionsExecutor/consts.ts

@@ -0,0 +1,4 @@
+export const TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT =
+  "action.localStorageToggleFlag.maxItemsReached";
+
+export const ACTION_EXECUTOR_EVENT_SOURCE = "ActionExecutor";

package/actionsExecutor/feedDecorator.ts

@@ -0,0 +1,171 @@
+import * as R from "ramda";
+import { getNamespaceAndKey } from "../appUtils/contextKeysManager/utils";
+import { createLogger } from "../logger";
+
+const { log_error, log_verbose } = createLogger({
+  subsystem: "FeedDecorator",
+  category: "General",
+});
+
+function getScope(scope) {
+  if (scope === "screen") {
+    return scope;
+  } else if (!scope || scope === "ctx") {
+    return "ctx";
+  } else {
+    log_verbose(
+      `decorateFeed: Unsupported scope "${scope}" provided in preference_editor_options. Defaulting to "ctx".`
+    );
+
+    return "ctx";
+  }
+}
+
+function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
+  const scope = getScope(
+    decoratedFeed.extensions?.preference_editor_options?.scope
+  );
+
+  const behavior = {
+    ...feed.extensions?.["behavior"],
+    select_mode: "multi",
+    current_selection: `@{${scope}/${key}}`,
+  };
+
+  if (!feed.extensions) {
+    decoratedFeed.extensions = {
+      behavior,
+    };
+  } else {
+    decoratedFeed.extensions.behavior = behavior;
+  }
+
+  const actionType =
+    decoratedFeed.extensions?.preference_editor_options?.scope === "screen"
+      ? "screenToggleFlag"
+      : decoratedFeed.extensions?.preference_editor_options?.scope === "session"
+        ? "sessionStorageToggleFlag"
+        : "localStorageToggleFlag";
+
+  decoratedFeed.entry?.forEach((entry: ZappEntry) => {
+    entry.type.value = "action";
+    entry.id = entry.extensions?.tag || entry.id;
+
+    entry.extensions = {
+      ...(entry.extensions || {}),
+      tap_actions: {
+        actions: [
+          {
+            type: actionType,
+            options: {
+              key,
+            },
+          },
+        ],
+      },
+    };
+  });
+
+  return decoratedFeed;
+}
+
+function makeSingleSelect(feed: ZappFeed, key, decoratedFeed) {
+  const scope = getScope(
+    decoratedFeed.extensions?.preference_editor_options?.scope
+  );
+
+  const behavior = {
+    ...feed.extensions?.["behavior"],
+    select_mode: "single",
+    current_selection: `@{${scope}/${key}}`,
+  };
+
+  if (!feed.extensions) {
+    decoratedFeed.extensions = {
+      behavior,
+    };
+  } else {
+    decoratedFeed.extensions.behavior = behavior;
+  }
+
+  const localStorageProducer = (entry: ZappFeed) => {
+    entry.id = entry.extensions?.tag || entry.id;
+    const { key: keyName, namespace } = getNamespaceAndKey(key);
+
+    const action =
+      decoratedFeed.extensions?.preference_editor_options?.scope === "session"
+        ? "sessionStorageSet"
+        : "localStorageSet";
+
+    return {
+      type: action,
+      options: {
+        content: {
+          [namespace]: {
+            [keyName]: entry.id,
+          },
+        },
+      },
+    };
+  };
+
+  const screenStateProducer = (entry: ZappFeed) => {
+    entry.id = entry.extensions?.tag || entry.id;
+
+    return {
+      type: "screenSetVariable",
+      options: {
+        key: `@{screen/${key}}`,
+        value: entry.id,
+      },
+    };
+  };
+
+  const producer =
+    decoratedFeed.extensions?.preference_editor_options?.scope === "screen"
+      ? screenStateProducer
+      : localStorageProducer;
+
+  decoratedFeed.entry?.forEach((entry: ZappEntry) => {
+    entry.type.value = "action";
+
+    entry.extensions = {
+      ...(entry.extensions || {}),
+      tap_actions: {
+        actions: [producer(entry)],
+      },
+    };
+  });
+
+  return decoratedFeed;
+}
+
+export const decorateFeed = (feed: ZappFeed) => {
+  if (!(feed.extensions?.["role"] === "preference_editor")) {
+    return feed;
+  }
+
+  const key = feed.extensions?.["preference_editor_options"]?.["key"];
+
+  if (!key) {
+    log_error(
+      `decorateFeed: No 'key' provided in feed titled "${feed.title}" with id "${feed.id}" in preference_editor_options. The preference_editor role requires a key for local storage.`
+    );
+
+    throw new Error(
+      "decorateFeed: No 'key' provided in feed preference_editor_options"
+    );
+  }
+
+  const decoratedFeed = R.clone(feed);
+
+  const isSingleSelect =
+    (feed.extensions?.["preference_editor_options"]?.select_mode ||
+      feed.extensions?.["behavior"]?.select_mode) === "single";
+
+  if (isSingleSelect) {
+    return makeSingleSelect(feed, key, decoratedFeed);
+  } else {
+    return makeMultiSelect(feed, key, decoratedFeed);
+  }
+};

package/actionsExecutor/screenResolver.ts

@@ -0,0 +1,11 @@
+import { useMemo } from "react";
+import { ScreenStateResolver } from "../appUtils/contextKeysManager/contextResolver";
+import { useScreenStateStore } from "../reactHooks/navigation/useScreenStateStore";
+
+export const useScreenResolvers = () => {
+  const screenStateStore = useScreenStateStore();
+
+  return useMemo(() => {
+    return { screen: new ScreenStateResolver(screenStateStore) };
+  }, [screenStateStore]);
+};