@applicaster/zapp-react-native-utils 16.0.0-rc.8 → 16.0.0-rc.80

package/modalState/__tests__/ContentViewModel.test.ts

@@ -0,0 +1,165 @@
+import { ContentViewModel } from "../ContentViewModel";
+import { loadItemsFromSource } from "../../actionsExecutor/actions/openBottomSheet";
+
+jest.mock("../../actionsExecutor/actions/openBottomSheet", () => ({
+  loadItemsFromSource: jest.fn(),
+}));
+
+describe("ContentViewModel", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("should initialize with items and not fetch if itemsUrl is not provided", () => {
+    const content = {
+      title: "Test Menu",
+      items: [{ title: "Item 1" }, { title: "Item 2" }],
+    };
+
+    const viewModel = new ContentViewModel(content);
+
+    expect(viewModel.getState()).toMatchObject({
+      items: content.items,
+      isLoading: false,
+      role: undefined,
+      behavior: undefined,
+    });
+
+    expect(loadItemsFromSource).not.toHaveBeenCalled();
+  });
+
+  it("seeds role and behavior from Content", () => {
+    const viewModel = new ContentViewModel({
+      title: "Playlists",
+      items: [{ title: "A" }],
+      role: "collection_selector",
+      behavior: { selectMode: "multi", currentSelection: ["a"] },
+    });
+
+    expect(viewModel.getState().role).toBe("collection_selector");
+
+    expect(viewModel.getState().behavior).toEqual({
+      selectMode: "multi",
+      currentSelection: ["a"],
+    });
+  });
+
+  it("should trigger fetch on init if items is empty and itemsUrl is present", async () => {
+    const mockItems = [{ title: "Fetched Item" }];
+
+    (loadItemsFromSource as jest.Mock).mockResolvedValueOnce({
+      items: mockItems,
+      role: "collection_selector",
+      behavior: { selectMode: "multi", currentSelection: [] },
+    });
+
+    const content = {
+      title: "Test Menu",
+      items: [],
+      itemsUrl: "http://example.com/items",
+    };
+
+    const viewModel = new ContentViewModel(content);
+
+    // Initial state should be loading
+    expect(viewModel.getState().isLoading).toBe(true);
+
+    // Wait for the asynchronous refetch to complete
+    await new Promise(process.nextTick);
+
+    expect(loadItemsFromSource).toHaveBeenCalledWith(
+      expect.stringMatching(/^http:\/\/example\.com\/items\?_t=\d+$/)
+    );
+
+    expect(viewModel.getState()).toMatchObject({
+      items: mockItems,
+      isLoading: false,
+      role: "collection_selector",
+      behavior: { selectMode: "multi", currentSelection: [] },
+    });
+  });
+
+  it("updates role and behavior on refetch", async () => {
+    (loadItemsFromSource as jest.Mock)
+      .mockResolvedValueOnce({
+        items: [{ title: "First" }],
+        role: "collection_selector",
+        behavior: { selectMode: "multi", currentSelection: [] },
+      })
+      .mockResolvedValueOnce({
+        items: [{ title: "Second", isSelected: true }],
+        role: "collection_selector",
+        behavior: { selectMode: "multi", currentSelection: ["2"] },
+      });
+
+    const viewModel = new ContentViewModel({
+      title: "Test Menu",
+      items: [],
+      itemsUrl: "http://example.com/items",
+    });
+
+    await new Promise(process.nextTick);
+
+    await viewModel.refetch();
+
+    expect(viewModel.getState().items[0].title).toBe("Second");
+    expect(viewModel.getState().behavior?.currentSelection).toEqual(["2"]);
+    expect(viewModel.getState().role).toBe("collection_selector");
+  });
+
+  it("should notify subscribers of state changes", async () => {
+    const mockItems = [{ title: "Fetched Item" }];
+
+    (loadItemsFromSource as jest.Mock).mockResolvedValue({
+      items: mockItems,
+    });
+
+    const content = {
+      title: "Test Menu",
+      items: [],
+      itemsUrl: "http://example.com/items",
+    };
+
+    const viewModel = new ContentViewModel(content);
+
+    // Wait for constructor's refetch to finish
+    await new Promise(process.nextTick);
+
+    const listener = jest.fn();
+    const unsubscribe = viewModel.subscribe(listener);
+
+    await viewModel.refetch();
+
+    expect(listener).toHaveBeenCalled();
+    expect(viewModel.getState().items).toEqual(mockItems);
+
+    unsubscribe();
+    listener.mockClear();
+
+    await viewModel.refetch();
+    expect(listener).not.toHaveBeenCalled();
+  });
+
+  it("should handle error states during fetching", async () => {
+    const error = new Error("Network Error");
+    (loadItemsFromSource as jest.Mock).mockRejectedValueOnce(error);
+
+    const content = {
+      title: "Test Menu",
+      items: [],
+      itemsUrl: "http://example.com/items",
+    };
+
+    const viewModel = new ContentViewModel(content);
+
+    await new Promise(process.nextTick);
+
+    expect(viewModel.getState()).toMatchObject({
+      items: [],
+      isLoading: false,
+      error: "Network Error",
+      role: undefined,
+      behavior: undefined,
+    });
+  });
+});

