@applicaster/zapp-react-native-utils 16.0.0-alpha.1803022420 → 16.0.0-alpha.1816065263

package/numberUtils/__tests__/toNumberWithDefaultZero.test.ts

@@ -0,0 +1,48 @@
+import { toNumberWithDefaultZero } from "..";
+
+const DEFAULT = 0;
+
+describe("toNumberWithDefaultZero", () => {
+  it("return number if input is number", () => {
+    const inputs = [-1, 0, 1, 100, 0.2];
+    expect.assertions(inputs.length);
+
+    inputs.forEach((input) => {
+      const output = toNumberWithDefaultZero(input);
+      expect(output).toBe(input);
+    });
+  });
+
+  it("return number if input is string as number", () => {
+    const inputs = ["-1", "0", "1", "100", "0.2"];
+    expect.assertions(inputs.length);
+
+    inputs.forEach((input) => {
+      const output = toNumberWithDefaultZero(input);
+      expect(output).toBe(Number(input));
+    });
+  });
+
+  it("return zero if input is not a number", () => {
+    const inputs = [
+      "vfdvf",
+      "5n",
+      "-5n",
+      null,
+      undefined,
+      NaN,
+      "",
+      {},
+      { test: 1 },
+      [],
+      [1],
+    ];
+
+    expect.assertions(inputs.length);
+
+    inputs.forEach((input) => {
+      const output = toNumberWithDefaultZero(input);
+      expect(output).toBe(DEFAULT);
+    });
+  });
+});

package/numberUtils/index.ts

@@ -1,18 +1,37 @@
-import * as R from "ramda";
+import { isNil } from "@applicaster/zapp-react-native-utils/utils";
+
 import { logger } from "@applicaster/zapp-react-native-utils/logger";
 
 const numberUtilsLogger = logger?.addSubsystem("NumberUtils");
 
+/** Matches Ramda isEmpty: "" / [] / {} are empty; numbers and bigints are not. */
+const isEmpty = (value: unknown): boolean => {
+  if (typeof value === "string" || Array.isArray(value)) {
+    return value.length === 0;
+  }
+
+  if (typeof value === "object" && value !== null) {
+    return Object.keys(value).length === 0;
+  }
+
+  return false;
+};
+
 export const toNumber = (value: unknown): number | undefined => {
-  if (R.isNil(value) || R.isEmpty(value)) {
+  if (isNil(value) || isEmpty(value)) {
     return undefined;
   }
 
   // Feature-detect BigInt support to avoid ReferenceError on older runtimes
   const isBigIntSupported = typeof BigInt !== "undefined";
-  const isBigIntValue = isBigIntSupported && R.is(BigInt, value);
-
-  if (R.is(Number, value) || isBigIntValue || R.is(String, value)) {
+  const isBigIntValue = isBigIntSupported && typeof value === "bigint";
+
+  if (
+    typeof value === "number" ||
+    isBigIntValue ||
+    typeof value === "string" ||
+    value instanceof String
+  ) {
     const numberOrNan = Number(value);
 
     return Number.isNaN(numberOrNan) ? undefined : numberOrNan;
@@ -59,7 +78,7 @@ export const toFiniteNumberWithDefault = (
 export const isLikeNumber = (value: unknown): boolean => {
   const possibleNumber = toNumber(value);
 
-  if (R.isNil(possibleNumber)) {
+  if (isNil(possibleNumber)) {
     return false;
   }
 
@@ -76,7 +95,7 @@ export const isMinusZero = (value: number) => {
 export const toPositiveNumber = (value: unknown): number | undefined => {
   const possibleNumber = toNumber(value);
 
-  if (R.isNil(possibleNumber)) {
+  if (isNil(possibleNumber)) {
     return undefined;
   }
 
@@ -97,7 +116,7 @@ export const toPositiveNumberWithDefault = (
 ): number => {
   const possibleNumber = toNumber(value);
 
-  if (R.isNil(possibleNumber)) {
+  if (isNil(possibleNumber)) {
     return defaultValue;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "16.0.0-alpha.1803022420",
+  "version": "16.0.0-alpha.1816065263",
   "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-alpha.1803022420",
+    "@applicaster/applicaster-types": "16.0.0-alpha.1816065263",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",

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();
+  });
+});