@applicaster/zapp-react-native-utils 16.0.0-alpha.5402127570 → 16.0.0-alpha.5548956531

package/actionsExecutor/actions/switchLayout.ts

@@ -0,0 +1,40 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
+import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
+import { ACTIVE_LAYOUT_ID_STORAGE_KEY } from "@applicaster/quick-brick-core/App/remoteContextReloader/consts";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the switchLayout action.
+ */
+export interface SwitchLayoutOptions {
+  /** The ID of the layout to switch to */
+  layoutId: string;
+}
+
+/**
+ * Switches the active layout and triggers an app reload.
+ * Saves the new layout ID to local storage before reloading.
+ */
+export const switchLayoutAction: ActionHandler<SwitchLayoutOptions> = async (
+  action
+): Promise<ActionResult> => {
+  log_info("handleAction: switchLayout event");
+
+  await localStorage.setItem(
+    ACTIVE_LAYOUT_ID_STORAGE_KEY,
+    action.options.layoutId
+  );
+
+  QuickBrickManager.sendQuickBrickEvent(QUICK_BRICK_EVENTS.FORCE_APP_RELOAD);
+
+  return ActionResult.Success;
+};

package/actionsExecutor/types.ts

@@ -0,0 +1,59 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { ActionResult } from "./ActionExecutor";
+import { useScreenStateStore } from "../reactHooks/navigation/useScreenStateStore";
+
+/**
+ * Base context object passed to action handlers during execution.
+ * Contains references to the current entry, screen, and other execution state.
+ */
+export interface ActionExecutionContext {
+  /** The entry associated with this action (e.g., the item that was tapped) */
+  entry?: ZappEntry;
+
+  /** The current screen/river data */
+  screenData?: ZappRiver;
+
+  /** The entry that defines the screen (if screen was opened from an entry) */
+  screenEntry?: ZappEntry;
+
+  /** The UI component that triggered the action.
+   * From UIComponentContext as `{ ...component, parent }`.
+   */
+  component?: ZappUIComponent & { parent?: ZappUIComponent };
+
+  /** The route identifier for the current screen */
+  screenRoute?: string;
+
+  /** The screen state store for managing screen-level state (Zustand store) */
+  screenStateStore?: ReturnType<typeof useScreenStateStore>;
+
+  /** Context entry for additional data */
+  entryContext?: ZappEntry;
+
+  /** Callback function for action completion */
+  callback?: (result: { success: boolean; error: any; abort: boolean }) => void;
+
+  screenState?: Record<any, any>;
+}
+
+/**
+ * Type for action handler functions.
+ * Handlers receive the action (which may have typed options) and execution context.
+ *
+ * @template _TOptions - Optional type hint for the action's options object (for documentation/intellisense)
+ * @param action - The action to execute
+ * @param context - The execution context
+ * @returns A promise that resolves to the action result
+ */
+export type ActionHandler<_TOptions = any> = (
+  action: ActionType,
+  context?: ActionExecutionContext
+) => Promise<ActionResult>;
+
+/**
+ * Factory function that creates an action handler.
+ * Used for actions that need to capture dependencies at registration time.
+ */
+export type ActionHandlerFactory<_TOptions = any> = (
+  ...dependencies: any[]
+) => ActionHandler<_TOptions>;

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/contextKeysManager/__tests__/getKey/failure.test.ts

@@ -46,7 +46,7 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key: invalidKey },
     });
 

package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts

@@ -47,7 +47,7 @@ describe("Context Keys Manager - removeKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 

package/appUtils/contextKeysManager/__tests__/setKey/failure/invalidKey.test.ts

@@ -48,7 +48,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 
@@ -105,7 +105,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 
@@ -162,7 +162,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 
@@ -217,7 +217,7 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedLogger.warn).toHaveBeenCalledWith({
       message:
-        "Provided key is not valid - expecing an object with namespace and key properties",
+        "Provided key is not valid - expecting an object with namespace and key properties",
       data: { key },
     });
 

package/appUtils/contextKeysManager/index.ts

