@applicaster/zapp-react-native-utils 16.0.0-rc.63 → 16.0.0-rc.64

package/actionsExecutor/__tests__/feedDecorator.test.ts

@@ -0,0 +1,61 @@
+import { decorateFeed } from "../feedDecorator";
+
+const preferenceFeed = (selectMode: string) =>
+  ({
+    id: "agree-component",
+    title: "I agree to the terms",
+    type: { value: "feed" },
+    extensions: {
+      role: "preference_editor",
+      preference_editor_options: {
+        key: "agree",
+        scope: "screen",
+        select_mode: selectMode,
+      },
+    },
+    entry: [
+      {
+        id: "I agree to the terms-agree",
+        title: "I agree to the terms",
+        type: { value: "action" },
+        extensions: { tag: "true" },
+      },
+    ],
+  }) as unknown as ZappFeed;
+
+describe("decorateFeed", () => {
+  it("decorates single select feeds with screenSetVariable", () => {
+    const decorated = decorateFeed(preferenceFeed("single"));
+
+    expect(decorated.extensions.behavior).toEqual(
+      expect.objectContaining({
+        select_mode: "single",
+        current_selection: "@{screen/agree}",
+      })
+    );
+
+    expect(decorated.entry[0].extensions.tap_actions.actions[0].type).toBe(
+      "screenSetVariable"
+    );
+  });
+
+  it("decorates multi select feeds with screenToggleFlag", () => {
+    const decorated = decorateFeed(preferenceFeed("multi"));
+
+    expect(decorated.extensions.behavior.select_mode).toBe("multi");
+
+    expect(decorated.entry[0].extensions.tap_actions.actions[0].type).toBe(
+      "screenToggleFlag"
+    );
+  });
+
+  it("leaves a feed without the preference_editor role untouched", () => {
+    const feed = preferenceFeed("single");
+    feed.extensions.role = undefined;
+
+    const decorated = decorateFeed(feed);
+
+    expect(decorated.extensions.behavior).toBeUndefined();
+    expect(decorated.entry[0].extensions.tap_actions).toBeUndefined();
+  });
+});

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

@@ -0,0 +1,133 @@
+import { createNavigateToScreenAction } from "../navigateToScreen";
+import { ActionResult } from "../../ActionExecutor";
+
+const river = { id: "screen-id", type: "parent-lock" } as unknown as ZappRiver;
+
+const rivers = { "screen-id": river } as Record<string, ZappRiver>;
+
+const contentTypes = {
+  parentLock: { screen_id: "screen-id" },
+} as unknown as ZappContentTypes;
+
+function createNavigator() {
+  return {
+    push: jest.fn(),
+    replace: jest.fn(),
+    replaceTop: jest.fn(),
+  } as unknown as QuickBrickAppNavigator;
+}
+
+describe("navigateToScreen navigationOptions", () => {
+  it("forwards navigationOptions to push when navigating to a screen", async () => {
+    const navigator = createNavigator();
+
+    const action = {
+      type: "navigateToScreen",
+      options: {
+        typeMapping: "parentLock",
+        navigationAction: "push",
+        navigationOptions: { pinFlow: "set-pin" },
+      },
+    };
+
+    const result = await createNavigateToScreenAction(
+      navigator,
+      rivers,
+      contentTypes
+    )(action);
+
+    expect(navigator.push).toHaveBeenCalledWith(river, {
+      pinFlow: "set-pin",
+    });
+
+    expect(result).toBe(ActionResult.Success);
+  });
+
+  it("forwards navigationOptions to replace when navigating to a screen", async () => {
+    const navigator = createNavigator();
+
+    const action = {
+      type: "navigateToScreen",
+      options: {
+        typeMapping: "parentLock",
+        navigationOptions: { pinFlow: "change-pin" },
+      },
+    };
+
+    await createNavigateToScreenAction(navigator, rivers, contentTypes)(action);
+
+    expect(navigator.replace).toHaveBeenCalledWith(river, {
+      pinFlow: "change-pin",
+    });
+  });
+
+  it("forwards navigationOptions to push when navigating with an entry", async () => {
+    const navigator = createNavigator();
+    const entry = { id: "entry-id" } as unknown as ZappEntry;
+
+    const action = {
+      type: "navigateToScreen",
+      options: {
+        typeMapping: "parentLock",
+        navigationAction: "push",
+        entry,
+        navigationOptions: { pinFlow: "set-pin" },
+      },
+    };
+
+    await createNavigateToScreenAction(navigator, rivers, contentTypes)(action);
+
+    expect(navigator.push).toHaveBeenCalledWith(
+      { id: "entry-id", type: { value: "parentLock" } },
+      { pinFlow: "set-pin" }
+    );
+  });
+
+  // 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 () => {
+    const navigator = createNavigator();
+    const entry = { id: "entry-id" } as unknown as ZappEntry;
+
+    const action = {
+      type: "navigateToScreen",
+      options: {
+        typeMapping: "parentLock",
+        entry,
+        navigationOptions: { pinFlow: "change-pin" },
+      },
+    };
+
+    await createNavigateToScreenAction(navigator, rivers, contentTypes)(action);
+
+    expect(navigator.replaceTop).toHaveBeenCalledWith(
+      { id: "entry-id", type: { value: "parentLock" } },
+      { pinFlow: "change-pin" }
+    );
+
+    expect(navigator.replace).not.toHaveBeenCalled();
+  });
+
+  // Regression guard: the no-options path must keep working unchanged.
+  it("still navigates when no navigationOptions are configured", async () => {
+    const navigator = createNavigator();
+
+    const action = {
+      type: "navigateToScreen",
+      options: {
+        typeMapping: "parentLock",
+        navigationAction: "push",
+      },
+    };
+
+    const result = await createNavigateToScreenAction(
+      navigator,
+      rivers,
+      contentTypes
+    )(action);
+
+    expect(navigator.push).toHaveBeenCalledTimes(1);
+    expect((navigator.push as jest.Mock).mock.calls[0][0]).toBe(river);
+    expect(result).toBe(ActionResult.Success);
+  });
+});

