@applicaster/zapp-react-native-utils 16.0.0-alpha.9534912292 → 16.0.0-alpha.9739533780

package/actionsExecutor/ActionExecutor.ts

@@ -1,4 +1,5 @@
 import { createLogger } from "../logger";
+import type { ActionExecutionContext, ActionHandler } from "./types";
 
 export enum ActionResult {
   Success = "success",
@@ -12,12 +13,12 @@ const { log_error, log_debug, log_info } = createLogger({
 });
 
 class ActionExecutor {
-  private registeredActions: Record<string, any> = {};
-  // TODO: Remove context
+  private registeredActions: Record<string, ActionHandler> = {};
 
+  // TODO: Remove context
   handleAction = async (
     action: ActionType,
-    context?: Record<string, any>
+    context?: ActionExecutionContext
   ): Promise<ActionResult> => {
     const handler = this.registeredActions[action.type];
     const entry = context?.entry as ZappEntry;
@@ -52,7 +53,7 @@ class ActionExecutor {
 
   handleActions = async (
     actionTypes: ActionType[],
-    context?: Record<string, any>
+    context?: ActionExecutionContext
   ): Promise<ActionResult> => {
     for (const action of actionTypes) {
       // TODO: Handle action result error
@@ -70,7 +71,7 @@ class ActionExecutor {
 
   handleEntryActions = async (
     entry: ZappEntry,
-    context?: Record<string, any>
+    context?: ActionExecutionContext
   ): Promise<ActionResult> => {
     const tapActions = entry.extensions?.tap_actions?.actions;
 
@@ -98,12 +99,9 @@ class ActionExecutor {
     delete this.registeredActions[actionType];
   };
 
-  registerAction = (
+  registerAction = <TOptions = Record<string, any>>(
     type: string,
-    handler: (
-      action: ActionType,
-      context?: Record<string, any>
-    ) => Promise<ActionResult>
+    handler: ActionHandler<TOptions>
   ) => {
     if (this.registeredActions[type]) {
       log_error(`registerAction: action type: ${type} already registered`);

package/actionsExecutor/ActionExecutorContext.tsx

@@ -5,44 +5,33 @@ import {
   actionExecutor as _actionExecutor,
   ActionResult,
 } from "./ActionExecutor";
-import {
-  batchRemoveAllFromNamespaceForStorage,
-  batchRemoveFromStorage,
-  batchSave,
-} from "../zappFrameworkUtils/localStorageHelper";
+import { ActionExecutionContext, ActionHandler } from "./types";
+import { batchRemoveAllFromNamespaceForStorage } 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 { 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";
-import {
-  EntryResolver,
-  resolveObjectValues,
-} from "../appUtils/contextKeysManager/contextResolver";
 import { useNavigation, useRivers } from "../reactHooks";
-import {
-  getInflatedDataSourceUrl,
-  getSearchContext,
-} from "../reactHooks/feed/useInflatedUrl";
-
 import { useContentTypes } from "@applicaster/zapp-react-native-redux/hooks";
 import { useSubscriberFor } from "../reactHooks/useSubscriberFor";
 import { APP_EVENTS } from "../appUtils/events";
-import {
-  localStorageToggleFlag,
-  sessionStorageToggleFlag,
-} from "./StorageActions";
+import { createLogger } from "../logger";
 
-import { screenSetVariable, screenToggleFlag } from "./ScreenActions";
 import {
-  StorageValuesToAdd,
-  StorageValuesToRemove,
-} from "../zappFrameworkUtils/types";
+  appRestartAction,
+  confirmDialogAction,
+  createNavigateToScreenAction,
+  localStorageRemoveAction,
+  localStorageSetAction,
+  localStorageToggleFlagAction,
+  refreshComponentAction,
+  screenSetVariableAction,
+  screenToggleFlagAction,
+  sendCloudEventAction,
+  sessionStorageRemoveAction,
+  sessionStorageSetAction,
+  sessionStorageToggleFlagAction,
+  switchLayoutAction,
+  showToastAction,
+} from "./actions";
 
 export const { log_error, log_info, log_debug } = createLogger({
   subsystem: "ActionExecutorContext",
@@ -50,25 +39,22 @@ export const { log_error, log_info, log_debug } = createLogger({
 });
 
 export type ActionExecutorContextType = {
-  registerAction: (
+  registerAction: <TOptions = Record<string, any>>(
     type: string,
-    handler: (
-      action: ActionType,
-      context?: Record<string, any>
-    ) => Promise<ActionResult>
+    handler: ActionHandler<TOptions>
   ) => void;
   unregisterAction: (type: string) => void;
   handleAction: (
     action: ActionType,
-    context?: Record<string, any>
+    context?: ActionExecutionContext
   ) => Promise<ActionResult>;
   handleActions: (
     actions: ActionType[],
-    context: Record<string, any>
+    context?: ActionExecutionContext
   ) => Promise<ActionResult>;
   handleEntryActions: (
     entry: ZappEntry,
-    context?: Record<string, any>
+    context?: ActionExecutionContext
   ) => Promise<ActionResult>;
 };
 
@@ -76,251 +62,35 @@ type Props = {
   children: React.ReactNode;
 };
 
-function findParentComponent(
-  childId: string,
-  parent: ZappRiver | ZappUIComponent
-): ZappRiver | ZappUIComponent | null {
-  for (const child of parent.ui_components) {
-    if (child.id === childId) return parent;
-
-    if (child.ui_components) {
-      const found = findParentComponent(childId, child);
-      if (found) return found;
-    }
-  }
-
-  return null;
-}
-
 const prepareDefaultActions = (actionExecutor) => {
-  actionExecutor.registerAction("localStorageSet", async (action) => {
-    const namespaces: StorageValuesToAdd = action.options.content;
-    await batchSave(namespaces, localStorage);
-    // TODO: Add support for ownershipKey and ownershipNamespace
-
-    return ActionResult.Success;
-  });
-
-  actionExecutor.registerAction("sessionStorageSet", async (action) => {
-    const namespaces: StorageValuesToAdd = action.options.content;
-    await batchSave(namespaces, sessionStorage);
-    // TODO: Add support for ownershipKey and ownershipNamespace
-
-    return ActionResult.Success;
-  });
-
-  actionExecutor.registerAction("localStorageRemove", async (action) => {
-    const namespaces: StorageValuesToRemove = action.options.content;
-    await batchRemoveFromStorage(namespaces, localStorage);
-    // TODO: Add support for ownershipKey and ownershipNamespace
-
-    return ActionResult.Success;
-  });
-
-  actionExecutor.registerAction("sessionStorageRemove", async (action) => {
-    const namespaces: StorageValuesToRemove = action.options.content;
-    await batchRemoveFromStorage(namespaces, sessionStorage);
-    // TODO: Add support for ownershipKey and ownershipNamespace
-
-    return ActionResult.Success;
-  });
+  actionExecutor.registerAction("localStorageSet", localStorageSetAction);
+  actionExecutor.registerAction("sessionStorageSet", sessionStorageSetAction);
+  actionExecutor.registerAction("localStorageRemove", localStorageRemoveAction);
 
   actionExecutor.registerAction(
-    "refreshComponent",
-    async (_action, context) => {
-      const dispatch = appStore.getDispatch();
-
-      const parentComponent = findParentComponent(
-        context?.component?.id,
-        context?.screenData
-      );
-
-      const componentSource = context?.component?.data?.source;
-
-      const componentData = componentSource
-        ? context.component.data
-        : parentComponent?.data;
-
-      const source = componentData?.source;
-      const mapping = componentData?.mapping;
-
-      let dataSource = source;
-
-      if (source && mapping) {
-        dataSource =
-          getInflatedDataSourceUrl({
-            source,
-            contexts: {
-              entry: context?.screenEntry,
-              screen: context?.screenData,
-              search: getSearchContext(null, mapping),
-            },
-            mapping,
-          }) || source;
-      }
-
-      log_info(`handleAction: refreshComponent for dataSource:${dataSource}`, {
-        source,
-        inflatedUrl: dataSource,
-        mapping,
-        entryContextId: context?.entryContext?.id,
-        entryId: context?.entry?.id,
-      });
-
-      // TODO: In theory we should wait callback to complete, before completing the action, but now it's not needed
-      // TODO: handle focused item removal
-      dispatch(
-        loadPipesData(dataSource, {
-          silentRefresh: false,
-          clearCache: true,
-          riverId: context?.screenData?.id,
-        })
-      );
-
-      return ActionResult.Success;
-    }
+    "sessionStorageRemove",
+    sessionStorageRemoveAction
   );
 
-  actionExecutor.registerAction("switchLayout", async (action) => {
-    log_info("handleAction: switchLayout event");
-
-    await localStorage.setItem(
-      ACTIVE_LAYOUT_ID_STORAGE_KEY,
-      action.options.layoutId
-    );
-
-    QuickBrickManager.sendQuickBrickEvent(QUICK_BRICK_EVENTS.FORCE_APP_RELOAD);
-
-    return ActionResult.Success;
-  });
-
-  actionExecutor.registerAction("appRestart", async () => {
-    log_info(`handleAction: ${QUICK_BRICK_EVENTS.FORCE_APP_RELOAD} event`);
-
-    QuickBrickManager.sendQuickBrickEvent(QUICK_BRICK_EVENTS.FORCE_APP_RELOAD);
-
-    return ActionResult.Success;
-  });
-
-  actionExecutor.registerAction("confirmDialog", async (action) => {
-    log_info("handleAction: confirmDialog event");
-
-    return new Promise<ActionResult>((resolve) => {
-      showConfirmationDialog({
-        ...action.options,
-        confirmCompletion: () => resolve(ActionResult.Success),
-        cancelCompletion: () => resolve(ActionResult.Cancel),
-      });
-    });
-  });
-
-  actionExecutor.registerAction("sendCloudEvent", async (action, context) => {
-    try {
-      const options = action.options;
-
-      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,
-              screen: screenResolver,
-            })
-          : options?.data || entry;
-
-      const cloudEvent = await createCloudEvent({
-        type: options.type || "com.applicaster.selector.action.v1",
-        data,
-        subject: options.subject || entry?.id,
-      });
-
-      log_info("handleAction: sendCloudEvent event", { cloudEvent });
-
-      const { error, code } = await sendCloudEvent(cloudEvent, options.url);
-
-      if (error) {
-        log_error("sendCloudEvent: error sending cloud event", { error });
-
-        return ActionResult.Error;
-      }
-
-      if (code && code >= 200 && code < 300 && !error) {
-        log_info("sendCloudEvent: cloud event sent successfully");
-
-        return ActionResult.Success;
-      }
-    } catch (error) {
-      log_error("sendCloudEvent: error sending cloud event", {
-        action,
-        error,
-      });
-    }
-
-    return ActionResult.Error;
-  });
+  actionExecutor.registerAction("refreshComponent", refreshComponentAction);
+  actionExecutor.registerAction("switchLayout", switchLayoutAction);
+  actionExecutor.registerAction("appRestart", appRestartAction);
+  actionExecutor.registerAction("confirmDialog", confirmDialogAction);
+  actionExecutor.registerAction("sendCloudEvent", sendCloudEventAction);
 
   actionExecutor.registerAction(
     "sessionStorageToggleFlag",
-    async (
-      action: ActionType,
-      context?: Record<string, any>
-    ): Promise<ActionResult> => {
-      return await sessionStorageToggleFlag(context, action);
-    }
+    sessionStorageToggleFlagAction
   );
 
   actionExecutor.registerAction(
     "localStorageToggleFlag",
-    async (
-      action: ActionType,
-      context?: Record<string, any>
-    ): Promise<ActionResult> => {
-      return await localStorageToggleFlag(context, action);
-    }
-  );
-
-  actionExecutor.registerAction(
-    "screenSetVariable",
-    async (
-      action: ActionType,
-      context?: Record<string, any>
-    ): Promise<ActionResult> => {
-      const route = context?.screenRoute;
-      const screenStateStore = context?.screenStateStore;
-
-      await screenSetVariable(
-        route,
-        screenStateStore,
-        { entry: context?.entry, options: action.options },
-        action
-      );
-
-      return Promise.resolve(ActionResult.Success);
-    }
+    localStorageToggleFlagAction
   );
 
-  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 Promise.resolve(ActionResult.Success);
-    }
-  );
+  actionExecutor.registerAction("screenSetVariable", screenSetVariableAction);
+  actionExecutor.registerAction("screenToggleFlag", screenToggleFlagAction);
+  actionExecutor.registerAction("showToast", showToastAction);
 };
 
 export const ActionExecutorContext =
@@ -361,82 +131,7 @@ export function withActionExecutor(Component) {
     useEffect(() => {
       return _actionExecutor.registerAction(
         "navigateToScreen",
-
-        async (action: ActionType, context?: Record<string, any>) => {
-          const screenType = action.options?.typeMapping;
-
-          if (!screenType) {
-            log_error("navigateToScreen: typeMapping option is missing");
-
-            return ActionResult.Error;
-          }
-
-          const navigationAction = action.options?.navigationAction;
-          const entrySource = action.options?.entry;
-
-          const entry = entrySource
-            ? entrySource === "@{entry/}"
-              ? context?.entry
-              : entrySource
-            : null;
-
-          if (entry) {
-            if (typeof entry !== "object") {
-              log_error(
-                `navigateToScreen: entry option is not an object, entry: ${entry}`
-              );
-
-              return ActionResult.Error;
-            }
-
-            log_info(
-              `navigateToScreen: navigating to screen type: ${screenType} with entry id: ${entry.id}`
-            );
-
-            const overriddenEntry = {
-              ...entry,
-              type: {
-                value: screenType,
-              },
-            };
-
-            if (navigationAction === "push") {
-              navigator.push(overriddenEntry);
-            } else {
-              navigator.replace(overriddenEntry);
-            }
-
-            return ActionResult.Success;
-          }
-
-          const screenId = contentTypes?.[screenType]?.screen_id || null;
-
-          if (!screenId) {
-            log_error(
-              `navigateToScreen: can not resolve screen type mapping: ${screenType}`
-            );
-
-            return ActionResult.Error;
-          }
-
-          const river = rivers[screenId];
-
-          if (!river) {
-            log_error("navigateToScreen: can not resolve river");
-
-            return ActionResult.Error;
-          }
-
-          context?.callback?.({ success: false, error: null, abort: true });
-
-          if (navigationAction === "push") {
-            navigator.push(river);
-          } else {
-            navigator.replace(river);
-          }
-
-          return ActionResult.Success;
-        }
+        createNavigateToScreenAction(navigator, rivers, contentTypes)
       );
     }, [navigator, rivers, contentTypes]);
 

package/actionsExecutor/actions/appRestart.ts

@@ -0,0 +1,24 @@
+/// <reference types="@applicaster/applicaster-types" />
+import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Restarts the application by triggering a force reload event.
+ * This action does not require any options or context.
+ */
+export const appRestartAction: ActionHandler =
+  async (): Promise<ActionResult> => {
+    log_info(`handleAction: ${QUICK_BRICK_EVENTS.FORCE_APP_RELOAD} event`);
+
+    QuickBrickManager.sendQuickBrickEvent(QUICK_BRICK_EVENTS.FORCE_APP_RELOAD);
+
+    return ActionResult.Success;
+  };

package/actionsExecutor/actions/confirmDialog.ts

@@ -0,0 +1,53 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { showConfirmationDialog } from "../../alertUtils";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the confirmDialog action.
+ */
+export interface ConfirmDialogOptions {
+  /** Dialog title (required) */
+  title: string;
+
+  /** Dialog message */
+  message?: string;
+
+  /** Confirm button text */
+  okButtonText?: string;
+
+  /** Cancel button text */
+  cancelButtonText?: string;
+
+  /** Callback when confirmed (deprecated - use action result) */
+  confirmCompletion?: () => void;
+
+  /** Callback when cancelled (deprecated - use action result) */
+  cancelCompletion?: () => void;
+}
+
+/**
+ * Shows a confirmation dialog to the user.
+ * Resolves to Success if user confirms, Cancel if user dismisses.
+ */
+export const confirmDialogAction: ActionHandler<ConfirmDialogOptions> = async (
+  action
+): Promise<ActionResult> => {
+  log_info("handleAction: confirmDialog event");
+
+  const options = action.options as ConfirmDialogOptions;
+
+  return new Promise<ActionResult>((resolve) => {
+    showConfirmationDialog({
+      ...options,
+      confirmCompletion: () => resolve(ActionResult.Success),
+      cancelCompletion: () => resolve(ActionResult.Cancel),
+    });
+  });
+};

package/actionsExecutor/actions/index.ts

@@ -0,0 +1,30 @@
+// Export action handlers
+export { localStorageSetAction } from "./localStorageSet";
+
+export { sessionStorageSetAction } from "./sessionStorageSet";
+
+export { localStorageRemoveAction } from "./localStorageRemove";
+
+export { sessionStorageRemoveAction } from "./sessionStorageRemove";
+
+export { refreshComponentAction } from "./refreshComponent";
+
+export { switchLayoutAction } from "./switchLayout";
+
+export { appRestartAction } from "./appRestart";
+
+export { confirmDialogAction } from "./confirmDialog";
+
+export { sendCloudEventAction } from "./sendCloudEvent";
+
+export { sessionStorageToggleFlagAction } from "./sessionStorageToggleFlag";
+
+export { localStorageToggleFlagAction } from "./localStorageToggleFlag";
+
+export { screenSetVariableAction } from "./screenSetVariable";
+
+export { screenToggleFlagAction } from "./screenToggleFlag";
+
+export { createNavigateToScreenAction } from "./navigateToScreen";
+
+export { showToastAction } from "./showToast";

package/actionsExecutor/actions/localStorageRemove.ts

@@ -0,0 +1,27 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import { batchRemoveFromStorage } from "../../zappFrameworkUtils/localStorageHelper";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { StorageValuesToRemove } from "../../zappFrameworkUtils/types";
+
+/**
+ * Options for localStorage/sessionStorage remove actions.
+ */
+export interface StorageRemoveOptions {
+  /** The keys to remove, organized by namespace */
+  content: StorageValuesToRemove;
+}
+
+/**
+ * Removes values from local storage organized by namespaces.
+ */
+export const localStorageRemoveAction: ActionHandler<
+  StorageRemoveOptions
+> = async (action): Promise<ActionResult> => {
+  const namespaces = action.options.content;
+  await batchRemoveFromStorage(namespaces, localStorage);
+  // TODO: Add support for ownershipKey and ownershipNamespace
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/localStorageSet.ts

@@ -0,0 +1,28 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import { batchSave } from "../../zappFrameworkUtils/localStorageHelper";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { StorageValuesToAdd } from "../../zappFrameworkUtils/types";
+
+/**
+ * Options for localStorage/sessionStorage set actions.
+ */
+export interface StorageSetOptions {
+  /** The values to save, organized by namespace */
+  content: StorageValuesToAdd;
+}
+
+/**
+ * Saves values to local storage organized by namespaces.
+ * The values persist across app sessions.
+ */
+export const localStorageSetAction: ActionHandler<StorageSetOptions> = async (
+  action
+): Promise<ActionResult> => {
+  const namespaces = action.options.content;
+  await batchSave(namespaces, localStorage);
+  // TODO: Add support for ownershipKey and ownershipNamespace
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/localStorageToggleFlag.ts

@@ -0,0 +1,28 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { localStorageToggleFlag } from "../StorageActions";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+
+/**
+ * Options for storage toggle flag actions (localStorage/sessionStorage).
+ */
+export interface StorageToggleFlagOptions {
+  /** The key/namespace for storing the flag */
+  key: string;
+
+  /** Path to extract the tag from entry */
+  selector?: string;
+
+  /** Maximum number of items that can be selected */
+  max_items?: number;
+}
+
+/**
+ * Toggles a flag in local storage (adds or removes an item from a collection).
+ * Used for features like favorites, watchlists, etc.
+ */
+export const localStorageToggleFlagAction: ActionHandler<
+  StorageToggleFlagOptions
+> = async (action, context?: ActionExecutionContext): Promise<ActionResult> => {
+  return await localStorageToggleFlag(context, action);
+};