@applicaster/zapp-react-native-utils 16.0.0-alpha.4380012274 → 16.0.0-alpha.4548770949

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__/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/openBottomSheet.ts

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

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"