@applicaster/zapp-react-native-utils 16.0.0-rc.9 → 16.0.0-rc.90

package/modalState/__tests__/useBottomSheetContent.test.ts

@@ -0,0 +1,349 @@
+import { renderHook, act, waitFor } from "@testing-library/react-native";
+
+import { modalOrchestrator } from "../ModalOrchestrator";
+import { MenuItem } from "../types";
+import { useBottomSheetContent } from "../useBottomSheetContent";
+import type { ContentState } from "../ContentViewModel";
+
+jest.mock("../ModalOrchestrator", () => ({
+  isPresentSubMenuAction: jest.requireActual("../types").isPresentSubMenuAction,
+  modalOrchestrator: {
+    canGoBack: false,
+    back: jest.fn(),
+    close: jest.fn(),
+  },
+}));
+
+type MockViewModel = {
+  getState: jest.Mock<ContentState, []>;
+  subscribe: jest.Mock<(listener: (state: ContentState) => void) => () => void>;
+  refetch: jest.Mock<Promise<void>, []>;
+};
+
+const createViewModel = (
+  initialState: ContentState
+): MockViewModel & {
+  emit: (nextState: ContentState) => void;
+} => {
+  let listener: ((state: ContentState) => void) | undefined;
+  const unsubscribe = jest.fn();
+
+  const viewModel: MockViewModel & { emit: (nextState: ContentState) => void } =
+    {
+      getState: jest.fn(() => initialState),
+      subscribe: jest.fn((nextListener) => {
+        listener = nextListener;
+
+        return unsubscribe;
+      }),
+      refetch: jest.fn().mockResolvedValue(undefined),
+      emit: (nextState) => {
+        listener?.(nextState);
+      },
+    };
+
+  return viewModel;
+};
+
+describe("useBottomSheetContent", () => {
+  const onPress = jest.fn().mockResolvedValue(undefined);
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    modalOrchestrator.canGoBack = false;
+  });
+
+  it("returns initial state from the view model", () => {
+    const viewModel = createViewModel({
+      items: [{ title: "Item 1" }],
+      isLoading: false,
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    expect(result.current.items).toEqual([{ title: "Item 1" }]);
+    expect(result.current.isLoading).toBe(false);
+    expect(result.current.error).toBeUndefined();
+    expect(result.current.showCentralLoading).toBe(false);
+    expect(result.current.canGoBack).toBe(false);
+    expect(viewModel.subscribe).toHaveBeenCalledTimes(1);
+  });
+
+  it("computes showCentralLoading when loading with no items", () => {
+    const viewModel = createViewModel({
+      items: [],
+      isLoading: true,
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    expect(result.current.showCentralLoading).toBe(true);
+  });
+
+  it("does not show central loading when items exist while loading", () => {
+    const viewModel = createViewModel({
+      items: [{ title: "Item 1" }],
+      isLoading: true,
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    expect(result.current.showCentralLoading).toBe(false);
+  });
+
+  it("updates when the view model emits new state", () => {
+    const viewModel = createViewModel({
+      items: [],
+      isLoading: true,
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    act(() => {
+      viewModel.emit({
+        items: [{ title: "Fetched Item" }],
+        isLoading: false,
+      });
+    });
+
+    expect(result.current.items).toEqual([{ title: "Fetched Item" }]);
+    expect(result.current.isLoading).toBe(false);
+    expect(result.current.showCentralLoading).toBe(false);
+  });
+
+  it("exposes error state from the view model", () => {
+    const viewModel = createViewModel({
+      items: [],
+      isLoading: false,
+      error: "Network Error",
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    expect(result.current.error).toBe("Network Error");
+  });
+
+  it("unsubscribes from the view model on unmount", () => {
+    const viewModel = createViewModel({
+      items: [],
+      isLoading: false,
+    });
+
+    const { unmount } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    const unsubscribeFn = viewModel.subscribe.mock.results[0]
+      .value as jest.Mock;
+
+    unmount();
+
+    expect(unsubscribeFn).toHaveBeenCalledTimes(1);
+  });
+
+  describe("handleItemPress", () => {
+    it("delegates to onPress and refetches for leaf items", async () => {
+      const viewModel = createViewModel({
+        items: [{ title: "Leaf" }],
+        isLoading: false,
+      });
+
+      const item: MenuItem = { title: "Leaf" };
+
+      const { result } = renderHook(() =>
+        useBottomSheetContent({ viewModel: viewModel as any, onPress })
+      );
+
+      await act(async () => {
+        await result.current.handleItemPress(item);
+      });
+
+      expect(onPress).toHaveBeenCalledWith(item);
+      expect(viewModel.refetch).toHaveBeenCalledTimes(1);
+    });
+
+    it("does not refetch when the item opens a present submenu action", async () => {
+      const viewModel = createViewModel({
+        items: [{ title: "Parent" }],
+        isLoading: false,
+      });
+
+      const item: MenuItem = {
+        title: "Parent",
+        action: {
+          type: "presentSubMenu",
+          menu: {
+            content: {
+              title: "Submenu",
+              items: [{ title: "Child" }],
+            },
+          },
+        },
+      };
+
+      const { result } = renderHook(() =>
+        useBottomSheetContent({ viewModel: viewModel as any, onPress })
+      );
+
+      await act(async () => {
+        await result.current.handleItemPress(item);
+      });
+
+      expect(onPress).toHaveBeenCalledWith(item);
+      expect(viewModel.refetch).not.toHaveBeenCalled();
+    });
+
+    it("awaits onPress before refetching", async () => {
+      const viewModel = createViewModel({
+        items: [{ title: "Leaf" }],
+        isLoading: false,
+      });
+
+      const item: MenuItem = { title: "Leaf" };
+      const callOrder: string[] = [];
+
+      onPress.mockImplementation(async () => {
+        callOrder.push("onPress");
+      });
+
+      viewModel.refetch.mockImplementation(async () => {
+        callOrder.push("refetch");
+      });
+
+      const { result } = renderHook(() =>
+        useBottomSheetContent({ viewModel: viewModel as any, onPress })
+      );
+
+      await act(async () => {
+        await result.current.handleItemPress(item);
+      });
+
+      expect(callOrder).toEqual(["onPress", "refetch"]);
+    });
+  });
+
+  describe("goBackOrClose", () => {
+    it("calls back when the orchestrator can go back", () => {
+      modalOrchestrator.canGoBack = true;
+
+      const viewModel = createViewModel({
+        items: [],
+        isLoading: false,
+      });
+
+      const { result } = renderHook(() =>
+        useBottomSheetContent({ viewModel: viewModel as any, onPress })
+      );
+
+      act(() => {
+        result.current.goBackOrClose();
+      });
+
+      expect(modalOrchestrator.back).toHaveBeenCalledTimes(1);
+      expect(modalOrchestrator.close).not.toHaveBeenCalled();
+    });
+
+    it("calls close when the orchestrator cannot go back", () => {
+      modalOrchestrator.canGoBack = false;
+
+      const viewModel = createViewModel({
+        items: [],
+        isLoading: false,
+      });
+
+      const { result } = renderHook(() =>
+        useBottomSheetContent({ viewModel: viewModel as any, onPress })
+      );
+
+      act(() => {
+        result.current.goBackOrClose();
+      });
+
+      expect(modalOrchestrator.close).toHaveBeenCalledTimes(1);
+      expect(modalOrchestrator.back).not.toHaveBeenCalled();
+    });
+  });
+
+  it("exposes close from the modal orchestrator", () => {
+    const viewModel = createViewModel({
+      items: [],
+      isLoading: false,
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    act(() => {
+      result.current.close();
+    });
+
+    expect(modalOrchestrator.close).toHaveBeenCalledTimes(1);
+  });
+
+  it("reflects canGoBack from the modal orchestrator", () => {
+    modalOrchestrator.canGoBack = true;
+
+    const viewModel = createViewModel({
+      items: [],
+      isLoading: false,
+    });
+
+    const { result } = renderHook(() =>
+      useBottomSheetContent({ viewModel: viewModel as any, onPress })
+    );
+
+    expect(result.current.canGoBack).toBe(true);
+  });
+
+  it("resubscribes when the view model instance changes", async () => {
+    const firstViewModel = createViewModel({
+      items: [{ title: "First" }],
+      isLoading: false,
+    });
+
+    const secondViewModel = createViewModel({
+      items: [{ title: "Second" }],
+      isLoading: false,
+    });
+
+    const { result, rerender } = renderHook(
+      ({ viewModel }) =>
+        useBottomSheetContent({ viewModel: viewModel as any, onPress }),
+      {
+        initialProps: { viewModel: firstViewModel },
+      }
+    );
+
+    expect(result.current.items).toEqual([{ title: "First" }]);
+
+    rerender({ viewModel: secondViewModel });
+
+    expect(
+      firstViewModel.subscribe.mock.results[0].value
+    ).toHaveBeenCalledTimes(1);
+
+    expect(secondViewModel.subscribe).toHaveBeenCalledTimes(1);
+
+    act(() => {
+      secondViewModel.emit({
+        items: [{ title: "Updated Second" }],
+        isLoading: false,
+      });
+    });
+
+    await waitFor(() => {
+      expect(result.current.items).toEqual([{ title: "Updated Second" }]);
+    });
+  });
+});

package/modalState/__tests__/useModalStoreState.test.ts

@@ -0,0 +1,142 @@
+import { act, renderHook } from "@testing-library/react-native";
+
+import { modalStore, useModalStoreState } from "../";
+
+const item = { id: "river-general", name: "Test Modal" };
+const props = { entry: { id: "modal-entry-1" } };
+
+const openModal = () =>
+  act(() => {
+    modalStore.getState().openModal({ item, props } as any);
+  });
+
+// Counts every render of the hook so the tests can assert on subscription
+// behaviour, not just on the returned value.
+const renderModalStoreState = (skipSubscription?: boolean) => {
+  const renders = { count: 0 };
+
+  const view = renderHook(() => {
+    renders.count += 1;
+
+    return skipSubscription === undefined
+      ? useModalStoreState()
+      : useModalStoreState(skipSubscription);
+  });
+
+  return { ...view, renders };
+};
+
+describe("useModalStoreState", () => {
+  afterEach(() => {
+    act(() => {
+      modalStore.getState().dismissModal();
+    });
+  });
+
+  describe("when subscribed (default)", () => {
+    it("returns the live modal state when called without arguments", () => {
+      const { result } = renderModalStoreState();
+
+      expect(result.current.visible).toBe(false);
+
+      openModal();
+
+      expect(result.current.visible).toBe(true);
+      expect(result.current.screen).toBe(item);
+      expect(result.current.props).toBe(props);
+    });
+
+    it("re-renders the consumer when the modal state changes", () => {
+      const { renders } = renderModalStoreState(false);
+
+      const rendersBeforeOpen = renders.count;
+
+      openModal();
+
+      expect(renders.count).toBeGreaterThan(rendersBeforeOpen);
+    });
+
+    // Counterpart to "returns a stable reference across store updates": an open
+    // modal is the one point where a live subscription and a skipped one hold
+    // different references, which is what makes that assertion meaningful.
+    it("returns a new reference while the modal is open", () => {
+      const { result } = renderModalStoreState(false);
+
+      const firstValue = result.current;
+
+      openModal();
+
+      expect(result.current).not.toBe(firstValue);
+    });
+  });
+
+  describe("when subscription is skipped", () => {
+    it("reports an empty modal state even while a modal is open", () => {
+      openModal();
+
+      expect(modalStore.getState().modalState.visible).toBe(true);
+
+      const { result } = renderModalStoreState(true);
+
+      expect(result.current).toMatchObject({
+        visible: false,
+        screen: null,
+        options: {},
+        props: {},
+      });
+    });
+
+    it("does not re-render the consumer when the modal state changes", () => {
+      const { renders } = renderModalStoreState(true);
+
+      const rendersBeforeOpen = renders.count;
+
+      openModal();
+
+      expect(renders.count).toBe(rendersBeforeOpen);
+    });
+
+    // The skipped branch has to hand back a module-level constant. Returning a
+    // fresh object would fail zustand's Object.is check and re-render on every
+    // store notification - the opposite of what skipping is for.
+    it("returns a stable reference across store updates", () => {
+      const { result } = renderModalStoreState(true);
+
+      const firstValue = result.current;
+
+      openModal();
+
+      // Asserted while the modal is open: dismissing resets the store to the
+      // very same initialModalState object, so an end-to-end round trip would
+      // hold this identity even for a live subscription.
+      expect(result.current).toBe(firstValue);
+
+      act(() => {
+        modalStore.getState().dismissModal();
+      });
+
+      expect(result.current).toBe(firstValue);
+    });
+  });
+
+  it("picks up the current modal state when it starts subscribing", () => {
+    let skipSubscription = true;
+
+    const { result, rerender } = renderHook(() =>
+      useModalStoreState(skipSubscription)
+    );
+
+    openModal();
+
+    expect(result.current.visible).toBe(false);
+
+    skipSubscription = false;
+
+    act(() => {
+      rerender(undefined);
+    });
+
+    expect(result.current.visible).toBe(true);
+    expect(result.current.screen).toBe(item);
+  });
+});

package/modalState/index.ts

@@ -1,83 +1,35 @@
-import { useStore, createStore } from "zustand";
-
-interface ModalState {
-  visible: boolean;
-  screen: any;
-  options: Record<string, unknown>;
-  props: Record<string, unknown>;
-}
-
-interface ModalStore {
-  modalState: ModalState;
-  setModalState: (newState: Partial<ModalState>) => void;
-  openModal: (
-    item: any,
-    options?: Record<string, unknown>,
-    props?: Record<string, unknown>
-  ) => void;
-  dismissModal: () => void;
-}
-
-const initialModalState: ModalState = {
-  visible: false,
-  screen: null,
-  options: {},
-  props: {},
-};
-
-export const modalStore = createStore<ModalStore>((set) => ({
-  modalState: initialModalState,
-  setModalState: (newState) =>
-    set((state) => ({
-      modalState: { ...state.modalState, ...newState },
-    })),
-  openModal: ({ item, options = {}, props }: OpenModalArg) =>
-    set({
-      modalState: {
-        visible: true,
-        screen: item,
-        options: {
-          animated: true,
-          animationType: "slide",
-          onShow: () => {},
-          presentationStyle: "overFullScreen",
-          transparent: true,
-          ...options,
-          onDismiss: () => set({ modalState: initialModalState }),
-          onRequestClose: () => set({ modalState: initialModalState }),
-        },
-        props,
-      },
-    }),
-  dismissModal: () => set(() => ({ modalState: initialModalState })),
-}));
-
-export const useModalStore = <T>(selector: (state: ModalStore) => T) =>
-  useStore(modalStore, selector);
-
-export const openModal = modalStore.getInitialState().openModal;
-
-export const dismissModal = modalStore.getInitialState().dismissModal;
-
-export const openBottomSheetModal = ({
-  ModalBottomSheetContent,
-  modalBottomSheetContentProps,
-  props = {},
-  options = {},
-}: OpenModalBottomSheetArgs) => {
-  openModal({
-    item: {
-      ModalBottomSheetContent,
-      modalBottomSheetContentProps,
-    },
-    props,
-    options: {
-      animationType: "none",
-      animated: false,
-      ...options,
-    },
-  });
-};
-
-export const useModalStoreState = (): ModalState =>
-  useModalStore<ModalState>((state) => state.modalState);
+export {
+  modalStore,
+  useModalStore,
+  openModal,
+  dismissModal,
+  openBottomSheetModal,
+  useModalStoreState,
+} from "./store";
+
+export type { ModalState, ModalStore } from "./store";
+
+export { modalOrchestrator } from "./ModalOrchestrator";
+
+export { ContentViewModel } from "./ContentViewModel";
+
+export type {
+  Menu,
+  MenuItem,
+  Header,
+  Content,
+  Action,
+  PresentSubMenuAction,
+  SecondaryAction,
+  SelectMode,
+  SelectionBehavior,
+} from "./types";
+
+export {
+  isPresentSubMenuAction,
+  getMenuItemActions,
+  OPERATIONS,
+  hasOperation,
+} from "./types";
+
+export { useBottomSheetContent } from "./useBottomSheetContent";