@applicaster/zapp-react-native-utils 16.0.0-rc.7 → 16.0.0-rc.71

package/playerUtils/__tests__/contentDataKeys.test.ts

@@ -0,0 +1,297 @@
+import {
+  resolvePlayerContentText,
+  VIDEO_PLAYER_CONTENT_DATA_KEYS,
+  AUDIO_PLAYER_CONTENT_DATA_KEYS,
+  createConfigValueGetter,
+} from "../contentDataKeys";
+
+const entry = {
+  id: "1",
+  type: { value: "audio" },
+  title: "Default Title",
+  summary: "Default Summary",
+  extensions: {
+    episode_name: "Custom Episode",
+    episode_subtitle: "Custom Subtitle",
+    blank: "",
+    show: { name: "Nested Show Name" },
+    genres: ["Drama", "Comedy"],
+    rating: 0,
+    is_featured: true,
+  },
+} as unknown as ZappEntry;
+
+const valueFrom =
+  (config: Record<string, unknown>): GetValue =>
+  (key: string) =>
+    (config[key] ?? null) as never;
+
+const resolveTitle = (config: Record<string, unknown>, target = entry) =>
+  resolvePlayerContentText({
+    entry: target,
+    field: "title",
+    value: valueFrom(config),
+  });
+
+const resolveSubtitle = (config: Record<string, unknown>, target = entry) =>
+  resolvePlayerContentText({
+    entry: target,
+    field: "subtitle",
+    value: valueFrom(config),
+  });
+
+describe("resolvePlayerContentText", () => {
+  describe("backward compatibility", () => {
+    it("returns entry.title when no configuration is stored", () => {
+      expect(resolveTitle({})).toBe("Default Title");
+    });
+
+    it("returns entry.summary when no configuration is stored", () => {
+      expect(resolveSubtitle({})).toBe("Default Summary");
+    });
+
+    it("returns the defaults when the source is explicitly the default option", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "title",
+          title_custom_data_key: "extensions.episode_name",
+        })
+      ).toBe("Default Title");
+
+      expect(
+        resolveSubtitle({
+          subtitle_data_key_source: "summary",
+          subtitle_custom_data_key: "extensions.episode_subtitle",
+        })
+      ).toBe("Default Summary");
+    });
+  });
+
+  describe("custom data key", () => {
+    it("resolves a dot path on the entry for the title", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.episode_name",
+        })
+      ).toBe("Custom Episode");
+    });
+
+    it("resolves a dot path on the entry for the subtitle", () => {
+      expect(
+        resolveSubtitle({
+          subtitle_data_key_source: "other",
+          subtitle_custom_data_key: "extensions.episode_subtitle",
+        })
+      ).toBe("Custom Subtitle");
+    });
+
+    it("resolves a nested dot path", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.show.name",
+        })
+      ).toBe("Nested Show Name");
+    });
+
+    it("resolves a top level entry key", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "summary",
+        })
+      ).toBe("Default Summary");
+    });
+
+    it("trims surrounding whitespace from the configured key", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "  extensions.episode_name  ",
+        })
+      ).toBe("Custom Episode");
+    });
+  });
+
+  describe("fallbacks", () => {
+    it("falls back to the default when the custom key is empty", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "",
+        })
+      ).toBe("Default Title");
+    });
+
+    it("falls back to the default when the custom key is whitespace only", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "   ",
+        })
+      ).toBe("Default Title");
+    });
+
+    it("falls back to the default when the custom key does not resolve", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.does_not_exist",
+        })
+      ).toBe("Default Title");
+    });
+
+    it("falls back to the default when the custom key resolves to an empty string", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.blank",
+        })
+      ).toBe("Default Title");
+    });
+
+    // The Studio field is free text, so a customer can easily stop one
+    // segment short (`extensions.show` rather than `extensions.show.name`)
+    // or aim the key at a list field. Rendering those would throw
+    // "Objects are not valid as a React child" and red-screen every screen
+    // containing the player.
+    it("falls back to the default when the custom key resolves to an object", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.show",
+        })
+      ).toBe("Default Title");
+    });
+
+    it("falls back to the default when the custom key resolves to an array", () => {
+      expect(
+        resolveSubtitle({
+          subtitle_data_key_source: "other",
+          subtitle_custom_data_key: "extensions.genres",
+        })
+      ).toBe("Default Summary");
+    });
+
+    it("falls back to the default when the custom key resolves to a boolean", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.is_featured",
+        })
+      ).toBe("Default Title");
+    });
+
+    // Numbers are renderable, so the guard above must not swallow them -
+    // including 0, which is falsy but perfectly displayable.
+    it("returns a numeric custom value rather than falling back", () => {
+      expect(
+        resolveTitle({
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.rating",
+        })
+      ).toBe(0);
+    });
+  });
+
+  describe("missing entry", () => {
+    it("returns undefined without throwing when the entry is undefined", () => {
+      expect(
+        resolvePlayerContentText({
+          entry: undefined,
+          field: "title",
+          value: valueFrom({}),
+        })
+      ).toBeUndefined();
+    });
+
+    it("returns undefined without throwing when a custom key is set", () => {
+      expect(
+        resolvePlayerContentText({
+          entry: undefined,
+          field: "title",
+          value: valueFrom({
+            title_data_key_source: "other",
+            title_custom_data_key: "extensions.episode_name",
+          }),
+        })
+      ).toBeUndefined();
+    });
+  });
+});
+
+describe("custom data key sets", () => {
+  it("reads the TV video keys when given that key set", () => {
+    const value = createConfigValueGetter({
+      video_player_title_data_key_source: "other",
+      video_player_title_custom_data_key: "extensions.episode_name",
+    });
+
+    expect(
+      resolvePlayerContentText({
+        entry,
+        field: "title",
+        value,
+        dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
+      })
+    ).toBe("Custom Episode");
+  });
+
+  it("reads the TV audio keys when given that key set", () => {
+    const value = createConfigValueGetter({
+      audio_player_summary_data_key_source: "other",
+      audio_player_summary_custom_data_key: "extensions.episode_subtitle",
+    });
+
+    expect(
+      resolvePlayerContentText({
+        entry,
+        field: "subtitle",
+        value,
+        dataKeys: AUDIO_PLAYER_CONTENT_DATA_KEYS,
+      })
+    ).toBe("Custom Subtitle");
+  });
+
+  it("ignores the mobile keys when a TV key set is supplied", () => {
+    const value = createConfigValueGetter({
+      title_data_key_source: "other",
+      title_custom_data_key: "extensions.episode_name",
+    });
+
+    expect(
+      resolvePlayerContentText({
+        entry,
+        field: "title",
+        value,
+        dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
+      })
+    ).toBe("Default Title");
+  });
+
+  it("defaults to the mobile key set when dataKeys is omitted", () => {
+    const value = createConfigValueGetter({
+      title_data_key_source: "other",
+      title_custom_data_key: "extensions.episode_name",
+    });
+
+    expect(resolvePlayerContentText({ entry, field: "title", value })).toBe(
+      "Custom Episode"
+    );
+  });
+});
+
+describe("createConfigValueGetter", () => {
+  it("returns null for a missing key", () => {
+    expect(createConfigValueGetter({})("anything")).toBeNull();
+  });
+
+  it("returns null for an undefined configuration", () => {
+    expect(createConfigValueGetter(undefined)("anything")).toBeNull();
+  });
+
+  it("returns the stored value", () => {
+    expect(createConfigValueGetter({ a: "b" })("a")).toBe("b");
+  });
+});

