@applicaster/zapp-react-native-utils 16.0.0-alpha.1701179921 → 16.0.0-alpha.1733304298

package/actionUtils/index.ts

@@ -3,5 +3,7 @@ import { isTV } from "../reactUtils";
 
 export const resolveDefaultAssetUri = (source: string | number): string =>
   isTV()
-    ? (source as string)
+    ? typeof source === "number"
+      ? Image.resolveAssetSource(source)?.uri || ""
+      : (source as string)
     : Image.resolveAssetSource(source as number)?.uri || "";

package/actionsExecutor/__tests__/StorageActions.test.ts

@@ -0,0 +1,98 @@
+import { ActionResult } from "../ActionExecutor";
+import { localStorageToggleFlag } from "../StorageActions";
+import { TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT } from "../consts";
+import { postEvent } from "../../reactHooks/useSubscriberFor";
+
+jest.mock("../ActionExecutorContext", () => ({
+  log_error: jest.fn(),
+  log_info: jest.fn(),
+}));
+
+jest.mock("../../reactHooks/useSubscriberFor", () => ({
+  postEvent: jest.fn(),
+}));
+
+// In-memory stand-in for the storage-backed provider; the limit check under
+// test lives in storageToggleFlag, not in the provider.
+const mockStore: Record<string, string[]> = {};
+
+jest.mock("../../storage/StorageMultiSelectProvider", () => ({
+  StorageMultiSelectProvider: {
+    getProvider: (keyNamespace: string) => ({
+      getSelectedAsync: async () => [...(mockStore[keyNamespace] ?? [])],
+      addItem: async (item: string) => {
+        mockStore[keyNamespace] = [...(mockStore[keyNamespace] ?? []), item];
+      },
+      removeItem: async (item: string) => {
+        mockStore[keyNamespace] = (mockStore[keyNamespace] ?? []).filter(
+          (it) => it !== item
+        );
+      },
+    }),
+  },
+}));
+
+const KEY = "user_preferences.teams";
+
+// Entries of a team selection feed with explicit tap actions
+// (localStorageToggleFlag with key and selector).
+const teamEntry = (n: number) =>
+  ({
+    id: `team-${n}`,
+    title: `Team ${n}`,
+    type: { value: "action" },
+    extensions: { tag: `TEAM ${n}` },
+  }) as unknown as ZappEntry;
+
+const tapAction = (extraOptions = {}) =>
+  ({
+    type: "localStorageToggleFlag",
+    options: { key: KEY, selector: "extensions.tag", ...extraOptions },
+  }) as unknown as ActionType;
+
+const tapTeams = async (count: number, extraOptions = {}) => {
+  const results: ActionResult[] = [];
+
+  for (let n = 1; n <= count; n++) {
+    results.push(
+      await localStorageToggleFlag(
+        { entry: teamEntry(n) },
+        tapAction(extraOptions)
+      )
+    );
+  }
+
+  return results;
+};
+
+describe("localStorageToggleFlag max_items", () => {
+  beforeEach(() => {
+    delete mockStore[KEY];
+    jest.clearAllMocks();
+  });
+
+  it("blocks the 11th team when max_items is in the action options", async () => {
+    const results = await tapTeams(11, { max_items: "10" });
+
+    expect(results.slice(0, 10)).toEqual(Array(10).fill(ActionResult.Success));
+    expect(results[10]).toBe(ActionResult.Cancel);
+    expect(mockStore[KEY]).toHaveLength(10);
+
+    expect(postEvent).toHaveBeenCalledWith(
+      TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT,
+      [expect.objectContaining({ maxItems: "10", tag: "TEAM 11" })]
+    );
+  });
+
+  it("still lets a selected team be removed at the limit", async () => {
+    await tapTeams(10, { max_items: "10" });
+
+    const result = await localStorageToggleFlag(
+      { entry: teamEntry(1) },
+      tapAction({ max_items: "10" })
+    );
+
+    expect(result).toBe(ActionResult.Success);
+    expect(mockStore[KEY]).toHaveLength(9);
+  });
+});

package/actionsExecutor/__tests__/feedDecorator.test.ts

@@ -59,3 +59,33 @@ describe("decorateFeed", () => {
     expect(decorated.entry[0].extensions.tap_actions).toBeUndefined();
   });
 });