package/modalState/__tests__/EditableCollectionRegistry.test.ts

@@ -0,0 +1,112 @@
+import {
+  EditableCollectionRegistry,
+  resolveEditableCollection,
+} from "../EditableCollectionRegistry";
+import { RemoteEditableCollection } from "../RemoteEditableCollection";
+import { EditableCollection } from "../EditableCollection";
+import { BehaviorSubject } from "rxjs";
+import type { Content, MenuItem } from "../types";
+
+function fakeCollection(): EditableCollection {
+  return {
+    items$: new BehaviorSubject<MenuItem[]>([]).asObservable(),
+    operations: [],
+  };
+}
+
+const refetch = jest.fn().mockResolvedValue(undefined);
+
+describe("EditableCollectionRegistry", () => {
+  beforeEach(() => {
+    // reset the static registry between tests
+    (EditableCollectionRegistry as any).providers = {};
+    jest.clearAllMocks();
+  });
+
+  it("registers and resolves a provider factory (new instance per call)", () => {
+    const instance = fakeCollection();
+    const factory = jest.fn(() => instance);
+    EditableCollectionRegistry.register("@{provider/x}", factory);
+
+    const resolved = EditableCollectionRegistry.getProvider("@{provider/x}");
+
+    expect(resolved).toBe(instance);
+    expect(factory).toHaveBeenCalledTimes(1);
+  });
+
+  it("returns null for an unknown provider token", () => {
+    expect(EditableCollectionRegistry.getProvider("@{provider/missing}")).toBe(
+      null
+    );
+  });
+});
+
+describe("resolveEditableCollection", () => {
+  beforeEach(() => {
+    (EditableCollectionRegistry as any).providers = {};
+    jest.clearAllMocks();
+  });
+
+  it("returns null when there are no dynamicCollection options", () => {
+    const content = { items: [] } as unknown as Content;
+
+    expect(resolveEditableCollection(content, refetch)).toBe(null);
+  });
+
+  it("resolves a local provider by token", () => {
+    const instance = fakeCollection();
+    EditableCollectionRegistry.register("@{provider/queue}", () => instance);
+
+    const content = {
+      items: [],
+      dynamicCollection: {
+        operations: ["remove"],
+        provider: "@{provider/queue}",
+      },
+    } as unknown as Content;
+
+    expect(resolveEditableCollection(content, refetch)).toBe(instance);
+  });
+
+  it("returns null (and does not throw) for an unregistered provider token", () => {
+    const content = {
+      items: [],
+      dynamicCollection: {
+        operations: ["remove"],
+        provider: "@{provider/unregistered}",
+      },
+    } as unknown as Content;
+
+    expect(resolveEditableCollection(content, refetch)).toBe(null);
+  });
+
+  it("builds a RemoteEditableCollection when a postUrl is present", () => {
+    const content = {
+      items: [],
+      dynamicCollection: {
+        operations: ["remove"],
+        postUrl: "https://x/cloud-events",
+      },
+    } as unknown as Content;
+
+    expect(resolveEditableCollection(content, refetch)).toBeInstanceOf(
+      RemoteEditableCollection
+    );
+  });
+
+  it("prefers a provider token over postUrl", () => {
+    const instance = fakeCollection();
+    EditableCollectionRegistry.register("@{provider/queue}", () => instance);
+
+    const content = {
+      items: [],
+      dynamicCollection: {
+        operations: ["remove"],
+        provider: "@{provider/queue}",
+        postUrl: "https://x/cloud-events",
+      },
+    } as unknown as Content;
+
+    expect(resolveEditableCollection(content, refetch)).toBe(instance);
+  });
+});

package/modalState/__tests__/ModalOrchestrator.phase3.test.ts

