@applicaster/zapp-react-native-utils 13.0.0-alpha.9433330286 → 13.0.0-rc.10

package/appUtils/RiverFocusManager/index.js

@@ -26,7 +26,7 @@ export const riverFocusManager = (function () {
   /**
    * Retrieve screen focus data by id
    *
-   * @param {{screenFocusableGroupId: string}} screenFocusableGroupId Unique Id of the screen from layout.json
+   * @param {String}  screenFocusableGroupId Id that was used to save screen data.
    *
    */
   function screenFocusableData({ screenFocusableGroupId }) {
@@ -36,9 +36,8 @@ export const riverFocusManager = (function () {
   /**
    * Clear screen data for specific screen
    *
-   * @param {{ screenId: string, isInsideContainer: boolean }}
-   * screenId Unique Id of the screen from layout.json
-   * isInsideContainer If this screen a screen picker child
+   * @param {String}  screenId Unique Id of the screen from layout.json
+   * @param {boolean} isInsideContainer If this screen a screen picker child
    *
    */
   function clearScreenData({ screenId, isInsideContainer }) {
@@ -61,13 +60,9 @@ export const riverFocusManager = (function () {
   /**
    * Focus on selected items
    *
-   * @param {{
-   * screenFocusableGroupId: string,
-   * screenFocusedOnItem: () => void,
-   * previousAction: QuickBrickNavigationActionType,
-   * isDeepLink: boolean }} object contains data for focus
-   * - `screenFocusedOnItem` focusable item to focus
-   * - `previousActionhistory` navigator history object
+   * @param {String}  screenFocusableGroupId Top group id that was saved as screenn
+   * @param {String} screenFocusedOnItem focusable item to focus
+   * @param {object} history navigator history object
    *
    */
   function focusOnSelectedItem({
@@ -120,15 +115,15 @@ export const riverFocusManager = (function () {
 
   /**
    * Create unique key that will be used for save focused group data inside specific screen
-   * @param {{ screenId: string, isInsideContainer: boolean }}
-   * screenId Unique Id of the screen from layout.json
-   * isInsideContainer If this screen a screen picker child
+   *
+   * @param {String}  screenId Unique Id of the screen from layout.json
+   * @param {boolean} isInsideContainer If this screen a screen picker child
    *
    */
   function screenFocusableGroupId({ screenId, isInsideContainer }) {
-    return `RiverFocusableGroup-${screenId}${
-      R.isNil(isInsideContainer) ? "" : "-isInsideContainer"
-    }`;
+    return R.isNil(isInsideContainer)
+      ? `RiverFocusableGroup-${screenId}`
+      : `RiverFocusableGroup-${screenId}-isInsideContainer`;
   }
 
   return {

package/appUtils/focusManager/treeDataStructure/Tree/index.js

@@ -59,7 +59,7 @@ export class Tree {
   /**
    * Update node with provided data from newNode
    * @private
-   * @param {Object} currentNode to update
+   * @param {Object} node to update
    * @param {Object} newNode node to take data from
    */
   updateNode(currentNode, newNode) {
@@ -175,6 +175,7 @@ export class Tree {
    * @private
    * @param {Object} node to check
    * @returns True if node has defined groupID
+   * @returns False if node has NOT defined groupID
    */
   hasGroupID(node) {
     return node.component && node.component.props.groupId;
@@ -190,7 +191,7 @@ export class Tree {
       const findChildNode = this.findInTree(node.component.props.groupId);
 
       if (findChildNode) {
-        this.root.children.pop();
+        this.root.children.pop(findChildNode);
         node.children.push(findChildNode);
       }
     }

package/appUtils/focusManager/treeDataStructure/Utils/index.js

@@ -191,6 +191,7 @@ const toDistance = ({ target, direction, comparisonRect }) => {
  * Get target in shortest distance in specified direction
  * @private
  * @param {Object} direction of the navigation, which led to this focus change
+ * @param {Object} excludedNode node which should be excluded from target group
  * @param {Array} targetNodes array of input target nodes
  * @param {Object} comparisonRect rectangle to compare sides in direction.
  * @returns {Object} target in direction.
@@ -299,7 +300,8 @@ export function findFocusableNode(direction, currentFocusNode) {
  * @public
  * @param {Object} direction of the navigation, which led to this focus change
  * @param {Object} component - object to check props.prioritiseFocusOn
- * @returns {Boolean} TRUE if object has priority in direction. FALSE if object has NO priority in direction.
+ * @returns {Boolean} TRUE if object has priority in direction.
+ * @returns {Boolean} FALSE if object has NO priority in direction.
  */
 export function hasPriorityInDirection(direction, component) {
   const { prioritiseFocusOn = 0 } = component.props;

package/appUtils/{index.ts → index.js}

@@ -9,7 +9,7 @@ export { KEYS, ARROW_KEYS } from "./keyCodes/keys";
 
 export { playerManager } from "./playerManager";
 
-export { AccessibilityManager } from "./accessibilityManager";
+export { accessibilityManager } from "./accessibilityManager";
 
 export function deprecationMessage(fn, replacement) {
   if (__DEV__ && process.env.NODE_ENV !== "test") {

package/appUtils/keyCodes/__tests__/keyCodes.test.js

@@ -13,7 +13,7 @@ const globalTizen = {
 describe("keyCodes", () => {
   describe("keyCode", () => {
     const { keyCode } = require("..");
-    const { KEYS } = require("../keys/keys.web");
+    const { KEYS } = require("../keys.web");
 
     it("returns an object for a given key event", () => {
       expect(keyCode(KEYS.Enter)).toMatchSnapshot();
@@ -63,7 +63,7 @@ describe("keyCodes", () => {
     it("uses the proper keyCode for the environment", () => {
       Platform.OS = "samsung_tv";
       const { keyCode } = require("../");
-      const { KEYS } = require("../keys/keys.web");
+      const { KEYS } = require("../keys.web");
 
       expect(globalTizen.tvinputdevice.registerKeyBatch).toHaveBeenCalledWith([
         "MediaPlay",
@@ -97,7 +97,7 @@ describe("keyCodes", () => {
     it("uses the proper keyCode for the environment", () => {
       Platform.OS = "lg_tv";
       const { keyCode } = require("..");
-      const { KEYS } = require("../keys/keys.web");
+      const { KEYS } = require("../keys.web");
       // Back is reserved on LG
       expect(keyCode({ keyCode: 417 }).matches(KEYS.Forward)).toBeTruthy();
     });

package/appUtils/keyCodes/{index.ts → index.js}

@@ -6,8 +6,6 @@ import * as R from "ramda";
 import { directionHelper } from "../directionHelper";
 import { KEYS, ARROW_KEYS } from "./keys";
 
-export { KEYS, ARROW_KEYS, keyEventMapper } from "./keys";
-
 /**
  * @typedef KeyCode
  * @property {Object} value of the Key

package/appUtils/keyCodes/{keys/keyEventMapper.ts → keys.android.js}

@@ -1,3 +1,22 @@
+export const KEYS = {
+  Enter: { code: "Enter", keyCode: 13 },
+  EnterKeyboard: { code: "EnterKeyboard", keyCode: 66 },
+  Back: { code: "Back", keyCode: 8 },
+  Space: { code: "Space", keyCode: 32 },
+  m: { code: "m", keyCode: 77 },
+  ArrowLeft: { code: "ArrowLeft", keyCode: 37 },
+  ArrowUp: { code: "ArrowUp", keyCode: 38 },
+  ArrowRight: { code: "ArrowRight", keyCode: 39 },
+  ArrowDown: { code: "ArrowDown", keyCode: 40 },
+};
+
+export const ARROW_KEYS = [
+  KEYS.ArrowUp,
+  KEYS.ArrowLeft,
+  KEYS.ArrowDown,
+  KEYS.ArrowRight,
+];
+
 export function keyEventMapper(keyCode) {
   switch (keyCode) {
     case 19: // ArrowUp

package/appUtils/keyCodes/keys.ios.js

@@ -0,0 +1,46 @@
+/* global tizen */
+const isTizen = typeof tizen !== "undefined";
+
+export const KEYS = {
+  Enter: { code: "Enter", keyCode: 13 },
+  Space: { code: "Space", keyCode: 32 },
+  m: { code: "m", keyCode: 77 },
+  ArrowLeft: { code: "ArrowLeft", keyCode: 37 },
+  ArrowUp: { code: "ArrowUp", keyCode: 38 },
+  ArrowRight: { code: "ArrowRight", keyCode: 39 },
+  ArrowDown: { code: "ArrowDown", keyCode: 40 },
+  Back: isTizen
+    ? { code: "Back", keyCode: 10009 }
+    : { code: "Backspace", keyCode: 8 },
+  Play: isTizen
+    ? { code: "MediaPlay", keyCode: 10252 }
+    : { code: "PlayPause", keyCode: 179 },
+  Pause: isTizen
+    ? { code: "MediaPause", keyCode: 19 }
+    : { code: "Pause", keyCode: 179 },
+  Forward: isTizen
+    ? { code: "MediaFastForward", keyCode: 417 }
+    : { code: "Forward", keyCode: 176 },
+  Rewind: isTizen
+    ? { code: "MediaRewind", keyCode: 412 }
+    : { code: "Rewind", keyCode: 177 },
+  VolumeUp: isTizen
+    ? { code: "VolumeUp", keyCode: 447 }
+    : { code: "VolumeUp", keyCode: 175 },
+  VolumeDown: isTizen
+    ? { code: "VolumeDown", keyCode: 448 }
+    : { code: "VolumeDown", keyCode: 174 },
+  ToggleMute: isTizen
+    ? { code: "VolumeMute", keyCode: 449 }
+    : { code: "VolumeMute", keyCode: 173 },
+  Stop: isTizen
+    ? { code: "MediaStop", keyCode: 413 }
+    : { code: "Q", keyCode: 81 },
+};
+
+export const ARROW_KEYS = [
+  KEYS.ArrowUp,
+  KEYS.ArrowLeft,
+  KEYS.ArrowDown,
+  KEYS.ArrowRight,
+];

package/appUtils/platform/platformUtils.ts

@@ -9,6 +9,20 @@ import {
 import { PLATFORM_KEYS, PLATFORMS } from "./const";
 import { createLogger, utilsLogger } from "../../logger";
 
+declare global {
+  interface Window {
+    VIZIO?: {
+      exitApplication: () => void;
+      Chromevox: {
+        play: (text: string) => void;
+      };
+      setClosedCaptionHandler: (
+        callback: (isCCEnabled: boolean) => void
+      ) => void;
+    };
+  }
+}
+
 const { log_debug } = createLogger({
   category: "General",
   subsystem: "PlatformUtils",

package/appUtils/playerManager/index.ts

@@ -169,8 +169,12 @@ export class PlayerManager {
     this.addPlayer(id, playerController);
 
     if (playerController.playerRole === PlayerRole.Primary) {
-      if (playerController.playerPluginId !== "QuickBrickPlayerPlugin") {
-        RNPlayerManager?.["QuickBrickPlayerPlugin"]?.stopBackgroundPlayback?.();
+      if (RNPlayerManager) {
+        Object.keys(RNPlayerManager).forEach((pluginId) => {
+          if (pluginId !== playerController.playerPluginId) {
+            RNPlayerManager[pluginId]?.stopBackgroundPlayback?.();
+          }
+        });
       }
 
       playerController.addListener({

package/domUtils/{cookieManager.ts → cookieManager.js}

@@ -2,6 +2,7 @@ import { domUtilsLogger } from "./logger";
 
 /**
  * Gets an object of cookies and sets them on the DOM.
+ * @param {Object} cookies selected data key for label.
  */
 export function setCookies(cookies): void {
   const cookieKeys = Object.keys(cookies);
@@ -24,7 +25,7 @@ export function setCookies(cookies): void {
 /**
  * Gets cookies set on DOM
  */
-export function getCookies(): typeof document.cookie {
+export function getCookies(): Object {
   try {
     if (document) {
       return document.cookie;

package/functionUtils/index.ts

@@ -111,12 +111,12 @@ type SubscriberFn<T> = (
 
 export type EventHandlerFn<T> = (event: string, ...args: unknown[]) => T;
 
-export type SubscriberObj<T extends {} = {}> = {
-  on: SubscriberFn<SubscriberObj<T>>;
-  invokeHandler: EventHandlerFn<SubscriberObj<T>>;
-  removeHandler: EventHandlerFn<SubscriberObj<T>>;
-  handlers: Record<string, SubscriberFn<SubscriberObj<T>>[] | []>;
-} & T;
+type SubscriberObj = Partial<{
+  on?: SubscriberFn<SubscriberObj>;
+  invokeHandler: EventHandlerFn<SubscriberObj>;
+  removeHandler: EventHandlerFn<SubscriberObj>;
+  handlers: Record<string, SubscriberFn<SubscriberObj>[] | []>;
+}>;
 
 export const clearObject = (object: { [key: string]: unknown }) =>
   Object.keys(object).forEach((key) => delete object[key]);
@@ -126,11 +126,7 @@ export const clearObject = (object: { [key: string]: unknown }) =>
  * @param {Object} obj to add the subscription feature on
  * @returns {Object} subscriber object
  */
-export function subscriber<T extends Partial<SubscriberObj> = {}>(
-  _obj: T = {} as T
-): SubscriberObj {
-  const obj: T = _obj;
-
+export function subscriber(obj: SubscriberObj = {}): SubscriberObj {
   if (!obj.handlers) {
     obj.handlers = {};
   }
@@ -176,7 +172,7 @@ export function subscriber<T extends Partial<SubscriberObj> = {}>(
       | SubscriberFn<SubscriberObj>[]
       | [];
 
-    return obj as SubscriberObj;
+    return obj;
   };
 
   /**
@@ -192,16 +188,16 @@ export function subscriber<T extends Partial<SubscriberObj> = {}>(
 
     R.compose(R.forEach(callHandlerWithDispose), R.propOr([], event))(handlers);
 
-    return obj as SubscriberObj;
+    return obj;
   };
 
   obj.removeHandler = function (event, handler) {
     handlers[event] = R.reject(R.equals(handler), handlers[event]);
 
-    return obj as SubscriberObj;
+    return obj;
   };
 
-  return obj as SubscriberObj;
+  return obj;
 }
 
 /**

package/modalState/index.ts

@@ -31,7 +31,11 @@ export const useModalStore = create<ModalStore>((set) => ({
     set((state) => ({
       modalState: { ...state.modalState, ...newState },
     })),
-  openModal: ({ item, options = {}, props }: OpenModalArg) =>
+  openModal: ({
+    item,
+    options = {},
+    props = { screenData: {} },
+  }: OpenModalArg) =>
     set({
       modalState: {
         visible: true,

package/navigationUtils/index.ts

@@ -324,13 +324,7 @@ export function getPathAttributes({
  * @param {object} rivers
  * @returns {object}
  */
-export function getRiverFromRoute({
-  route,
-  rivers,
-}: {
-  route: string;
-  rivers: Record<string, ZappRiver>;
-}) {
+export function getRiverFromRoute({ route, rivers }) {
   if (!route) {
     return null;
   }
@@ -443,7 +437,7 @@ export const runZappHooksForEntry = async (
 
   let success;
   let payload;
-  const rivers: Record<string, ZappRiver> = appStore.get("rivers");
+  const rivers = appStore.get("rivers");
   const plugins = appStore.get("plugins");
   const appData = appStore.get("appData");
 
@@ -498,16 +492,13 @@ export const runZappHooksForEntry = async (
       payload = _payload;
     };
 
-  const hooksManager = HooksManager(hooksOptions);
-
-  hooksManager.subscriber
+  HooksManager(hooksOptions)
     .on(HOOKS_EVENTS.PRESENT_SCREEN_HOOK, handleHookPresent)
     .on(HOOKS_EVENTS.START_BACKGROUND_HOOK, handleBackgroundHook)
     .on(HOOKS_EVENTS.ERROR, onFinished(false))
     .on(HOOKS_EVENTS.CANCEL, onFinished(false))
-    .on(HOOKS_EVENTS.COMPLETE, onFinished(true));
-
-  hooksManager.handleHooks(entry);
+    .on(HOOKS_EVENTS.COMPLETE, onFinished(true))
+    .handleHooks(entry);
 
   // eslint-disable-next-line no-unmodified-loop-condition
   while (success === undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "13.0.0-alpha.9433330286",
+  "version": "13.0.0-rc.10",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -28,7 +28,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "13.0.0-alpha.9433330286",
+    "@applicaster/applicaster-types": "13.0.0-rc.10",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "create-react-context": "^0.2.3",

package/reactHooks/navigation/index.ts

@@ -320,19 +320,16 @@ export const useZappHooksForEntry = (
         callbacks?.handleHookComplete?.(props);
       };
 
-      const hookManager = HooksManager(hooksOptions);
-
-      hookManager.subscriber
+      const hookManager = HooksManager(hooksOptions)
         .on(HOOKS_EVENTS.PRESENT_SCREEN_HOOK, handleHookPresent)
         .on(HOOKS_EVENTS.ERROR, handleHookError)
         .on(HOOKS_EVENTS.CANCEL, handleHookCancel)
         .on(HOOKS_EVENTS.START_BACKGROUND_HOOK, handleBackgroundHook)
-        .on(HOOKS_EVENTS.COMPLETE, handleHookComplete);
-
-      hookManager.handleHooks(entry);
+        .on(HOOKS_EVENTS.COMPLETE, handleHookComplete)
+        .handleHooks(entry);
 
       return () => {
-        hookManager.subscriber
+        hookManager
           .removeHandler(HOOKS_EVENTS.PRESENT_SCREEN_HOOK, handleHookPresent)
           .removeHandler(HOOKS_EVENTS.ERROR, handleHookError)
           .removeHandler(HOOKS_EVENTS.CANCEL, handleHookCancel)

package/reactUtils/index.ts

@@ -109,6 +109,20 @@ export const isTvOSPlatform = () => getPlatform() === "tvos";
 
 export const isAndroidTVPlatform = () => getPlatform() === "android_tv";
 
+declare global {
+  interface Window {
+    VIZIO?: {
+      Chromevox: {
+        play: (text: string) => void;
+      };
+      exitApplication: () => void;
+      setClosedCaptionHandler: (
+        callback: (isCCEnabled: boolean) => void
+      ) => void;
+    };
+  }
+}
+
 /**
  * Platforms found in userAgent string, please note that simulators
  * might not have the same agents that the devices have