@applicaster/zapp-react-native-utils 16.0.0-rc.10 → 16.0.0-rc.100

package/configurationUtils/modalBlocksParser.ts

@@ -0,0 +1,214 @@
+import { getAllSpecificStyles } from "./manifestKeyParser";
+
+export type ModalBlocksConfig = {
+  header: {
+    container: Record<string, any>;
+    title: Record<string, any>;
+    closeButton: Record<string, any>;
+    actionButtons: Record<string, any>;
+  };
+  /**
+   * Queue Section Header (BB Variant 3) — shared by Next in Queue / Next Up.
+   * Separate from Theme modal `header` so top-title styles do not collide.
+   */
+  sectionHeader: {
+    title: Record<string, any>;
+    actionButtons: Record<string, any>;
+  };
+  action: {
+    background: Record<string, any>;
+    title: Record<string, any>;
+    icons: Record<string, any>;
+    leadingIcon: Record<string, any>;
+    trailingIcon: Record<string, any>;
+  };
+  item: {
+    background: Record<string, any>;
+    image: Record<string, any>;
+    nowPlayingContainer: Record<string, any>;
+    nowPlayingAsset: Record<string, any>;
+    nowPlayingLabel: Record<string, any>;
+    textLabel1: Record<string, any>;
+    textLabel2: Record<string, any>;
+    buttonsContainer: Record<string, any>;
+    button1: Record<string, any>;
+    button2: Record<string, any>;
+    /** Studio item.checkbox_asset / item.checked_checkbox_asset */
+    checkbox?: Record<string, any>;
+    /** Studio reorder/remove icons for Edit Order rows */
+    actionButtons?: Record<string, any>;
+  };
+  nowPlayingItem?: {
+    background: Record<string, any>;
+    image: Record<string, any>;
+    nowPlayingContainer: Record<string, any>;
+    nowPlayingAsset: Record<string, any>;
+    nowPlayingLabel: Record<string, any>;
+    textLabel1: Record<string, any>;
+    textLabel2: Record<string, any>;
+    buttonsContainer: Record<string, any>;
+    button1: Record<string, any>;
+    button2: Record<string, any>;
+    checkbox?: Record<string, any>;
+    actionButtons?: Record<string, any>;
+  };
+  button: {
+    background: Record<string, any>;
+    title: Record<string, any>;
+    icons: Record<string, any>;
+    leadingIcon: Record<string, any>;
+  };
+};
+
+export const getEmptyModalBlocksStructure = (): ModalBlocksConfig => {
+  const result: ModalBlocksConfig = {
+    header: {
+      container: {},
+      title: {},
+      closeButton: {},
+      actionButtons: {},
+    },
+    sectionHeader: {
+      title: {},
+      actionButtons: {},
+    },
+    action: {
+      background: {},
+      title: {},
+      icons: {},
+      leadingIcon: {},
+      trailingIcon: {},
+    },
+    item: {
+      background: {},
+      image: {},
+      nowPlayingContainer: {},
+      nowPlayingAsset: {},
+      nowPlayingLabel: {},
+      textLabel1: {},
+      textLabel2: {},
+      buttonsContainer: {},
+      button1: {},
+      button2: {},
+      checkbox: {},
+      actionButtons: {},
+    },
+    nowPlayingItem: {
+      background: {},
+      image: {},
+      nowPlayingContainer: {},
+      nowPlayingAsset: {},
+      nowPlayingLabel: {},
+      textLabel1: {},
+      textLabel2: {},
+      buttonsContainer: {},
+      button1: {},
+      button2: {},
+      checkbox: {},
+      actionButtons: {},
+    },
+    button: {
+      background: {},
+      title: {},
+      icons: {},
+      leadingIcon: {},
+    },
+  };
+
+  return result;
+};
+
+export const parseModalBlocksConfiguration = (
+  configuration: Record<string, any>,
+  componentName: string
+): ModalBlocksConfig => {
+  const result = getEmptyModalBlocksStructure();
+
+  if (!configuration || !componentName) {
+    return result;
+  }
+
+  const normalizedComponentName = componentName.replace(/-/g, "_");
+
+  // Helper to parse sub-components for a block
+  const parseBlock = (blockName: string, subComponents: string[]) => {
+    subComponents.forEach((subComponent) => {
+      // e.g. header_container
+      const fullSubComponentName = `${blockName}_${subComponent}`;
+
+      // e.g. result.header.container
+      const camelSubComponent = subComponent.replace(/_([a-z0-9])/g, (g) =>
+        g[1].toUpperCase()
+      );
+
+      const camelBlockName = (blockName as string).replace(
+        /_([a-z0-9])/g,
+        (g) => g[1].toUpperCase()
+      ) as keyof ModalBlocksConfig;
+
+      getAllSpecificStyles({
+        configuration,
+        componentName: normalizedComponentName,
+        subComponentName: fullSubComponentName,
+        styleSeparator: "",
+        outStyles:
+          result[camelBlockName]![
+            camelSubComponent as keyof (typeof result)[typeof camelBlockName]
+          ],
+      });
+    });
+  };
+
+  parseBlock("header", [
+    "container",
+    "title",
+    "close_button",
+    "action_buttons",
+  ]);
+
+  parseBlock("section_header", ["title", "action_buttons"]);
+
+  parseBlock("action", [
+    "background",
+    "title",
+    "icons",
+    "leading_icon",
+    "trailing_icon",
+  ]);
+
+  parseBlock("item", [
+    "background",
+    "image",
+    "now_playing_container",
+    "now_playing_asset",
+    "now_playing_label",
+    // Underscored form (QB convention) and Studio/manifest-generator form
+    // without the underscore before the digit (text_label1).
+    "text_label_1",
+    "text_label_2",
+    "text_label1",
+    "text_label2",
+    "buttons_container",
+    "button_1",
+    "button_2",
+  ]);
+
+  parseBlock("now_playing_item", [
+    "background",
+    "image",
+    "now_playing_container",
+    "now_playing_asset",
+    "now_playing_label",
+    "text_label_1",
+    "text_label_2",
+    "text_label1",
+    "text_label2",
+    "buttons_container",
+    "button_1",
+    "button_2",
+  ]);
+
+  parseBlock("button", ["background", "title", "icons", "leading_icon"]);
+
+  return result;
+};

