@applicaster/zapp-react-native-utils 16.0.0-alpha.1263110541 → 16.0.0-alpha.1314750780

package/actionsExecutor/actions/openBottomSheet.ts

@@ -8,6 +8,7 @@ import { modalOrchestrator } from "../../modalState/ModalOrchestrator";
 import { openBottomSheetModal } from "../../modalState/store";
 import {
   DynamicCollectionOptions,
+  getMenuItemActions,
   isPresentSubMenuAction,
   Menu,
   MenuItem,
@@ -91,6 +92,7 @@ export function entryToMenuItem(
     icon: firstImage?.src,
     isSelected: currentSelection.includes(itemId),
     action: primaryAction,
+    actions: tapActions,
     entryActions: entry.extensions?.entry_action || [],
   };
 }
@@ -206,7 +208,11 @@ export async function openBottomSheetAction(
           items: [],
           onPress: () => {},
           contentComponent: content.component,
-          contentComponentProps: content.props || {},
+          contentComponentProps: {
+            ...(content.props || {}),
+            actionContext: context,
+          },
+          themePluginId,
         },
       });
 
@@ -222,7 +228,18 @@ export async function openBottomSheetAction(
 
     let dynamicCollection: DynamicCollectionOptions | undefined;
 
-    if (Array.isArray(inlineItems) && inlineItems.length > 0) {
+    const rawDynamicCollection =
+      content?.dynamicCollection ??
+      content?.extensions?.dynamic_collection_options;
+
+    // An empty items array is a valid starting state for a provider-backed or
+    // offline collection. A sheet with neither items nor a source still errors.
+    const hasDynamicCollection = Boolean(rawDynamicCollection);
+
+    if (
+      Array.isArray(inlineItems) &&
+      (inlineItems.length > 0 || hasDynamicCollection)
+    ) {
       log_info("openBottomSheet: using inline items from action options", {
         count: inlineItems.length,
       });
@@ -234,10 +251,7 @@ export async function openBottomSheetAction(
         entryToMenuItem(entry, behavior?.currentSelection ?? [])
       );
 
-      dynamicCollection = parseDynamicCollectionOptions(
-        content?.dynamicCollection ??
-          content?.extensions?.dynamic_collection_options
-      );
+      dynamicCollection = parseDynamicCollectionOptions(rawDynamicCollection);
     } else if (itemsUrl) {
       log_info(`openBottomSheet: loading items from source: ${itemsUrl}`);
 
@@ -275,6 +289,9 @@ export async function openBottomSheetAction(
         dynamicCollection,
         themePluginId,
         styleOverrides: styleOverrides ?? content?.styleOverrides,
+        emptyMessage: content?.emptyMessage,
+        operationButtons: content?.operationButtons,
+        context,
       },
     };
 
@@ -288,18 +305,21 @@ export async function openBottomSheetAction(
      *   reference it.
      */
     const onItemPress = async (item: MenuItem): Promise<void> => {
-      if (!item.action || isPresentSubMenuAction(item.action)) {
-        // Submenu navigation is handled internally by the orchestrator
-        return;
-      }
+      const actions = getMenuItemActions(item);
 
-      await actionExecutor.handleAction(
-        item.action as ActionType,
-        {
-          ...context,
-          entry: item as any,
-        } as any
+      const executableActions = actions.filter(
+        (action) => !isPresentSubMenuAction(action)
       );
+
+      if (executableActions.length > 0) {
+        await actionExecutor.handleActions(
+          executableActions as ActionType[],
+          {
+            ...context,
+            entry: item as any,
+          } as any
+        );
+      }
     };
 
     if (action.options?.replace) {

package/actionsExecutor/actions/presentScreen.ts

@@ -0,0 +1,78 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler, ActionExecutionContext } from "../types";
+import type { PresentScreenFn } from "../../reactHooks/navigation/usePresentScreen";
+import { createLogger } from "../../logger";
+
+const { log_error } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the presentScreen action.
+ */
+export interface PresentScreenOptions {
+  /** The screen type to present (from content types mapping) */
+  typeMapping: string;
+
+  /**
+   * Entry to present the screen with. Can be:
+   * - "@{entry/}" to use the context entry
+   * - A ZappEntry object
+   * - undefined to present the screen without an entry
+   */
+  entry?: "@{entry/}" | ZappEntry;
+}
+
+/**
+ * Creates a present-screen action handler with the provided dependencies.
+ *
+ * Unlike navigateToScreen, this action does not return until the presented
+ * screen reports a result, so a screen that gates the flow (a parental lock,
+ * for example) can stop the remaining actions by being cancelled.
+ *
+ * @param presentScreen - Presents a screen as a modal and resolves with its result
+ * @returns An action handler that presents a screen and awaits its outcome
+ */
+export function createPresentScreenAction(
+  presentScreen: PresentScreenFn
+): ActionHandler<PresentScreenOptions> {
+  return async function presentScreenAction(
+    action,
+    context?: ActionExecutionContext
+  ): Promise<ActionResult> {
+    const typeMapping = action.options?.typeMapping;
+
+    if (!typeMapping) {
+      log_error("presentScreen: typeMapping option is missing");
+
+      return ActionResult.Error;
+    }
+
+    const entrySource = action.options?.entry;
+
+    const entry = entrySource
+      ? entrySource === "@{entry/}"
+        ? context?.entry
+        : entrySource
+      : undefined;
+
+    if (entry && typeof entry !== "object") {
+      log_error(
+        `presentScreen: entry option is not an object, entry: ${entry}`
+      );
+
+      return ActionResult.Error;
+    }
+
+    const result = await presentScreen({ typeMapping, entry });
+
+    if (result.error) {
+      return ActionResult.Error;
+    }
+
+    // Anything short of success stops the remaining actions in the chain.
+    return result.success ? ActionResult.Success : ActionResult.Cancel;
+  };
+}

package/actionsExecutor/actions/screenToggleFlag.ts

@@ -27,12 +27,10 @@ export const screenToggleFlagAction: ActionHandler<
   const screenRoute = context?.screenRoute;
   const screenStateStore = context?.screenStateStore;
 
-  await screenToggleFlag(
+  return await screenToggleFlag(
     screenRoute,
     screenStateStore,
     { entry: context?.entry, options: action.options },
     action
   );
-
-  return ActionResult.Success;
 };

package/actionsExecutor/actions/showAlert.ts

@@ -0,0 +1,51 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { showAlertDialog } 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 showAlert action.
+ */
+export interface ShowAlertOptions {
+  /** Dialog title (required) */
+  title: string;
+
+  /** Dialog message */
+  message?: string;
+
+  /** Dismiss button text. Defaults to "OK" */
+  okButtonText?: string;
+}
+
+/**
+ * Tells the user something and waits for them to acknowledge it.
+ *
+ * One button, because there is nothing to decide. Use `confirmDialog` when the
+ * user is choosing between going on and backing out; a `confirmDialog` without
+ * a cancel label still renders two buttons, the second one blank.
+ *
+ * Always resolves to Success: dismissing a notice is not a cancellation, so the
+ * rest of the chain runs.
+ */
+export const showAlertAction: ActionHandler<ShowAlertOptions> = async (
+  action
+): Promise<ActionResult> => {
+  log_info("handleAction: showAlert event");
+
+  const options = action.options as ShowAlertOptions;
+
+  return new Promise<ActionResult>((resolve) => {
+    showAlertDialog({
+      title: options?.title,
+      message: options?.message,
+      okButtonText: options?.okButtonText || "OK",
+      completion: () => resolve(ActionResult.Success),
+    });
+  });
+};

package/actionsExecutor/actions/showToast.ts

@@ -5,7 +5,7 @@ import { postEvent } from "../../reactHooks/useSubscriberFor";
 
 export const CONFIRMATION_TOAST_SOURCE = "confirmation";
 
-export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 1000;
+export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 5000;
 
 /**
  * Shows a mobile confirmation toast with Theme defaults from
@@ -13,7 +13,7 @@ export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 1000;
  *
  * 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)
+ * `timeout` to 5000 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.
  *

package/actionsExecutor/consts.ts

@@ -9,6 +9,7 @@ export const ACTION_TYPES = {
   PRESENT_SUB_MENU: "presentSubMenu",
   SEND_CLOUD_EVENT: "sendCloudEvent",
   NAVIGATE_TO_SCREEN: "navigateToScreen",
+  PRESENT_SCREEN: "presentScreen",
   GO_BACK: "goBack",
   GO_HOME: "goHome",
   SHOW_TOAST: "showToast",
@@ -22,6 +23,7 @@ export const ACTION_TYPES = {
   SWITCH_LAYOUT: "switchLayout",
   APP_RESTART: "appRestart",
   CONFIRM_DIALOG: "confirmDialog",
+  SHOW_ALERT: "showAlert",
   SCREEN_SET_VARIABLE: "screenSetVariable",
   SCREEN_TOGGLE_FLAG: "screenToggleFlag",
 } as const;

package/actionsExecutor/feedDecorator.ts

@@ -47,6 +47,11 @@ function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
         ? "sessionStorageToggleFlag"
         : "localStorageToggleFlag";
 
+  // the toggle actions read their limit from their own options
+  const maxItems = Number(
+    decoratedFeed.extensions?.preference_editor_options?.max_items
+  );
+
   decoratedFeed.entry?.forEach((entry: ZappEntry) => {
     entry.type.value = "action";
     entry.id = entry.extensions?.tag || entry.id;
@@ -59,6 +64,7 @@ function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
             type: actionType,
             options: {
               key,
+              ...(maxItems > 0 && { max_items: maxItems }),
             },
           },
         ],

package/actionsExecutor/types.ts

@@ -30,6 +30,13 @@ export interface ActionExecutionContext {
   /** Context entry for additional data */
   entryContext?: ZappEntry;
 
+  /**
+   * Sets the entry that the screen opened by this tap reads as `@{entry/...}`.
+   * Actions that open a screen call it themselves, so a tap that does not open
+   * one (a selection toggle) does not update the shared entry context.
+   */
+  setEntryContext?: (entry: ZappEntry) => void;
+
   /** Callback function for action completion */
   callback?: (result: { success: boolean; error: any; abort: boolean }) => void;
 

package/appUtils/contextKeysManager/__tests__/getKey/failure.test.ts

@@ -1,4 +1,4 @@
-import { ContextKeysManager, NOTHING } from "../..";
+import { ContextKeysManager } from "../..";
 
 describe("Context Keys Manager - getKey", () => {
   it("returns null if key is invalid", async () => {
@@ -34,8 +34,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest.spyOn(contextManager, "getKeyByReference");
-
     // run
     const result = await contextManager.getKey(invalidKey);
 
@@ -50,7 +48,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key: invalidKey },
     });
 
-    expect(getKeyByReference).not.toHaveBeenCalled();
     expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
     expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
@@ -90,10 +87,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -107,8 +100,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key },
     });
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -152,10 +143,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -169,8 +156,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key },
     });
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -214,10 +199,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -231,8 +212,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key },
     });
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/getKey/success/fullSearch.test.ts

