@applicaster/zapp-react-native-ui-components 12.0.3-rc.2 → 13.0.0-alpha.1338463240

package/Components/BaseFocusable/index.tsx

@@ -1,5 +1,4 @@
 import * as React from "react";
-import * as R from "ramda";
 
 import {
   BaseFocusable as BaseFocusableInterface,
@@ -8,6 +7,7 @@ import {
 
 import { createReactRef } from "@applicaster/zapp-react-native-utils/reactUtils";
 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";
 
 type ScrollDirection = FocusManager.IOS.Direction | FocusManager.Web.Direction;
@@ -131,6 +131,12 @@ export class BaseFocusable<
   willLoseFocus: FocusManager.FocusEventCB = (focusable, scrollDirection) => {
     const { willLoseFocus = noop } = this.props;
     willLoseFocus(focusable, scrollDirection);
+
+    focusManager.invokeHandler?.(
+      FOCUS_EVENTS.WILL_LOSE_FOCUS,
+      this,
+      scrollDirection
+    );
   };
 
   willReceiveFocus: FocusManager.FocusEventCB = (
@@ -139,6 +145,12 @@ export class BaseFocusable<
   ) => {
     const { willReceiveFocus = noop } = this.props;
     willReceiveFocus(focusable, scrollDirection);
+
+    focusManager.invokeHandler?.(
+      FOCUS_EVENTS.WILL_RECEIVE_FOCUS,
+      this,
+      scrollDirection
+    );
   };
 
   /**
@@ -151,6 +163,8 @@ export class BaseFocusable<
     const { onFocus = noop } = this.props;
     this.setFocusedState(true);
     onFocus(focusable, scrollDirection);
+
+    focusManager.invokeHandler?.(FOCUS_EVENTS.FOCUS, this, scrollDirection);
   };
 
   /**
@@ -165,6 +179,12 @@ export class BaseFocusable<
   ) => {
     const { hasReceivedFocus = noop } = this.props;
     hasReceivedFocus(focusable, scrollDirection);
+
+    focusManager.invokeHandler?.(
+      FOCUS_EVENTS.HAS_RECEIVED_FOCUS,
+      this,
+      scrollDirection
+    );
   };
 
   /**
@@ -176,6 +196,12 @@ export class BaseFocusable<
   hasLostFocus: FocusManager.FocusEventCB = (focusable, scrollDirection) => {
     const { hasLostFocus = noop } = this.props;
     hasLostFocus(focusable, scrollDirection);
+
+    focusManager.invokeHandler?.(
+      FOCUS_EVENTS.HAS_LOST_FOCUS,
+      this,
+      scrollDirection
+    );
   };
 
   /**
@@ -202,6 +228,7 @@ export class BaseFocusable<
     const { onBlur = noop } = this.props;
     this.setFocusedState(false);
     onBlur(focusable, scrollDirection);
+    focusManager.invokeHandler?.(FOCUS_EVENTS.BLUR, this, scrollDirection);
   };
 
   onPress = (keyEvent?: Nullable<React.MouseEvent>) => {
@@ -242,68 +269,4 @@ export class BaseFocusable<
       this.setState({ focused });
     }
   };
-
-  /**
-   * will invoke the underlying component's focus method
-   * @param {Object} scrollDirection
-   * @returns {Promise}
-   */
-  focus(_, scrollDirection) {
-    return this.onFocus(this, scrollDirection); // invokeComponentMethod(this, "onFocus", scrollDirection);
-  }
-
-  /**
-   * will invoke the underlying component's blur method
-   * @param {Object} scrollDirection
-   * @returns {Promise}
-   */
-  blur(
-    _,
-    scrollDirection?: FocusManager.Web.Direction | FocusManager.IOS.Direction
-  ) {
-    return this.onBlur(this, scrollDirection);
-  }
-
-  /**
-   * Sets the focus on this item. Will trigger sequentially a sequence of
-   * functions (willReceiveFocus, focus, hasReceivedFocus). If these functions (defined in the Focusable
-   * Item underlying component) return promises, execution will wait before it proceeds to the next. This
-   * is useful for triggering sequential operations that specifically require to fully run before or after
-   * focus is actually set on that item.
-   * @param {string} scrollDirection string representation of the direction of the navigation which landed
-   * to this item being focused
-   */
-  _executeFocusSequence(methodNames, scrollDirection) {
-    return R.reduce(
-      (sequence, methodName) => {
-        const method = this[methodName]; // Access the method by name
-
-        if (typeof method !== "function") {
-          throw new Error(
-            `Method '${methodName}' not found or not a function.`
-          );
-        }
-
-        return sequence
-          .then(() => method.call(this, scrollDirection))
-          .catch((e) => {
-            throw e; // Re-throw for consistent error handling
-          });
-      },
-      Promise.resolve(),
-      methodNames
-    );
-  }
-
-  setFocus(scrollDirection) {
-    const focusMethods = ["willReceiveFocus", "focus", "hasReceivedFocus"];
-
-    return this._executeFocusSequence(focusMethods, scrollDirection);
-  }
-
-  setBlur(scrollDirection) {
-    const blurMethods = ["willLoseFocus", "blur", "hasLostFocus"];
-
-    return this._executeFocusSequence(blurMethods, scrollDirection);
-  }
 }

package/Components/Cell/Cell.tsx

@@ -14,10 +14,7 @@ import { BaseFocusable } from "../BaseFocusable";
 import { AccessibilityManager } from "@applicaster/zapp-react-native-utils/appUtils/accessibilityManager";
 
 type Props = {
-  item: {
-    id: string;
-    title: string;
-  };
+  item: ZappEntry;
   index: number;
   shouldScrollHorizontally: (arg1: [any]) => boolean | null | undefined;
   shouldScrollVertically: (...args: any) => boolean | null | undefined;
@@ -33,10 +30,9 @@ type Props = {
     id: string;
   };
   selected?: boolean;
-  CellRenderer: React.ComponentType<{
-    item: any;
-    state: string;
-  }> & { hasFocusableInside: (item: Record<string, string>) => boolean };
+  CellRenderer: React.FunctionComponent<any> & {
+    hasFocusableInside: (item: ZappEntry) => boolean;
+  };
   preferredFocus: boolean;
   navigator: {
     push: (arg1: Record<any, any>) => void;

package/Components/Cell/CellWithFocusable.tsx

@@ -46,7 +46,7 @@ const useCellFocusedState = (
 
 type Props = {
   item: ZappEntry;
-  CellRenderer: React.ComponentType<{ item: Object; state: string }>;
+  CellRenderer: React.FunctionComponent<any>;
   id: string;
   groupId: string;
   onFocus: Function;

package/Components/Cell/TvOSCellComponent.tsx

@@ -2,7 +2,7 @@ import * as React from "react";
 import * as R from "ramda";
 import { View, StyleSheet } from "react-native";
 
-import { Focusable } from "@applicaster/zapp-react-native-ui-components/Components/Focusable";
+import { Focusable } from "@applicaster/zapp-react-native-ui-components/Components/Focusable/FocusableTvOS";
 import { FocusableCell } from "@applicaster/zapp-react-native-ui-components/Components/FocusableCell";
 import { getItemType } from "@applicaster/zapp-react-native-utils/navigationUtils";
 import { SCREEN_TYPES } from "@applicaster/zapp-react-native-utils/navigationUtils/itemTypes";
@@ -36,10 +36,9 @@ type Props = {
     component_type: string;
   };
   selected: boolean;
-  CellRenderer: React.ComponentType<{
-    item: any;
-    state: string;
-  }> & { hasFocusableInside: (item: any) => boolean };
+  CellRenderer: React.FunctionComponent<any> & {
+    hasFocusableInside: (item: any) => boolean;
+  };
   preferredFocus: boolean;
   navigator: {
     push: (arg1: Record<any, any>) => void;
@@ -252,7 +251,7 @@ export class TvOSCellComponent extends React.Component<Props, State> {
 
     const focusableId = R.join("-", [component?.id, id, index]);
 
-    const handleFocus = (arg1: any, index: number) => {
+    const handleFocus = (arg1: any, index?: number) => {
       const focusFn = onFocus || noop;
       focusFn(arg1, index);
 
@@ -285,7 +284,7 @@ export class TvOSCellComponent extends React.Component<Props, State> {
       <View onLayout={this.onLayout} style={styles.container}>
         <Focusable
           id={focusableId}
-          groupId={groupId || component?.id}
+          groupId={(groupId || component?.id).toString()}
           onFocus={handleFocus}
           onBlur={onBlur || this.onBlur}
           isParallaxDisabled={this.layout?.width > 1740}
@@ -304,7 +303,7 @@ export class TvOSCellComponent extends React.Component<Props, State> {
                   index,
                   CellRenderer,
                   item,
-                  focused: this.props.focused || selectedCell || focused,
+                  focused: !!(this.props.focused || selectedCell || focused),
                   scrollTo: this.scrollTo,
                   behavior,
                 }}

package/Components/Focusable/Focusable.tsx

@@ -1,4 +1,5 @@
 import * as React from "react";
+import * as R from "ramda";
 
 import { BaseFocusable } from "../BaseFocusable";
 import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
@@ -41,6 +42,8 @@ class Focusable extends BaseFocusable<Props> {
     this.resetLongPressTimeout = this.resetLongPressTimeout.bind(this);
     this.longPress = this.longPress.bind(this);
     this.press = this.press.bind(this);
+    this.focus = this.focus.bind(this);
+    this.blur = this.blur.bind(this);
   }
 
   /**
@@ -52,6 +55,37 @@ class Focusable extends BaseFocusable<Props> {
     return this.preferredFocus();
   }
 
+  /**
+   * Sets the focus on this item. Will trigger sequentially a sequence of
+   * functions (willReceiveFocus, focus, hasReceivedFocus). If these functions (defined in the Focusable
+   * Item underlying component) return promises, execution will wait before it proceeds to the next. This
+   * is useful for triggering sequential operations that specifically require to fully run before or after
+   * focus is actually set on that item.
+   * @param {string} scrollDirection string representation of the direction of the navigation which landed
+   * to this item being focused
+   */
+  setFocus(scrollDirection) {
+    const focusMethods = [
+      this.willReceiveFocus,
+      this.focus,
+      this.hasReceivedFocus,
+    ];
+
+    const self = this;
+
+    return R.reduce(
+      (sequence, method) => {
+        return sequence
+          .then(() => method.apply(self, [scrollDirection]))
+          .catch((e) => {
+            throw e;
+          });
+      },
+      Promise.resolve(),
+      focusMethods
+    );
+  }
+
   startLongPressTimeout() {
     this.longPressTimeout = setTimeout(() => {
       this.longPress(null);
@@ -68,6 +102,26 @@ class Focusable extends BaseFocusable<Props> {
     }
   }
 
+  /**
+   * will invoke the underlying component's focus method
+   * @param {Object} scrollDirection
+   * @returns {Promise}
+   */
+  focus(scrollDirection) {
+    return this.onFocus(this, scrollDirection); // invokeComponentMethod(this, "onFocus", scrollDirection);
+  }
+
+  /**
+   * will invoke the underlying component's blur method
+   * @param {Object} scrollDirection
+   * @returns {Promise}
+   */
+  blur(
+    scrollDirection?: FocusManager.Web.Direction | FocusManager.IOS.Direction
+  ) {
+    return this.onBlur(this, scrollDirection);
+  }
+
   /**
    * will invoke the underlying component's press method
    * @param {Object} keyEvent

package/Components/Focusable/FocusableTvOS.tsx

@@ -16,6 +16,8 @@ function noop() {}
 type Props = {
   id: string;
   groupId: string;
+  willReceiveFocus?: (nativeEvent: React.SyntheticEvent) => void;
+  hasReceivedFocus?: (nativeEvent: React.SyntheticEvent) => void;
   onPress?: (nativeEvent: React.SyntheticEvent) => void;
   onFocus?: (nativeEvent: React.SyntheticEvent) => void;
   onBlur?: (nativeEvent: React.SyntheticEvent) => void;
@@ -35,6 +37,8 @@ type Props = {
   forceFocus?: boolean;
   initialFocus?: boolean;
   onLayout?: (e: any) => void;
+  offsetUpdater: (arg1: string, arg2: number) => number;
+  style: any;
 };
 
 export class Focusable extends BaseFocusable<Props> {

package/Components/FocusableList/index.tsx

@@ -15,6 +15,7 @@ import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
 
 import { useParentFocus, useCheckItemIdsForUnique } from "./hooks";
 import { FocusableListItemWrapper } from "./FocusableListItemWrapper";
+import { FocusableScrollView } from "../FocusableScrollView";
 
 const mapIndexed = R.addIndex(R.map);
 
@@ -54,6 +55,7 @@ export type Props<ItemT> = FlatListProps<ItemT> & {
   disableNextFocusUp?: boolean;
   disableNextFocusLeft?: boolean;
   disableNextFocusRight?: boolean;
+  useScrollView?: boolean;
 } & ParentFocus;
 
 function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
@@ -89,6 +91,7 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
     // eslint-disable-next-line unused-imports/no-unused-vars
     onAllComponentsLoaded, // TODO: re-implement it
     omitPropsPropagation = [],
+    useScrollView = false,
   } = props;
 
   useCheckItemIdsForUnique({ componentId: props.id, items: data });
@@ -274,6 +277,7 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
         "initialFocusDirection",
         "withStateMemory",
         "useSequentialLoading",
+        "useScrollView",
         ...omitPropsPropagation,
       ],
       R.__
@@ -296,15 +300,27 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
   return (
     // @ts-ignore
     <ChildrenFocusDeactivatorView flex={1}>
-      <FlatList
-        focusable={false}
-        scrollEnabled={false}
-        ref={ref}
-        {...getFlatListProps(props)}
-        renderItem={renderItem}
-        onEndReached={onEndReached}
-        initialNumToRender={initialNumToRender}
-      />
+      {useScrollView ? (
+        <FocusableScrollView
+          ref={ref}
+          {...getFlatListProps(props)}
+          onEndReached={onEndReached}
+          initialNumToRender={initialNumToRender}
+          renderItem={renderItem}
+          focused={focused}
+          data={data}
+        />
+      ) : (
+        <FlatList
+          focusable={false}
+          scrollEnabled={false}
+          ref={ref}
+          {...getFlatListProps(props)}
+          renderItem={renderItem}
+          onEndReached={onEndReached}
+          initialNumToRender={initialNumToRender}
+        />
+      )}
     </ChildrenFocusDeactivatorView>
   );
 }

package/Components/FocusableScrollView/index.tsx

@@ -11,6 +11,13 @@ import {
   useInitialFocus,
 } from "@applicaster/zapp-react-native-utils/focusManager";
 
+export type FocusableScrollViewRenderItem = (info: {
+  item: ZappUIComponent;
+  index: number;
+  focused: boolean;
+  parentFocus: ParentFocus;
+}) => React.ReactElement;
+
 export type Props = ScrollViewProps & {
   id?: number | string;
   horizontal?: boolean;
@@ -32,17 +39,27 @@ export type Props = ScrollViewProps & {
   initialFocusDirection?: FocusManager.Android.FocusNavigationDirections;
   onAllComponentsLoaded?: () => void;
   omitPropsPropagation?: Array<keyof FlatListProps<any>>;
-  renderItem: (info: {
-    item: ZappUIComponent;
-    index: number;
-    focused: boolean;
-    parentFocus: ParentFocus;
-  }) => React.ReactElement;
+  renderItem: FocusableScrollViewRenderItem;
 } & ParentFocus;
 
 type State = boolean[];
 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 {
+  let entry;
+
+  if (R.isNil(index)) {
+    entry = unwrapArray(data);
+  } else if (typeof index === "number") {
+    entry = unwrapArray(data[index]);
+  }
+
+  return entry;
+}
+
 const focusableStateReducer = (
   state: State,
   { index = null, isFocusable, type = null }: Action
@@ -73,7 +90,7 @@ const extendScrollViewRef = (_ref, childCompsMeasurementsMap) => {
   };
 
   _ref.scrollToIndex = (params) => {
-    const { index, viewOffset } = params;
+    const { index, viewOffset = 0 } = params;
 
     const itemByIndex = R.find(R.propEq("index", index))(
       R.values(childCompsMeasurementsMap)
@@ -129,8 +146,11 @@ function FocusableScrollViewComponent(props: Props, ref) {
   );
 
   const getFocusableEntryId = React.useCallback(
-    (_entry: ZappEntry, index?: number) => {
-      const entry = R.isNil(index) ? _entry : data[index];
+    (_entry: ZappEntry | null, index?: number) => {
+      const entry: { id?: string } = getEntry(
+        R.isNil(index) ? _entry : data,
+        index
+      );
 
       return entry ? `${props.id}--${entry?.id}` : undefined;
     },
@@ -273,11 +293,18 @@ function FocusableScrollViewComponent(props: Props, ref) {
   const renderItem = React.useCallback(
     (item, index) => {
       const renderArgs = { item, index };
-      const id = `${props.id}--${renderArgs?.item?.id}`;
-      const nextFocus = getNextFocus(renderArgs?.index);
+
+      const id = getFocusableEntryId(
+        Array.isArray(item) ? item[0] : item,
+        index
+      );
+
+      const nextFocus = getNextFocus(index);
 
       const onItemLayout = (event) => {
-        childCompsMeasurementsMap.current[item.id] = {
+        childCompsMeasurementsMap.current[
+          Array.isArray(item) ? index : item.id
+        ] = {
           index,
           layout: event.nativeEvent.layout,
         };

package/Components/NativeFocusables/{index.js → index.ts}

@@ -1,10 +1,12 @@
 import { requireNativeComponent, View } from "react-native";
 import { isAppleTV } from "@applicaster/zapp-react-native-ui-components/Helpers/Platform";
 
+// @TODO define the types
 export const FocusableGroupNative = isAppleTV()
-  ? requireNativeComponent("FocusableGroupViewModule", null)
+  ? requireNativeComponent<any>("FocusableGroupViewModule")
   : View;
 
+// @TODO define the types
 export const FocusableItemNative = isAppleTV()
-  ? requireNativeComponent("FocusableViewModule", null)
+  ? requireNativeComponent<any>("FocusableViewModule")
   : View;

package/Decorators/Analytics/{index.js → index.tsx}

@@ -5,18 +5,18 @@ import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
 
 type ComponentProps = {
   component: {
-    id: string,
-    rules: { item_limit: number, component_cells_selectable: boolean },
-    component_type: string,
+    id: string;
+    rules: { item_limit: number; component_cells_selectable: boolean };
+    component_type: string;
     styles: {
-      cell_style: string,
-      header: { visible: boolean },
-      component_cells_selectable: boolean,
-    },
-  },
-  zappPipesData: { url: string, data: { title: string } },
-  selected: boolean,
-  assets: { menu_button: string },
+      cell_style: string;
+      header: { visible: boolean };
+      component_cells_selectable: boolean;
+    };
+  };
+  zappPipesData: { url: string; data: { title: string } };
+  selected: boolean;
+  assets: { menu_button: string };
 };
 
 function withAnalytics(Component) {

package/README.md

@@ -78,17 +78,6 @@ export default MyAwesomeComponent;
 export { MyAwesomeComponent } from "./MyAwesomeComponent";
 ```
 
-We provide flow types for component props - please use it to make sure your component will be compliant
-
-```javascript
-import * as React from "react";
-import type { ZappComponentProps } from "../../flow-types"; // in the root of the project
-
-export class MyComponent extends React.Component<ZappComponentProps> {
-  /* ... */
-}
-```
-
 ## Connecting my component to Zapp Pipes
 
 Zapp App components rely on [Zapp-Pipes](https://github.com/applicaster/zapp-pipes) to load data.
@@ -100,10 +89,9 @@ In order to connect your component to ZappPipes, you simply need to use the `Zap
 import * as React from "react";
 import { View, Text } from "react-native";
 import { zappPipesDataConnector } from "../ZappPipesDataConnector";
-import type { ZappComponentProps } from "../../flow-types";
 
 @zappPipesDataConnector
-export class MyComponent extends React.Component<ZappComponentProps> {
+export class MyComponent extends React.Component {
   renderComponent = (data) => {
     return (
       <View>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-ui-components",
-  "version": "12.0.3-rc.2",
+  "version": "13.0.0-alpha.1338463240",
   "description": "Applicaster Zapp React Native ui components for the Quick Brick App",
   "main": "index.js",
   "types": "index.d.ts",
@@ -34,10 +34,10 @@
     "redux-mock-store": "^1.5.3"
   },
   "dependencies": {
-    "@applicaster/applicaster-types": "12.0.3-rc.2",
-    "@applicaster/zapp-react-native-bridge": "12.0.3-rc.2",
-    "@applicaster/zapp-react-native-redux": "12.0.3-rc.2",
-    "@applicaster/zapp-react-native-utils": "12.0.3-rc.2",
+    "@applicaster/applicaster-types": "13.0.0-alpha.1338463240",
+    "@applicaster/zapp-react-native-bridge": "13.0.0-alpha.1338463240",
+    "@applicaster/zapp-react-native-redux": "13.0.0-alpha.1338463240",
+    "@applicaster/zapp-react-native-utils": "13.0.0-alpha.1338463240",
     "promise": "^8.3.0",
     "react-router-native": "^5.1.2",
     "url": "^0.11.0",