@applicaster/zapp-react-native-utils 12.0.0-alpha.6602834797 → 12.0.0-alpha.7101461483

package/actionsExecutor/ActionExecutorContext.tsx

@@ -11,11 +11,9 @@ import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickB
 import { showConfirmationDialog } from "../alertUtils";
 import { createCloudEvent, sendCloudEvent } from "../cloudEventsUtils";
 import { createLogger } from "../logger";
-import {
-  StorageMultiSelectProvider
-} from "@applicaster/zapp-react-native-bridge/ZappStorage/StorageMultiSelectProvider";
+import { StorageMultiSelectProvider } from "@applicaster/zapp-react-native-bridge/ZappStorage/StorageMultiSelectProvider";
 
-const { log_error, log_debug, log_info } = createLogger({
+const { log_error, log_info } = createLogger({
   subsystem: "ActionExecutorContext",
   category: "General",
 });
@@ -110,11 +108,17 @@ const prepareDefaultActions = (actionExecutor) => {
       const tag = entry?.extensions?.tag;
 
       if (keyNamespace && tag) {
-        const multiSelectProvider = StorageMultiSelectProvider.getProvider(keyNamespace);
+        const multiSelectProvider =
+          StorageMultiSelectProvider.getProvider(keyNamespace);
 
         const selectedItems = await multiSelectProvider.getSelectedAsync();
         const isTagInSelectedItems = selectedItems.includes(tag);
-        log_info(`handleAction: localStorageToggleFlag event will ${isTagInSelectedItems ? "remove" : "add"} tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`);
+
+        log_info(
+          `handleAction: localStorageToggleFlag event will ${
+            isTagInSelectedItems ? "remove" : "add"
+          } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
+        );
 
         if (selectedItems.includes(tag)) {
           await multiSelectProvider.removeItem(tag);
@@ -122,13 +126,17 @@ const prepareDefaultActions = (actionExecutor) => {
           await multiSelectProvider.addItem(tag);
         }
       } else {
-        log_error("handleAction: localStorageToggleFlag event missing keyNamespace or tag", { keyNamespace, tag });
+        log_error(
+          "handleAction: localStorageToggleFlag event missing keyNamespace or tag",
+          { keyNamespace, tag }
+        );
 
         return ActionResult.Error;
       }
 
       return ActionResult.Success;
-    });
+    }
+  );
 };
 
 export const ActionExecutorContext =

package/appUtils/orientationHelper.ts

@@ -2,6 +2,7 @@
 import * as ReactNative from "react-native";
 import { isTV, platformSelect } from "../reactUtils";
 import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
+import { useIsTablet } from "@applicaster/zapp-react-native-utils/reactHooks";
 
 import {
   QUICK_BRICK_EVENTS,
@@ -9,7 +10,6 @@ import {
   sendQuickBrickEvent,
 } from "@applicaster/zapp-react-native-bridge/QuickBrick";
 import { utilsLogger } from "../logger";
-import { useIsTablet } from "../reactHooks/device/useIsTablet";
 
 const { DeviceEventEmitter, NativeModules, NativeEventEmitter } = ReactNative;
 

package/appUtils/playerManager/player.ts

@@ -278,6 +278,10 @@ export class Player {
     return this.playerState.isBuffering;
   };
 
+  isReadyToPlay = (): boolean => {
+    return this.playerState.isReadyToPlay;
+  };
+
   // Methods to call actions on the player
   seekTo = (_position: number) => {};
 
@@ -652,6 +656,10 @@ export class Player {
     _selected?: QuickBrickPlayer.TextTrack | QuickBrickPlayer.AudioTrack
   ) => {};
 
+  setPlaybackRate = (_rate) => {};
+  startSleepTimer = (_timestamp) => {};
+  cancelSleepTimer = () => {};
+
   getPluginConfiguration = () => null;
   appStateChange = (_appState, _previousAppState) => {};
 

package/appUtils/playerManager/playerFactory.ts

@@ -1,17 +1,29 @@
 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";
 
 type PlayerFactoryItem = {
   Component: any;
   controller: Player;
 };
 
+type PlayerFactoryProps = {
+  player: any,
+  playerId: string,
+  autoplay: boolean,
+  entry: ZappEntry,
+  muted: boolean,
+  playerPluginId: string,
+  screenConfig: Record<string, any>,
+  playerRole: PlayerRole,
+}
+
 interface PlayerConstructor {
   new (params: any): Player;
 }
 
-export const playerFactory = (config: any): PlayerFactoryItem | null => {
+export const playerFactory = (config: PlayerFactoryProps): PlayerFactoryItem | null => {
   const IDENTIFIER = config?.playerPluginId;
 
   if (!IDENTIFIER) {

package/appUtils/playerManager/playerNative.ts

@@ -41,6 +41,9 @@ const PlayerModuleFuncNames = {
   rewind: "rewind",
   play: "play",
   pause: "pause",
+  startSleepTimer: "startSleepTimer",
+  cancelSleepTimer: "cancelSleepTimer",
+  getSleepTimerEnd: "getSleepTimerEnd",
 };
 
 export class PlayerNative extends Player {
@@ -172,6 +175,25 @@ export class PlayerNative extends Player {
     }
   };
 
+  startSleepTimer = (sleepTimestamp: number) => {
+    if (
+      !this.invokeNativeFunction(
+        PlayerModuleFuncNames.startSleepTimer,
+        sleepTimestamp
+      )
+    ) {
+      this.currentPlayerComponent()?.["startSleepTimer"](sleepTimestamp);
+    }
+  };
+
+  cancelSleepTimer = () => {
+    if (!this.invokeNativeFunction(PlayerModuleFuncNames.cancelSleepTimer)) {
+      this.currentPlayerComponent()?.[
+        PlayerModuleFuncNames.cancelSleepTimer
+      ]?.();
+    }
+  };
+
   disableBufferAnimation = (): boolean => false;
 
   setLanguage = (
@@ -180,6 +202,10 @@ export class PlayerNative extends Player {
     this.currentPlayerComponent()?.["setLanguage"]?.(selected);
   };
 
+  setPlaybackRate = (rate: number) => {
+    this.currentPlayerComponent()?.["setPlaybackRate"]?.(rate);
+  };
+
   getPluginConfiguration = () => {
     return (this.currentPlayerComponent() as any)?.props?.pluginConfiguration;
   };

package/appUtils/playerManager/usePlayerState.tsx

@@ -9,6 +9,7 @@ type PlayerState = {
   isLive: boolean;
   isPaused: boolean;
   isBuffering: boolean;
+  isReadyToPlay: boolean;
 };
 
 export const usePlayerState = (
@@ -20,12 +21,14 @@ export const usePlayerState = (
   const [seekableDuration, setSeekableDuration] = React.useState<number>(null);
   const [isLive, setIsLive] = React.useState<boolean>(null);
   const [isBuffering, setIsBuffering] = React.useState<boolean>(false);
+  const [isReadyToPlay, setIsReadyToPlay] = React.useState<boolean>(false);
   const [isPaused, setIsPaused] = React.useState<boolean>(false);
 
   const player: Player = usePlayer(playerId);
 
   const onPlayerChangeState = React.useCallback(() => {
     setIsBuffering(player.isBuffering());
+    setIsReadyToPlay(player.isReadyToPlay);
     setCurrentTime(player.getContentPosition());
     setDuration(player.getDuration());
     setSeekableDuration(player.getSeekableDuration());
@@ -60,7 +63,16 @@ export const usePlayerState = (
       isLive,
       isPaused,
       isBuffering,
+      isReadyToPlay,
     }),
-    [currentTime, duration, seekableDuration, isLive, isPaused, isBuffering]
+    [
+      currentTime,
+      duration,
+      seekableDuration,
+      isLive,
+      isPaused,
+      isBuffering,
+      isReadyToPlay,
+    ]
   );
 };

package/cellUtils/index.ts

@@ -343,6 +343,19 @@ export const ifElseFocused = R.curry(
     state === "focused" ? focusedValue : defaultValue
 );
 
+export const ifElseSelected = R.curry(
+  (state: string, selectedValue, defaultValue) => {
+    switch (state) {
+      case "selected":
+        return selectedValue;
+      case "focused_selected":
+        return selectedValue;
+      default:
+        return defaultValue;
+    }
+  }
+);
+
 /**
  * Map textAlign values to their corresponding alignSelf values
  * This is so that we could use the same field for both properties

package/modalState/index.ts

@@ -0,0 +1,57 @@
+import { create } from "zustand";
+
+interface ModalState {
+  visible: boolean;
+  screen: any;
+  options: Record<string, unknown>;
+  props: Record<string, unknown>;
+}
+
+interface ModalStore {
+  modalState: ModalState;
+  setModalState: (newState: Partial<ModalState>) => void;
+  openModal: (
+    item: any,
+    options?: Record<string, unknown>,
+    props?: Record<string, unknown>
+  ) => void;
+  dismissModal: () => void;
+}
+
+const initialModalState: ModalState = {
+  visible: false,
+  screen: null,
+  options: {},
+  props: {},
+};
+
+export const useModalStore = create<ModalStore>((set) => ({
+  modalState: initialModalState,
+  setModalState: (newState) =>
+    set((state) => ({
+      modalState: { ...state.modalState, ...newState },
+    })),
+  openModal: ({
+    item,
+    options = {},
+    props = { screenData: {} },
+  }: OpenModalArg) =>
+    set({
+      modalState: {
+        visible: true,
+        screen: item,
+        options: {
+          animated: true,
+          animationType: "slide",
+          onShow: () => {},
+          presentationStyle: "overFullScreen",
+          transparent: true,
+          ...options,
+          onDismiss: () => set({ modalState: initialModalState }),
+          onRequestClose: () => set({ modalState: initialModalState }),
+        },
+        props,
+      },
+    }),
+  dismissModal: () => set(() => ({ modalState: initialModalState })),
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "12.0.0-alpha.6602834797",
+  "version": "12.0.0-alpha.7101461483",
   "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": "12.0.0-alpha.6602834797",
+    "@applicaster/applicaster-types": "12.0.0-alpha.7101461483",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "create-react-context": "^0.2.3",

package/pluginUtils/index.ts

@@ -68,11 +68,13 @@ export function findComponentByType({
  * Returns the plugin for a given identifier, if found
  * @param identifier of the plugin to look for
  * @param plugins map of the available plugins
+ * @param doNotWarn if set to true, will not log a warning if plugin is not found
  * @return whole plugin if found, undefined otherwise
  */
 export function findPluginByIdentifier(
   identifier: string,
-  plugins: (QuickBrickPlugin | ZappPlugin | Plugin)[]
+  plugins: (QuickBrickPlugin | ZappPlugin | Plugin)[],
+  doNotWarn: boolean = false
 ): (QuickBrickPlugin | ZappPlugin | Plugin) | undefined {
   if (!identifier) {
     return undefined;
@@ -84,10 +86,12 @@ export function findPluginByIdentifier(
   )(plugins);
 
   if (!plugin && identifier !== "river" && identifier !== "hooks") {
-    pluginUtilsLogger.warning({
-      message: `Could not find plugin for identifier ${identifier}`,
-      data: { identifier },
-    });
+    if (!doNotWarn) {
+      pluginUtilsLogger.warning({
+        message: `Could not find plugin for identifier ${identifier}`,
+        data: { identifier },
+      });
+    }
   }
 
   return plugin;

package/reactHooks/cell-click/__tests__/index.test.js

@@ -1,6 +1,7 @@
 import * as React from "react";
 import { cleanup, renderHook } from "@testing-library/react-hooks";
 import { CellTapContext } from "@applicaster/zapp-react-native-ui-components/Contexts/CellTapContext";
+import { waitFor } from "@testing-library/react-native";
 
 const navigator = {
   getPathname: () => "pathnameMock",
@@ -64,13 +65,16 @@ describe("useCellClick", () => {
     cleanup();
   });
 
-  it("runs onCellTap", () => {
+  it("runs onCellTap", async () => {
     const { result } = renderHook(() => useCellClick(mockProps), { wrapper });
     const useCellClickHook = result.current;
 
     useCellClickHook();
 
-    expect(onCellTap).toHaveBeenCalled();
+    await waitFor(() => {
+      expect(onCellTap).toHaveBeenCalled();
+    });
+
     cleanup();
   });
 });

package/reactHooks/cell-click/index.ts

@@ -53,7 +53,7 @@ export const useCellClick = (props: Props) => {
   );
 
   const onPress = React.useCallback(
-    (_item?: ZappEntry | any, _index?: number) => {
+    async (_item?: ZappEntry | any, _index?: number) => {
       // Making sure we are not getting GestureResponderEvent in here.
       const isZappEntry = _item?.id && _item?.type;
       const selectedItem = isZappEntry ? _item : props.item;
@@ -70,7 +70,7 @@ export const useCellClick = (props: Props) => {
       logOnPress(selectedItem, pathname, component, onCellTap);
 
       if (selectedItem) {
-        actionExecutor?.handleEntryActions(selectedItem);
+        await actionExecutor?.handleEntryActions(selectedItem);
       }
 
       if (selectedItem?.type?.value === "action") {

package/reactHooks/device/index.ts

@@ -1,6 +1,5 @@
 export { useOrientation } from "./useOrientation";
 
-// @ts-ignore
 export { useIsTablet } from "./useIsTablet";
 
 export { useMemoizedIsTablet } from "./useMemoizedIsTablet";

package/reactHooks/device/useIsTablet.tsx

@@ -1,3 +1,28 @@
-// Template function for TS to correctly compile.
-// The RN app will use files with platform suffixes
-export const useIsTablet = (): boolean => false;
+/* eslint react-native/split-platform-components: off */
+
+import { Platform, PlatformIOSStatic, NativeModules } from "react-native";
+import { platformSelect } from "@applicaster/zapp-react-native-utils/reactUtils";
+import { F as alwaysFalse } from "ramda";
+import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
+
+const useIsTabletIos = (): boolean => {
+  const { isPad } = Platform as PlatformIOSStatic;
+
+  return isPad;
+};
+
+const useIsTabletAndroid = (): boolean => {
+  const { initialProps } = NativeModules.QuickBrickCommunicationModule;
+
+  return toBooleanWithDefaultFalse(initialProps?.is_tablet);
+};
+
+export const useIsTablet = platformSelect({
+  ios: useIsTabletIos,
+  android: useIsTabletAndroid,
+  lg_tv: alwaysFalse,
+  samsung_tv: alwaysFalse,
+  android_tv: alwaysFalse,
+  tvos: alwaysFalse,
+  default: alwaysFalse,
+});

package/reactHooks/device/useMemoizedIsTablet.ts

@@ -1,6 +1,6 @@
 import * as React from "react";
 import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
-import { useIsTablet } from "./index";
+import { useIsTablet } from "./useIsTablet";
 
 export const useMemoizedIsTablet = () => {
   const isTablet = useIsTablet();

package/reactHooks/device/useOrientation.tsx

@@ -1,6 +1,8 @@
 import { useWindowDimensions } from "react-native";
 
-export const useOrientation = (): string => {
+type Return = "landscape" | "portrait";
+
+export const useOrientation = (): Return => {
   const { width, height } = useWindowDimensions();
   const isLandscape = width > height;
 

package/reactHooks/layout/index.ts

@@ -1,9 +1,10 @@
 import * as R from "ramda";
 import { StatusBar, Platform } from "react-native";
+import { useSafeAreaInsets } from "react-native-safe-area-context";
 
 import { platformSelect, isTV } from "../../reactUtils";
 import { useIsNavBarVisible } from "../navigation";
-import { useSafeAreaInsets } from "react-native-safe-area-context";
+
 import { isTablet } from "./isTablet";
 
 export { isTablet } from "./isTablet";

package/reactHooks/navigation/__tests__/index.test.tsx

@@ -51,7 +51,7 @@ const modalItem = {
 
 const mainStackNavigator = {
   getStackForPathname: jest.fn().mockReturnValue(homeStack),
-  modalState: {},
+  getModalState: () => {},
   videoModalState: {},
 };
 
@@ -62,9 +62,9 @@ const videoModalNavigator = {
 
 const modalNavigator = {
   ...mainStackNavigator,
-  modalState: {
-    screen: modalItem,
-  },
+  getModalState: () => ({
+    screen: modalItem || {},
+  }),
 };
 
 const hookModalNavigator = {
@@ -219,7 +219,7 @@ describe("useRoute", () => {
       });
 
       expect(result.current.screenData.id).toEqual(
-        modalNavigator.modalState.screen.id
+        modalNavigator.getModalState().screen.id
       );
     });
   });

package/reactHooks/navigation/index.ts

@@ -177,9 +177,7 @@ export const useNavigationPluginData = (): ZappNavigation | undefined => {
     ? (useRouteScreenData.targetScreen as ZappRiver).navigations
     : (useRouteScreenData as ZappRiver).navigations;
 
-  const navigationMenu = navigations?.find((nav) => nav.category === "menu");
-
-  return navigationMenu;
+  return navigations?.find((nav) => nav.category === "menu");
 };
 
 export const useNavigationType = (): MenuTypes => {
@@ -255,10 +253,10 @@ export const useRoute = () => {
   ]);
 
   const currentStack = navigator.getStackForPathname(pathname);
-  const modalState = navigator.modalState;
+  const modalState: ModalState = navigator.getModalState?.();
   const hookModalState = useZappHooksModalState();
 
-  const modalScreenData = modalState.screen;
+  const modalScreenData = modalState?.screen || null;
 
   const hookModalScreenData = hookModalState.state.screenData?.payload;
 

package/reactHooks/device/useIsTablet.android.tsx

@@ -1,14 +0,0 @@
-import { useWindowDimensions } from "react-native";
-import { useOrientation } from "./useOrientation";
-import { isTablet } from "../layout";
-
-/**
- * Determines weather the given device is a tablet based on dimensions, orientation, and platform
- * @returns {Boolean} isTablet - returns whether the given device is a tablet
- */
-export const useIsTablet = (): boolean => {
-  const dimensions = useWindowDimensions();
-  const orientation = useOrientation();
-
-  return isTablet(dimensions, orientation);
-};

package/reactHooks/device/useIsTablet.ios.tsx

@@ -1,7 +0,0 @@
-import { Platform, PlatformIOSStatic } from "react-native";
-
-export const useIsTablet = (): boolean => {
-  const { isPad } = Platform as PlatformIOSStatic;
-
-  return isPad;
-};

package/reactHooks/device/useIsTablet.web.tsx

@@ -1,3 +0,0 @@
-export const useIsTablet = (): boolean => {
-  return false;
-};