+
+describe("decorateFeed max_items", () => {
+  const toggleAction = (feed: ZappFeed) =>
+    decorateFeed(feed).entry[0].extensions.tap_actions.actions[0];
+
+  it.each([
+    ["screen", "screenToggleFlag"],
+    ["session", "sessionStorageToggleFlag"],
+    ["ctx", "localStorageToggleFlag"],
+  ])("passes max_items to the %s toggle action", (scope, type) => {
+    const feed = preferenceFeed("multi");
+    feed.extensions.preference_editor_options.scope = scope;
+    feed.extensions.preference_editor_options.max_items = "10";
+
+    const toggle = toggleAction(feed);
+
+    expect(toggle.type).toBe(type);
+    expect(toggle.options).toEqual({ key: "agree", max_items: 10 });
+  });
+
+  it.each([undefined, 0, "0", "ten", -1])(
+    "does not set a limit for max_items %p",
+    (maxItems) => {
+      const feed = preferenceFeed("multi");
+      feed.extensions.preference_editor_options.max_items = maxItems;
+
+      expect(toggleAction(feed).options).toEqual({ key: "agree" });
+    }
+  );
+});

package/actionsExecutor/__tests__/screenToggleFlag.test.ts

@@ -0,0 +1,90 @@
+import { ActionExecutor, ActionResult } from "../ActionExecutor";
+import { screenToggleFlagAction } from "../actions/screenToggleFlag";
+
+jest.mock("../ActionExecutorContext", () => ({
+  log_error: jest.fn(),
+  log_info: jest.fn(),
+}));
+
+jest.mock("../StorageActions", () => ({
+  onMaxTagsReached: jest.fn(),
+}));
+
+// not used here, but it pulls the native bridge logger in at import time
+jest.mock("../../storage/ScreenSingleValueProvider", () => ({}));
+
+jest.mock("../../logger", () => ({
+  createLogger: () => ({
+    log_error: jest.fn(),
+    log_debug: jest.fn(),
+    log_info: jest.fn(),
+  }),
+}));
+
+const mockSelected: string[] = [];
+
+jest.mock("../../storage/ScreenStateMultiSelectProvider", () => ({
+  ScreenMultiSelectProvider: {
+    getProvider: () => ({
+      getSelectedAsync: async () => [...mockSelected],
+      addItem: async (item: string) => {
+        mockSelected.push(item);
+      },
+      removeItem: async (item: string) => {
+        mockSelected.splice(mockSelected.indexOf(item), 1);
+      },
+    }),
+  },
+}));
+
+const toggleAction = (options = {}) =>
+  ({
+    type: "screenToggleFlag",
+    options: { key: "teams", selector: "extensions.tag", ...options },
+  }) as unknown as ActionType;
+
+const context = (tag: string) => ({
+  screenRoute: "/screen",
+  screenStateStore: {},
+  entry: { id: tag, extensions: { tag } },
+});
+
+describe("screenToggleFlagAction at the max_items limit", () => {
+  beforeEach(() => {
+    mockSelected.length = 0;
+  });
+
+  it("returns the cancellation so the chained actions do not run", async () => {
+    const afterToggle = jest.fn();
+    const executor = new ActionExecutor();
+
+    executor.registerAction("screenToggleFlag", screenToggleFlagAction);
+
+    executor.registerAction("sendCloudEvent", async () => {
+      afterToggle();
+
+      return ActionResult.Success;
+    });
+
+    mockSelected.push("A", "B");
+
+    const result = await executor.handleActions(
+      [toggleAction({ max_items: 2 }), { type: "sendCloudEvent" }],
+      context("C") as never
+    );
+
+    expect(result).toBe(ActionResult.Cancel);
+    expect(afterToggle).not.toHaveBeenCalled();
+    expect(mockSelected).toEqual(["A", "B"]);
+  });
+
+  it("lets the chain continue below the limit", async () => {
+    const result = await screenToggleFlagAction(
+      toggleAction({ max_items: 2 }),
+      context("A") as never
+    );
+
+    expect(result).toBe(ActionResult.Success);
+    expect(mockSelected).toEqual(["A"]);
+  });
+});

package/actionsExecutor/actions/__tests__/navigateToScreen.test.ts

@@ -83,9 +83,7 @@ describe("navigateToScreen navigationOptions", () => {
     );
   });
 
