@applicaster/zapp-react-native-utils 15.1.13-alpha.1034774223 → 15.1.13

package/playerUtils/__tests__/resolvePlayerActions.test.ts

@@ -1,138 +0,0 @@
-import { resolvePlayerActions } from "../resolvePlayerActions";
-import { selectActionButtons } from "../../conf/player/selectors";
-import { uiActionsRegistry } from "../../uiActionsRegistrator";
-
-jest.mock("../../conf/player/selectors", () => ({
-  selectActionButtons: jest.fn(),
-}));
-
-const action = (identifier: string) =>
-  ({ identifier, action: { invokeAction: jest.fn() } }) as any;
-
-describe("resolvePlayerActions", () => {
-  const entry = {
-    id: "e1",
-    extensions: {
-      entry_action: [
-        { button: { alias: "add_to_playlist" }, actions: [{ type: "test" }] },
-        { button: { alias: "add_to_queue" }, actions: [{ type: "test" }] },
-      ],
-    },
-  };
-
-  // The entry's own actions never reach the registry; the caller expands them.
-  const expandEntryActions = jest.fn(() => [
-    action("entry_action_0"),
-    action("entry_action_1"),
-  ]);
-
-  beforeEach(() => {
-    expandEntryActions.mockClear();
-
-    jest
-      .spyOn(uiActionsRegistry, "getActions")
-      .mockImplementation((name) => [action(name)]);
-  });
-
-  afterEach(() => {
-    jest.restoreAllMocks();
-  });
-
-  it("expands entry_actions through the caller and keeps config order", () => {
-    (selectActionButtons as jest.Mock).mockReturnValue(
-      "entry_actions,local_storage_favourites_action,offline-content-button"
-    );
-
-    const result = resolvePlayerActions({
-      configuration: {},
-      entry,
-      expandEntryActions,
-    });
-
-    expect(expandEntryActions).toHaveBeenCalledWith(entry);
-
-    expect(uiActionsRegistry.getActions).not.toHaveBeenCalledWith(
-      "entry_actions",
-      entry
-    );
-
-    expect(result.map((item) => item.identifier)).toEqual([
-      "entry_action_0",
-      "entry_action_1",
-      "local_storage_favourites_action",
-      "offline-content-button",
-    ]);
-  });
-
-  it.each([undefined, null, ""])(
-    "resolves nothing when the config is %p",
-    (configured) => {
-      (selectActionButtons as jest.Mock).mockReturnValue(configured);
-
-      expect(
-        resolvePlayerActions({ configuration: {}, entry, expandEntryActions })
-      ).toEqual([]);
-    }
-  );
-
-  it("does not cap the resolved list at two items", () => {
-    (selectActionButtons as jest.Mock).mockReturnValue("a,b,c");
-
-    expect(
-      resolvePlayerActions({
-        configuration: {},
-        entry,
-        expandEntryActions,
-      }).map((item) => item.identifier)
-    ).toEqual(["a", "b", "c"]);
-  });
-
-  it("has no special case for any plugin identifier", () => {
-    (selectActionButtons as jest.Mock).mockReturnValue(
-      "open-modal-bottom-sheet-cell-action,local_storage_favourites_action"
-    );
-
-    expect(
-      resolvePlayerActions({
-        configuration: {},
-        entry,
-        expandEntryActions,
-      }).map((item) => item.identifier)
-    ).toEqual([
-      "open-modal-bottom-sheet-cell-action",
-      "local_storage_favourites_action",
-    ]);
-  });
-
-  it("collapses a repeated identifier in the config string", () => {
-    (selectActionButtons as jest.Mock).mockReturnValue(
-      "favorites,favorites,share"
-    );
-
-    expect(
-      resolvePlayerActions({
-        configuration: {},
-        entry,
-        expandEntryActions,
-      }).map((item) => item.identifier)
-    ).toEqual(["favorites", "share"]);
-  });
-
-  it("drops resolved items that cannot be invoked", () => {
-    (selectActionButtons as jest.Mock).mockReturnValue("broken,share");
-
-    (uiActionsRegistry.getActions as jest.Mock).mockImplementation((name) =>
-      name === "broken"
-        ? [{ identifier: "broken" } as any]
-        : [action(name as string)]
-    );
-
-    expect(
-      resolvePlayerActions({
-        configuration: {},
-        entry,
-        expandEntryActions,
-      }).map((item) => item.identifier)
-    ).toEqual(["share"]);
-  });
-});

package/playerUtils/resolvePlayerActions.ts

