@applicaster/zapp-react-native-ui-components 13.0.0-alpha.8357105823 → 13.0.0-alpha.8432878190

package/Components/BaseFocusable/index.ios.ts

@@ -25,7 +25,7 @@ type Props = {
 };
 
 export class BaseFocusable<
-  T extends Props = Props
+  T extends Props = Props,
 > extends BaseFocusableInterface<T> {
   constructor(props) {
     super(props);

package/Components/BaseFocusable/index.tsx

@@ -35,7 +35,7 @@ type Props = {
 };
 
 export class BaseFocusable<
-  T extends Props = Props
+  T extends Props = Props,
 > extends BaseFocusableInterface<T> {
   constructor(props) {
     super(props);

package/Components/Cell/Cell.tsx

@@ -273,10 +273,14 @@ export class CellComponent extends React.Component<Props, State> {
             if (isFocused) {
               const accessibilityManager = AccessibilityManager.getInstance();
 
+              const accessibilityTitle =
+                item?.extensions?.accessibility?.label || item?.title || "";
+
+              const accessibilityHint =
+                item?.extensions?.accessibility?.hint || "";
+
               accessibilityManager.readText({
-                text: String(
-                  item.extensions?.accessibility?.label || item.title
-                ),
+                text: `${accessibilityTitle} ${accessibilityHint}`,
               });
             }
 

package/Components/Cell/CellWithFocusable.ios.tsx

@@ -0,0 +1,126 @@
+/** TODO: Remove this file when tvos FocusableGroup
+ * behaviour is aligned to the web one
+ * FocusableGroup should only send onFocus and onBlur events when
+ * Focus enters and leaves the Focusables inside the branch
+ */
+import * as React from "react";
+
+import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
+import * as FOCUS_EVENTS from "@applicaster/zapp-react-native-utils/appUtils/focusManager/events";
+import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
+import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
+
+import { isAppleTV } from "../../Helpers/Platform";
+import { useCellState } from "../MasterCell/utils";
+
+const useCellFocusedState = (
+  skipFocusManagerRegistration: boolean,
+  groupId: string,
+  id: string
+) => {
+  const [currentCellFocused, setCurrentCellFocused] = React.useState(false);
+
+  React.useEffect(() => {
+    const isGroupItemFocused = () => {
+      if (!skipFocusManagerRegistration) {
+        const isFocused = focusManager.isGroupItemFocused(groupId, id);
+        setCurrentCellFocused(isFocused);
+      }
+    };
+
+    const handler = () => {
+      // tvOS hack for properly checking focus
+      if (isAppleTV()) {
+        setTimeout(() => {
+          isGroupItemFocused();
+        }, 0);
+      } else {
+        isGroupItemFocused();
+      }
+    };
+
+    focusManager.on(FOCUS_EVENTS.FOCUS, handler);
+
+    return () => {
+      focusManager.removeHandler(FOCUS_EVENTS.FOCUS, handler);
+    };
+  }, [groupId, skipFocusManagerRegistration]);
+
+  return currentCellFocused;
+};
+
+type Props = {
+  item: ZappEntry;
+  CellRenderer: React.FunctionComponent<any>;
+  id: string;
+  groupId: string;
+  onFocus: Function;
+  index: number;
+  scrollTo: Function;
+  preferredFocus?: boolean;
+  skipFocusManagerRegistration?: boolean;
+  isFocusable?: boolean;
+  behavior: Behavior;
+  focused?: boolean;
+};
+
+export function CellWithFocusable(props: Props) {
+  const {
+    index,
+    item,
+    CellRenderer,
+    id,
+    groupId,
+    onFocus,
+    scrollTo = noop,
+    preferredFocus,
+    skipFocusManagerRegistration,
+    isFocusable,
+    behavior,
+    focused,
+  } = props;
+
+  const isFocused = useCellFocusedState(
+    skipFocusManagerRegistration,
+    groupId,
+    id
+  );
+
+  const state = useCellState({
+    id: item.id,
+    behavior,
+    focused: isFocused || toBooleanWithDefaultFalse(focused),
+  });
+
+  const [focusedButtonId, setFocusedButtonId] = React.useState(undefined);
+
+  // for horizontal scrolling
+  React.useEffect(() => {
+    if (focusedButtonId) {
+      scrollTo(index);
+    }
+  }, [focusedButtonId]);
+
+  const handleToggleFocus = (value) => {
+    setFocusedButtonId(value.focusedButtonId);
+
+    if (value.focusable) {
+      onFocus(value.focusable, value.mouse);
+    }
+  };
+
+  return (
+    <CellRenderer
+      item={item}
+      groupId={groupId}
+      onToggleFocus={handleToggleFocus}
+      state={state}
+      prefixId={id}
+      focusedButtonId={focusedButtonId}
+      preferredFocus={preferredFocus}
+      skipFocusManagerRegistration={skipFocusManagerRegistration}
+      isFocusable={isFocusable}
+      focused={focused}
+    />
+  );
+}

package/Components/Cell/CellWithFocusable.tsx

@@ -1,48 +1,10 @@
 import * as React from "react";
 
-import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
-import * as FOCUS_EVENTS from "@applicaster/zapp-react-native-utils/appUtils/focusManager/events";
 import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
 import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
 
-import { isAppleTV } from "../../Helpers/Platform";
 import { useCellState } from "../MasterCell/utils";
-
-const useCellFocusedState = (
-  skipFocusManagerRegistration: boolean,
-  groupId: string,
-  id: string
-) => {
-  const [currentCellFocused, setCurrentCellFocused] = React.useState(false);
-
-  React.useEffect(() => {
-    const isGroupItemFocused = () => {
-      if (!skipFocusManagerRegistration) {
-        const isFocused = focusManager.isGroupItemFocused(groupId, id);
-        setCurrentCellFocused(isFocused);
-      }
-    };
-
-    const handler = () => {
-      // tvOS hack for properly checking focus
-      if (isAppleTV()) {
-        setTimeout(() => {
-          isGroupItemFocused();
-        }, 0);
-      } else {
-        isGroupItemFocused();
-      }
-    };
-
-    focusManager.on(FOCUS_EVENTS.FOCUS, handler);
-
-    return () => {
-      focusManager.removeHandler(FOCUS_EVENTS.FOCUS, handler);
-    };
-  }, [groupId, skipFocusManagerRegistration]);
-
-  return currentCellFocused;
-};
+import { FocusableGroup } from "../FocusableGroup";
 
 type Props = {
   item: ZappEntry;
@@ -75,11 +37,7 @@ export function CellWithFocusable(props: Props) {
     focused,
   } = props;
 
-  const isFocused = useCellFocusedState(
-    skipFocusManagerRegistration,
-    groupId,
-    id
-  );
+  const [isFocused, setIsFocused] = React.useState(false);
 
   const state = useCellState({
     id: item.id,
@@ -96,26 +54,52 @@ export function CellWithFocusable(props: Props) {
     }
   }, [focusedButtonId]);
 
-  const handleToggleFocus = (value) => {
-    setFocusedButtonId(value.focusedButtonId);
+  const handleToggleFocus = React.useCallback(
+    (value) => {
+      setFocusedButtonId(value.focusedButtonId);
+
+      if (value.focusable) {
+        onFocus(value.focusable, value.mouse);
+      }
+    },
+    [onFocus]
+  );
+
+  const onGroupFocus = React.useCallback(() => {
+    if (!skipFocusManagerRegistration) {
+      setIsFocused(true);
+    }
+  }, [skipFocusManagerRegistration]);
 
-    if (value.focusable) {
-      onFocus(value.focusable, value.mouse);
+  const onGroupBlur = React.useCallback(() => {
+    if (!skipFocusManagerRegistration) {
+      setIsFocused(false);
     }
-  };
+  }, [skipFocusManagerRegistration]);
 
   return (
-    <CellRenderer
-      item={item}
+    <FocusableGroup
+      id={`focusable-cell-wrapper-${id}`}
+      testID={"cell-with-focusable-cell-renderer-focusable-group"}
       groupId={groupId}
-      onToggleFocus={handleToggleFocus}
-      state={state}
-      prefixId={id}
-      focusedButtonId={focusedButtonId}
       preferredFocus={preferredFocus}
-      skipFocusManagerRegistration={skipFocusManagerRegistration}
-      isFocusable={isFocusable}
-      focused={focused}
-    />
+      shouldUsePreferredFocus
+      onFocus={onGroupFocus}
+      onBlur={onGroupBlur}
+    >
+      <CellRenderer
+        testID={"cell-with-focusable-cell-renderer"}
+        item={item}
+        groupId={`focusable-cell-wrapper-${id}`}
+        onToggleFocus={handleToggleFocus}
+        state={state}
+        prefixId={id}
+        focusedButtonId={focusedButtonId}
+        preferredFocus={true}
+        skipFocusManagerRegistration={skipFocusManagerRegistration}
+        isFocusable={isFocusable}
+        focused={focused}
+      />
+    </FocusableGroup>
   );
 }

package/Components/Cell/__tests__/CellWIthFocusable.test.js

@@ -1,7 +1,7 @@
 import { View } from "react-native";
 import React from "react";
 import { act, render } from "@testing-library/react-native";
-import { CellWithFocusable } from "../CellWithFocusable";
+import { CellWithFocusable } from "../CellWithFocusable.tsx";
 
 import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
 
@@ -23,7 +23,9 @@ describe("CellWithFocusable", () => {
 
     const wrapper = renderWith(props);
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("default");
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
+
+    expect(element.props.state).toBe("default");
   });
 
   it("should render in default state", () => {
@@ -40,8 +42,9 @@ describe("CellWithFocusable", () => {
     focusManager.isGroupItemFocused = jest.fn(() => true);
 
     const wrapper = renderWith(props);
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("default");
+    expect(element.props.state).toBe("default");
   });
 
   it("should render in focused state", () => {
@@ -55,13 +58,17 @@ describe("CellWithFocusable", () => {
       scrollTo: jest.fn(),
     };
 
-    focusManager.isGroupItemFocused = jest.fn(() => true);
     const wrapper = renderWith(props);
 
+    const focusableGroupComponent = wrapper.getByTestId(
+      "cell-with-focusable-cell-renderer-focusable-group"
+    );
+
     act(() => {
-      focusManager.on.mock.calls[focusManager.on.mock.calls.length - 1][1]();
+      focusableGroupComponent.props.onFocus();
     });
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("focused");
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
+    expect(element.props.state).toBe("focused");
   });
 });

package/Components/ErrorScreen/index.tsx

@@ -1,13 +1,13 @@
 import React, { useMemo } from "react";
 import * as R from "ramda";
 import {
-  View,
+  ImageStyle,
   StyleSheet,
   Text,
-  ViewStyle,
-  TextStyle,
-  ImageStyle,
   TextProps,
+  TextStyle,
+  View,
+  ViewStyle,
 } from "react-native";
 import { defaultAsset } from "./defaultAsset";
 import { platformSelect } from "@applicaster/zapp-react-native-utils/reactUtils";
@@ -150,13 +150,13 @@ export function ErrorScreen(props: Props) {
   return (
     <View style={[baseStyles.container, styles.screen]}>
       <View style={[baseStyles.container, styles.component]}>
-        {assetEnabled && (
+        {assetEnabled ? (
           <Image
             fadeDuration={0}
             source={{ uri: asset }}
             style={styles.asset}
           />
-        )}
+        ) : null}
         <Text style={styles.title} {...titleProps}>
           {title}
         </Text>

package/Components/Focusable/Focusable.tsx

@@ -1,3 +1,4 @@
+/* eslint-disable react/no-unknown-property */
 import * as React from "react";
 
 import { BaseFocusable } from "../BaseFocusable";

package/Components/Focusable/Touchable.tsx

@@ -1,25 +1,24 @@
 import * as React from "react";
 
-type Props =
-  | {
-      id: string;
-      children: React.ReactNode;
-      onPress?: (ref: FocusManager.TouchableRef) => void;
-      onPressIn?: (ref: FocusManager.TouchableRef) => void;
-      onPressOut?: (ref: FocusManager.TouchableRef) => void;
-      onLongPress?: (ref: FocusManager.TouchableRef) => void;
-      onFocus?: (
-        ref: FocusManager.TouchableRef,
-        options: FocusManager.Android.CallbackOptions
-      ) => void;
-      onBlur?: (
-        ref: FocusManager.TouchableRef,
-        options: FocusManager.Android.CallbackOptions
-      ) => void;
-
-      disableFocus?: boolean;
-      blockFocus?: boolean;
-    } & Partial<ParentFocus>;
+type Props = {
+  id: string;
+  children: React.ReactNode;
+  onPress?: (ref: FocusManager.TouchableRef) => void;
+  onPressIn?: (ref: FocusManager.TouchableRef) => void;
+  onPressOut?: (ref: FocusManager.TouchableRef) => void;
+  onLongPress?: (ref: FocusManager.TouchableRef) => void;
+  onFocus?: (
+    ref: FocusManager.TouchableRef,
+    options: FocusManager.Android.CallbackOptions
+  ) => void;
+  onBlur?: (
+    ref: FocusManager.TouchableRef,
+    options: FocusManager.Android.CallbackOptions
+  ) => void;
+
+  disableFocus?: boolean;
+  blockFocus?: boolean;
+} & Partial<ParentFocus>;
 
 export class Touchable extends React.Component<Props> {
   onPress(focusableRef: FocusManager.TouchableRef): void {

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

@@ -38,22 +38,16 @@ 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
       style={style as ImageStyle}
       onError={React.useCallback(() => setErrorState(true), [])}
-      source={
-        shouldRenderImg ? withDimensions(source) : defaultPlaceHolderImage
-      }
+      // as we have defaults as "" for placeholder image, we need to pass undefined to source to not throw warnings
+      source={_source?.uri ? _source : undefined}
       {...R.omit(["source"], otherProps)}
     />
   );

package/Components/MasterCell/DefaultComponents/ImageBorderContainer/__tests__/index.test.ts

@@ -0,0 +1,93 @@
+import { ImageBorderContainer } from "../index";
+import { getImageContainerMarginStyles } from "@applicaster/zapp-react-native-utils/cellUtils";
+
+const mockValue = (key) => {
+  const values = {
+    cell_padding_top: 1,
+    cell_padding_left: 2,
+    cell_padding_right: 3,
+    cell_padding_bottom: 4,
+    image_border_size: 5,
+    image_focused_border_color: "red",
+    image_selected_border_color: "blue",
+    image_focused_selected_border_color: "green",
+    image_border_color: "black",
+    image_corner_radius: 10,
+    image_border_position: "outside",
+    image_border_padding_top: 6,
+    image_border_padding_right: 7,
+    image_border_padding_bottom: 8,
+    image_border_padding_left: 9,
+    image_margin_top: 11,
+    image_margin_left: 12,
+    image_margin_right: 13,
+    image_margin_bottom: 14,
+  };
+
+  return values[key] || 0;
+};
+
+describe("ImageBorderContainer", () => {
+  it("calculates style properties correctly", () => {
+    const marginStyles = getImageContainerMarginStyles({ value: mockValue });
+
+    expect(marginStyles.marginTop).toBe(11);
+    expect(marginStyles.marginLeft).toBe(12);
+    expect(marginStyles.marginRight).toBe(13);
+    expect(marginStyles.marginBottom).toBe(14);
+
+    const props = {
+      value: mockValue,
+      state: "default",
+      imageStyles: {},
+    };
+
+    const result = ImageBorderContainer(props);
+
+    expect(result.style.marginTop).toBe(12); // 11 + 1
+    expect(result.style.marginLeft).toBe(14); // 12 + 2
+    expect(result.style.marginRight).toBe(16); // 13 + 3
+    expect(result.style.marginBottom).toBe(18); // 14 + 4
+    expect(result.style.borderWidth).toBe(5);
+    expect(result.style.borderColor).toBe("black");
+    expect(result.style.borderRadius).toBe(10);
+    expect(result.additionalProps.borderPosition).toBe("outside");
+    expect(result.additionalProps.borderPaddingTop).toBe(6);
+    expect(result.additionalProps.borderPaddingRight).toBe(7);
+    expect(result.additionalProps.borderPaddingBottom).toBe(8);
+    expect(result.additionalProps.borderPaddingLeft).toBe(9);
+  });
+
+  it("handles focused state correctly", () => {
+    const props = {
+      value: mockValue,
+      state: "focused",
+      imageStyles: {},
+    };
+
+    const result = ImageBorderContainer(props);
+    expect(result.style.borderColor).toBe("red");
+  });
+
+  it("handles selected state correctly", () => {
+    const props = {
+      value: mockValue,
+      state: "selected",
+      imageStyles: {},
+    };
+
+    const result = ImageBorderContainer(props);
+    expect(result.style.borderColor).toBe("blue");
+  });
+
+  it("handles focused and selected state correctly", () => {
+    const props = {
+      value: mockValue,
+      state: "focused_selected",
+      imageStyles: {},
+    };
+
+    const result = ImageBorderContainer(props);
+    expect(result.style.borderColor).toBe("green");
+  });
+});

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

@@ -244,7 +244,7 @@ const LiveImageComponent = (props: LiveImageProps) => {
   return (
     <>
       <Image {...props} applyMaxSize />
-      {isShouldRender && (
+      {isShouldRender ? (
         <View style={[style, positionAbsolute]}>
           <PlayerLiveImage
             uri={props.uri}
@@ -257,7 +257,7 @@ const LiveImageComponent = (props: LiveImageProps) => {
             audioMutedByDefault={audio_muted_by_default}
           />
         </View>
-      )}
+      ) : null}
     </>
   );
 };

package/Components/MasterCell/DefaultComponents/SecondaryImage/utils.ts

@@ -17,7 +17,7 @@ const SECONDARY_IMAGE_PREFIX = "secondary_image";
 
 type ImageSizing = typeof IMAGE_SIZING_FIT | typeof IMAGE_SIZING_FILL;
 
-type ImagePosition = typeof IMAGE_POSITION[keyof typeof IMAGE_POSITION];
+type ImagePosition = (typeof IMAGE_POSITION)[keyof typeof IMAGE_POSITION];
 
 export type DisplayMode =
   | typeof DISPLAY_MODE_FIXED

package/Components/MasterCell/DefaultComponents/__tests__/image.test.js

@@ -39,6 +39,6 @@ describe("image with no source", () => {
     );
 
     const testInstance = testRenderer.root;
-    expect(testInstance.findByType(Image).props.source).toEqual({ uri: "" });
+    expect(testInstance.findByType(Image).props.source).toBeUndefined();
   });
 });