@applicaster/zapp-react-native-ui-components 12.0.0-rc.26 → 12.0.0-rc.28

package/Components/Screen/__tests__/Screen.test.tsx

@@ -6,6 +6,14 @@ const Mocked_RouteManager = jest.fn((props) => (
   <View testID="routeManager" {...props} />
 ));
 
+const mock_navBarVisibleFlag = true;
+
+const mockIsNavBarVisible = jest.fn(() => mock_navBarVisibleFlag);
+
+jest.mock("react-native-safe-area-context", () => ({
+  useSafeAreaInsets: () => ({ top: 44 }),
+}));
+
 jest.mock("../../RouteManager", () => ({
   RouteManager: Mocked_RouteManager,
 }));
@@ -23,47 +31,42 @@ jest.mock(
   })
 );
 
-let mock_navBarVisibleFlag = true;
-
-jest.mock("../navigationHandler.ts", () => ({
-  isNavBarVisible: jest.fn(() => mock_navBarVisibleFlag),
-}));
-
 jest.mock("@applicaster/zapp-react-native-utils/analyticsUtils", () => ({
   useAnalytics: jest.fn(() => ({
     sendScreenEvent: jest.fn(),
   })),
 }));
 
-const {
-  allowedOrientationsForScreen,
-  getOrientation,
-  useGetScreenOrientation,
-} = require("@applicaster/zapp-react-native-utils/appUtils/orientationHelper");
-
 jest.mock("@applicaster/zapp-react-native-utils/theme", () => ({
   useTheme: jest.fn(() => ({
     app_background_color: "blue",
   })),
 }));
 
