@applicaster/zapp-react-native-utils 15.1.7 → 15.1.9-alpha.3547421944

package/appUtils/playerManager/player.ts

@@ -1,8 +1,21 @@
 import * as R from "ramda";
-import { BehaviorSubject } from "rxjs";
+import { BehaviorSubject, Observable } from "rxjs";
+import { distinctUntilChanged } from "rxjs/operators";
 import { isEmptyOrNil } from "@applicaster/zapp-react-native-utils/cellUtils";
 import { createLogger, utilsLogger } from "../../logger";
-import { getBoolFromConfigValue } from "../../configurationUtils";
+import {
+  getBoolFromConfigValue,
+  imageSrcFromMediaItem,
+} from "../../configurationUtils";
+// Imported from the leaf modules rather than the `playerUtils` barrel: that
+// barrel imports `playerManager`, so going through it would create a require
+// cycle (playerManager/index -> player -> playerUtils/index -> playerManager).
+import {
+  resolvePlayerTitleSubtitle,
+  getPlayerContentDataKeys,
+} from "../../playerUtils/resolvePlayerTitleSubtitle";
+import { isAudioItem } from "../../playerUtils/isAudioItem";
+import { isTV } from "../../reactUtils";
 import { PlayerRole, SharedPlayerCallBacksKeys } from "./const";
 import { OverlaysObserver } from "./OverlayObserver/OverlaysObserver";
 import { TVSeekController } from "../../reactHooks/player/TVSeekControlller/TVSeekController";
@@ -19,6 +32,23 @@ export declare type PlayerControllerListenerData = {
   id: string;
   listener: QuickBrickPlayer.SharedPlayerCallBacks;
 };
+
+/**
+ * The player's resolved Title/Subtitle text, published by the player the same
+ * way duration and progress are. Consumers render these values as-is rather
+ * than reading `entry` or the plugin configuration themselves.
+ */
+export type PlayerContent = {
+  title: Option<string | number>;
+  summary: Option<string | number>;
+  /**
+   * Cover art for the content currently playing. Published alongside the text
+   * (rather than read from `entry` by whoever needs it) so it follows the same
+   * entry: on live audio that means the programme's own artwork, refreshed
+   * with every feed poll, instead of the channel's.
+   */
+  imageUrl: Option<string>;
+};
 /**
  * Player Instance Controller
  * Instance exposes utility methods that will help set or get state
@@ -45,6 +75,7 @@ export class Player {
   readonly playerRole: PlayerRole = PlayerRole.Unspecified;
   private overlaysObserver?: OverlaysObserver | null;
   private entryObservable?: BehaviorSubject<ZappEntry> | null;
+  private contentSubject?: BehaviorSubject<PlayerContent> | null;
 
   protected listeners: {
     [key: string]: QuickBrickPlayer.SharedPlayerCallBacks;
@@ -58,7 +89,17 @@ export class Player {
 
   set entry(newEntry: ZappEntry | null) {
     this._entry = newEntry;
+    // The live entry is scoped to the entry it overlays - see
+    // `OverlaysObserver.clearLiveEntry`. No-op when there is no observer,
+    // which is every non-live player.
+    this.overlaysObserver?.clearLiveEntry();
     this.entryObservable?.next(newEntry);
+    // Optional chaining short-circuits the whole call expression, so
+    // `getContent()` is NOT evaluated while no subscriber exists. That
+    // matters: `PlayerNative` assigns `this.entry` in its constructor, before
+    // subclass arrow-function properties such as `getPluginConfiguration`
+    // have been assigned.
+    this.contentSubject?.next(this.getContent());
   }
 
   constructor(props) {
@@ -117,6 +158,77 @@ export class Player {
     return this.entryObservable;
   };
 
+  /**
+   * The player's resolved Title/Subtitle.
+   *
+   * Resolved on demand rather than cached: the plugin configuration arrives
+   * asynchronously on both the native and cast paths, so a value computed once
+   * at entry-set time would be stale for whichever arrives first.
+   *
+   * Every fallback (no config, empty/whitespace key, unresolvable key, key
+   * resolving to an empty string or to a non-string/non-number) lives in
+   * `resolvePlayerContentText` and is never reimplemented here.
+   */
+  getContent = (): PlayerContent => {
+    // Live audio keeps playing one channel while the programme on air
+    // changes, so the observer's freshly-loaded programme entry wins when
+    // there is one. Read through `?.` so this never constructs an observer:
+    // a VOD or cast player has none and falls straight through to its entry.
+    const entry = this.overlaysObserver?.liveEntry ?? this.entry;
+
+    return {
+      ...resolvePlayerTitleSubtitle({
+        entry,
+        pluginConfiguration: this.getPluginConfiguration(),
+        dataKeys: getPlayerContentDataKeys({
+          isTV: isTV(),
+          isAudioContent: isAudioItem(entry),
+        }),
+      }),
+      // Same selection Android's `EntryHelpers.extractCoverImage` makes:
+      // prefer the `image_base` media item, otherwise the first one available.
+      // Reused rather than reimplemented so the two platforms cannot drift.
+      imageUrl: entry ? imageSrcFromMediaItem(entry, []) : undefined,
+    };
+  };
+
+  /**
+   * Created lazily, like `entryObservable`. An eagerly created subject would
+   * resolve during `PlayerNative`'s constructor and call a not-yet-assigned
+   * `getPluginConfiguration`.
+   *
+   * The seed is produced by calling the resolver, never from raw entry fields:
+   * a `BehaviorSubject` replays its seed synchronously on subscribe, so a raw
+   * seed would overwrite correctly-resolved text at mount.
+   */
+  getContentObservable = (): Observable<PlayerContent> => {
+    if (!this.contentSubject) {
+      this.contentSubject = new BehaviorSubject<PlayerContent>(
+        this.getContent()
+      );
+    }
+
+    return this.contentSubject.asObservable().pipe(
+      // `resolvePlayerTitleSubtitle` returns a fresh object every call, so
+      // reference equality would never dedupe. Compare by value.
+      distinctUntilChanged(
+        (previous, next) =>
+          previous.title === next.title &&
+          previous.summary === next.summary &&
+          previous.imageUrl === next.imageUrl
+      )
+    );
+  };
+
+  /**
+   * Re-resolves and publishes the current content. Called when something the
+   * resolution depends on changed without `entry` itself being reassigned -
+   * today that is the observer swapping in a newly-loaded live programme.
+   */
+  publishContent = () => {
+    this.contentSubject?.next(this.getContent());
+  };
+
   /**
    * ---------------------------------------- PLAYER SETTERS GETTERS ----------------------------------------
    * These methods let you get information about the content / ad playing

package/appUtils/playerManager/usePlayerContent.tsx

@@ -0,0 +1,43 @@
+import * as React from "react";
+import { Player, PlayerContent } from "./player";
+import { usePlayer } from "./usePlayer";
+
+const EMPTY_CONTENT: PlayerContent = {
+  title: null,
+  summary: null,
+  imageUrl: null,
+};
+
+/**
+ * Subscribes to the player's resolved Title/Subtitle, the same way
+ * `usePlayerState` subscribes to playback state. Modeled on that hook
+ * deliberately: one React bridge pattern for everything the manager publishes.
+ *
+ * Passing no `playerId` uses the active player, which is the right default -
+ * only one player instance is live at a time. `usePlayer` additionally swaps
+ * to the casting receiver while casting, so this follows cast handover
+ * automatically.
+ */
+export const usePlayerContent = (playerId?: string): PlayerContent => {
+  const player: Player = usePlayer(playerId);
+
+  const [content, setContent] = React.useState<PlayerContent>(
+    () => player?.getContent() ?? EMPTY_CONTENT
+  );
+
+  React.useEffect(() => {
+    if (!player) {
+      setContent(EMPTY_CONTENT);
+
+      return;
+    }
+
+    const subscription = player
+      .getContentObservable()
+      .subscribe((next) => setContent(next));
+
+    return () => subscription.unsubscribe();
+  }, [player]);
+
+  return content;
+};

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/manifestUtils/defaultManifestConfigurations/player.js