package/actionsExecutor/actions/navigateToScreen.ts

@@ -25,6 +25,19 @@ export interface NavigateToScreenOptions {
    * - undefined to navigate to screen without entry
    */
   entry?: "@{entry/}" | ZappEntry;
+
+  /**
+   * Arbitrary values passed through to the destination screen.
+   *
+   * They are stored on the navigation route as `NavigationScreenData.options`
+   * and read on the target screen via `useNavigation().data?.options`. Use this
+   * to hand per-navigation parameters to a screen instead of routing them
+   * through module-level state.
+   *
+   * Note: `legacyScreenData()` does not carry these values, so they are not
+   * visible through `useCurrentScreenData()` / `useRoute()`.
+   */
+  navigationOptions?: Record<string, unknown>;
 }
 
 /**
@@ -55,6 +68,7 @@ export function createNavigateToScreenAction(
 
     const navigationAction = action.options?.navigationAction;
     const entrySource = action.options?.entry;
+    const navigationOptions = action.options?.navigationOptions;
 
     const entry = entrySource
       ? entrySource === "@{entry/}"
@@ -83,10 +97,10 @@ export function createNavigateToScreenAction(
       };
 
       if (navigationAction === "push") {
-        navigator.push(overriddenEntry);
+        navigator.push(overriddenEntry, navigationOptions);
       } else {
         // Use replaceTop for entries since replace() only accepts ZappRiver
-        navigator.replaceTop(overriddenEntry);
+        navigator.replaceTop(overriddenEntry, navigationOptions);
       }
 
       return ActionResult.Success;
@@ -113,9 +127,9 @@ export function createNavigateToScreenAction(
     context?.callback?.({ success: false, error: null, abort: true });
 
     if (navigationAction === "push") {
-      navigator.push(river);
+      navigator.push(river, navigationOptions);
     } else {
-      navigator.replace(river);
+      navigator.replace(river, navigationOptions);
     }
 
     return ActionResult.Success;

package/actionsExecutor/feedDecorator.ts

@@ -159,13 +159,13 @@ export const decorateFeed = (feed: ZappFeed) => {
 
   const decoratedFeed = R.clone(feed);
 
-  const isSingleSelect =
-    (feed.extensions?.preference_editor_options?.select_mode ||
-      feed.extensions?.behavior?.select_mode) === "single";
+  const selectMode =
+    feed.extensions?.preference_editor_options?.select_mode ||
+    feed.extensions?.behavior?.select_mode;
 
-  if (isSingleSelect) {
+  if (selectMode === "single") {
     return makeSingleSelect(feed, key, decoratedFeed);
-  } else {
-    return makeMultiSelect(feed, key, decoratedFeed);
   }
+
+  return makeMultiSelect(feed, key, decoratedFeed);
 };

package/cellUtils/index.ts

@@ -65,11 +65,38 @@ export const isEmptyOrNil = (value: any): boolean =>
  */
 export const getLabel = (dataKeyValue, customDataKeyValue) => (entry) => {
   const label = getKeyForLabel(dataKeyValue, customDataKeyValue);
-  const isPath = label && R.length(label) > 0;
-  const fallback = isEmptyOrNil(label) ? "" : R.head(label);
+  const isPath = label && label.length > 0;
+
+  // An unresolved key is rendered as-is, because a data key is allowed to be a
+  // literal label ("More") rather than a path. Fall back to the whole key
+  // instead of its first segment: "extensions.section" reads as an unresolved
+  // path, while "extensions" reads as a legitimate label and hides the problem.
+  const fallback = isEmptyOrNil(label) ? "" : label.join(".");
 
   try {
-    return isPath ? R.pathOr(fallback, label, entry) : fallback;
+    if (!isPath) {
+      return fallback;
+    }
+
+    const resolved = label.reduce(
+      (value, key) => (value == null ? undefined : value[key]),
+      entry
+    );
+
+    if (isNotNil(resolved)) {
+      return resolved;
+    }
+
+    // A multi-segment key is unambiguously a path, so failing to resolve it is
+    // a misconfiguration rather than someone typing a literal label.
+    if (label.length > 1) {
+      cellUtilsLogger.warning({
+        message: `getLabel: data key "${fallback}" was not found on the entry, rendering the key itself`,
+        data: { dataKeyValue, customDataKeyValue, entryId: entry?.id },
+      });
+    }
+
+    return fallback;
   } catch (error) {
     cellUtilsLogger.warning({
       data: { error, dataKeyValue, customDataKeyValue },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "16.0.0-rc.63",
+  "version": "16.0.0-rc.64",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "16.0.0-rc.63",
+    "@applicaster/applicaster-types": "16.0.0-rc.64",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",