@applicaster/zapp-react-native-utils 16.0.0-alpha.9183418480 → 16.0.0-alpha.9506982263

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);
+};

package/actionsExecutor/actions/navigateToScreen.ts

@@ -0,0 +1,123 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info, log_error } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the navigateToScreen action.
+ */
+export interface NavigateToScreenOptions {
+  /** The screen type to navigate to (from content types mapping) */
+  typeMapping: string;
+
+  /** Navigation action: push adds to history, replace replaces current screen */
+  navigationAction?: "push" | "replace";
+
+  /**
+   * Entry to navigate with. Can be:
+   * - "@{entry/}" to use the context entry
+   * - A ZappEntry object
+   * - undefined to navigate to screen without entry
+   */
+  entry?: "@{entry/}" | ZappEntry;
+}
+
+/**
+ * Creates a navigation action handler with the provided dependencies.
+ * This factory pattern allows the action to access navigation state at runtime.
+ *
+ * @param navigator - The app navigator for push/replace operations
+ * @param rivers - Map of screen IDs to river definitions
+ * @param contentTypes - Map of content type names to screen configurations
+ * @returns An action handler that performs screen navigation
+ */
+export function createNavigateToScreenAction(
+  navigator: QuickBrickAppNavigator,
+  rivers: Record<string, ZappRiver>,
+  contentTypes: ZappContentTypes
+): ActionHandler<NavigateToScreenOptions> {
+  return async function navigateToScreenAction(
+    action,
+    context?: ActionExecutionContext
+  ): Promise<ActionResult> {
+    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: ZappEntry = {
+        ...entry,
+        type: {
+          value: screenType,
+        },
+      };
+
+      if (navigationAction === "push") {
+        navigator.push(overriddenEntry);
+      } else {
+        // Use replaceTop for entries since replace() only accepts ZappRiver
+        navigator.replaceTop(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;
+  };
+}

package/actionsExecutor/actions/refreshComponent.ts

@@ -0,0 +1,79 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
+import { loadPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
+import {
+  getInflatedDataSourceUrl,
+  getSearchContext,
+} from "../../reactHooks/feed/useInflatedUrl";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/** Prefer component data.source, otherwise direct UIComponentContext parent. */
+function getComponentFeedData(component) {
+  if (component?.data?.source) {
+    return component.data;
+  }
+
+  if (component?.parent?.data?.source) {
+    return component.parent.data;
+  }
+
+  return null;
+}
+
+/**
+ * Refreshes a component's data by reloading its data source.
+ * Supports URL inflation with context variables.
+ */
+export const refreshComponentAction: ActionHandler = async (
+  _action,
+  context?: ActionExecutionContext
+): Promise<ActionResult> => {
+  const dispatch = appStore.getDispatch();
+
+  const componentData = getComponentFeedData(context?.component);
+
+  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;
+};

package/actionsExecutor/actions/screenSetVariable.ts

@@ -0,0 +1,35 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { screenSetVariable } from "../ScreenActions";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+
+/**
+ * Options for screenSetVariable action.
+ */
+export interface ScreenSetVariableOptions {
+  /** The key/namespace for storing the variable */
+  key: string;
+
+  /** Path to extract the value from entry */
+  selector?: string;
+}
+
+/**
+ * Sets a variable in screen state storage.
+ * The value is extracted from the entry using the selector option.
+ */
+export const screenSetVariableAction: ActionHandler<
+  ScreenSetVariableOptions
+> = async (action, context?: ActionExecutionContext): Promise<ActionResult> => {
+  const route = context?.screenRoute;
+  const screenStateStore = context?.screenStateStore;
+
+  await screenSetVariable(
+    route,
+    screenStateStore,
+    { entry: context?.entry, options: action.options },
+    action
+  );
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/screenToggleFlag.ts

@@ -0,0 +1,38 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { screenToggleFlag } from "../ScreenActions";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+
+/**
+ * Options for screenToggleFlag action.
+ */
+export interface ScreenToggleFlagOptions {
+  /** The key/namespace for storing the flag */
+  key: string;
+
+  /** Path to extract the tag from entry (e.g., "extensions.tag") */
+  selector?: string;
+
+  /** Maximum number of items that can be selected */
+  max_items?: number;
+}
+
+/**
+ * Toggles a flag in screen state storage (adds or removes an item from a collection).
+ * Useful for screen-level multi-select functionality.
+ */
+export const screenToggleFlagAction: ActionHandler<
+  ScreenToggleFlagOptions
+> = async (action, context?: ActionExecutionContext): Promise<ActionResult> => {
+  const screenRoute = context?.screenRoute;
+  const screenStateStore = context?.screenStateStore;
+
+  await screenToggleFlag(
+    screenRoute,
+    screenStateStore,
+    { entry: context?.entry, options: action.options },
+    action
+  );
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/sendCloudEvent.ts

@@ -0,0 +1,88 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { createCloudEvent, sendCloudEvent } from "../../cloudEventsUtils";
+import {
+  EntryResolver,
+  resolveObjectValues,
+} from "../../appUtils/contextKeysManager/contextResolver";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info, log_error } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the sendCloudEvent action.
+ */
+export interface SendCloudEventOptions {
+  /** The cloud event type (defaults to "com.applicaster.selector.action.v1") */
+  type?: string;
+
+  /** The event data payload */
+  data?: Record<string, any>;
+
+  /** The event subject (defaults to entry.id) */
+  subject?: string;
+
+  /** The URL endpoint to send the event to */
+  url: string;
+
+  /** Whether to inflate data with context variables */
+  inflateData?: boolean;
+}
+
+/**
+ * Sends a cloud event to a remote endpoint.
+ * Supports data inflation using context variables from entry and screen.
+ */
+export const sendCloudEventAction: ActionHandler<
+  SendCloudEventOptions
+> = async (action, context?: ActionExecutionContext): Promise<ActionResult> => {
+  try {
+    const options = action.options as SendCloudEventOptions;
+
+    const entry = context?.entry || {};
+    const entryResolver = new EntryResolver(entry as ZappEntry);
+    const screenData = context?.screenStateStore?.getState?.()?.data || {};
+    const screenResolver = new EntryResolver(screenData as ZappEntry);
+
+    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 || String((entry as ZappEntry)?.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;
+};

package/actionsExecutor/actions/sessionStorageRemove.ts

@@ -0,0 +1,19 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
+import { batchRemoveFromStorage } from "../../zappFrameworkUtils/localStorageHelper";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { StorageRemoveOptions } from "./localStorageRemove";
+
+/**
+ * Removes values from session storage organized by namespaces.
+ */
+export const sessionStorageRemoveAction: ActionHandler<
+  StorageRemoveOptions
+> = async (action): Promise<ActionResult> => {
+  const namespaces = action.options.content;
+  await batchRemoveFromStorage(namespaces, sessionStorage);
+  // TODO: Add support for ownershipKey and ownershipNamespace
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/sessionStorageSet.ts

@@ -0,0 +1,20 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
+import { batchSave } from "../../zappFrameworkUtils/localStorageHelper";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { StorageSetOptions } from "./localStorageSet";
+
+/**
+ * Saves values to session storage organized by namespaces.
+ * The values persist only for the current app session.
+ */
+export const sessionStorageSetAction: ActionHandler<StorageSetOptions> = async (
+  action
+): Promise<ActionResult> => {
+  const namespaces = (action.options as StorageSetOptions).content;
+  await batchSave(namespaces, sessionStorage);
+  // TODO: Add support for ownershipKey and ownershipNamespace
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/sessionStorageToggleFlag.ts

@@ -0,0 +1,15 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { sessionStorageToggleFlag } from "../StorageActions";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+import { StorageToggleFlagOptions } from "./localStorageToggleFlag";
+
+/**
+ * Toggles a flag in session storage (adds or removes an item from a collection).
+ * Values persist only for the current app session.
+ */
+export const sessionStorageToggleFlagAction: ActionHandler<
+  StorageToggleFlagOptions
+> = async (action, context?: ActionExecutionContext): Promise<ActionResult> => {
+  return await sessionStorageToggleFlag(context, action);
+};

package/actionsExecutor/actions/showToast.ts

@@ -0,0 +1,87 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { postEvent } from "../../reactHooks/useSubscriberFor";
+
+export const CONFIRMATION_TOAST_SOURCE = "confirmation";
+
+export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 1000;
+
+/**
+ * Shows a mobile confirmation toast with Theme defaults from
+ * `Confirmation Toast / Message` in the base theme plugin.
+ *
+ * This action is confirmation-only by design: it always stamps
+ * `source: "confirmation"` (so Theme confirmation styles apply) and defaults
+ * `timeout` to 1000 ms. Non-confirmation toasts (e.g. Offline Experience)
+ * must post on the shared `"showToast"` event bus directly and omit `source`.
+ * Callers may override individual style fields; Theme supplies the rest.
+ *
+ * @example From React via ActionExecutorContext
+ * ```tsx
+ * import React, { useContext } from "react";
+ * import { ActionExecutorContext } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutorContext";
+ *
+ * function QueueButton() {
+ *   const { handleAction } = useContext(ActionExecutorContext);
+ *
+ *   const onPress = () => {
+ *     void handleAction({
+ *       type: "showToast",
+ *       options: { message: "Added to queue" },
+ *     });
+ *   };
+ *
+ *   return <Button onPress={onPress} title="Add to queue" />;
+ * }
+ * ```
+ *
+ * @example From code via the actionExecutor singleton
+ * ```ts
+ * import { actionExecutor } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutor";
+ *
+ * await actionExecutor.handleAction({
+ *   type: "showToast",
+ *   options: {
+ *     message: "Playlist created",
+ *     style: { backgroundColor: "#00AA55" }, // optional partial override
+ *   },
+ * });
+ * ```
+ *
+ * @example From entry / pipes actions JSON
+ * ```json
+ * {
+ *   "type": "showToast",
+ *   "options": {
+ *     "message": "Item removed from playlist"
+ *   }
+ * }
+ * ```
+ */
+export interface ShowToastActionOptions {
+  id?: string;
+  message?: string;
+  extraMessage?: string;
+  style?: any;
+  timeout?: number;
+}
+
+export const showToastAction: ActionHandler<ShowToastActionOptions> = async (
+  action
+): Promise<ActionResult> => {
+  const options = action?.options;
+
+  postEvent("showToast", [
+    {
+      id: options?.id,
+      message: options?.message,
+      extraMessage: options?.extraMessage,
+      style: options?.style,
+      timeout: options?.timeout ?? CONFIRMATION_TOAST_DEFAULT_TIMEOUT,
+      source: CONFIRMATION_TOAST_SOURCE,
+    },
+  ]);
+
+  return ActionResult.Success;
+};

package/actionsExecutor/actions/switchLayout.ts

@@ -0,0 +1,40 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { ACTIVE_LAYOUT_ID_STORAGE_KEY } from "@applicaster/quick-brick-core/App/remoteContextReloader/consts";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the switchLayout action.
+ */
+export interface SwitchLayoutOptions {
+  /** The ID of the layout to switch to */
+  layoutId: string;
+}
+
+/**
+ * Switches the active layout and triggers an app reload.
+ * Saves the new layout ID to local storage before reloading.
+ */
+export const switchLayoutAction: ActionHandler<SwitchLayoutOptions> = async (
+  action
+): Promise<ActionResult> => {
+  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;
+};