package/playerUtils/__tests__/resolvePlayerTitleSubtitle.test.ts

@@ -0,0 +1,180 @@
+import {
+  resolvePlayerTitleSubtitle,
+  getPlayerContentDataKeys,
+} from "../resolvePlayerTitleSubtitle";
+import {
+  VIDEO_PLAYER_CONTENT_DATA_KEYS,
+  AUDIO_PLAYER_CONTENT_DATA_KEYS,
+} from "../contentDataKeys";
+
+const entry = {
+  id: "1",
+  title: "Default Title",
+  summary: "Default Summary",
+  extensions: {
+    episode_name: "Custom Episode",
+    episode_subtitle: "Custom Subtitle",
+  },
+} as unknown as ZappEntry;
+
+describe("resolvePlayerTitleSubtitle", () => {
+  it("returns entry.title/entry.summary when nothing is configured", () => {
+    expect(
+      resolvePlayerTitleSubtitle({ entry, pluginConfiguration: {} })
+    ).toEqual({
+      title: "Default Title",
+      summary: "Default Summary",
+    });
+  });
+
+  it("returns entry.title/entry.summary when pluginConfiguration is undefined", () => {
+    expect(
+      resolvePlayerTitleSubtitle({ entry, pluginConfiguration: undefined })
+    ).toEqual({
+      title: "Default Title",
+      summary: "Default Summary",
+    });
+  });
+
+  it("returns null for both fields without throwing when entry is missing", () => {
+    expect(
+      resolvePlayerTitleSubtitle({
+        entry: undefined,
+        pluginConfiguration: {
+          title_data_key_source: "other",
+          title_custom_data_key: "extensions.episode_name",
+        },
+      })
+    ).toEqual({ title: null, summary: null });
+  });
+
+  it("does not mutate the entry it is given", () => {
+    const original = JSON.parse(JSON.stringify(entry));
+
+    resolvePlayerTitleSubtitle({
+      entry,
+      pluginConfiguration: {
+        title_data_key_source: "other",
+        title_custom_data_key: "extensions.episode_name",
+      },
+    });
+
+    expect(entry).toEqual(original);
+  });
+
+  describe("default (mobile) key set", () => {
+    it("resolves the title from the default (mobile) custom data key", () => {
+      expect(
+        resolvePlayerTitleSubtitle({
+          entry,
+          pluginConfiguration: {
+            title_data_key_source: "other",
+            title_custom_data_key: "extensions.episode_name",
+          },
+        })
+      ).toEqual({
+        title: "Custom Episode",
+        summary: "Default Summary",
+      });
+    });
+
+    it("ignores TV-only custom data keys", () => {
+      expect(
+        resolvePlayerTitleSubtitle({
+          entry,
+          pluginConfiguration: {
+            video_player_title_data_key_source: "other",
+            video_player_title_custom_data_key: "extensions.episode_name",
+          },
+        })
+      ).toEqual({
+        title: "Default Title",
+        summary: "Default Summary",
+      });
+    });
+  });
+
+  describe("dataKeys parameter (e.g. VIDEO_PLAYER_CONTENT_DATA_KEYS)", () => {
+    it("resolves the title from the TV video custom data key when dataKeys is VIDEO_PLAYER_CONTENT_DATA_KEYS", () => {
+      expect(
+        resolvePlayerTitleSubtitle({
+          entry,
+          pluginConfiguration: {
+            video_player_title_data_key_source: "other",
+            video_player_title_custom_data_key: "extensions.episode_name",
+            video_player_summary_data_key_source: "other",
+            video_player_summary_custom_data_key: "extensions.episode_subtitle",
+          },
+          dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
+        })
+      ).toEqual({
+        title: "Custom Episode",
+        summary: "Custom Subtitle",
+      });
+    });
+
+    it("ignores mobile custom data keys when dataKeys is VIDEO_PLAYER_CONTENT_DATA_KEYS", () => {
+      expect(
+        resolvePlayerTitleSubtitle({
+          entry,
+          pluginConfiguration: {
+            title_data_key_source: "other",
+            title_custom_data_key: "extensions.episode_name",
+          },
+          dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
+        })
+      ).toEqual({
+        title: "Default Title",
+        summary: "Default Summary",
+      });
+    });
+
+    it("produces a different resolved title than the default key set for the same configuration object", () => {
+      const pluginConfiguration = {
+        title_data_key_source: "other",
+        title_custom_data_key: "extensions.episode_name",
+        video_player_title_data_key_source: "other",
+        video_player_title_custom_data_key: "extensions.episode_subtitle",
+      };
+
+      const defaultResolved = resolvePlayerTitleSubtitle({
+        entry,
+        pluginConfiguration,
+      });
+
+      const tvResolved = resolvePlayerTitleSubtitle({
+        entry,
+        pluginConfiguration,
+        dataKeys: VIDEO_PLAYER_CONTENT_DATA_KEYS,
+      });
+
+      expect(defaultResolved.title).toBe("Custom Episode");
+      expect(tvResolved.title).toBe("Custom Subtitle");
+      expect(defaultResolved.title).not.toBe(tvResolved.title);
+    });
+  });
+});
+
+describe("getPlayerContentDataKeys", () => {
+  it("returns AUDIO_PLAYER_CONTENT_DATA_KEYS for TV audio content", () => {
+    expect(getPlayerContentDataKeys({ isTV: true, isAudioContent: true })).toBe(
+      AUDIO_PLAYER_CONTENT_DATA_KEYS
+    );
+  });
+
+  it("returns VIDEO_PLAYER_CONTENT_DATA_KEYS for TV video content", () => {
+    expect(
+      getPlayerContentDataKeys({ isTV: true, isAudioContent: false })
+    ).toBe(VIDEO_PLAYER_CONTENT_DATA_KEYS);
+  });
+
+  it("returns undefined (the default/mobile key set) on mobile, regardless of content type", () => {
+    expect(
+      getPlayerContentDataKeys({ isTV: false, isAudioContent: true })
+    ).toBeUndefined();
+
+    expect(
+      getPlayerContentDataKeys({ isTV: false, isAudioContent: false })
+    ).toBeUndefined();
+  });
+});