-  // Entries cannot go through replace(), which only accepts a river, so the
-  // non-push path falls back to replaceTop().
-  it("forwards navigationOptions to replaceTop when navigating with an entry", async () => {
+  it("forwards navigationOptions to replace when navigating with an entry", async () => {
     const navigator = createNavigator();
     const entry = { id: "entry-id" } as unknown as ZappEntry;
 
@@ -100,12 +98,12 @@ describe("navigateToScreen navigationOptions", () => {
 
     await createNavigateToScreenAction(navigator, rivers, contentTypes)(action);
 
-    expect(navigator.replaceTop).toHaveBeenCalledWith(
+    expect(navigator.replace).toHaveBeenCalledWith(
       { id: "entry-id", type: { value: "parentLock" } },
       { pinFlow: "change-pin" }
     );
 
-    expect(navigator.replace).not.toHaveBeenCalled();
+    expect(navigator.replaceTop).not.toHaveBeenCalled();
   });
 
   // Regression guard: the no-options path must keep working unchanged.
@@ -131,3 +129,139 @@ describe("navigateToScreen navigationOptions", () => {
     expect(result).toBe(ActionResult.Success);
   });
 });
+
+describe("navigateToScreen target resolution", () => {
+  function run(options, context?) {
+    const navigator = createNavigator();
+
+    const result = createNavigateToScreenAction(
+      navigator,
+      rivers,
+      contentTypes
+    )({ type: "navigateToScreen", options }, context);
+
+    return { navigator, result };
+  }
+
+  it("overrides entry.type with typeMapping when both are provided", async () => {
+    const entry = {
+      id: "entry-id",
+      type: { value: "video" },
+    } as unknown as ZappEntry;
+
+    const { navigator, result } = run({
+      typeMapping: "parentLock",
+      navigationAction: "push",
+      entry,
+    });
+
+    expect(await result).toBe(ActionResult.Success);
+
+    expect(navigator.push).toHaveBeenCalledWith(
+      { id: "entry-id", type: { value: "parentLock" } },
+      undefined
+    );
+
+    expect(entry.type).toEqual({ value: "video" });
+  });
+
+  it("navigates with the entry's own type when typeMapping is not provided", async () => {
+    const entry = {
+      id: "entry-id",
+      type: { value: "video" },
+    } as unknown as ZappEntry;
+
+    const { navigator, result } = run({ navigationAction: "push", entry });
+
+    expect(await result).toBe(ActionResult.Success);
+
+    expect(navigator.push).toHaveBeenCalledWith(
+      { id: "entry-id", type: { value: "video" } },
+      undefined
+    );
+  });
+
+  it("resolves the context entry when entry is @{entry/} and typeMapping is not provided", async () => {
+    const entry = {
+      id: "context-entry-id",
+      type: { value: "video" },
+    } as unknown as ZappEntry;
+
+    const { navigator, result } = run({ entry: "@{entry/}" }, { entry });
+
+    expect(await result).toBe(ActionResult.Success);
+
+    expect(navigator.replace).toHaveBeenCalledWith(
+      { id: "context-entry-id", type: { value: "video" } },
+      undefined
+    );
+  });
+
+  it("returns an error when neither typeMapping nor entry type is provided", async () => {
+    const entry = { id: "entry-id" } as unknown as ZappEntry;
+
+    const { navigator, result } = run({ navigationAction: "push", entry });
+
+    expect(await result).toBe(ActionResult.Error);
+    expect(navigator.push).not.toHaveBeenCalled();
+    expect(navigator.replace).not.toHaveBeenCalled();
+  });
+
+  it("returns an error when neither typeMapping nor entry is provided", async () => {
+    const { navigator, result } = run({ navigationAction: "push" });
+
+    expect(await result).toBe(ActionResult.Error);
+    expect(navigator.push).not.toHaveBeenCalled();
+  });
+
+  it("returns an error when typeMapping has no screen_id mapping", async () => {
+    const callback = jest.fn();
+
+    const { navigator, result } = run(
+      { typeMapping: "unknownType", navigationAction: "push" },
+      { callback }
+    );
+
+    expect(await result).toBe(ActionResult.Error);
+    expect(navigator.push).not.toHaveBeenCalled();
+    expect(callback).not.toHaveBeenCalled();
+  });
+
+  it("returns an error when the mapped screen_id has no river", async () => {
+    const navigator = createNavigator();
+    const callback = jest.fn();
+
+    const result = await createNavigateToScreenAction(navigator, rivers, {
+      orphan: { screen_id: "missing-screen-id" },
+    } as unknown as ZappContentTypes)(
+      {
+        type: "navigateToScreen",
+        options: { typeMapping: "orphan", navigationAction: "push" },
+      },
+      { callback }
+    );
+
+    expect(result).toBe(ActionResult.Error);
+    expect(navigator.push).not.toHaveBeenCalled();
+    expect(callback).not.toHaveBeenCalled();
+  });
+
+  it("aborts the action pipeline before navigating to a resolved river", async () => {
+    const callback = jest.fn();
+
+    const { navigator, result } = run(
+      { typeMapping: "parentLock" },
+      { callback }
+    );
+
+    expect(await result).toBe(ActionResult.Success);
+
+    expect(callback).toHaveBeenCalledWith({
+      success: false,
+      error: null,
+      abort: true,
+    });
+
+    expect(navigator.replace).toHaveBeenCalledWith(river, undefined);
+  });
+});

package/actionsExecutor/actions/__tests__/openBottomSheet.customContent.test.ts

@@ -60,6 +60,30 @@ describe("openBottomSheetAction custom content", () => {
     });
   });
 
+  it("passes themePluginId through to the name sheet", async () => {
+    const CustomContent = function CustomContent() {
+      return null;
+    };
+
+    await openBottomSheetAction({
+      type: "openBottomSheet",
+      options: {
+        header: { title: "Create New Playlist" },
+        themePluginId: "playlist-experience",
+        content: {
+          component: CustomContent,
+          props: { buttonLabel: "Create" },
+        },
+      },
+    } as any);
+
+    const args = (openBottomSheetModal as jest.Mock).mock.calls[0][0];
+
+    expect(args.modalBottomSheetContentProps.themePluginId).toBe(
+      "playlist-experience"
+    );
+  });
+
   it("returns Error when neither list data nor content.component is provided", async () => {
     const result = await openBottomSheetAction({
       type: "openBottomSheet",

package/actionsExecutor/actions/__tests__/openBottomSheet.inlineItems.test.ts

@@ -2,6 +2,22 @@ import { openBottomSheetAction } from "../openBottomSheet";
 import { actionExecutor, ActionResult } from "../../ActionExecutor";
 import { modalOrchestrator } from "../../../modalState/ModalOrchestrator";
 
+jest.mock("@applicaster/zapp-pipes-v2-client", () => ({
+  PipesClientResponseHelper: jest.fn(() => ({ error: null })),
+  RequestBuilder: jest.fn(() => ({
+    setEntryContext: jest.fn().mockReturnThis(),
+    setScreenContext: jest.fn().mockReturnThis(),
+    setUrl: jest.fn().mockReturnThis(),
+    buildAxiosRequest: jest.fn().mockResolvedValue(undefined),
+    call: jest.fn().mockResolvedValue({
+      response: {
+        entry: [],
+        extensions: { dynamic_collection_options: { operations: "add" } },
+      },
+    }),
+  })),
+}));
+
 jest.mock("../../../modalState/store", () => ({
   openBottomSheetModal: jest.fn(),
 }));
@@ -165,6 +181,62 @@ describe("openBottomSheetAction inline items", () => {
     expect(menu.content.emptyMessage).toBe("Queued items will be added here");
   });
 
+  it("forwards content.operationButtons onto the menu", async () => {
+    const result = await openBottomSheetAction({
+      type: "openBottomSheet",
+      options: {
+        header: { title: "Playlists" },
+        content: {
+          items: [{ id: "p1", title: "Playlist 1" }],
+          operationButtons: {
+            add: {
+              title: "Create New Playlist",
+              iconURL: "https://example.com/add.png",
+            },
+          },
+        },
+      },
+    } as any);
+
+    expect(result).toBe(ActionResult.Success);
+
+    const [menu] = (modalOrchestrator.open as jest.Mock).mock.calls[0];
+
+    expect(menu.content.operationButtons).toEqual({
+      add: {
+        title: "Create New Playlist",
+        iconURL: "https://example.com/add.png",
+      },
+    });
+  });
+
+  it("preserves Add presentation when loading itemsUrl content", async () => {
+    const result = await openBottomSheetAction({
+      type: "openBottomSheet",
+      options: {
+        content: {
+          itemsUrl: "https://example.com/collections",
+          operationButtons: {
+            add: {
+              title: "Create Collection",
+              iconURL: "file:///bundled-add.png",
+            },
+          },
+        },
+      },
+    });
+
+    expect(result).toBe(ActionResult.Success);
+    const [menu] = (modalOrchestrator.open as jest.Mock).mock.calls[0];
+
+    expect(menu.content).toMatchObject({
+      operationButtons: {
+        add: { title: "Create Collection", iconURL: "file:///bundled-add.png" },
+      },
+      dynamicCollection: { operations: ["add"] },
+    });
+  });
+
   it("pushes a new sheet by default even when another sheet is already open", async () => {
     (modalOrchestrator as any).stackSize = 1;
 

package/actionsExecutor/actions/navigateToScreen.ts

@@ -13,7 +13,7 @@ const { log_info, log_error } = createLogger({
  */
 export interface NavigateToScreenOptions {
   /** The screen type to navigate to (from content types mapping) */
-  typeMapping: string;
+  typeMapping?: string;
 
   /** Navigation action: push adds to history, replace replaces current screen */
   navigationAction?: "push" | "replace";
@@ -58,14 +58,6 @@ export function createNavigateToScreenAction(
     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 navigationOptions = action.options?.navigationOptions;
@@ -76,61 +68,53 @@ export function createNavigateToScreenAction(
         : entrySource
       : null;
 
-    if (entry) {
-      if (typeof entry !== "object") {
-        log_error(
-          `navigateToScreen: entry option is not an object, entry: ${entry}`
-        );
+    const screenType = action.options?.typeMapping || entry?.type?.value;
 
-        return ActionResult.Error;
-      }
+    const navigate =
+      navigationAction === "push" ? navigator.push : navigator.replace;
+
+    let navigatingEntry: ZappEntry | ZappRiver = entry;
 
+    if (entry && screenType) {
       log_info(
         `navigateToScreen: navigating to screen type: ${screenType} with entry id: ${entry.id}`
       );
 
-      const overriddenEntry: ZappEntry = {
+      navigatingEntry = {
         ...entry,
-        type: {
-          value: screenType,
-        },
+        type: { value: screenType },
       };
+    } else {
+      if (!screenType) {
+        log_error(
+          "navigateToScreen: options.typeMapping or entry?.type?.value is not provided"
+        );
 
-      if (navigationAction === "push") {
-        navigator.push(overriddenEntry, navigationOptions);
-      } else {
-        // Use replaceTop for entries since replace() only accepts ZappRiver
-        navigator.replaceTop(overriddenEntry, navigationOptions);
+        return ActionResult.Error;
       }
 
-      return ActionResult.Success;
-    }
-
-    const screenId = contentTypes?.[screenType]?.screen_id || null;
+      const screenId = contentTypes?.[screenType]?.screen_id || null;
+      const river = rivers?.[screenId];
 
-    if (!screenId) {
-      log_error(
-        `navigateToScreen: can not resolve screen type mapping: ${screenType}`
-      );
+      if (!screenId) {
+        log_error(
+          `navigateToScreen: can not resolve screen type mapping: ${screenType}`
+        );
 
-      return ActionResult.Error;
-    }
+        return ActionResult.Error;
+      }
 
-    const river = rivers[screenId];
+      if (!river) {
+        log_error("navigateToScreen: can not resolve river");
 
-    if (!river) {
-      log_error("navigateToScreen: can not resolve river");
+        return ActionResult.Error;
+      }
 
-      return ActionResult.Error;
+      navigatingEntry = river;
     }
 
     context?.callback?.({ success: false, error: null, abort: true });
-
-    if (navigationAction === "push") {
-      navigator.push(river, navigationOptions);
-    } else {
-      navigator.replace(river, navigationOptions);
-    }
+    navigate(navigatingEntry, navigationOptions);
 
     return ActionResult.Success;
   };

package/actionsExecutor/actions/openBottomSheet.ts

@@ -212,6 +212,7 @@ export async function openBottomSheetAction(
             ...(content.props || {}),
             actionContext: context,
           },
+          themePluginId,
         },
       });
 
@@ -289,6 +290,7 @@ export async function openBottomSheetAction(
         themePluginId,
         styleOverrides: styleOverrides ?? content?.styleOverrides,
         emptyMessage: content?.emptyMessage,
+        operationButtons: content?.operationButtons,
         context,
       },
     };

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/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 }),
             },
           },
         ],