@@ -1,4 +1,4 @@
-import { ContextKeysManager, NOTHING } from "../../..";
+import { ContextKeysManager } from "../../..";
 
 describe("Context Keys Manager - getKey", () => {
   it("returns value if found in session-storage", async () => {
@@ -35,10 +35,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -47,8 +43,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -92,10 +86,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -104,8 +94,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -149,10 +137,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -161,8 +145,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -209,10 +191,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -221,8 +199,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/getKey/success/searchInSecure.test.ts

@@ -1,4 +1,4 @@
-import { ContextKeysManager, NOTHING } from "../../..";
+import { ContextKeysManager } from "../../..";
 import { DEFAULT_NAMESPACE } from "../../../consts";
 
 describe("Context Keys Manager - getKey", () => {
@@ -36,10 +36,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -48,8 +44,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", DEFAULT_NAMESPACE);
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       DEFAULT_NAMESPACE

package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts

@@ -34,11 +34,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest.spyOn(
-      contextManager,
-      "removeReferenceForKey"
-    );
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -51,8 +46,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).not.toHaveBeenCalled();
-
     expect(mockedSessionStorage.removeItem).not.toHaveBeenCalled();
     expect(mockedLocalStorage.removeItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.removeItem).not.toHaveBeenCalled();
@@ -92,10 +85,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -107,8 +96,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -159,10 +146,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -174,8 +157,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -226,10 +207,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -241,8 +218,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/removeKey/success.test.ts

@@ -34,10 +34,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -46,8 +42,6 @@ describe("Context Keys Manager - removeKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"