package/playerUtils/contentDataKeys.ts

@@ -0,0 +1,134 @@
+import { get } from "@applicaster/zapp-react-native-utils/utils";
+import { isNotEmptyString } from "@applicaster/zapp-react-native-utils/stringUtils";
+
+type GetValue = <T = string | number | null>(key: string) => T;
+
+export type PlayerContentField = "title" | "subtitle";
+
+const CUSTOM_SOURCE = "other";
+
+const DEFAULT_ENTRY_PATH: Record<PlayerContentField, string> = {
+  title: "title",
+  subtitle: "summary",
+};
+
+/**
+ * Configuration keys backing each field, exported so callers can build a
+ * stable configuration getter without duplicating the key strings.
+ */
+export const PLAYER_CONTENT_DATA_KEYS: Record<
+  PlayerContentField,
+  { source: string; custom: string }
+> = {
+  title: {
+    source: "title_data_key_source",
+    custom: "title_custom_data_key",
+  },
+  subtitle: {
+    source: "subtitle_data_key_source",
+    custom: "subtitle_custom_data_key",
+  },
+};
+
+export type PlayerContentDataKeys = Record<
+  PlayerContentField,
+  { source: string; custom: string }
+>;
+
+/**
+ * TV keeps separate Title/Summary configuration per media type. Mobile has
+ * no equivalent split - it shares a single `PLAYER_CONTENT_DATA_KEYS` set
+ * for both video and audio - which is why these sets carry a media-type
+ * prefix (`video_player_*` / `audio_player_*`) and mobile's doesn't.
+ */
+export const VIDEO_PLAYER_CONTENT_DATA_KEYS: PlayerContentDataKeys = {
+  title: {
+    source: "video_player_title_data_key_source",
+    custom: "video_player_title_custom_data_key",
+  },
+  subtitle: {
+    source: "video_player_summary_data_key_source",
+    custom: "video_player_summary_custom_data_key",
+  },
+};
+
+export const AUDIO_PLAYER_CONTENT_DATA_KEYS: PlayerContentDataKeys = {
+  title: {
+    source: "audio_player_title_data_key_source",
+    custom: "audio_player_title_custom_data_key",
+  },
+  subtitle: {
+    source: "audio_player_summary_data_key_source",
+    custom: "audio_player_summary_custom_data_key",
+  },
+};
+
+/**
+ * Builds a GetValue over a plugin configuration object. Callers that hold a
+ * configuration rather than a `value` closure use this instead of hand-rolling
+ * the lookup.
+ */
+export const createConfigValueGetter =
+  (configuration: Option<Record<string, any>>): GetValue =>
+  <T>(key: string) =>
+    (configuration?.[key] ?? null) as T;
+
+type ResolvePlayerContentTextParams = {
+  entry: Option<ZappEntry>;
+  field: PlayerContentField;
+  value: GetValue;
+  dataKeys?: PlayerContentDataKeys;
+};
+
+/**
+ * Resolves the text shown for the player's Title or Subtitle.
+ *
+ * Unless the customer explicitly selected the "Other" data key source and
+ * supplied a resolvable key, this returns the hardcoded entry field the
+ * player has always used, which keeps existing apps unchanged.
+ */
+export const resolvePlayerContentText = ({
+  entry,
+  field,
+  value,
+  dataKeys,
+}: ResolvePlayerContentTextParams): Option<string | number> => {
+  if (!entry) {
+    return undefined;
+  }
+
+  const defaultValue = get(entry, DEFAULT_ENTRY_PATH[field]);
+
+  const { source, custom } = (dataKeys ?? PLAYER_CONTENT_DATA_KEYS)[field];
+
+  if (value(source) !== CUSTOM_SOURCE) {
+    return defaultValue;
+  }
+
+  const customKey = value<Option<string>>(custom);
+
+  // Only trim when the config value really is a string - it comes from
+  // free-text Studio configuration and can be a non-string (or null/undefined),
+  // and calling .trim() on that would throw.
+  const trimmedKey = isNotEmptyString(customKey) ? customKey.trim() : customKey;
+
+  if (!isNotEmptyString(trimmedKey)) {
+    return defaultValue;
+  }
+
+  const customValue = get(entry, trimmedKey);
+
+  if (customValue === null || customValue === undefined || customValue === "") {
+    return defaultValue;
+  }
+
+  // The key is free text in the Studio, so it can easily land on an object or
+  // an array (`extensions.show` instead of `extensions.show.name`). Those
+  // reach <Text> untouched and throw "Objects are not valid as a React child",
+  // so they fall back like every other unusable key.
+  if (typeof customValue !== "string" && typeof customValue !== "number") {
+    return defaultValue;
+  }
+
+  return customValue;
+};