@@ -109,7 +109,7 @@ export class ContextKeysManager {
     if (!keyIsValid(parsedKey)) {
       this._logger.warn({
         message:
-          "Provided key is not valid - expecing an object with namespace and key properties",
+          "Provided key is not valid - expecting an object with namespace and key properties",
         data: { key },
       });
 

package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts

@@ -59,6 +59,7 @@ type PlayNextConfig = {
 export type PlayNextState = PlayNextConfig & {
   triggerTime: number;
   handleUserCancelPlayNext: () => void;
+  hidePlayNext: () => void;
 };
 
 export class OverlaysObserver {
@@ -76,7 +77,7 @@ export class OverlaysObserver {
   private chapterMarkerEvents: ChapterMarkerEvent[];
   readonly player: Player;
   private playNextConfig?: PlayNextConfig;
-  private isCanceledByUser = false;
+  private isPlayNextSuppressed = false;
 
   constructor({ player }: ChapterMarkersObserverProps) {
     this.chapterSubject = new BehaviorSubject(null);
@@ -143,11 +144,15 @@ export class OverlaysObserver {
     return this.titleSummarySubject.asObservable().pipe(distinctUntilChanged());
   }
 
-  handleUserCancelPlayNext = () => {
-    this.isCanceledByUser = true;
+  hidePlayNext = () => {
+    this.isPlayNextSuppressed = true;
     this.playNextSubject.next(null);
   };
 
+  handleUserCancelPlayNext = () => {
+    this.hidePlayNext();
+  };
+
   preparePlayNext = async () => {
     try {
       const plugins = appStore.get("plugins");
@@ -270,7 +275,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 +358,7 @@ export class OverlaysObserver {
     const shouldPlayNextBeVisible = currentTime > triggerTime;
 
     if (shouldPlayNextBeVisible) {
-      if (this.isCanceledByUser) {
+      if (this.isPlayNextSuppressed) {
         return;
       }
 
@@ -361,10 +366,11 @@ export class OverlaysObserver {
         ...this.playNextConfig,
         triggerTime,
         handleUserCancelPlayNext: this.handleUserCancelPlayNext,
+        hidePlayNext: this.hidePlayNext,
       });
     } else {
       this.playNextSubject.next(null);
-      this.isCanceledByUser = false;
+      this.isPlayNextSuppressed = false;
     }
   };
 

package/appUtils/playerManager/__tests__/playerFactory.test.ts

@@ -10,7 +10,7 @@ jest.mock("@applicaster/zapp-react-native-utils/pluginUtils", () => ({
     mockFindPluginByIdentifier(id, plugins),
 }));
 
-import { PlayerRole } from "../conts";
+import { PlayerRole } from "../const";
 import { playerFactory } from "../playerFactory";
 
 const fakeComponent = () => null;

package/appUtils/playerManager/{conts.ts → const.ts}

@@ -67,3 +67,23 @@ export enum PlayerRole {
   Chromecast = "Chromecast",
   Unspecified = "Unspecified",
 }
+
+/**
+ * The playback engine backing a web player. Published on
+ * `window.applicaster.playerType` when a player is created, so that plugins
+ * observing the player can tell which engine they are looking at instead of
+ * inferring it from the API the instance happens to expose.
+ *
+ * Keep in sync with `ApplicasterGlobals["playerType"]` in applicaster-types.
+ */
+export enum WebPlayerEngine {
+  Videojs = "videojs",
+  Hlsjs = "hlsjs",
+  Dashjs = "dashjs",
+}
+
+export enum PLAYER_EVENTS {
+  PlayNextTriggered = "play_next_triggered",
+}
+
+export type PlayNextTriggeredEvent = { id: string };

package/appUtils/playerManager/index.ts

@@ -9,7 +9,7 @@ import {
   unsubscribeToDeviceNetworkChanges,
 } from "@applicaster/quick-brick-core/App/NetworkStatusProvider/utils";
 import { setUserLanguagePreference } from "./userLanguagePreference";
-import { PlayerRole } from "./conts";
+import { PlayerRole } from "./const";
 import { RNPlayerManager } from "./nativePlayerManager";
 
 const { log_error, log_debug, log_warning } = createLogger({

package/appUtils/playerManager/player.ts

@@ -3,7 +3,7 @@ import { BehaviorSubject } from "rxjs";
 import { isEmptyOrNil } from "@applicaster/zapp-react-native-utils/cellUtils";
 import { createLogger, utilsLogger } from "../../logger";
 import { getBoolFromConfigValue } from "../../configurationUtils";
-import { PlayerRole, SharedPlayerCallBacksKeys } from "./conts";
+import { PlayerRole, SharedPlayerCallBacksKeys } from "./const";
 import { OverlaysObserver } from "./OverlayObserver/OverlaysObserver";
 import { TVSeekController } from "../../reactHooks/player/TVSeekControlller/TVSeekController";
 

package/appUtils/playerManager/playerFactory.ts

@@ -1,7 +1,7 @@
 import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
 import { findPluginByIdentifier } from "@applicaster/zapp-react-native-utils/pluginUtils";
 import { Player } from "./player";
-import { PlayerRole } from "./conts";
+import { PlayerRole } from "./const";
 
 type PlayerFactoryItem = {
   Component: any;

package/appUtils/playerManager/playerNative.ts

@@ -3,7 +3,7 @@ import { isEmptyOrNil } from "@applicaster/zapp-react-native-utils/cellUtils";
 import { createLogger, utilsLogger } from "../../logger";
 import { Player } from "./player";
 import { findNodeHandle } from "react-native";
-import { PlayerRole } from "./conts";
+import { PlayerRole } from "./const";
 import { toBooleanWithDefaultFalse } from "../../booleanUtils";
 import { RNPlayerManager } from "./nativePlayerManager";
 

package/appUtils/playerManager/usePlayerControllerSetup.tsx

@@ -3,7 +3,7 @@ import { useConfiguration } from "../../reactHooks/useConfiguration";
 import { useEffect } from "react";
 import { playerManager } from "./index";
 import { useValidatePlayerConfig } from "../../playerUtils/useValidatePlayerConfig";
-import { PlayerRole } from "./conts";
+import { PlayerRole } from "./const";
 import { isAppleTV } from "@applicaster/zapp-react-native-ui-components/Helpers/Platform";
 import { TVSeekController } from "../../reactHooks/player/TVSeekControlller/TVSeekController";
 import { KeyInputHandler } from "../keyInputHandler/KeyInputHandler";

package/appUtils/playerManager/userLanguagePreference.ts

@@ -1,7 +1,7 @@
 import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
 import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
 import { createLogger, utilsLogger } from "../../logger";
-import { userPreferencesNamespace } from "./conts";
+import { userPreferencesNamespace } from "./const";
 
 export const preferredAudioLanguageStorageKey = "preferred_audio_language";
 

package/arrayUtils/__tests__/{anyThruthy.test.ts → anyTruthy.test.ts}

@@ -21,4 +21,12 @@ describe("anyTruthy", () => {
     expect(anyTruthy([true])).toBe(true);
     expect(anyTruthy([false])).toBe(false);
   });
+
+  it("should return true when the first value is true", () => {
+    expect(anyTruthy([true, false, false])).toBe(true);
+  });
+
+  it("should return true when only the last value is true", () => {
+    expect(anyTruthy([false, false, true])).toBe(true);
+  });
 });