+const NavBar = jest.fn((props) => <View testID="navBar" {...props} />);
+
+jest.mock(
+  "@applicaster/zapp-react-native-app/App/Layout/layoutHelpers",
+  () => ({
+    getNavigationPluginModule: () => NavBar,
+  })
+);
+
 jest.mock("@applicaster/zapp-react-native-utils/reactHooks/screen", () => ({
-  useCurrentScreenData: jest.fn(() => ({
+  ...(jest.requireActual(
+    "@applicaster/zapp-react-native-utils/reactHooks/screen"
+  ) as any),
+  useScreenData: jest.fn(() => ({
     id: "testId",
+    navigations: [{ id: "testId", category: "nav_bar" }],
   })),
-  useNavbarState: jest.fn(() => ({
-    visible: jest.fn(() => mock_navBarVisibleFlag),
+  useCurrentScreenData: jest.fn(() => ({
+    id: "testId",
   })),
 }));
 
-const { isNavBarVisible } = require("../navigationHandler");
-
-const NavBar = jest.fn((props) => <View testID="navBar" {...props} />);
-const navigator = {};
-const navBarProps = { nav_items: [] };
-const screenData = {};
-
 jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation", () => ({
+  isNavBarVisible: mockIsNavBarVisible,
   useRoute: jest.fn(() => ({
     pathname: "/river/testId",
   })),
@@ -89,9 +92,26 @@ jest.mock("@applicaster/zapp-react-native-redux/hooks", () => ({
   }),
 }));
 
+const {
+  ORIENTATIONS,
+} = require("@applicaster/zapp-react-native-utils/appUtils/orientationHelper");
+
+const {
+  useCurrentScreenData,
+} = require("@applicaster/zapp-react-native-utils/reactHooks/screen");
+
+const {
+  allowedOrientationsForScreen,
+  getOrientation,
+  useGetScreenOrientation,
+} = require("@applicaster/zapp-react-native-utils/appUtils/orientationHelper");
+
+const navigator = {};
+const navBarProps = { nav_items: [] };
+const screenData = {};
+
 const screenProps = {
   pathname: "/foo/path",
-  NavBar,
   navigator,
   navBarProps,
   screenData,
@@ -105,7 +125,6 @@ describe("<Screen Component />", () => {
   beforeEach(() => {
     allowedOrientationsForScreen.mockClear();
     getOrientation.mockClear();
-    isNavBarVisible.mockClear();
     useGetScreenOrientation.mockClear();
   });
 
@@ -121,14 +140,9 @@ describe("<Screen Component />", () => {
 
   describe("when the navbar should be hidden", () => {
     beforeEach(() => {
-      mock_navBarVisibleFlag = false;
       wrapper = create(<Screen {...screenProps} />);
     });
 
-    afterEach(() => {
-      mock_navBarVisibleFlag = true;
-    });
-
     it("renders correctly", () => {
       act(() => {
         wrapper = create(<Screen {...screenProps} />);
@@ -138,44 +152,44 @@ describe("<Screen Component />", () => {
     });
   });
 
-  // it("invokes the orientation hook when the route changes", () => {
-  //   act(() => {
-  //     wrapper = create(<Screen {...screenProps} />);
-  //   });
-
-  //   // @ts-ignore
-  //   useCurrentScreenData.mockReturnValue({
-  //     id: "player-testId",
-  //     general: { screen_orientation: ORIENTATIONS.landscapeSensor },
-  //     plugin_type: "player",
-  //   });
-
-  //   act(() => {
-  //     wrapper.update(
-  //       <Screen
-  //         {...screenProps}
-  //         pathname="/playable"
-  //         screenData={{
-  //           id: "player-testId",
-  //           general: { screen_orientation: ORIENTATIONS.landscapeSensor },
-  //           plugin_type: "player",
-  //         }}
-  //       />
-  //     );
-  //   });
-
-  //   useCurrentScreenData.mockReturnValue({
-  //     id: "player-testId",
-  //     general: { screen_orientation: ORIENTATIONS.landscapeSensor },
-  //   });
-
-  //   act(() => {
-  //     wrapper.update(<Screen {...screenProps} />);
-  //   });
-
-  //   expect(allowedOrientationsForScreen).toHaveBeenNthCalledWith(
-  //     1,
-  //     ORIENTATIONS.landscapeSensor
-  //   );
-  // });
+  it("invokes the orientation hook when the route changes", () => {
+    act(() => {
+      wrapper = create(<Screen {...screenProps} />);
+    });
+
+    // @ts-ignore
+    useCurrentScreenData.mockReturnValue({
+      id: "player-testId",
+      general: { screen_orientation: ORIENTATIONS.landscapeSensor },
+      plugin_type: "player",
+    });
+
+    act(() => {
+      wrapper.update(
+        <Screen
+          {...screenProps}
+          pathname="/playable"
+          screenData={{
+            id: "player-testId",
+            general: { screen_orientation: ORIENTATIONS.landscapeSensor },
+            plugin_type: "player",
+          }}
+        />
+      );
+    });
+
+    useCurrentScreenData.mockReturnValue({
+      id: "player-testId",
+      general: { screen_orientation: ORIENTATIONS.landscapeSensor },
+    });
+
+    act(() => {
+      wrapper.update(<Screen {...screenProps} />);
+    });
+
+    expect(allowedOrientationsForScreen).toHaveBeenNthCalledWith(
+      1,
+      ORIENTATIONS.landscapeSensor
+    );
+  });
 });

package/Components/Screen/__tests__/__snapshots__/Screen.test.tsx.snap

@@ -6,17 +6,19 @@ exports[`<Screen Component /> when the navbar should be hidden renders correctly
     Object {
       "backgroundColor": "blue",
       "flex": 1,
+      "paddingTop": 0,
     }
   }
 >
   <View
-    nav_items={Array []}
+    id="/river/testId"
+    selected="testId"
     testID="navBar"
+    title=""
   />
   <View>
     <View
-      pathname="/foo/path"
-      screenData={Object {}}
+      pathname="/river/testId"
       testID="routeManager"
     />
   </View>
@@ -29,17 +31,19 @@ exports[`<Screen Component /> when the navbar should show renders correctly 1`]
     Object {
       "backgroundColor": "blue",
       "flex": 1,
+      "paddingTop": 0,
     }
   }
 >
   <View
-    nav_items={Array []}
+    id="/river/testId"
+    selected="testId"
     testID="navBar"
+    title=""
   />
   <View>
     <View
-      pathname="/foo/path"
-      screenData={Object {}}
+      pathname="/river/testId"
       testID="routeManager"
     />
   </View>

package/Components/Screen/__tests__/navigationHandler.test.ts

@@ -1,183 +1,6 @@
-import { isNavBarVisible, isMenuVisible } from "../navigationHandler";
+import { isMenuVisible } from "../navigationHandler";
 
 describe("NavigationHandler", () => {
-  describe("isNavBarVisible", () => {
-    it("returns false when the route is a player route", () => {
-      const navBarVisible = isNavBarVisible(
-        "/playable/some_vod_item",
-        {},
-        undefined,
-        false
-      );
-
-      expect(navBarVisible).toBe(false);
-    });
-
-    it("returns false when the next screen is the QB search screen", () => {
-      const navBarVisible = isNavBarVisible(
-        "/river/A1234",
-        {
-          type: "qb_search_screen",
-        },
-        undefined,
-        false
-      );
-
-      expect(navBarVisible).toBe(false);
-    });
-
-    describe("when screen is a hook", () => {
-      it("returns true if the `showNavBar` flag is set to true", () => {
-        const navBarVisible = isNavBarVisible(
-          "",
-          {
-            hookPlugin: {
-              module: {
-                showNavBar: true,
-              },
-            },
-          },
-          undefined,
-          false
-        );
-
-        expect(navBarVisible).toBe(true);
-      });
-
-      it("returns true if presentFullScreen flag is set to false", () => {
-        const navBarVisible = isNavBarVisible(
-          "",
-          {
-            hookPlugin: {
-              module: {
-                presentFullScreen: false,
-              },
-            },
-          },
-          undefined,
-          false
-        );
-
-        expect(navBarVisible).toBe(true);
-      });
-
-      it("returns false if presentFullScreen flag is set to true", () => {
-        const navBarVisible = isNavBarVisible(
-          "",
-          {
-            hookPlugin: {
-              module: {
-                presentFullScreen: true,
-              },
-            },
-          },
-          undefined,
-          false
-        );
-
-        expect(navBarVisible).toBe(false);
-      });
-    });
-
-    it("returns false if the screen's general settings allow screen presentation", () => {
-      const navBarVisible = isNavBarVisible(
-        "",
-        {
-          general: {
-            allow_screen_plugin_presentation: true,
-          },
-        },
-        undefined,
-        false
-      );
-
-      expect(navBarVisible).toBe(false);
-    });
-
-    it("returns false if the screen's general settings hide app nav bar", () => {
-      const navBarVisible = isNavBarVisible(
-        "",
-        {
-          general: {
-            hide_app_nav_bar: true,
-          },
-        },
-        undefined,
-        false
-      );
-
-      expect(navBarVisible).toBe(false);
-    });
-
-    it("returns false if it's secondary nav bar and hide_secondary_level_menu is true", () => {
-      const navBarVisible = isNavBarVisible(
-        "",
-        {
-          navigations: [
-            {
-              styles: {
-                hide_secondary_level_menu: true,
-              },
-            },
-          ],
-        },
-        undefined,
-        true
-      );
-
-      expect(navBarVisible).toBe(false);
-    });
-
-    it("returns true if it's secondary nav bar and hide_secondary_level_menu is false", () => {
-      const navBarVisible = isNavBarVisible(
-        "",
-        {
-          navigations: [
-            {
-              styles: {
-                hide_secondary_level_menu: false,
-              },
-            },
-          ],
-        },
-        undefined,
-        true
-      );
-
-      expect(navBarVisible).toBe(true);
-    });
-
-    it("returns true if it's first level menu and hide_secondary_level_menu is true", () => {
-      const navBarVisible = isNavBarVisible(
-        "",
-        {
-          navigations: [
-            {
-              styles: {
-                hide_secondary_level_menu: false,
-              },
-            },
-          ],
-        },
-        undefined,
-        false
-      );
-
-      expect(navBarVisible).toBe(true);
-    });
-
-    it("returns true otherwise", () => {
-      const navBarVisible = isNavBarVisible(
-        "",
-        { navigations: [] },
-        undefined,
-        false
-      );
-
-      expect(navBarVisible).toBe(true);
-    });
-  });
-
   describe("isMenuVisible", () => {
     it("returns false when the route is a player route", () => {
       const menuVisible = isMenuVisible("/playable/some_vod_item", {});

package/Components/Screen/index.tsx

@@ -1,36 +1,26 @@
 /// <reference types="@applicaster/applicaster-types" />
-import React, { useMemo } from "react";
+import React from "react";
 import * as R from "ramda";
 import { View } from "react-native";
-import { RouteManager } from "../RouteManager";
-import { useTheme } from "@applicaster/zapp-react-native-utils/theme";
-import { useScreenOrientationHandler } from "./orientationHandler";
-import { useScreenConfiguration } from "../River/useScreenConfiguration";
-import { useCurrentScreenData } from "@applicaster/zapp-react-native-utils/reactHooks/screen";
 import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
-import { ScreenContextProvider } from "../../Contexts/ScreenContext";
 
-type Props = {
-  pathname: string;
-  screenData: Record<string, any>;
-  NavBar: ZappPlugin;
-  Menu: ZappPlugin;
-  navBarProps: Record<string, any>;
-  isNavBarVisible: boolean;
-  menuProps: {
-    setToggleMenu: () => void;
-    toggleMenu: () => void;
-    openMenu: () => void;
-    setOpenMenu: () => void;
-    closeMenu: () => void;
-    setCloseMenu: () => void;
-    dimensions: { window: number };
-    navigator: ZappNavigationProps;
-    bottomTabBarHeight: number;
-    isRTL: boolean;
-    category: string;
-  } & QuickBrickAppNavigator;
-};
+import { useTheme } from "@applicaster/zapp-react-native-utils/theme";
+import { getComponentModule } from "@applicaster/zapp-react-native-utils/pluginUtils";
+import { getNavigationPropsV2 } from "@applicaster/zapp-react-native-utils/navigationUtils";
+import { useSafeAreaInsets } from "react-native-safe-area-context";
+import {
+  useDimensions,
+  useRoute,
+  useCurrentScreenData,
+  useNavbarState,
+  useScreenData,
+} from "@applicaster/zapp-react-native-utils/reactHooks";
+import { getNavigationPluginModule } from "@applicaster/zapp-react-native-app/App/Layout/layoutHelpers";
+
+import { ScreenContextProvider } from "../../Contexts/ScreenContext";
+import { RouteManager } from "../RouteManager";
+import { useScreenConfiguration } from "../River/useScreenConfiguration";
+import { useScreenOrientationHandler } from "./orientationHandler";
 
 function colorIsNotTransparent(color) {
   const layers = R.compose(
@@ -49,25 +39,68 @@ function isValidColor(string) {
   return string && string !== "transparent" && colorIsNotTransparent(string);
 }
 
-export function Screen(props: Props) {
-  const { pathname, screenData, NavBar } = props;
+type Props = {
+  pathname: string;
+  screenData: unknown;
+  setToggleMenu: () => void;
+  setCloseMenu: () => void;
+};
+
+export function Screen({ setToggleMenu, setCloseMenu }: Props) {
+  const theme = useTheme<BaseThemePropertiesMobile>();
   const { plugins } = usePickFromState(["plugins"]);
 
-  const offlinePlugin = useMemo(
+  // Gets the data for the current screen configuration
+  const currentScreenData = useCurrentScreenData();
+  const { backgroundColor } = useScreenConfiguration(currentScreenData.id);
+  const insets = useSafeAreaInsets();
+
+  const { width: screenWidth } = useDimensions("screen", {
+    fullDimensions: true,
+  });
+
+  const routeData = useRoute();
+
+  const currentRiver = useScreenData(
+    (routeData.screenData as ZappRiver)?.targetScreen
+      ? (routeData.screenData as ZappRiver)?.targetScreen.id
+      : (routeData.screenData as ZappRiver)?.screen_id
+  );
+
+  const { title } = useNavbarState();
+
+  const navBarProps = React.useMemo(
+    () => ({
+      ...getNavigationPropsV2({
+        currentRiver,
+        title,
+        category: "nav_bar",
+      }),
+      setToggleMenu,
+      setCloseMenu,
+    }),
+    [currentRiver, setCloseMenu, setToggleMenu]
+  );
+
+  const NavBar = React.useMemo(
     () =>
-      R.compose(
-        R.prop("module"),
-        R.find(R.propEq("identifier", "offline-experience"))
-      )(plugins),
-    [plugins]
+      getNavigationPluginModule(
+        "nav_bar",
+        currentRiver,
+        plugins
+      ) as React.ComponentType<MobileNavBarPluginProps>,
+    []
   );
 
-  const { OfflineFallbackScreen } = offlinePlugin;
+  const { screenData, pathname } = routeData;
 
-  // Gets the data for the current screen configuration
-  const currentScreenData = useCurrentScreenData();
-  const theme = useTheme();
-  const { backgroundColor } = useScreenConfiguration(currentScreenData.id);
+  const offlinePlugin = getComponentModule({
+    plugins,
+    components: {},
+    componentType: "offline-experience",
+  });
+
+  const { OfflineFallbackScreen } = offlinePlugin;
 
   const style = React.useMemo(
     () => ({
@@ -75,21 +108,28 @@ export function Screen(props: Props) {
       backgroundColor: isValidColor(backgroundColor)
         ? backgroundColor
         : theme.app_background_color,
+      paddingTop: 0,
+      // paddingBottom: insets.bottom, // Should be applied directly by UI plugin
+      // paddingLeft: insets.left, // Should be applied directly by UI plugin
+      // paddingRight: insets.right, // Should be applied directly by UI plugin
     }),
-    [theme.app_background_color, backgroundColor]
+    [insets, screenWidth, theme.app_background_color, backgroundColor]
   );
 
   const targetScreenData =
-    currentScreenData || screenData?.targetScreen || screenData;
+    currentScreenData || (screenData as any)?.targetScreen || screenData;
 
   useScreenOrientationHandler({ screenData: targetScreenData });
 
   return (
     <ScreenContextProvider pathname={pathname}>
       <View style={style}>
-        <NavBar key={pathname} {...props.navBarProps} />
+        <NavBar
+          {...{ ...(navBarProps as MobileNavBarPluginProps), id: pathname }}
+        />
 
         <OfflineFallbackScreen screenData={screenData}>
+          {/* @TODO RouteManager doesn't use props, can they be removed ?  */}
           <RouteManager pathname={pathname} screenData={screenData} />
         </OfflineFallbackScreen>
       </View>

package/Components/Screen/navigationHandler.ts

@@ -1,85 +1,3 @@
-import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
-
-/**
- * This function helps to decide wether the navbar should be presented on the screen
- * based on route and / or screen Data
- *
- * Currently the scenarios include
- * - players => false
- * - search screen plugin => false
- * - hooks with `showNavBar: true` or `presentFullScreen` not set to true, defaults to no navbar for hook screens
- * - screens with `allow_screen_plugin_presentation` in general property => false
- *
- * @param {String} route current route of the screen
- * @param {Object} screenData payload associated with the currently presented screen
- * @returns {Boolean}
- */
-export function isNavBarVisible(
-  route,
-  screenData,
-  showNavBar,
-  canGoBack,
-  videoModalState: QuickBrickVideoModalState | null = null
-) {
-  /* screenData is not actual navigator.data
-   * or navigator.screenData,
-   * but navigator.data.screen */
-  if (route.includes("playable")) {
-    return false;
-  }
-
-  if (
-    videoModalState?.mode === "FULLSCREEN" &&
-    videoModalState?.visible === true
-  ) {
-    return false;
-  }
-
-  if (screenData?.type === "qb_search_screen" && !isTV()) {
-    return false;
-  }
-
-  /* Match if screen is Hook */
-  if (route.startsWith("/hooks/")) {
-    const module = screenData?.module;
-
-    if (module?.presentFullScreen) {
-      return false;
-    }
-
-    return module?.showNavBar ?? false;
-  }
-
-  if (screenData?.hookPlugin) {
-    const hookPlugin = screenData?.hookPlugin?.module;
-
-    return (
-      hookPlugin?.showNavBar || hookPlugin?.presentFullScreen !== true || false
-    );
-  }
-
-  if (
-    screenData?.general?.allow_screen_plugin_presentation ||
-    screenData?.general?.hide_app_nav_bar
-  ) {
-    return false;
-  }
-
-  const hideSecondaryLevel = screenData?.navigations?.some(
-    (navigation) => navigation.styles?.hide_secondary_level_menu
-  );
-
-  if (canGoBack && hideSecondaryLevel) {
-    return false;
-  }
-
-  if (typeof showNavBar === "boolean" && !showNavBar) {
-    return false;
-  }
-
-  return true;
-}
-
 /**
  * This function helps to decide wether the menu should be presented on the screen
  * based on route and / or screen Data