package/entryActions/__tests__/buildEntryActions.test.ts

@@ -0,0 +1,235 @@
+import { buildEntryActions } from "../buildEntryActions";
+
+describe("buildEntryActions - alias & label resolution", () => {
+  const mockDeps = {
+    actionExecutor: { handleActions: jest.fn() } as any,
+    actionContext: {},
+  };
+
+  const resolveEntryActions = (entry: ZappEntry) =>
+    buildEntryActions(entry, mockDeps);
+
+  it("resolves entry action with explicit button title", () => {
+    const entry = {
+      id: "entry-1",
+      extensions: {
+        entry_action: [
+          {
+            button: {
+              title: "Custom Action Title",
+              iconURL: "http://example.com/icon.png",
+            },
+            actions: [{ type: "test" }],
+            dismiss_on_action: true,
+          },
+        ],
+      },
+    };
+
+    const actions = resolveEntryActions(entry as any);
+
+    expect(actions).toHaveLength(1);
+    expect(actions[0].identifier).toBe("entry_action_0");
+
+    const state = actions[0].action.initialEntryState(entry as any);
+
+    expect(state).toEqual({
+      state: 0,
+      label: "Custom Action Title",
+      asset: "http://example.com/icon.png",
+    });
+  });
+
+  it("resolves entry action with button label property", () => {
+    const entry = {
+      id: "entry-2",
+      extensions: {
+        entry_action: [
+          {
+            button: { label: "Label Property Action" },
+            actions: [{ type: "test" }],
+          },
+        ],
+      },
+    };
+
+    const actions = resolveEntryActions(entry as any);
+
+    expect(actions).toHaveLength(1);
+    const state = actions[0].action.initialEntryState(entry as any);
+    expect(state.label).toBe("Label Property Action");
+  });
+
+  it("humanizes an un-overridden alias and falls back to the placeholder asset", () => {
+    const entry = {
+      id: "entry-3",
+      extensions: {
+        entry_action: [
+          {
+            button: { alias: "add_all_to_queue" },
+            actions: [{ type: "test" }],
+            dismiss_on_action: true,
+          },
+          {
+            button: { alias: "custom_unknown_action" },
+            actions: [{ type: "test" }],
+          },
+        ],
+      },
+    };
+
+    const actions = resolveEntryActions(entry as any);
+
+    expect(actions).toHaveLength(2);
+
+    // No built-in alias vocabulary any more: underscores become spaces and
+    // only the first letter is capitalized, so "queue" stays lowercase.
+    expect(actions[0].action.initialEntryState(entry as any)).toMatchObject({
+      state: 0,
+      label: "Add all to queue",
+    });
+
+    expect(actions[1].action.initialEntryState(entry as any)).toMatchObject({
+      state: 0,
+      label: "Custom unknown action",
+    });
+
+    // The asset has no such fallback: without an override it is the red-box
+    // placeholder, so a missing Studio icon is visible rather than absent.
+    for (const action of actions) {
+      expect(action.action.initialEntryState(entry as any)).toMatchObject({
+        asset: expect.stringMatching(/^data:image\/png;base64,/),
+      });
+    }
+  });
+
+  it("prefers aliasPresentation overrides over the humanized fallbacks", () => {
+    const deps = {
+      actionExecutor: { handleActions: jest.fn() } as any,
+      actionContext: {},
+      aliasPresentation: {
+        labels: { add_all_to_queue: "Add all to Queue" },
+        assets: { add_all_to_queue: "http://example.com/queue.png" },
+      },
+    };
+
+    const entry = {
+      id: "entry-4",
+      extensions: {
+        entry_action: [
+          {
+            button: { alias: "add_all_to_queue" },
+            actions: [{ type: "test" }],
+          },
+          {
+            button: { alias: "not_overridden" },
+            actions: [{ type: "test" }],
+          },
+        ],
+      },
+    };
+
+    const actions = buildEntryActions(entry as any, deps);
+
+    expect(actions[0].action.initialEntryState(entry as any)).toMatchObject({
+      label: "Add all to Queue",
+      asset: "http://example.com/queue.png",
+    });
+
+    // Overrides are per-alias, so an alias absent from the map still humanizes.
+    expect(actions[1].action.initialEntryState(entry as any)).toMatchObject({
+      label: "Not overridden",
+    });
+  });
+
+  it("returns no asset when the button has neither iconURL nor alias", () => {
+    const entry = {
+      id: "entry-5",
+      extensions: {
+        entry_action: [
+          {
+            button: { label: "Plain Label" },
+            actions: [{ type: "test" }],
+          },
+        ],
+      },
+    };
+
+    const actions = resolveEntryActions(entry as any);
+    const state = actions[0].action.initialEntryState(entry as any);
+
+    expect(state.label).toBe("Plain Label");
+    expect(state.asset).toBeUndefined();
+  });
+
+  it("uses actionExecutor.getActionState for plugin-provided label and asset", () => {
+    mockDeps.actionExecutor.getActionState = jest.fn(() => ({
+      label: "From Plugin",
+      asset: "plugin_asset",
+    }));
+
+    const entry = {
+      id: "entry-plugin-state",
+      extensions: {
+        entry_action: [
+          {
+            button: { alias: "custom_plugin_action" },
+            actions: [{ type: "plugin-action" }],
+          },
+        ],
+      },
+    };
+
+    const actions = resolveEntryActions(entry as any);
+    const state = actions[0].action.initialEntryState(entry as any);
+
+    expect(mockDeps.actionExecutor.getActionState).toHaveBeenCalledWith(
+      "plugin-action",
+      entry
+    );
+
+    expect(state).toMatchObject({
+      label: "From Plugin",
+      asset: "plugin_asset",
+    });
+  });
+});
+
+describe("buildEntryActions - invokeAction execution context", () => {
+  it("forwards the List component from invoke options into handleActions", async () => {
+    const handleActions = jest.fn();
+
+    const component = {
+      id: "list-1",
+      data: { source: "https://example.com/user/collections/abc" },
+    };
+
+    const deps = {
+      actionExecutor: { handleActions } as any,
+      actionContext: { screenData: { id: "playlist-screen" } },
+    };
+
+    const entry = {
+      id: "entry-1",
+      extensions: {
+        entry_action: [
+          {
+            button: { title: "Edit Name" },
+            actions: [{ type: "refreshComponent" }],
+          },
+        ],
+      },
+    };
+
+    const [action] = buildEntryActions(entry as any, deps);
+
+    await action.action.invokeAction(entry as any, { component });
+
+    expect(handleActions).toHaveBeenCalledWith([{ type: "refreshComponent" }], {
+      entry,
+      entryContext: entry,
+      screenData: { id: "playlist-screen" },
+      component,
+    });
+  });
+});