@@ -0,0 +1,47 @@
+import { modalOrchestrator } from "../ModalOrchestrator";
+import { modalStore } from "../store";
+
+describe("ModalOrchestrator phase 3", () => {
+  beforeEach(() => {
+    modalOrchestrator.close();
+    modalStore.getState().dismissModal();
+  });
+
+  it("does not forward styleVariant", () => {
+    modalOrchestrator.open({
+      content: {
+        title: "Playlists",
+        items: [{ title: "Favorites" }],
+        role: "collection_selector",
+        behavior: { selectMode: "multi", currentSelection: [] },
+      },
+    });
+
+    const props = (modalStore.getState().modalState.screen as any)
+      ?.modalBottomSheetContentProps;
+
+    expect(props.styleVariant).toBeUndefined();
+    expect(props.viewModel).toBeDefined();
+    expect(props.viewModel.getState().role).toBe("collection_selector");
+    expect(props.title).toBe("Playlists");
+  });
+
+  it("forwards header title and subtitle as summary", () => {
+    modalOrchestrator.open({
+      header: {
+        title: "Sleep Timer",
+        subtitle: "remaining",
+      },
+      content: {
+        title: "Sleep Timer",
+        items: [{ id: "5", title: "5 minutes" }],
+      },
+    });
+
+    const props = (modalStore.getState().modalState.screen as any)
+      ?.modalBottomSheetContentProps;
+
+    expect(props.title).toBe("Sleep Timer");
+    expect(props.summary).toBe("remaining");
+  });
+});

package/modalState/__tests__/RemoteEditableCollection.test.ts

