@applicaster/zapp-react-native-ui-components 13.0.0-alpha.3592913150 → 13.0.0-alpha.3637360334

package/Components/FocusableGroup/FocusableTvOS.tsx

@@ -1,17 +1,30 @@
 import * as React from "react";
 import { FocusableGroupNative } from "@applicaster/zapp-react-native-ui-components/Components/NativeFocusables";
 import { BaseFocusable } from "@applicaster/zapp-react-native-ui-components/Components/BaseFocusable";
-
-function noop() {}
+import { createLogger } from "@applicaster/zapp-react-native-utils/logger";
+
+const { log_verbose } = createLogger({
+  subsystem: "General",
+  category: "FocusableGroup",
+});
+
+type FocusableGroupNativeEvent = {
+  nativeEvent: {
+    focusHeading: FocusManager.Direction;
+    groupId: string;
+    isActive: boolean;
+    isFocusDisabled: boolean;
+    isFocusingByUser: boolean;
+    itemId: string;
+    target: number;
+  };
+};
 
 type Props = {
   id: string;
   children: (arg1: boolean) => React.ComponentType<any>;
-  onWillUpdateFocus: (nativeEvent: any) => void;
-  onDidUpdateFocus: (nativeEvent: any) => void;
   isFocusDisabled: boolean;
-  initialItemId: string;
-  resetFocusToInitialValue: boolean;
+  isWithMemory: boolean;
   focusGroupRef: React.Component;
   shouldUsePreferredFocus: boolean;
   groupId: string;
@@ -21,86 +34,26 @@ type Props = {
 };
 
 export class FocusableGroup extends BaseFocusable<Props> {
-  focusableGroupNativeRef: React.Component | null;
-  constructor(props) {
-    super(props);
-    this.focusableGroupNativeRef = null;
-
-    this.state = {
-      isActive: false,
-    };
-
-    this.onWillUpdateFocus = this.onWillUpdateFocus.bind(this);
-    this.onDidUpdateFocus = this.onDidUpdateFocus.bind(this);
-    this.isGroup = true;
-
-    this.shouldUsePreferredFocus = this.shouldUsePreferredFocus.bind(this);
-    this.measureView = this.measureView.bind(this);
-  }
-
-  connectedScreenId() {
-    const {
-      screenData: { screenId, parentScreenId },
-    } = this.props;
-
-    if (screenId) {
-      return null;
-    }
-
-    return parentScreenId ? `${parentScreenId}-${screenId}` : screenId;
-  }
-
-  /**
-   * tells whether the group should give focus to a preferred item when it gains focus from another
-   * group
-   * @returns {boolean}
-   */
-  shouldUsePreferredFocus() {
-    return this.props.shouldUsePreferredFocus || false;
-  }
-
-  /**
-   * indicates whether the underlying component should claim preferred focus
-   * when navigating into the group of this item
-   * @returns {boolean}
-   */
-  isPreferredFocus() {
-    return this.props.preferredFocus || false;
-  }
-
-  onWillUpdateFocus({ nativeEvent }) {
-    const { isActive } = nativeEvent;
-    this.setState({ isActive });
-    const { onWillUpdateFocus = noop } = this.props;
-    onWillUpdateFocus(nativeEvent);
-  }
-
-  onDidUpdateFocus({ nativeEvent }) {
-    const { onDidUpdateFocus = noop } = this.props;
-    onDidUpdateFocus(nativeEvent);
-  }
-
-  setFocusDisabled(isFocusDisabled) {
-    if (this.ref) {
-      this.ref.current.setNativeProps({
-        isFocusDisabled,
-      });
-    }
-  }
-
   render() {
     const {
       children,
       id,
       isFocusDisabled,
-      initialItemId,
-      resetFocusToInitialValue,
-      style,
+      isWithMemory,
+      style = {},
       groupId,
       ...otherProps
     } = this.props;
 
-    const focusableStyles = style || {};
+    const onGroupFocus = ({ nativeEvent }: FocusableGroupNativeEvent) => {
+      log_verbose("FOCUSABLE_GROUP: onGroupFocus", { nativeEvent });
+      this.onFocus(this.ref, nativeEvent.focusHeading);
+    };
+
+    const onGroupBlur = ({ nativeEvent }: FocusableGroupNativeEvent) => {
+      log_verbose("FOCUSABLE_GROUP: onGroupBlur", { nativeEvent });
+      this.onBlur(this.ref, nativeEvent.focusHeading);
+    };
 
     return (
       <FocusableGroupNative
@@ -108,16 +61,11 @@ export class FocusableGroup extends BaseFocusable<Props> {
         itemId={id}
         ref={this.ref}
         isFocusDisabled={isFocusDisabled}
-        initialItemId={initialItemId}
-        resetFocusToInitialValue={resetFocusToInitialValue}
-        onLayout={this.measureView}
-        onViewFocus={this.onFocus}
-        onViewPress={this.onPress}
-        onViewBlur={this.onBlur}
-        style={focusableStyles}
+        isWithMemory={isWithMemory}
+        onGroupFocus={onGroupFocus}
+        onGroupBlur={onGroupBlur}
+        style={style}
         {...otherProps}
-        onWillUpdateFocus={this.onWillUpdateFocus}
-        onDidUpdateFocus={this.onDidUpdateFocus}
       >
         {children}
       </FocusableGroupNative>

package/Components/FocusableGroup/index.tsx

@@ -16,12 +16,9 @@ type Props = {
   prioritiseFocusOn?: number;
   groupId?: string;
   hasTVPreferredFocus?: boolean;
-  resetFocusToInitialValue?: boolean;
   onFocus?: () => void;
   onBlur?: () => void;
-  onWillUpdateFocus?: (event?: any) => void;
   willReceiveFocus?: (event?: any) => void;
-  onDidUpdateFocus?: (event?: any) => void;
   hasLostFocus?: any;
   nextFocusUp?: any;
   nextFocusDown?: any;

package/Components/FocusableList/index.tsx

@@ -311,6 +311,7 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
         />
       ) : (
         <FlatList
+          testID="focusable-list-flat-list"
           focusable={false}
           scrollEnabled={false}
           ref={ref}

package/Components/FocusableScrollView/index.tsx

@@ -48,7 +48,7 @@ type Action = { index?: number; isFocusable: boolean; type?: string };
 const unwrapArray = (maybeArray) =>
   Array.isArray(maybeArray) ? maybeArray[0] : maybeArray;
 
-function getEntry<T>(data: T | T[], index: unknown): T {
+const getEntry = <T extends unknown>(data: T | T[], index: unknown): T => {
   let entry;
 
   if (R.isNil(index)) {
@@ -58,7 +58,7 @@ function getEntry<T>(data: T | T[], index: unknown): T {
   }
 
   return entry;
-}
+};
 
 const focusableStateReducer = (
   state: State,
@@ -310,6 +310,8 @@ function FocusableScrollViewComponent(props: Props, ref) {
         };
       };
 
+      const onSetIsFocusable = setIsFocusable(renderArgs.index);
+
       return (
         <View key={id} onLayout={onItemLayout}>
           <Focusable
@@ -332,6 +334,7 @@ function FocusableScrollViewComponent(props: Props, ref) {
             id={id}
             disableFocus={shouldDisableFocus(renderArgs?.index)}
             blockFocus={!isRendered(renderArgs?.index)}
+            onSetIsFocusable={onSetIsFocusable}
             {...focusableItemProps}
           >
             {(focused, parentFocus, parentRef) => (
@@ -346,7 +349,7 @@ function FocusableScrollViewComponent(props: Props, ref) {
                 isReadyToRender={isReadyToRender}
                 onLoadFinished={onLoadFinished(renderArgs.index)}
                 onLoadFailed={onLoadFailed(renderArgs.index)}
-                setIsFocusable={setIsFocusable(renderArgs.index)}
+                setIsFocusable={onSetIsFocusable}
               />
             )}
           </Focusable>

package/Components/HandlePlayable/HandlePlayable.tsx

@@ -1,14 +1,14 @@
 import * as React from "react";
 import * as R from "ramda";
-import { ViewStyle } from "react-native";
 import {
   findPluginByType,
   findPluginByIdentifier,
 } from "@applicaster/zapp-react-native-utils/pluginUtils";
-import { useDimensions } from "@applicaster/zapp-react-native-utils/reactHooks/layout";
 import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
-import { useNavigation } from "@applicaster/zapp-react-native-utils/reactHooks";
-import { platformSelect } from "@applicaster/zapp-react-native-utils/reactUtils";
+import {
+  useDimensions,
+  useNavigation,
+} from "@applicaster/zapp-react-native-utils/reactHooks";
 
 import { BufferAnimation } from "../PlayerContainer/BufferAnimation";
 import { PlayerContainer } from "../PlayerContainer";
@@ -78,12 +78,6 @@ const getPlayer = (
   return getPlayerWithModuleProperties(PlayerModule);
 };
 
-const dimensionsContext: "window" | "screen" = platformSelect({
-  android_tv: "window",
-  amazon: "window",
-  default: "screen",
-});
-
 type PlayableComponent = {
   Component: React.ComponentType<any>;
 };
@@ -91,16 +85,11 @@ type PlayableComponent = {
 export function HandlePlayable({
   item,
   isModal,
-  modalHeight,
-  modalWidth,
   mode,
   groupId,
 }: Props): React.ReactElement | null {
   const state = usePickFromState();
 
-  const { width: screenWidth, height: screenHeight } =
-    useDimensions(dimensionsContext);
-
   const { closeVideoModal } = useNavigation();
 
   const [Player, playerModuleProperties] = getPlayer(item, state);
@@ -118,9 +107,7 @@ export function HandlePlayable({
     if (!isModal) {
       closeVideoModal();
     }
-  }, []);
 
-  React.useEffect(() => {
     const castStateHandler = async () => {
       const castState = await CastPlugin?.getCastState();
       setCasting(castState === "Connected");
@@ -142,23 +129,23 @@ export function HandlePlayable({
   }, []);
 
   React.useEffect(() => {
-    if (casting) {
-      setPlayable({ Component: CastPlugin?.CastHandler });
-    } else {
-      setPlayable({ Component: PlayerContainer });
-    }
+    setPlayable({
+      Component: casting ? CastPlugin?.CastHandler : PlayerContainer,
+    });
   }, [casting]);
 
-  const Component = playable?.Component;
+  const { width: screenWidth, height: screenHeight } = useDimensions("window");
 
   const style = React.useMemo(
     () => ({
-      width: isModal ? modalWidth : mode === "PIP" ? "100%" : screenWidth,
-      height: isModal ? modalHeight : mode === "PIP" ? "100%" : screenHeight,
+      width: isModal ? "100%" : mode === "PIP" ? "100%" : screenWidth,
+      height: isModal ? "100%" : mode === "PIP" ? "100%" : screenHeight,
     }),
-    [screenWidth, screenHeight, modalHeight, modalWidth, isModal, mode]
+    [screenWidth, screenHeight, isModal, mode]
   );
 
+  const Component = playable?.Component;
+
   if (Component) {
     return (
       <Component
@@ -174,5 +161,5 @@ export function HandlePlayable({
     );
   }
 
-  return !isModal ? <BufferAnimation videoStyle={style as ViewStyle} /> : null;
+  return !isModal ? <BufferAnimation videoStyle={style} /> : null;
 }

package/Components/Layout/TV/NavBarContainer.tsx

@@ -1,7 +1,5 @@
 import * as React from "react";
-import { View, StyleSheet } from "react-native";
-import { useCurrentScreenData } from "@applicaster/zapp-react-native-utils/reactHooks/screen";
-import { useScreenConfiguration } from "../../River/useScreenConfiguration";
+import { StyleSheet, View } from "react-native";
 
 type Props = {
   children: React.ReactNode;
@@ -14,32 +12,29 @@ const styles = StyleSheet.create({
     position: "absolute",
     top: 0,
     zIndex: 10,
-    width: 1920,
+    flex: 1,
+    width: "100%",
+  },
+  themeStyles: {
+    // limits the height of the focusable container of the TopMenuBarTV component
+    // to prevent it from being overlapped by the screen content,
+    // as it makes TopMenuBarTV unfocusable on tvOS
+    maxHeight: 1,
   },
 });
 
 export const NavBarContainer = ({ children, isVisible, onReady }: Props) => {
-  const screen = useCurrentScreenData();
-  const screenConfig = useScreenConfiguration(screen?.id);
-
-  const themeStyles = React.useMemo(
-    () => ({
-      // limits the height of the focusable container of the TopMenuBarTV component
-      // to prevent it from being overlapped by the screen content,
-      // as it makes TopMenuBarTV unfocusable on tvOS
-      maxHeight: 1,
-    }),
-    [screenConfig]
-  );
-
   React.useEffect(() => {
     setTimeout(() => {
       onReady?.(true);
     }, 0);
-  }, []);
+  }, [onReady]);
 
   return isVisible ? (
-    <View testID="nav-bar-container" style={[styles.container, themeStyles]}>
+    <View
+      testID="nav-bar-container"
+      style={[styles.container, styles.themeStyles]}
+    >
       {children}
     </View>
   ) : null;

package/Components/Layout/TV/ScreenContainer.tsx

@@ -55,8 +55,11 @@ export const ScreenContainer = React.memo(function ScreenContainer({
   ComponentsExtraProps,
   NavBar,
 }: Props) {
-  const { screenMarginBottom } = React.useContext(ScreenLayoutContext);
+  const { screenMarginBottom, resetScreenLayout } =
+    React.useContext(ScreenLayoutContext);
+
   const { currentRoute, screenData } = useNavigation();
+
   const screen = useCurrentScreenData();
 
   const { marginBottom, backgroundColor, paddingTop, paddingBottom } =
@@ -65,6 +68,10 @@ export const ScreenContainer = React.memo(function ScreenContainer({
   const theme = useTheme();
   const getThemeValue = React.useCallback(R.propOr(0, R.__, theme), [theme]);
 
+  React.useEffect(() => {
+    resetScreenLayout();
+  }, [currentRoute]);
+
   const fullscreen = React.useCallback(
     displayFullScreen({ currentRoute, screenData }),
     [currentRoute, screenData]

package/Components/Layout/TV/ScreenLayoutContextProvider.tsx

@@ -60,10 +60,15 @@ export function ScreenLayoutContextProvider(props: {
     initialState
   );
 
+  const resetScreenLayout = React.useCallback(() => {
+    setScreenLayout(initialState);
+  }, [initialState]);
+
   const screenLayoutValue = React.useMemo(
     () => ({
       ...screenLayout,
       setScreenLayout,
+      resetScreenLayout,
     }),
     [screenLayout]
   );

package/Components/Layout/TV/__tests__/ScreenContainer.test.tsx

@@ -56,11 +56,12 @@ describe("ScreenContainer", () => {
   };
 
   const setScreenLayout = () => {};
+  const resetScreenLayout = () => {};
 
   const wrapper = ({ children }) => (
     <WrappedWithProviders>
       <ScreenLayoutContext.Provider
-        value={{ ...screenLayout, setScreenLayout }}
+        value={{ ...screenLayout, setScreenLayout, resetScreenLayout }}
       >
         <ScreenContainer NavBar={View}>{children}</ScreenContainer>
       </ScreenLayoutContext.Provider>

package/Components/Layout/TV/__tests__/__snapshots__/NavBarContainer.test.tsx.snap

@@ -5,13 +5,14 @@ exports[`NavBarContainer renders 1`] = `
   style={
     [
       {
+        "flex": 1,
         "position": "absolute",
         "top": 0,
-        "width": 1920,
+        "width": "100%",
         "zIndex": 10,
       },
       {
-        "maxHeight": 10,
+        "maxHeight": 1,
       },
     ]
   }

package/Components/Layout/TV/__tests__/__snapshots__/ScreenContainer.test.tsx.snap

@@ -16,13 +16,14 @@ exports[`ScreenContainer renders 1`] = `
     style={
       [
         {
+          "flex": 1,
           "position": "absolute",
           "top": 0,
-          "width": 1920,
+          "width": "100%",
           "zIndex": 10,
         },
         {
-          "maxHeight": 10,
+          "maxHeight": 1,
         },
       ]
     }

package/Components/MasterCell/DefaultComponents/ActionButton.tsx

@@ -4,7 +4,6 @@ import { TouchableOpacity, ViewStyle } from "react-native";
 import { useActions } from "@applicaster/zapp-react-native-utils/reactHooks/actions";
 
 import Image from "./Image";
-
 type Props = {
   item: ZappEntry | ZappFeed;
   flavour?: "flavour_1" | "flavour_2";
@@ -69,7 +68,7 @@ export function ActionButton(props: Props) {
     if (!((actionDisabled || !actionContext) && actionState !== null)) {
       setActionState(actionContext.initialEntryState(item));
     }
-  }, [actionDisabled, item?.id, actionContext, action]);
+  }, [actionDisabled, item?.id, actionContext, action, setActionState]);
 
   const onPress = useCallback(() => {
     actionContext.invokeAction(item, {
@@ -85,7 +84,7 @@ export function ActionButton(props: Props) {
         setActionState(state);
       });
     }
-  }, [item?.id]);
+  }, [item?.id, setActionState, actionContext]);
 
   if (actionDisabled || !actionContext) return null;
   const AssetComponent = actionState?.asset;

package/Components/MasterCell/DefaultComponents/BorderContainerView/__tests__/index.test.tsx

@@ -0,0 +1,66 @@
+import {
+  BorderContainerView,
+  getBorderPadding, // Export for testing (using a double underscore prefix is a common convention)
+} from "../index";
+import * as React from "react";
+import { render } from "@testing-library/react-native";
+import { toNumberWithDefaultZero } from "@applicaster/zapp-react-native-utils/numberUtils";
+import { View } from "react-native";
+
+jest.mock("@applicaster/zapp-react-native-utils/numberUtils", () => ({
+  toNumberWithDefaultZero: jest.fn((value) => Number(value) || 0),
+}));
+
+describe("BorderContainerView", () => {
+  describe("getBorderPadding", () => {
+    it("returns 0 for inside", () => {
+      expect(getBorderPadding("inside", 10)).toBe(0);
+    });
+
+    it("returns borderWidth / 2 for center", () => {
+      expect(getBorderPadding("center", 10)).toBe(5);
+    });
+
+    it("returns borderWidth for outside", () => {
+      expect(getBorderPadding("outside", 10)).toBe(10);
+    });
+
+    it("returns borderWidth for invalid position", () => {
+      // @ts-ignore
+      expect(getBorderPadding("other_value", 10)).toBe(10);
+    });
+  });
+
+  it("Border component renders null if no borderPosition", () => {
+    const style = { borderWidth: 5, borderRadius: 10, borderColor: "red" };
+
+    const padding = {
+      paddingTop: 2,
+      paddingRight: 3,
+      paddingBottom: 4,
+      paddingLeft: 5,
+    };
+
+    const borderPosition = null;
+
+    const { queryByTestId } = render(
+      <BorderContainerView
+        style={style}
+        testID="border-container"
+        borderPosition={borderPosition}
+        borderPaddingTop={toNumberWithDefaultZero(padding.paddingTop)}
+        borderPaddingRight={toNumberWithDefaultZero(padding.paddingRight)}
+        borderPaddingBottom={toNumberWithDefaultZero(padding.paddingBottom)}
+        borderPaddingLeft={toNumberWithDefaultZero(padding.paddingLeft)}
+      >
+        <View testID="child" />
+      </BorderContainerView>
+    );
+
+    const children = queryByTestId("border-container").children;
+
+    expect(children[1].props.testID).toBe("child");
+
+    expect(children[0].children.length).toBe(0);
+  });
+});

package/Components/MasterCell/DefaultComponents/BorderContainerView/index.tsx

@@ -28,7 +28,10 @@ const styles = StyleSheet.create({
   },
 });
 
-const getBorderPadding = (borderPosition: BorderPosition, borderWidth) => {
+export const getBorderPadding = (
+  borderPosition: BorderPosition,
+  borderWidth: number
+) => {
   switch (borderPosition) {
     case "inside":
       return 0;

package/Components/MasterCell/DefaultComponents/Image/Image.ios.tsx

@@ -1,6 +1,6 @@
 import * as React from "react";
 import { Image as RnImage, ImageStyle } from "react-native";
-import * as R from "ramda";
+import { equals, omit } from "ramda";
 
 import { useImageSource } from "./hooks";
 
@@ -17,7 +17,7 @@ type Props = Record<string, any> & {
   withDimensions: (source: Source) => Source;
 };
 
-const MemoizedImage = React.memo(RnImage, R.equals);
+const MemoizedImage = React.memo(RnImage, equals);
 
 function Image({
   style,
@@ -38,23 +38,18 @@ function Image({
 
   const shouldRenderImg = source && !error;
 
-  // Default placeholder image fallback is empty string because it won't rerender
-  // in case of undefined or {uri: undefined} source
-  // https://github.com/facebook/react-native/issues/9195
-  const defaultPlaceHolderImage = React.useMemo(
-    () => ({ uri: placeholderImage || "" }),
-    [source, error]
-  );
+  const _source = shouldRenderImg
+    ? withDimensions(source)
+    : { uri: placeholderImage };
 
   return (
-    // @ts-ignore
     <MemoizedImage
+      key={_source?.uri || "no-image"}
       style={style as ImageStyle}
       onError={React.useCallback(() => setErrorState(true), [])}
-      source={
-        shouldRenderImg ? withDimensions(source) : defaultPlaceHolderImage
-      }
-      {...R.omit(["source"], otherProps)}
+      // as we have defaults as "" for placeholder image, we need to pass undefined to source to not throw warnings
+      source={_source?.uri ? _source : undefined}
+      {...omit(["source"], otherProps)}
     />
   );
 }

package/Components/MasterCell/DefaultComponents/Image/hooks/useImage.ts

@@ -1,5 +1,5 @@
 import * as React from "react";
-import * as R from "ramda";
+import { path } from "ramda";
 
 import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
 import { useActions } from "@applicaster/zapp-react-native-utils/reactHooks/actions";
@@ -7,9 +7,13 @@ import { extractAsset } from "./utils";
 
 type Return = { uri: string } | null;
 
+const getSourceContext = path(["source", "context"]);
+const getSourceUri = path(["source", "uri"]);
+const getState = path(["state"]);
+
 export const useImageSource = ({ uri, entry, otherProps }): Return => {
-  const uriContext = R.path(["source", "context"], otherProps);
-  const uriState = R.path(["state"], otherProps);
+  const uriContext = getSourceContext(otherProps);
+  const uriState = getState(otherProps);
 
   const action = useActions(uriContext);
 
@@ -34,7 +38,7 @@ export const useImageSource = ({ uri, entry, otherProps }): Return => {
     return { uri };
   }
 
-  const uriFromSource = R.path(["source", "uri"], otherProps);
+  const uriFromSource = getSourceUri(otherProps);
 
   if (uriFromSource) {
     return { uri: uriFromSource };
@@ -56,7 +60,7 @@ const getSource = (uri, showDefault, placeholderImage, otherProps) => {
     return { uri };
   }
 
-  const uriFromSource = R.path(["source", "uri"], otherProps);
+  const uriFromSource = getSourceUri(otherProps);
 
   if (uriFromSource) {
     return { uri: uriFromSource };
@@ -72,8 +76,8 @@ export const useImageSourceWithDefault = ({
   placeholderImage,
   otherProps,
 }): Return => {
-  const uriContext = R.path(["source", "context"], otherProps);
-  const uriState = R.path(["state"], otherProps);
+  const uriContext = getSourceContext(otherProps);
+  const uriState = getState(otherProps);
 
   const action = useActions(uriContext);