@applicaster/zapp-react-native-utils 16.0.0-alpha.4416921324 → 16.0.0-alpha.4635728545

package/actionsExecutor/actions/refreshComponent.ts

@@ -57,6 +57,12 @@ export const refreshComponentAction: ActionHandler = async (
       }) || source;
   }
 
+  if (!dataSource) {
+    log_info("handleAction: refreshComponent skipped: no dataSource found");
+
+    return ActionResult.Success;
+  }
+
   log_info(`handleAction: refreshComponent for dataSource:${dataSource}`, {
     source,
     inflatedUrl: dataSource,

package/actionsExecutor/actions/sendCloudEvent.ts

@@ -62,10 +62,15 @@ export const sendCloudEventAction: ActionHandler<
       subject: options.subject || String((entry as ZappEntry)?.id || ""),
     });
 
-    log_info("handleAction: sendCloudEvent event", { cloudEvent });
+    log_info("handleAction: sending sendCloudEvent to URL", {
+      url: options.url,
+      cloudEvent,
+    });
 
     const { error, code } = await sendCloudEvent(cloudEvent, options.url);
 
+    log_info("handleAction: sendCloudEvent result", { code, error });
+
     if (error) {
       log_error("sendCloudEvent: error sending cloud event", { error });
 

package/actionsExecutor/actions/showAlert.ts

@@ -0,0 +1,51 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { showAlertDialog } from "../../alertUtils";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the showAlert action.
+ */
+export interface ShowAlertOptions {
+  /** Dialog title (required) */
+  title: string;
+
+  /** Dialog message */
+  message?: string;
+
+  /** Dismiss button text. Defaults to "OK" */
+  okButtonText?: string;
+}
+
+/**
+ * Tells the user something and waits for them to acknowledge it.
+ *
+ * One button, because there is nothing to decide. Use `confirmDialog` when the
+ * user is choosing between going on and backing out; a `confirmDialog` without
+ * a cancel label still renders two buttons, the second one blank.
+ *
+ * Always resolves to Success: dismissing a notice is not a cancellation, so the
+ * rest of the chain runs.
+ */
+export const showAlertAction: ActionHandler<ShowAlertOptions> = async (
+  action
+): Promise<ActionResult> => {
+  log_info("handleAction: showAlert event");
+
+  const options = action.options as ShowAlertOptions;
+
+  return new Promise<ActionResult>((resolve) => {
+    showAlertDialog({
+      title: options?.title,
+      message: options?.message,
+      okButtonText: options?.okButtonText || "OK",
+      completion: () => resolve(ActionResult.Success),
+    });
+  });
+};

package/actionsExecutor/actions/showToast.ts

@@ -3,12 +3,65 @@ import { ActionResult } from "../ActionExecutor";
 import { ActionHandler } from "../types";
 import { postEvent } from "../../reactHooks/useSubscriberFor";
 
+export const CONFIRMATION_TOAST_SOURCE = "confirmation";
+
+export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 5000;
+
 /**
- * Options for showToast action.
+ * Shows a mobile confirmation toast with Theme defaults from
+ * `Confirmation Toast / Message` in the base theme plugin.
+ *
+ * This action is confirmation-only by design: it always stamps
+ * `source: "confirmation"` (so Theme confirmation styles apply) and defaults
+ * `timeout` to 5000 ms. Non-confirmation toasts (e.g. Offline Experience)
+ * must post on the shared `"showToast"` event bus directly and omit `source`.
+ * Callers may override individual style fields; Theme supplies the rest.
+ *
+ * @example From React via ActionExecutorContext
+ * ```tsx
+ * import React, { useContext } from "react";
+ * import { ActionExecutorContext } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutorContext";
+ *
+ * function QueueButton() {
+ *   const { handleAction } = useContext(ActionExecutorContext);
+ *
+ *   const onPress = () => {
+ *     void handleAction({
+ *       type: "showToast",
+ *       options: { message: "Added to queue" },
+ *     });
+ *   };
+ *
+ *   return <Button onPress={onPress} title="Add to queue" />;
+ * }
+ * ```
+ *
+ * @example From code via the actionExecutor singleton
+ * ```ts
+ * import { actionExecutor } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutor";
+ *
+ * await actionExecutor.handleAction({
+ *   type: "showToast",
+ *   options: {
+ *     message: "Playlist created",
+ *     style: { backgroundColor: "#00AA55" }, // optional partial override
+ *   },
+ * });
+ * ```
+ *
+ * @example From entry / pipes actions JSON
+ * ```json
+ * {
+ *   "type": "showToast",
+ *   "options": {
+ *     "message": "Item removed from playlist"
+ *   }
+ * }
+ * ```
  */
 export interface ShowToastActionOptions {
-  id: string;
-  message: string;
+  id?: string;
+  message?: string;
   extraMessage?: string;
   style?: any;
   timeout?: number;
@@ -17,13 +70,16 @@ export interface ShowToastActionOptions {
 export const showToastAction: ActionHandler<ShowToastActionOptions> = async (
   action
 ): Promise<ActionResult> => {
+  const options = action?.options;
+
   postEvent("showToast", [
     {
-      id: action.options.id,
-      message: action.options.message,
-      extraMessage: action.options.extraMessage,
-      style: action.options.style,
-      timeout: action.options.timeout,
+      id: options?.id,
+      message: options?.message,
+      extraMessage: options?.extraMessage,
+      style: options?.style,
+      timeout: options?.timeout ?? CONFIRMATION_TOAST_DEFAULT_TIMEOUT,
+      source: CONFIRMATION_TOAST_SOURCE,
     },
   ]);
 

package/actionsExecutor/consts.ts

@@ -2,3 +2,30 @@ export const TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT =
   "action.localStorageToggleFlag.maxItemsReached";
 
 export const ACTION_EXECUTOR_EVENT_SOURCE = "ActionExecutor";
+
+export const ACTION_TYPES = {
+  OPEN_BOTTOM_SHEET: "openBottomSheet",
+  DISMISS_BOTTOM_SHEET: "dismissBottomSheet",
+  PRESENT_SUB_MENU: "presentSubMenu",
+  SEND_CLOUD_EVENT: "sendCloudEvent",
+  NAVIGATE_TO_SCREEN: "navigateToScreen",
+  PRESENT_SCREEN: "presentScreen",
+  GO_BACK: "goBack",
+  GO_HOME: "goHome",
+  SHOW_TOAST: "showToast",
+  LOCAL_STORAGE_SET: "localStorageSet",
+  LOCAL_STORAGE_REMOVE: "localStorageRemove",
+  LOCAL_STORAGE_TOGGLE_FLAG: "localStorageToggleFlag",
+  SESSION_STORAGE_SET: "sessionStorageSet",
+  SESSION_STORAGE_REMOVE: "sessionStorageRemove",
+  SESSION_STORAGE_TOGGLE_FLAG: "sessionStorageToggleFlag",
+  REFRESH_COMPONENT: "refreshComponent",
+  SWITCH_LAYOUT: "switchLayout",
+  APP_RESTART: "appRestart",
+  CONFIRM_DIALOG: "confirmDialog",
+  SHOW_ALERT: "showAlert",
+  SCREEN_SET_VARIABLE: "screenSetVariable",
+  SCREEN_TOGGLE_FLAG: "screenToggleFlag",
+} as const;
+
+export type KnownActionType = (typeof ACTION_TYPES)[keyof typeof ACTION_TYPES];

package/actionsExecutor/feedDecorator.ts

@@ -159,13 +159,13 @@ export const decorateFeed = (feed: ZappFeed) => {
 
   const decoratedFeed = R.clone(feed);
 
-  const isSingleSelect =
-    (feed.extensions?.preference_editor_options?.select_mode ||
-      feed.extensions?.behavior?.select_mode) === "single";
+  const selectMode =
+    feed.extensions?.preference_editor_options?.select_mode ||
+    feed.extensions?.behavior?.select_mode;
 
-  if (isSingleSelect) {
+  if (selectMode === "single") {
     return makeSingleSelect(feed, key, decoratedFeed);
-  } else {
-    return makeMultiSelect(feed, key, decoratedFeed);
   }
+
+  return makeMultiSelect(feed, key, decoratedFeed);
 };

package/analyticsUtils/PlayerAnalyticsManager.ts

@@ -8,7 +8,7 @@ import {
 } from "../appUtils/playerManager";
 import { Player } from "../appUtils/playerManager/player";
 import { AnalyticPlayerListener } from "./AnalyticPlayerListener";
-import { PlayerRole } from "../appUtils/playerManager/conts";
+import { PlayerRole } from "../appUtils/playerManager/const";
 
 enum PlayerAnalyticsTrackerType {
   PlayerAnalyticsTracker = "PlayerAnalyticsTracker",

package/appUtils/HooksManager/index.ts

@@ -498,6 +498,15 @@ export function HooksManager({
         presentUI
       );
     } catch (e) {
+      // Without this the failure is invisible: the hook stops right after the
+      // "Executing hook" line, with nothing in the log explaining why and no
+      // remaining hook ever running.
+      logHookEvent(
+        hooksManagerLogger.error,
+        `runInBackground: hook ${hookPlugin.identifier} threw: ${e?.message}`,
+        { hook: hookPlugin, payload, error: e, stack: e?.stack }
+      );
+
       hookPlugin.setStateAndNotify(HOOKS_EVENTS.ERROR, {
         error: e,
         hookPlugin,

package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts

@@ -2,9 +2,8 @@ import { BehaviorSubject, Observable } from "rxjs";
 import { distinctUntilChanged } from "rxjs/operators";
 import { Player } from "../player";
 import { createLogger, utilsLogger } from "../../../logger";
-import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
+import { getPluginByIdentifier } from "@applicaster/zapp-react-native-utils/pluginUtils";
 import {
-  findPluginByIdentifier,
   loadFeedEntry,
   loadFeedAndPrefetchThumbnailImage,
   parseTimeToSeconds,
@@ -19,6 +18,12 @@ export const { log_verbose, log_debug, log_info, log_error } = createLogger({
   parent: utilsLogger,
 });
 
+/**
+ * Mirrors `initial_value` for `audio_live_player_update_interval` in
+ * `defaultManifestConfigurations/player.js`.
+ */
+const DEFAULT_LIVE_CONTENT_UPDATE_INTERVAL_SECONDS = 60;
+
 type ChapterMarkerOriginal = {
   id: string;
   title: string;
@@ -40,11 +45,6 @@ export type LiveMetadataConfig = {
   updateInterval: number;
 };
 
-export type TitleSummaryEvent = {
-  title: string | number;
-  summary: string | number;
-};
-
 type ChapterMarkersObserverProps = {
   player: Player;
 };
@@ -59,24 +59,23 @@ type PlayNextConfig = {
 export type PlayNextState = PlayNextConfig & {
   triggerTime: number;
   handleUserCancelPlayNext: () => void;
+  hidePlayNext: () => void;
 };
 
 export class OverlaysObserver {
   readonly chapterSubject: BehaviorSubject<ChapterMarkerEvent>;
   private playNextSubject: BehaviorSubject<PlayNextState>;
   private liveMetadataSubject: BehaviorSubject<LiveMetadataEvent>;
-  private titleSummarySubject: BehaviorSubject<TitleSummaryEvent>;
-  private feedUrl: string;
-  private reloadData: () => void;
-  private updateTitleAndDescription: (data: any) => void;
-  private feedDataInterval: any;
+  private liveContentInterval: any;
+  private liveContentGeneration = 0;
+  private _liveEntry: ZappEntry | null = null;
   private liveMetadataUpdateInterval: any;
   private releasePlayerObserver?: () => void;
   readonly entry: ZappEntry;
   private chapterMarkerEvents: ChapterMarkerEvent[];
   readonly player: Player;
   private playNextConfig?: PlayNextConfig;
-  private isCanceledByUser = false;
+  private isPlayNextSuppressed = false;
 
   constructor({ player }: ChapterMarkersObserverProps) {
     this.chapterSubject = new BehaviorSubject(null);
@@ -85,41 +84,140 @@ export class OverlaysObserver {
     this.player = player;
     this.entry = player.getEntry();
 
-    this.titleSummarySubject = new BehaviorSubject<TitleSummaryEvent>({
-      title: this.entry?.title || "",
-      summary: this.entry?.summary || "",
-    });
-
     this.liveMetadataSubject = new BehaviorSubject<LiveMetadataEvent>(
       this.entry?.extensions?.liveMetadata || null
     );
 
     this.chapterMarkerEvents = this.prepareChapterMarkers();
     this.releasePlayerObserver = this.subscribeToPlayerEvents();
-    this.feedUrl = "";
-    this.reloadData = () => {};
-    this.updateTitleAndDescription = () => {};
-    this.feedDataInterval = null;
+    this.liveContentInterval = null;
     this.liveMetadataUpdateInterval = null;
     void this.preparePlayNext();
     void this.prepareLiveMetadata();
   }
 
-  private setupFeedDataInterval(interval: number) {
-    if (this.feedUrl && this.reloadData && this.updateTitleAndDescription) {
-      this.feedDataInterval = setInterval(() => {
-        this.reloadData();
-      }, interval * 1000);
+  /**
+   * Polls the live feed and pushes each loaded entry into the player, which
+   * re-resolves its Title/Subtitle and publishes on its content channel.
+   *
+   * Runs entirely outside React: `loadFeedEntry` builds its request through
+   * `RequestBuilder.setUrl`, which inflates URL macros with the entry and
+   * screen contexts, so no `useInflatedUrl` is needed. `prepareLiveMetadata`
+   * below already polls this way.
+   */
+  public startLiveContentUpdates() {
+    this.stopLiveContentUpdates();
+
+    if (!this.player?.isLive?.()) {
+      log_debug("startLiveContentUpdates: Player is not live. Skipping...");
+
+      return;
     }
+
+    const feedUrl = this.getLiveContentFeedUrl();
+
+    if (!feedUrl) {
+      log_debug(
+        "startLiveContentUpdates: Entry carries no live channel feed. Skipping..."
+      );
+
+      return;
+    }
+
+    const intervalSeconds = this.getLiveContentUpdateInterval();
+
+    // Clearing the interval cannot cancel a request already in flight, so each
+    // run carries the generation it started in. A response that arrives after
+    // a stop or a restart belongs to a channel that is no longer playing and
+    // is dropped, rather than publishing the previous programme's title over
+    // the current one.
+    const generation = ++this.liveContentGeneration;
+
+    const load = async () => {
+      try {
+        const entry = await loadFeedEntry(feedUrl, this.entry);
+
+        if (generation !== this.liveContentGeneration) {
+          return;
+        }
+
+        this._liveEntry = entry;
+        this.player.publishContent();
+      } catch {
+        // `loadFeedEntry` already logs the failure. Keep whatever content is
+        // currently published rather than blanking the title on a transient
+        // network error.
+      }
+    };
+
+    void load();
+
+    this.liveContentInterval = setInterval(load, intervalSeconds * 1000);
   }
 
-  public clearFeedDataInterval() {
-    if (this.feedDataInterval) {
-      clearInterval(this.feedDataInterval);
-      this.feedDataInterval = null;
+  public stopLiveContentUpdates() {
+    // Invalidates any in-flight request as well as the interval.
+    this.liveContentGeneration += 1;
+
+    if (this.liveContentInterval) {
+      clearInterval(this.liveContentInterval);
+      this.liveContentInterval = null;
     }
   }
 
+  /**
+   * The programme feed for the channel currently playing. Derived here rather
+   * than by the caller so no UI component needs to know where a live channel
+   * keeps its feed, or that the URL has to be rewritten to reach the
+   * programme ("livePage") view of it.
+   */
+  private getLiveContentFeedUrl(): string {
+    const channelSrc =
+      this.player.getEntry()?.extensions?.live?.channel_src ?? "";
+
+    return channelSrc.replace(new RegExp("subClass", "g"), "livePage");
+  }
+
+  /**
+   * Falls back to the manifest's own `initial_value` when the app ships no
+   * value: `intervalSeconds * 1000` would otherwise be `NaN`, and
+   * `setInterval` treats `NaN` as `0` - a tight loop hammering the feed.
+   */
+  private getLiveContentUpdateInterval(): number {
+    const configured =
+      this.player.getPluginConfiguration()?.audio_live_player_update_interval;
+
+    const seconds = Number(configured);
+
+    return Number.isFinite(seconds) && seconds > 0
+      ? seconds
+      : DEFAULT_LIVE_CONTENT_UPDATE_INTERVAL_SECONDS;
+  }
+
+  /**
+   * The entry most recently loaded from the live channel feed - the programme
+   * currently on air, as opposed to `player.entry`, which is the channel and
+   * stays put for the whole listening session.
+   *
+   * Read by `Player.getContent()`, which prefers it over the player's own
+   * entry. It lives here rather than on `Player` because it is live-feed
+   * state, like `liveMetadata` and play-next: a VOD or cast player never has
+   * an observer at all, so it never carries this either.
+   */
+  public get liveEntry(): ZappEntry | null {
+    return this._liveEntry;
+  }
+
+  /**
+   * Called by `Player`'s `entry` setter. The live entry is an overlay on the
+   * current entry, so its lifetime is scoped to that entry: without this, a
+   * programme from a previous channel would shadow the new one forever - the
+   * content would change but the title would not.
+   */
+  public clearLiveEntry() {
+    this._liveEntry = null;
+  }
+
   public clearLiveMetadataUpdateInterval() {
     if (this.liveMetadataUpdateInterval) {
       clearInterval(this.liveMetadataUpdateInterval);
@@ -127,34 +225,19 @@ export class OverlaysObserver {
     }
   }
 
-  public setFeedDataHandlers(
-    feedUrl: string,
-    reloadData: () => void,
-    interval: number,
-    updateTitleAndDescription: (data: any) => void
-  ) {
-    this.feedUrl = feedUrl;
-    this.reloadData = reloadData;
-    this.updateTitleAndDescription = updateTitleAndDescription;
-    this.setupFeedDataInterval(interval);
-  }
-
-  public getTitleSummaryObservable(): Observable<TitleSummaryEvent> {
-    return this.titleSummarySubject.asObservable().pipe(distinctUntilChanged());
-  }
+  hidePlayNext = () => {
+    this.isPlayNextSuppressed = true;
+    this.playNextSubject.next(null);
+  };
 
   handleUserCancelPlayNext = () => {
-    this.isCanceledByUser = true;
-    this.playNextSubject.next(null);
+    this.hidePlayNext();
   };
 
   preparePlayNext = async () => {
     try {
-      const plugins = appStore.get("plugins");
-
-      const playNextPlugin: any = findPluginByIdentifier(
-        "QuickBrickPlayNextOverlay",
-        plugins
+      const playNextPlugin: any = getPluginByIdentifier(
+        "QuickBrickPlayNextOverlay"
       );
 
       if (!playNextPlugin) {
@@ -165,7 +248,7 @@ export class OverlaysObserver {
         return;
       }
 
-      const playNextFeedUrl: string = retrieveFeedUrl(this.entry);
+      const playNextFeedUrl: string = await retrieveFeedUrl(this.entry);
 
       if (!playNextFeedUrl || typeof playNextFeedUrl !== "string") {
         log_debug(
@@ -270,7 +353,7 @@ export class OverlaysObserver {
 
   // TODO: Hack for video end, will be replaced with playlist prev/next in the future
   getPlayNextEntry = () =>
-    !this.isCanceledByUser ? this.playNextConfig?.entry : null;
+    !this.isPlayNextSuppressed ? this.playNextConfig?.entry : null;
 
   prepareChapterMarkers = () => {
     const chapterMarkers: ChapterMarkerOriginal[] =
@@ -353,7 +436,7 @@ export class OverlaysObserver {
     const shouldPlayNextBeVisible = currentTime > triggerTime;
 
     if (shouldPlayNextBeVisible) {
-      if (this.isCanceledByUser) {
+      if (this.isPlayNextSuppressed) {
         return;
       }
 
@@ -361,10 +444,11 @@ export class OverlaysObserver {
         ...this.playNextConfig,
         triggerTime,
         handleUserCancelPlayNext: this.handleUserCancelPlayNext,
+        hidePlayNext: this.hidePlayNext,
       });
     } else {
       this.playNextSubject.next(null);
-      this.isCanceledByUser = false;
+      this.isPlayNextSuppressed = false;
     }
   };
 
@@ -389,9 +473,8 @@ export class OverlaysObserver {
     this.chapterSubject.complete();
     this.playNextSubject.complete();
     this.liveMetadataSubject.complete();
-    this.titleSummarySubject.complete();
     this.releasePlayerObserver?.();
-    this.clearFeedDataInterval();
+    this.stopLiveContentUpdates();
     this.clearLiveMetadataUpdateInterval();
     this.releasePlayerObserver = null;
   };

package/appUtils/playerManager/OverlayObserver/__tests__/getUpcomingQueue.test.ts

@@ -0,0 +1,67 @@
+import { getUpcomingQueue } from "../getUpcomingQueue";
+
+describe("getUpcomingQueue", () => {
+  it("returns null when plugin is not provided or has no module", async () => {
+    expect(await getUpcomingQueue(undefined)).toBeNull();
+    expect(await getUpcomingQueue({} as any)).toBeNull();
+  });
+
+  it("returns null when QueueManager is not present on module", async () => {
+    const plugin = {
+      identifier: "queue-action",
+      module: {},
+    } as any;
+
+    expect(await getUpcomingQueue(plugin)).toBeNull();
+  });
+
+  it("calls setupQuickBrickQueue when QueueManager is not initialized", async () => {
+    const setupQuickBrickQueue = jest.fn();
+    const mockUpcoming = [{ id: "item_1" }];
+
+    const QueueManager = {
+      isInitialized: jest
+        .fn()
+        .mockReturnValueOnce(false)
+        .mockReturnValueOnce(true),
+      instance: {
+        getUpcomingQueue: jest.fn().mockResolvedValue(mockUpcoming),
+      },
+    };
+
+    const plugin = {
+      identifier: "queue-action",
+      module: {
+        QueueManager,
+        setupQuickBrickQueue,
+      },
+    } as any;
+
+    const result = await getUpcomingQueue(plugin);
+
+    expect(setupQuickBrickQueue).toHaveBeenCalled();
+    expect(result).toEqual(mockUpcoming);
+  });
+
+  it("returns upcoming items when QueueManager is already initialized", async () => {
+    const mockUpcoming = [{ id: "item_1" }, { id: "item_2" }];
+
+    const QueueManager = {
+      isInitialized: jest.fn().mockReturnValue(true),
+      instance: {
+        getUpcomingQueue: jest.fn().mockResolvedValue(mockUpcoming),
+      },
+    };
+
+    const plugin = {
+      identifier: "queue-action",
+      module: {
+        QueueManager,
+      },
+    } as any;
+
+    const result = await getUpcomingQueue(plugin);
+
+    expect(result).toEqual(mockUpcoming);
+  });
+});