@@ -0,0 +1,326 @@
+import { RemoteEditableCollection } from "../RemoteEditableCollection";
+import { actionExecutor } from "../../actionsExecutor/ActionExecutor";
+import type { Content, MenuItem } from "../types";
+
+jest.mock("../../actionsExecutor/ActionExecutor", () => ({
+  actionExecutor: { handleAction: jest.fn() },
+  ActionResult: { Success: "success", Error: "error" },
+}));
+
+const handleAction = actionExecutor.handleAction as jest.Mock;
+
+/**
+ * BehaviorSubject emits its current value synchronously on subscribe, so this
+ * returns the latest items snapshot.
+ */
+function currentItems(col: RemoteEditableCollection): MenuItem[] {
+  let items: MenuItem[] = [];
+  const sub = col.items$.subscribe((i) => (items = i));
+  sub.unsubscribe();
+
+  return items;
+}
+
+const removeAction = { type: "sendCloudEvent", options: { foo: "bar" } };
+
+const itemWithRemove: MenuItem = {
+  id: "1",
+  title: "A",
+  entryActions: [{ button: { alias: "remove_item" }, actions: [removeAction] }],
+};
+
+const itemPlain: MenuItem = { id: "2", title: "B" };
+
+function makeCollection(
+  items: MenuItem[],
+  refetch = jest.fn().mockResolvedValue(undefined),
+  operations = ["remove", "reorder"]
+) {
+  const content = {
+    items,
+    dynamicCollection: { operations, postUrl: "https://x/cloud-events" },
+  } as unknown as Content;
+
+  return { col: new RemoteEditableCollection(content, refetch), refetch };
+}
+
+describe("RemoteEditableCollection", () => {
+  beforeEach(() => jest.clearAllMocks());
+
+  it("exposes the declared operations and initial items", () => {
+    const { col } = makeCollection([itemWithRemove, itemPlain]);
+
+    expect(col.operations).toEqual(["remove", "reorder"]);
+    expect(currentItems(col)).toEqual([itemWithRemove, itemPlain]);
+  });
+
+  describe("remove", () => {
+    it("optimistically removes, dispatches the aliased action, then refetches", async () => {
+      handleAction.mockResolvedValue("success");
+      const { col, refetch } = makeCollection([itemWithRemove, itemPlain]);
+
+      await col.remove(0);
+
+      expect(handleAction).toHaveBeenCalledWith(removeAction, {
+        entry: itemWithRemove,
+      });
+
+      expect(refetch).toHaveBeenCalledTimes(1);
+      expect(currentItems(col)).toEqual([itemPlain]);
+    });
+
+    it("rolls back to the snapshot when the action dispatch fails", async () => {
+      handleAction.mockRejectedValue(new Error("network"));
+      const { col, refetch } = makeCollection([itemWithRemove, itemPlain]);
+
+      await col.remove(0);
+
+      // optimistic removal reverted
+      expect(currentItems(col)).toEqual([itemWithRemove, itemPlain]);
+      // refetch never reached on failure
+      expect(refetch).not.toHaveBeenCalled();
+    });
+
+    it("lets the refetched server result replace the optimistic list", async () => {
+      handleAction.mockResolvedValue("success");
+      const serverItems: MenuItem[] = [{ id: "99", title: "server truth" }];
+
+      const refetch = jest.fn();
+      const { col } = makeCollection([itemWithRemove, itemPlain], refetch);
+
+      // Emulate ContentViewModel.refetch pushing authoritative items via sync()
+      refetch.mockImplementation(async () => {
+        col.sync(serverItems);
+      });
+
+      await col.remove(0);
+
+      expect(currentItems(col)).toEqual(serverItems);
+    });
+
+    it("is a no-op for an out-of-range index", async () => {
+      const { col, refetch } = makeCollection([itemWithRemove]);
+
+      await col.remove(5);
+
+      expect(handleAction).not.toHaveBeenCalled();
+      expect(refetch).not.toHaveBeenCalled();
+      expect(currentItems(col)).toEqual([itemWithRemove]);
+    });
+
+    it("skips dispatch (no throw) when no matching alias exists", async () => {
+      const { col, refetch } = makeCollection([itemPlain, itemWithRemove]);
+
+      await col.remove(0); // itemPlain has no entryActions
+
+      expect(handleAction).not.toHaveBeenCalled();
+      // still optimistic-removes and refetches (server is source of truth)
+      expect(refetch).toHaveBeenCalledTimes(1);
+      expect(currentItems(col)).toEqual([itemWithRemove]);
+    });
+  });
+
+  describe("move", () => {
+    it("optimistically reorders and dispatches reorder_item with itemIds", async () => {
+      handleAction.mockResolvedValue("success");
+
+      const itemA: MenuItem = {
+        id: "2",
+        title: "B",
+        entryActions: [
+          { button: { alias: "reorder_item" }, actions: [removeAction] },
+        ],
+      };
+
+      const moved: MenuItem = {
+        id: "3",
+        title: "C",
+        entryActions: [
+          { button: { alias: "reorder_item" }, actions: [removeAction] },
+        ],
+      };
+
+      const { col, refetch } = makeCollection([moved, itemA]);
+
+      await col.move(["2", "3"]);
+
+      expect(currentItems(col)).toEqual([itemA, moved]);
+
+      expect(handleAction).toHaveBeenCalledWith(
+        {
+          ...removeAction,
+          options: {
+            ...removeAction.options,
+            itemIds: ["2", "3"],
+            data: {
+              ...removeAction.options?.data,
+              itemIds: ["2", "3"],
+            },
+          },
+        },
+        { entry: itemA }
+      );
+
+      expect(refetch).toHaveBeenCalledTimes(1);
+    });
+
+    it("rolls back on failure", async () => {
+      handleAction.mockRejectedValue(new Error("nope"));
+
+      const itemA: MenuItem = {
+        id: "2",
+        title: "B",
+        entryActions: [
+          { button: { alias: "reorder_item" }, actions: [removeAction] },
+        ],
+      };
+
+      const moved: MenuItem = {
+        id: "3",
+        title: "C",
+        entryActions: [
+          { button: { alias: "reorder_item" }, actions: [removeAction] },
+        ],
+      };
+
+      const { col } = makeCollection([moved, itemA]);
+
+      await col.move(["2", "3"]);
+
+      expect(currentItems(col)).toEqual([moved, itemA]);
+    });
+
+    it("is a no-op for empty or non-existent IDs", async () => {
+      const { col, refetch } = makeCollection([itemWithRemove, itemPlain]);
+
+      await col.move([]);
+
+      expect(refetch).not.toHaveBeenCalled();
+      expect(currentItems(col)).toEqual([itemWithRemove, itemPlain]);
+    });
+  });
+
+  describe("sync", () => {
+    it("replaces the current items with the provided list", () => {
+      const { col } = makeCollection([itemWithRemove]);
+      const next: MenuItem[] = [{ id: "7", title: "next" }];
+
+      col.sync(next);
+
+      expect(currentItems(col)).toEqual(next);
+    });
+
+    it("suppresses sync updates while a local mutation is in-flight", async () => {
+      let resolveAction: () => void = () => {};
+
+      handleAction.mockImplementation(
+        () =>
+          new Promise<void>((resolve) => {
+            resolveAction = resolve;
+          })
+      );
+
+      const { col } = makeCollection([itemWithRemove, itemPlain]);
+      const staleServerItems: MenuItem[] = [{ id: "stale", title: "Stale" }];
+
+      // Initiate optimistic removal (mutation in-flight)
+      const removePromise = col.remove(0);
+
+      // Verify optimistic state applied locally
+      expect(currentItems(col)).toEqual([itemPlain]);
+
+      // Attempt sync while mutation is in-flight
+      col.sync(staleServerItems);
+
+      // Verify sync was suppressed and optimistic state remained
+      expect(currentItems(col)).toEqual([itemPlain]);
+
+      // Resolve the in-flight mutation
+      resolveAction();
+      await removePromise;
+
+      // After mutation completes, sync applies normally
+      const freshServerItems: MenuItem[] = [{ id: "fresh", title: "Fresh" }];
+      col.sync(freshServerItems);
+
+      expect(currentItems(col)).toEqual(freshServerItems);
+    });
+  });
+
+  describe("deleteCollection", () => {
+    it("optimistically clears items and calls refetch", async () => {
+      handleAction.mockResolvedValue("success");
+      const { col, refetch } = makeCollection([itemWithRemove, itemPlain]);
+
+      await col.deleteCollection();
+
+      expect(currentItems(col)).toEqual([]);
+      expect(refetch).toHaveBeenCalledTimes(1);
+    });
+
+    it("dispatches aliased action when first item contains delete_collection alias", async () => {
+      handleAction.mockResolvedValue("success");
+
+      const deleteAction = {
+        type: "sendCloudEvent",
+        options: { subject: "delete_collection" },
+      };
+
+      const itemWithDelete: MenuItem = {
+        id: "100",
+        title: "Collection Item",
+        entryActions: [
+          {
+            button: { alias: "delete_collection" },
+            actions: [deleteAction],
+          },
+        ],
+      };
+
+      const { col, refetch } = makeCollection([itemWithDelete]);
+
+      await col.deleteCollection();
+
+      expect(handleAction).toHaveBeenCalledWith(deleteAction, {
+        entry: itemWithDelete,
+      });
+
+      expect(refetch).toHaveBeenCalledTimes(1);
+      expect(currentItems(col)).toEqual([]);
+    });
+  });
+
+  describe("add", () => {
+    it("dispatches actions from dynamicCollection.events.add and refetches", async () => {
+      handleAction.mockResolvedValue("success");
+
+      const addAction = {
+        type: "sendCloudEvent",
+        options: {
+          url: "https://x/cloud-events",
+          type: "com.applicaster.collection.create.v1",
+          subject: "create_collection",
+        },
+      };
+
+      const content = {
+        items: [],
+        dynamicCollection: {
+          operations: ["add"],
+          postUrl: "https://x/cloud-events",
+          events: {
+            add: [addAction],
+          },
+        },
+      } as any;
+
+      const refetch = jest.fn().mockResolvedValue(undefined);
+      const col = new RemoteEditableCollection(content, refetch);
+
+      await col.add();
+
+      expect(handleAction).toHaveBeenCalledWith(addAction);
+      expect(refetch).toHaveBeenCalledTimes(1);
+    });
+  });
+});