package/entryActions/aliasPresentation.ts

@@ -0,0 +1,108 @@
+/**
+ * Presentation fallbacks for backend action aliases.
+ *
+ * Entries may declare an action by `alias` alone, without a label or an icon.
+ * There is no built-in alias vocabulary: a label falls back to a humanized
+ * version of the alias itself, and an icon falls back to an inline placeholder
+ * that is deliberately conspicuous, so a missing asset reads as unconfigured
+ * rather than as a deliberate blank.
+ *
+ * Both are last resorts, not a framework guarantee: an app that speaks its own
+ * alias vocabulary or needs other languages passes labels and assets through
+ * `EntryActionDeps.aliasPresentation`, which is consulted per alias.
+ */
+
+import { EntryAction } from "./types";
+
+import { createLogger } from "@applicaster/zapp-react-native-utils/logger";
+
+const logger = createLogger({
+  category: "zapp-react-native-utils:aliasPresentation",
+});
+
+const PLACEHOLDER_RED_BOX =
+  "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAJ0lEQVR4nO3NMQEAAAjDsIF/z2ACvlRAU5NMHuvPOQAAAAAAAMBdC/07Ai5sNw+CAAAAAElFTkSuQmCC";
+
+/** Per-app labels and icons, keyed by alias, that outrank the fallbacks. */
+export type AliasPresentation = {
+  labels?: Record<string, string>;
+  assets?: Record<string, string>;
+};
+
+function formatAliasLabel(
+  alias: string,
+  overrides?: AliasPresentation
+): string {
+  const label = overrides?.labels?.[alias];
+
+  if (label) {
+    return label;
+  }
+
+  const formatted = alias.replace(/_/g, " ");
+
+  return formatted.charAt(0).toUpperCase() + formatted.slice(1);
+}
+
+const nonEmptyString = (value: unknown): value is string =>
+  typeof value === "string" && value.length > 0;
+
+/**
+ * Label the backend stated outright, if any. Distinct from
+ * {@link resolveButtonLabel} because an explicit label outranks the executor's
+ * action state, while the alias fallback does not.
+ */
+export function resolveExplicitLabel(
+  button: EntryAction["button"]
+): string | undefined {
+  if (nonEmptyString(button?.title)) {
+    return button.title;
+  }
+
+  if (nonEmptyString(button?.label)) {
+    return button.label;
+  }
+
+  return undefined;
+}
+
+/** Label to show for an entry action: explicit title/label, else the alias. */
+export function resolveButtonLabel(
+  button: EntryAction["button"],
+  overrides?: AliasPresentation
+): string {
+  const explicit = resolveExplicitLabel(button);
+
+  if (explicit) {
+    return explicit;
+  }
+
+  if (nonEmptyString(button?.alias)) {
+    return formatAliasLabel(button.alias, overrides);
+  }
+
+  return "";
+}
+
+/** Icon to show for an entry action: explicit iconURL, matching alias asset or fallback to red box. */
+export function resolveButtonAsset(
+  button: EntryAction["button"],
+  overrides?: AliasPresentation
+): string | undefined {
+  if (button?.iconURL) {
+    return button.iconURL;
+  }
+
+  if (!button?.alias) {
+    return undefined;
+  }
+
+  if (!overrides?.assets?.[button.alias]) {
+    logger.log_warning(
+      `Entry action alias '${button.alias}' was not resolved by any plugin feedDecorator or app override. Falling back to placeholder red box.`,
+      { data: { button } }
+    );
+  }
+
+  return overrides?.assets?.[button.alias] ?? PLACEHOLDER_RED_BOX;
+}