@applicaster/zapp-react-native-utils 16.0.0-alpha.3439504142 → 16.0.0-alpha.3502052160

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

package/arrayUtils/__tests__/arrayUtils.test.ts

@@ -28,6 +28,30 @@ describe("shiftArray", () => {
     expect(shiftArray(negativeOffset, array)).toMatchSnapshot();
     expect(shiftArray(2 * negativeOffset, array)).toMatchSnapshot();
   });
+
+  it("returns a new array and does not mutate the original", () => {
+    const original = ["a", "b", "c"];
+    const result = shiftArray(1, original);
+
+    expect(result).toEqual(["b", "c", "a"]);
+    expect(result).not.toBe(original);
+    expect(original).toEqual(["a", "b", "c"]);
+  });
+
+  it("returns an empty array when shifting an empty array", () => {
+    expect(shiftArray(1, [])).toEqual([]);
+    expect(shiftArray(-1, [])).toEqual([]);
+  });
+
+  it("returns the same order for a single-element array", () => {
+    expect(shiftArray(1, [1])).toEqual([1]);
+    expect(shiftArray(-1, [1])).toEqual([1]);
+  });
+
+  it("handles an offset equal to the array length", () => {
+    expect(shiftArray(4, array)).toEqual(array);
+    expect(shiftArray(-4, array)).toEqual(array);
+  });
 });
 
 describe("removeItemFromList", () => {
@@ -58,6 +82,38 @@ describe("removeItemFromList", () => {
       arrayOfObjects
     );
   });
+
+  it("returns the same reference when the item is not found", () => {
+    const list = [1, 2, 3];
+
+    expect(removeItemFromList(4, list)).toBe(list);
+  });
+
+  it("returns a new array when the item is removed", () => {
+    const list = [1, 2, 3];
+    const result = removeItemFromList(2, list);
+
+    expect(result).toEqual([1, 3]);
+    expect(result).not.toBe(list);
+    expect(list).toEqual([1, 2, 3]);
+  });
+
+  it("removes only the first occurrence of a duplicate item", () => {
+    expect(removeItemFromList(2, [1, 2, 2, 3])).toEqual([1, 2, 3]);
+  });
+
+  it("removes the first and last items", () => {
+    expect(removeItemFromList(1, [1, 2, 3])).toEqual([2, 3]);
+    expect(removeItemFromList(3, [1, 2, 3])).toEqual([1, 2]);
+  });
+
+  it("returns an empty list when removing from an empty list", () => {
+    expect(removeItemFromList(1, [])).toEqual([]);
+  });
+
+  it("returns an empty list when removing the only item", () => {
+    expect(removeItemFromList(1, [1])).toEqual([]);
+  });
 });
 
 describe("mapPromises", () => {
@@ -84,145 +140,146 @@ describe("mapPromises", () => {
     values.forEach((value) => {
       expect(promiseFn).toHaveBeenNthCalledWith(value, value, value - 1);
     });
-  });
 
-  describe("removeItemFromList", () => {
-    it("removes an item from a list", () => {
-      const arrayOfPrimitives = [1, 2, 3, 4];
-      expect(removeItemFromList(1, arrayOfPrimitives)).toEqual([2, 3, 4]);
+    expect.assertions(values.length + 1);
+  });
 
-      const arrayOfObjects = [
-        { prop: "value1" },
-        { prop: "value2" },
-        { prop: "value3" },
-      ];
+  it("resolves to an empty array for an empty input", async () => {
+    await expect(mapPromises(promiseFn, [])).resolves.toEqual([]);
+    expect(promiseFn).not.toHaveBeenCalled();
+  });
 
-      expect(removeItemFromList({ prop: "value2" }, arrayOfObjects)).toEqual([
-        { prop: "value1" },
-        { prop: "value3" },
-      ]);
-    });
+  it("rejects when any promise rejects", async () => {
+    const failingFn = jest.fn((num) =>
+      num === 2 ? Promise.reject(new Error("fail")) : Promise.resolve(num)
+    );
 
-    it("leaves the list as is if the item is not found", () => {
-      const arrayOfObjects = [
-        { prop: "value1" },
-        { prop: "value2" },
-        { prop: "value3" },
-      ];
+    await expect(mapPromises(failingFn, [1, 2, 3])).rejects.toThrow("fail");
+  });
+});
 
-      expect(removeItemFromList({ prop: "value4" }, arrayOfObjects)).toEqual(
-        arrayOfObjects
-      );
+describe("reducePromises", () => {
+  const promiseFn = jest.fn((current, previous, index, cb) => {
+    return new Promise((resolve) => {
+      setTimeout(() => {
+        resolve(previous + current);
+        cb?.(index);
+      }, 1);
     });
   });
 
-  describe("mapPromises", () => {
-    const promiseFn = jest.fn((num) => Promise.resolve(num + 1));
+  beforeEach(() => {
+    promiseFn.mockClear();
+  });
 
-    beforeEach(() => {
-      promiseFn.mockClear();
-    });
+  it("is a curried function; and returns the reduced promise values", async () => {
+    const promiseReducer = reducePromises(promiseFn);
 
-    it("is a curried function, and returns an array of resolved values", async () => {
-      const promiseMapper = mapPromises(promiseFn);
-      const values = [1, 2, 3];
+    const initialValue = 0;
+    const values = [1, 2, 3];
+    const sumOfValues = initialValue + values.reduce((a, b) => a + b, 0);
 
-      expect(typeof promiseMapper).toBe("function");
-      await expect(promiseMapper(values)).resolves.toEqual([2, 3, 4]);
-    });
+    expect(typeof promiseReducer).toBe("function");
 
-    it("calls all the promises immediately", () => {
-      const values = [1, 2, 3];
+    await expect(promiseReducer(initialValue, values)).resolves.toEqual(
+      sumOfValues
+    );
+  });
 
-      mapPromises(promiseFn, values);
-      expect(promiseFn).toHaveBeenCalledTimes(values.length);
+  it("calls promises one after the other", (done) => {
+    const values = [1, 2, 3];
+    const previousValues = [0, 1, 3];
+
+    reducePromises(
+      (current, previous, index) =>
+        promiseFn(current, previous, index, (index) => {
+          expect(promiseFn).toHaveBeenCalledTimes(index + 1);
+
+          expect(promiseFn).toHaveBeenNthCalledWith(
+            index + 1,
+            values[index],
+            previousValues[index],
+            index,
+            expect.any(Function)
+          );
+
+          if (index === 2) done();
+        }),
+      0,
+      values
+    );
 
-      values.forEach((value) => {
-        expect(promiseFn).toHaveBeenNthCalledWith(value, value, value - 1);
-      });
+    expect.assertions(values.length * 2);
+  });
 
-      expect.assertions(values.length + 1);
-    });
+  it("returns the initial value for an empty list", async () => {
+    await expect(reducePromises(promiseFn, 10, [])).resolves.toBe(10);
+    expect(promiseFn).not.toHaveBeenCalled();
   });
 
-  describe("reduce promises", () => {
-    const promiseFn = jest.fn((current, previous, index, cb) => {
-      return new Promise((resolve) => {
-        setTimeout(() => {
-          resolve(previous + current);
-          cb?.(index);
-        }, 1);
-      });
-    });
+  it("reduces a single-element list", async () => {
+    await expect(reducePromises(promiseFn, 5, [2])).resolves.toBe(7);
+  });
 
-    beforeEach(() => {
-      promiseFn.mockClear();
+  it("rejects when a promise rejects", async () => {
+    const failingFn = jest.fn(async (current, previous) => {
+      if (current === 2) throw new Error("reduce fail");
+
+      return previous + current;
     });
 
-    it("is a curried function; and returns the reduced promise values", async () => {
-      const promiseReducer = reducePromises(promiseFn);
+    await expect(reducePromises(failingFn, 0, [1, 2, 3])).rejects.toThrow(
+      "reduce fail"
+    );
+  });
+});
+
+describe("mapAndSplit", () => {
+  it("maps over a list of values and split it in chunks", () => {
+    const values = new Array(20).fill(0).map((_, i) => i);
+
+    const alphabet = Array.from(Array(26)).map((_, i) =>
+      String.fromCharCode(i + 65)
+    );
 
-      const initialValue = 0;
-      const values = [1, 2, 3];
-      const sumOfValues = initialValue + values.reduce((a, b) => a + b, 0);
+    const getLetterForInt = (num) => alphabet[num];
+    const chunkSize = 5;
 
-      expect(typeof promiseReducer).toBe("function");
+    const result = mapAndSplit<number, string>(
+      getLetterForInt,
+      chunkSize
+    )(values);
 
-      await expect(promiseReducer(initialValue, values)).resolves.toEqual(
-        sumOfValues
-      );
-    });
+    expect(result.length).toBe(values.length / chunkSize);
 
-    it("calls promises one after the other", (done) => {
-      const values = [1, 2, 3];
-      const previousValues = [0, 1, 3];
-
-      reducePromises(
-        (current, previous, index) =>
-          promiseFn(current, previous, index, (index) => {
-            expect(promiseFn).toHaveBeenCalledTimes(index + 1);
-
-            expect(promiseFn).toHaveBeenNthCalledWith(
-              index + 1,
-              values[index],
-              previousValues[index],
-              index,
-              expect.any(Function)
-            );
-
-            if (index === 2) done();
-          }),
-        0,
-        values
-      );
-
-      expect.assertions(values.length * 2);
+    result.forEach((chunk, chunkIndex) => {
+      chunk.forEach((value, index) => {
+        expect(value).toBe(alphabet[chunkIndex * chunkSize + index]);
+      });
     });
   });
 
-  describe("mapAndSplit", () => {
-    it("maps over a list of values and split it in chunks", () => {
-      const values = new Array(20).fill(0).map((_, i) => i);
+  it("is a curried function", () => {
+    const mapper = (n: number) => n * 2;
+    const splitBy2 = mapAndSplit(mapper, 2);
 
-      const alphabet = Array.from(Array(26)).map((_, i) =>
-        String.fromCharCode(i + 65)
-      );
+    expect(typeof splitBy2).toBe("function");
 
-      const getLetterForInt = (num) => alphabet[num];
-      const chunkSize = 5;
+    expect(splitBy2([1, 2, 3, 4])).toEqual([
+      [2, 4],
+      [6, 8],
+    ]);
+  });
 
-      const result = mapAndSplit<number, string>(
-        getLetterForInt,
-        chunkSize
-      )(values);
+  it("returns an empty list for an empty input", () => {
+    expect(mapAndSplit((n: number) => n, 2)([])).toEqual([]);
+  });
 
-      expect(result.length).toBe(values.length / chunkSize);
+  it("puts remaining items in a final smaller chunk", () => {
+    expect(mapAndSplit((n: number) => n, 2)([1, 2, 3])).toEqual([[1, 2], [3]]);
+  });
 
-      result.forEach((chunk, chunkIndex) => {
-        chunk.forEach((value, index) => {
-          expect(value).toBe(alphabet[chunkIndex * chunkSize + index]);
-        });
-      });
-    });
+  it("returns a single chunk when chunk size exceeds the list length", () => {
+    expect(mapAndSplit((n: number) => n * 10, 10)([1, 2])).toEqual([[10, 20]]);
   });
 });

package/arrayUtils/__tests__/isEmptyArray.test.ts

@@ -60,4 +60,15 @@ describe("isEmptyArray", () => {
 
     expect(isEmptyArray(value)).toBe(false);
   });
+
+  it("array with falsy values is not empty", () => {
+    expect(isEmptyArray([0])).toBe(false);
+    expect(isEmptyArray([false])).toBe(false);
+    expect(isEmptyArray([null])).toBe(false);
+    expect(isEmptyArray([undefined])).toBe(false);
+  });
+
+  it("nested empty array is not empty", () => {
+    expect(isEmptyArray([[]])).toBe(false);
+  });
 });