package/modalState/__tests__/index.test.ts

@@ -1,4 +1,4 @@
-import { modalStore } from "../";
+import { modalStore, getMenuItemActions } from "../";
 
 describe("Modal State", () => {
   it("should have initial state", () => {
@@ -48,4 +48,33 @@ describe("Modal State", () => {
       });
     });
   });
+
+  describe("getMenuItemActions", () => {
+    it("returns actions array when actions is provided", () => {
+      const actions = [{ type: "action1" }, { type: "action2" }];
+      const item = { id: "1", title: "Item", actions };
+
+      expect(getMenuItemActions(item)).toEqual(actions);
+    });
+
+    it("returns [action] when single action is provided", () => {
+      const action = { type: "action1" };
+      const item = { id: "1", title: "Item", action };
+
+      expect(getMenuItemActions(item)).toEqual([action]);
+    });
+
+    it("returns action when action is passed as an array", () => {
+      const actions = [{ type: "action1" }];
+      const item = { id: "1", title: "Item", action: actions as any };
+
+      expect(getMenuItemActions(item)).toEqual(actions);
+    });
+
+    it("returns empty array when no action or actions are provided", () => {
+      expect(getMenuItemActions({ id: "1", title: "Item" })).toEqual([]);
+      expect(getMenuItemActions(null)).toEqual([]);
+      expect(getMenuItemActions(undefined)).toEqual([]);
+    });
+  });
 });