@@ -1,71 +0,0 @@
-import { selectActionButtons } from "../conf/player/selectors";
-import {
-  usableActionItems,
-  RegisteredAction,
-  resolveActionIdentifiers,
-} from "../uiActionsRegistrator";
-
-export type ResolvePlayerActionsParams = {
-  configuration: any;
-  entry: ZappEntry | ZappFeed;
-  /** Expands the `entry_actions` token; see `resolveActionIdentifiers`. */
-  expandEntryActions?: (entry: ZappEntry | ZappFeed) => RegisteredAction[];
-};
-
-/**
- * The player's action buttons, resolved against the entry.
- *
- * Every `player_action_buttons` token goes through `uiActionsRegistry`, except
- * `entry_actions`, which the caller expands from the entry itself. The list is
- * not capped; the overlay decides how many fit and sends the rest to the sheet.
- */
-export function resolvePlayerActions({
-  configuration,
-  entry,
-  expandEntryActions,
-}: ResolvePlayerActionsParams): RegisteredAction[] {
-  const buttonsString = selectActionButtons(configuration);
-
-  if (!buttonsString) {
-    return [];
-  }
-
-  // Deduped at the source: `player_action_buttons` is a hand-typed string, so
-  // the same identifier can legitimately appear twice. Left alone, a repeat
-  // would be counted twice against the inline limit, rendered twice on the
-  // overlay, and collide as a React key. Items with no `invokeAction` are
-  // dropped here too - they can never do anything.
-  return usableActionItems(
-    resolveActionIdentifiers({
-      identifiers: buttonsString,
-      entry,
-      expandEntryActions,
-    })
-  );
-}
-
-/** One control on the player overlay, before overflow is applied. */
-export type ActionButtonDescriptor =
-  | { kind: "subtitle" }
-  | { kind: "close" }
-  | { kind: "airplay" }
-  | { kind: "action"; action: RegisteredAction };
-
-/**
- * The Overflow control, produced by `splitOverflow` when more content actions
- * resolve than fit on the overlay.
- */
-export type OverflowDescriptor = {
-  kind: "overflow";
-  /**
-   * Every content action, the overlay companion included. An overlay button
-   * renders nothing when its action has no icon, so the companion needs the
-   * sheet as a second home or it could be reachable from nowhere.
-   */
-  additionalActions: RegisteredAction[];
-};
-
-/** What the overlay actually renders, once overflow has been applied. */
-export type PlayerControlDescriptor =
-  | ActionButtonDescriptor
-  | OverflowDescriptor;

package/uiActionsRegistrator/__tests__/resolveActionIdentifiers.test.ts

@@ -1,93 +0,0 @@
-import {
-  parseActionIdentifiers,
-  resolveActionIdentifiers,
-} from "../resolveActionIdentifiers";
-import { uiActionsRegistry } from "../registry";
-
-const action = (identifier: string) =>
-  ({ identifier, action: { invokeAction: jest.fn() } }) as any;
-
-describe("parseActionIdentifiers", () => {
-  it("parses comma-separated identifiers", () => {
-    expect(parseActionIdentifiers(" a, b , ,c ")).toEqual(["a", "b", "c"]);
-  });
-
-  it("parses identifier arrays", () => {
-    expect(parseActionIdentifiers([" a ", "", "b", "  ", "c"])).toEqual([
-      "a",
-      "b",
-      "c",
-    ]);
-  });
-
-  it("returns empty array for nil config", () => {
-    expect(parseActionIdentifiers(null)).toEqual([]);
-    expect(parseActionIdentifiers(undefined)).toEqual([]);
-  });
-});
-
-describe("resolveActionIdentifiers", () => {
-  const entry = { id: "entry-1" } as any;
-
-  beforeEach(() => {
-    jest
-      .spyOn(uiActionsRegistry, "getActions")
-      .mockImplementation((identifier) => [action(identifier)] as any);
-  });
-
-  afterEach(() => {
-    jest.restoreAllMocks();
-  });
-
-  it("resolves through registry by default", () => {
-    const result = resolveActionIdentifiers({
-      identifiers: "favorites,share",
-      entry,
-    });
-
-    expect(result.map((item) => item.identifier)).toEqual([
-      "favorites",
-      "share",
-    ]);
-
-    expect(uiActionsRegistry.getActions).toHaveBeenCalledWith(
-      "favorites",
-      entry
-    );
-
-    expect(uiActionsRegistry.getActions).toHaveBeenCalledWith("share", entry);
-  });
-
-  it("expands entry_actions through the caller, not the registry", () => {
-    const expanded = [action("entry_action_0"), action("entry_action_1")];
-    const expandEntryActions = jest.fn(() => expanded);
-
-    const unregister = uiActionsRegistry.registerAction("share", {
-      invokeAction: jest.fn(),
-    });
-
-    try {
-      const result = resolveActionIdentifiers({
-        identifiers: "entry_actions,share",
-        entry,
-        expandEntryActions,
-      });
-
-      expect(expandEntryActions).toHaveBeenCalledWith(entry);
-
-      expect(result.map((item) => item.identifier)).toEqual([
-        "entry_action_0",
-        "entry_action_1",
-        "share",
-      ]);
-    } finally {
-      unregister();
-    }
-  });
-
-  it("resolves nothing for entry_actions when the caller cannot expand it", () => {
-    expect(
-      resolveActionIdentifiers({ identifiers: "entry_actions", entry })
-    ).toEqual([]);
-  });
-});