@@ -1352,6 +1352,35 @@ function getPlayerConfiguration({ platform, version }) {
             type: "switch",
             label_tooltip: "Select whether you want to display title in player",
           },
+          {
+            section: "title",
+            key: "title_data_key_source",
+            label: "Title data key",
+            initial_value: "title",
+            type: "select",
+            options: [
+              { text: "Title", value: "title" },
+              { text: "Other", value: "other" },
+            ],
+            label_tooltip:
+              "Select which feed data key provides the player content title. Keep 'Title' to use the entry title",
+          },
+          {
+            section: "title",
+            key: "title_custom_data_key",
+            label: "Custom title data key",
+            initial_value: "",
+            type: "text_input",
+            rules: "conditional",
+            conditional_fields: [
+              {
+                key: "styles/title_data_key_source",
+                condition_value: "other",
+              },
+            ],
+            label_tooltip:
+              "Data key on the feed entry, dot notation supported, for example extensions.episode_name. Falls back to the entry title if the key is empty or missing",
+          },
           {
             section: "title",
             key: "title_font_android",
@@ -1759,6 +1788,35 @@ function getPlayerConfiguration({ platform, version }) {
             label_tooltip:
               "Select whether you want to display subtitle in player",
           },
+          {
+            section: "subtitle",
+            key: "subtitle_data_key_source",
+            label: "Subtitle data key",
+            initial_value: "summary",
+            type: "select",
+            options: [
+              { text: "Subtitle", value: "summary" },
+              { text: "Other", value: "other" },
+            ],
+            label_tooltip:
+              "Select which feed data key provides the player content subtitle. Keep 'Subtitle' to use the entry summary",
+          },
+          {
+            section: "subtitle",
+            key: "subtitle_custom_data_key",
+            label: "Custom subtitle data key",
+            initial_value: "",
+            type: "text_input",
+            rules: "conditional",
+            conditional_fields: [
+              {
+                key: "styles/subtitle_data_key_source",
+                condition_value: "other",
+              },
+            ],
+            label_tooltip:
+              "Data key on the feed entry, dot notation supported, for example extensions.episode_subtitle. Falls back to the entry summary if the key is empty or missing",
+          },
           {
             section: "subtitle",
             key: "subtitle_font_android",
@@ -2923,6 +2981,33 @@ function getPlayerConfiguration({ platform, version }) {
         "Video Player - Title Text",
         "Video Player Title Text Label Styles",
         [
+          {
+            key: "video_player_title_data_key_source",
+            label: "Video title data key",
+            initial_value: "title",
+            type: "select",
+            options: [
+              { text: "Title", value: "title" },
+              { text: "Other", value: "other" },
+            ],
+            label_tooltip:
+              "Select which feed data key provides the video player title. Keep 'Title' to use the entry title",
+          },
+          {
+            key: "video_player_title_custom_data_key",
+            label: "Custom video title data key",
+            initial_value: "",
+            type: "text_input",
+            rules: "conditional",
+            conditional_fields: [
+              {
+                key: "styles/video_player_title_data_key_source",
+                condition_value: "other",
+              },
+            ],
+            label_tooltip:
+              "Data key on the feed entry, dot notation supported, for example extensions.episode_name. Falls back to the entry title if the key is empty or missing",
+          },
           {
             key: "player_title_color",
             label: "Font color",
@@ -3008,6 +3093,33 @@ function getPlayerConfiguration({ platform, version }) {
         "Video Player - Summary Text",
         "Video Player Summary Text Label Styles",
         [
+          {
+            key: "video_player_summary_data_key_source",
+            label: "Video summary data key",
+            initial_value: "summary",
+            type: "select",
+            options: [
+              { text: "Summary", value: "summary" },
+              { text: "Other", value: "other" },
+            ],
+            label_tooltip:
+              "Select which feed data key provides the video player summary. Keep 'Summary' to use the entry summary",
+          },
+          {
+            key: "video_player_summary_custom_data_key",
+            label: "Custom video summary data key",
+            initial_value: "",
+            type: "text_input",
+            rules: "conditional",
+            conditional_fields: [
+              {
+                key: "styles/video_player_summary_data_key_source",
+                condition_value: "other",
+              },
+            ],
+            label_tooltip:
+              "Data key on the feed entry, dot notation supported, for example extensions.episode_subtitle. Falls back to the entry summary if the key is empty or missing",
+          },
           {
             key: "player_summary_color",
             label: "Font color",
@@ -3093,6 +3205,33 @@ function getPlayerConfiguration({ platform, version }) {
         "Audio Player - Title Text",
         "Audio Player Title Text Label Styles",
         [
+          {
+            key: "audio_player_title_data_key_source",
+            label: "Audio title data key",
+            initial_value: "title",
+            type: "select",
+            options: [
+              { text: "Title", value: "title" },
+              { text: "Other", value: "other" },
+            ],
+            label_tooltip:
+              "Select which feed data key provides the audio player title. Keep 'Title' to use the entry title",
+          },
+          {
+            key: "audio_player_title_custom_data_key",
+            label: "Custom audio title data key",
+            initial_value: "",
+            type: "text_input",
+            rules: "conditional",
+            conditional_fields: [
+              {
+                key: "styles/audio_player_title_data_key_source",
+                condition_value: "other",
+              },
+            ],
+            label_tooltip:
+              "Data key on the feed entry, dot notation supported, for example extensions.episode_name. Falls back to the entry title if the key is empty or missing",
+          },
           {
             key: "audio_player_title_color",
             label: "Audio player title color",
@@ -3178,6 +3317,33 @@ function getPlayerConfiguration({ platform, version }) {
         "Audio Player - Summary Text",
         "Audio Player Summary Text Label Styles",
         [
+          {
+            key: "audio_player_summary_data_key_source",
+            label: "Audio summary data key",
+            initial_value: "summary",
+            type: "select",
+            options: [
+              { text: "Summary", value: "summary" },
+              { text: "Other", value: "other" },
+            ],
+            label_tooltip:
+              "Select which feed data key provides the audio player summary. Keep 'Summary' to use the entry summary",
+          },
+          {
+            key: "audio_player_summary_custom_data_key",
+            label: "Custom audio summary data key",
+            initial_value: "",
+            type: "text_input",
+            rules: "conditional",
+            conditional_fields: [
+              {
+                key: "styles/audio_player_summary_data_key_source",
+                condition_value: "other",
+              },
+            ],
+            label_tooltip:
+              "Data key on the feed entry, dot notation supported, for example extensions.episode_subtitle. Falls back to the entry summary if the key is empty or missing",
+          },
           {
             key: "audio_player_summary_color",
             label: "Audio player summary color",

package/package.json

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