package/playerUtils/index.ts

@@ -9,6 +9,36 @@ import { Dimensions } from "react-native";
 
 export { getPlayerActionButtons } from "./getPlayerActionButtons";
 
+export {
+  resolvePlayerContentText,
+  PLAYER_CONTENT_DATA_KEYS,
+  VIDEO_PLAYER_CONTENT_DATA_KEYS,
+  AUDIO_PLAYER_CONTENT_DATA_KEYS,
+  createConfigValueGetter,
+} from "./contentDataKeys";
+
+export type {
+  PlayerContentField,
+  PlayerContentDataKeys,
+} from "./contentDataKeys";
+
+export {
+  resolvePlayerTitleSubtitle,
+  getPlayerContentDataKeys,
+} from "./resolvePlayerTitleSubtitle";
+
+export { isAudioItem } from "./isAudioItem";
+
+export const HLS_MIME_TYPES = [
+  "application/x-mpegURL",
+  "application/vnd.apple.mpegurl",
+];
+
+export const STREAMING_VIDEO_MIME_TYPES = [
+  ...HLS_MIME_TYPES,
+  "application/dash+xml",
+];
+
 /**
  * Gets duration value from player manager, and from extensions
  * then checks whether the value from either is a not a valid number
@@ -27,7 +57,7 @@ export function isLiveLegacy(content) {
   ]);
 
   const durationFromExt = R.path(["extensions", "duration"], content);
-  const durationFromMgr = playerManager.getDuration();
+  const durationFromMgr = playerManager.getInstanceController()?.getDuration();
   const duration = Math.floor(durationFromExt || durationFromMgr);
 
   const isLive = R.anyPass([isNotaValidNumber, R.lte(R.__, 0)])(duration);
@@ -71,7 +101,9 @@ function isLiveByManager(): boolean {
     return true;
   }
 
-  const durationFromPlayerManager = playerManager.getDuration();
+  const durationFromPlayerManager = playerManager
+    .getInstanceController()
+    ?.getDuration();
 
   return isLiveByDuration(durationFromPlayerManager);
 }
@@ -80,19 +112,14 @@ export function isLive(entry: ZappEntry): boolean {
   return isEntryLive(entry) || isLiveByManager();
 }
 
-export const isAudioItem = (item: Option<ZappEntry>) => {
-  if (
-    isString(item?.content?.type) &&
-    item?.content?.type?.includes?.("audio")
-  ) {
-    return true;
-  }
-
-  if (isString(item?.type?.value) && item?.type?.value?.includes?.("audio")) {
-    return true;
-  }
+export const isVideoItem = (item: Option<ZappEntry>) => {
+  const contentType = item?.content?.type;
 
-  return false;
+  return (
+    isString(contentType) &&
+    (contentType.includes("video") ||
+      STREAMING_VIDEO_MIME_TYPES.includes(contentType))
+  );
 };
 
 export const isInlineTV = (screenData) => {