package/uiActionsRegistrator/__tests__/subscribe.test.ts

@@ -1,107 +0,0 @@
-import { isActionAvailableFor, uiActionsRegistry } from "../registry";
-
-const value = { invokeAction: jest.fn() };
-
-describe("uiActionsRegistry.subscribe", () => {
-  it("fires on registration and on unregistration", () => {
-    const listener = jest.fn();
-    const unsubscribe = uiActionsRegistry.subscribe(listener);
-
-    const unregister = uiActionsRegistry.registerAction("late-action", value);
-
-    expect(listener).toHaveBeenCalledTimes(1);
-
-    unregister();
-
-    expect(listener).toHaveBeenCalledTimes(2);
-
-    unsubscribe();
-  });
-
-  it("lets a listener see the action it was told about", () => {
-    let seen: string[] = [];
-
-    const unsubscribe = uiActionsRegistry.subscribe(() => {
-      seen = uiActionsRegistry
-        .getActions("late-action", { id: "e1" } as any)
-        .map((item) => item.identifier);
-    });
-
-    const unregister = uiActionsRegistry.registerAction("late-action", value);
-
-    expect(seen).toEqual(["late-action"]);
-
-    unregister();
-    unsubscribe();
-  });
-
-  it("stops calling a listener once unsubscribed", () => {
-    const listener = jest.fn();
-
-    uiActionsRegistry.subscribe(listener)();
-
-    uiActionsRegistry.registerAction("another-action", value)();
-
-    expect(listener).not.toHaveBeenCalled();
-  });
-
-  it("survives a listener that unsubscribes itself while being notified", () => {
-    const other = jest.fn();
-
-    const unsubscribeOther = uiActionsRegistry.subscribe(other);
-
-    const unsubscribeSelf = uiActionsRegistry.subscribe(() => {
-      unsubscribeSelf();
-    });
-
-    expect(() =>
-      uiActionsRegistry.registerAction("self-removing", value)()
-    ).not.toThrow();
-
-    expect(other).toHaveBeenCalled();
-
-    unsubscribeOther();
-  });
-});
-
-describe("isActionAvailableFor", () => {
-  const entry = { id: "e1" } as any;
-
-  it("shows an action that states no opinion", () => {
-    expect(isActionAvailableFor({ invokeAction: jest.fn() }, entry)).toBe(true);
-  });
-
-  it.each([
-    ["isSupportDownloads"],
-    ["isActionSupported"],
-    ["isActionAvailable"],
-  ])("honours %s", (predicate) => {
-    expect(
-      isActionAvailableFor(
-        { invokeAction: jest.fn(), [predicate]: () => false } as any,
-        entry
-      )
-    ).toBe(false);
-  });
-
-  it("asks only the first predicate the action defines", () => {
-    const isActionAvailable = jest.fn(() => true);
-
-    expect(
-      isActionAvailableFor(
-        {
-          invokeAction: jest.fn(),
-          isSupportDownloads: () => false,
-          isActionAvailable,
-        } as any,
-        entry
-      )
-    ).toBe(false);
-
-    expect(isActionAvailable).not.toHaveBeenCalled();
-  });
-
-  it("treats a missing action as unavailable-free", () => {
-    expect(isActionAvailableFor(undefined, entry)).toBe(true);
-  });
-});

package/uiActionsRegistrator/__tests__/usableActionItems.test.ts

@@ -1,52 +0,0 @@
-import { usableActionItems } from "../usableActionItems";
-
-const action = (identifier: string) =>
-  ({ identifier, action: { invokeAction: jest.fn() } }) as any;
-
-describe("usableActionItems", () => {
-  it("keeps a usable list untouched, in order", () => {
-    const base = [action("share"), action("favorites")];
-
-    expect(usableActionItems(base).map((item) => item.identifier)).toEqual([
-      "share",
-      "favorites",
-    ]);
-  });
-
-  it("keeps the first of a repeated identifier", () => {
-    const firstShare = action("share");
-    const secondShare = action("share");
-
-    const result = usableActionItems([
-      firstShare,
-      action("favorites"),
-      secondShare,
-    ]);
-
-    expect(result.map((item) => item.identifier)).toEqual([
-      "share",
-      "favorites",
-    ]);
-
-    expect(result[0]).toBe(firstShare);
-  });
-
-  it("drops items that cannot be invoked or have no identifier", () => {
-    const result = usableActionItems([
-      action("share"),
-      { identifier: "blank" } as any,
-      { identifier: "no-invoke", action: {} } as any,
-      { action: { invokeAction: jest.fn() } } as any,
-      action("entry_action_0"),
-    ]);
-
-    expect(result.map((item) => item.identifier)).toEqual([
-      "share",
-      "entry_action_0",
-    ]);
-  });
-
-  it("tolerates a missing list", () => {
-    expect(usableActionItems(undefined as any)).toEqual([]);
-  });
-});