@applicaster/zapp-react-native-utils 15.0.0-rc.2 → 15.0.0-rc.21

package/analyticsUtils/AnalyticPlayerListener.ts

@@ -35,8 +35,11 @@ export class AnalyticPlayerListener
     this.handleAnalyticEvent(PLAYBACK_EVENT.complete);
   };
 
-  onError = (err: Error) => {
-    this.handleAnalyticEvent(PLAYBACK_EVENT.error, err); // TODO: Check error format
+  onError = (err: QuickBrickPlayer.PlayerErrorI) => {
+    this.handleAnalyticEvent(
+      PLAYBACK_EVENT.error,
+      err.toObject?.() || { message: err.message }
+    );
   };
 
   onPlayerPause = (event) => {

package/appUtils/focusManager/__tests__/__snapshots__/focusManager.test.js.snap

@@ -69,6 +69,7 @@ exports[`focusManagerIOS should be defined 1`] = `
   "getGroupRootById": [Function],
   "getPreferredFocusChild": [Function],
   "invokeHandler": [Function],
+  "isChildOf": [Function],
   "isFocusOn": [Function],
   "isGroupItemFocused": [Function],
   "moveFocus": [Function],

package/appUtils/focusManager/index.ios.ts

@@ -1,12 +1,20 @@
 import { NativeModules } from "react-native";
 import * as R from "ramda";
 
-import { isCurrentFocusOn } from "../focusManagerAux/utils";
+import {
+  isCurrentFocusOn,
+  isChildOf as isChildOfUtils,
+} from "../focusManagerAux/utils";
 import { Tree } from "./treeDataStructure/Tree";
 import { findFocusableNode } from "./treeDataStructure/Utils";
 import { subscriber } from "../../functionUtils";
 import { findChild } from "./utils";
 
+import {
+  emitRegistered,
+  emitUnregistered,
+} from "../focusManagerAux/utils/utils.ios";
+
 const { FocusableManagerModule } = NativeModules;
 
 /**
@@ -180,10 +188,14 @@ export const focusManager = (function () {
   function register({ id, component }) {
     const { isGroup = false } = component;
 
+    emitRegistered(id);
+
     return isGroup ? registerGroup(id, component) : registerItem(id, component);
   }
 
   function unregister(id, { group = false } = {}) {
+    emitUnregistered(id);
+
     group ? unregisterGroup(id) : unregisterItem(id);
   }
 
@@ -400,6 +412,10 @@ export const focusManager = (function () {
     return id && isCurrentFocusOn(id, currentFocusNode);
   }
 
+  function isChildOf(childId, parentId): boolean {
+    return isChildOfUtils(focusableTree, childId, parentId);
+  }
+
   return {
     on,
     invokeHandler,
@@ -422,5 +438,6 @@ export const focusManager = (function () {
     isGroupItemFocused,
     getPreferredFocusChild,
     isFocusOn,
+    isChildOf,
   };
 })();

package/appUtils/focusManagerAux/utils/index.ts

@@ -190,3 +190,21 @@ export const isCurrentFocusOn = (id, node) => {
 
   return isCurrentFocusOn(id, node.parent);
 };
+
+export const isChildOf = (focusableTree, childId, parentId) => {
+  if (isNil(childId) || isNil(parentId)) {
+    return false;
+  }
+
+  const childNode = focusableTree.findInTree(childId);
+
+  if (isNil(childNode)) {
+    return false;
+  }
+
+  if (childNode.parent?.id === parentId) {
+    return true;
+  }
+
+  return isChildOf(focusableTree, childNode.parent?.id, parentId);
+};

package/appUtils/focusManagerAux/utils/utils.ios.ts

@@ -0,0 +1,35 @@
+import { ReplaySubject } from "rxjs";
+import { filter } from "rxjs/operators";
+import { BUTTON_PREFIX } from "@applicaster/zapp-react-native-ui-components/Components/MasterCell/DefaultComponents/tv/TvActionButtons/const";
+import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager/index.ios";
+
+type FocusableID = string;
+type RegistrationEvent = {
+  id: FocusableID;
+  registered: boolean;
+};
+
+const isFocusableButton = (id: Option<FocusableID>): boolean =>
+  id && id.includes?.(BUTTON_PREFIX);
+
+const registeredSubject$ = new ReplaySubject<RegistrationEvent>(1);
+
+export const focusableButtonsRegistration$ = (focusableGroupId: string) =>
+  registeredSubject$.pipe(
+    filter(
+      (value) =>
+        value.registered && focusManager.isChildOf(value.id, focusableGroupId)
+    )
+  );
+
+export const emitRegistered = (id: Option<FocusableID>): void => {
+  if (isFocusableButton(id)) {
+    registeredSubject$.next({ id, registered: true });
+  }
+};
+
+export const emitUnregistered = (id: Option<FocusableID>): void => {
+  if (isFocusableButton(id)) {
+    registeredSubject$.next({ id, registered: false });
+  }
+};

package/appUtils/playerManager/conts.ts

@@ -2,6 +2,27 @@ export const userPreferencesNamespace = "user_preferences";
 
 export const skipActionType = "show_skip";
 
+export class PlayerError
+  extends Error
+  implements QuickBrickPlayer.PlayerErrorI
+{
+  description: string;
+
+  constructor(message: string, description: string) {
+    super(message);
+    this.description = description;
+
+    Object.setPrototypeOf(this, PlayerError.prototype);
+  }
+
+  toObject() {
+    return {
+      error: this.message,
+      message: this.description,
+    };
+  }
+}
+
 export enum SharedPlayerCallBacksKeys {
   OnPlayerResume = "onPlayerResume",
   OnPlayerPause = "onPlayerPause",

package/arrayUtils/__tests__/allTruthy.test.ts

@@ -0,0 +1,24 @@
+import { allTruthy } from "..";
+
+describe("allTruthy", () => {
+  it("should return true when all values are true", () => {
+    expect(allTruthy([true, true, true])).toBe(true);
+  });
+
+  it("should return false when at least one value is false", () => {
+    expect(allTruthy([true, false, true])).toBe(false);
+  });
+
+  it("should return false when all values are false", () => {
+    expect(allTruthy([false, false, false])).toBe(false);
+  });
+
+  it("should return false for an empty array", () => {
+    expect(allTruthy([])).toBe(false);
+  });
+
+  it("should handle single-element arrays correctly", () => {
+    expect(allTruthy([true])).toBe(true);
+    expect(allTruthy([false])).toBe(false);
+  });
+});

package/arrayUtils/__tests__/anyThruthy.test.ts

@@ -0,0 +1,24 @@
+import { anyTruthy } from "..";
+
+describe("anyTruthy", () => {
+  it("should return true when at least one value is true", () => {
+    expect(anyTruthy([false, true, false])).toBe(true);
+  });
+
+  it("should return false when all values are false", () => {
+    expect(anyTruthy([false, false, false])).toBe(false);
+  });
+
+  it("should return true when all values are true", () => {
+    expect(anyTruthy([true, true, true])).toBe(true);
+  });
+
+  it("should return false for an empty array", () => {
+    expect(anyTruthy([])).toBe(false);
+  });
+
+  it("should handle single-element arrays correctly", () => {
+    expect(anyTruthy([true])).toBe(true);
+    expect(anyTruthy([false])).toBe(false);
+  });
+});

package/arrayUtils/index.ts

@@ -116,3 +116,8 @@ export const sample = (xs: unknown[]): unknown => {
 
   return xs[index];
 };
+
+export const allTruthy = (xs: boolean[]) =>
+  isFilledArray(xs) && xs.every(Boolean);
+
+export const anyTruthy = (xs: boolean[]) => xs.some(Boolean);

package/navigationUtils/index.ts

@@ -575,24 +575,27 @@ export function routeIsPlayerScreen(currentRoute) {
   return currentRoute?.includes("/playable");
 }
 
-export const getNavBarProps =
-  (currentRiver: ZappRiver, pathname: string, title: string) => () => {
-    const props = getNavigationPropsV2({
-      currentRiver,
-      title,
-      category: "nav_bar",
-    });
+export const getNavBarProps = (
+  currentRiver: ZappRiver,
+  pathname: string,
+  title: string
+) => {
+  const props = getNavigationPropsV2({
+    currentRiver,
+    title,
+    category: "nav_bar",
+  });
 
-    if (props) {
-      return {
-        ...props,
-        id: pathname,
-        pathname: pathname,
-      };
-    }
+  if (props) {
+    return {
+      ...props,
+      id: pathname,
+      pathname: pathname,
+    };
+  }
 
-    return null;
-  };
+  return null;
+};
 
 export const findMenuPlugin = (
   navigations: ZappNavigation[],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "15.0.0-rc.2",
+  "version": "15.0.0-rc.21",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "15.0.0-rc.2",
+    "@applicaster/applicaster-types": "15.0.0-rc.21",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",

package/reactHooks/feed/useBatchLoading.ts

@@ -151,7 +151,13 @@ export const useBatchLoading = (
         }
       }
     });
-  }, [feedUrls, feeds, loadPipesDataDispatcher]);
+  }, [
+    batchComponents,
+    feeds,
+    getUrl,
+    loadPipesDataDispatcher,
+    options.riverId,
+  ]);
 
   React.useEffect(() => {
     runBatchLoading();

package/reactHooks/feed/useFeedLoader.tsx

@@ -37,15 +37,6 @@ export const useFeedLoader = ({
   mapping,
   pipesOptions = {},
 }: Props): FeedLoaderResponse => {
-  useEffect(() => {
-    if (!feedUrl) {
-      logger.warning({
-        message: "Required parameter feedUrl is missing",
-        data: { feedUrl },
-      });
-    }
-  }, []);
-
   const isInitialRender = useIsInitialRender();
 
   const callableFeedUrl = useInflatedUrl({ feedUrl, mapping });

package/reactHooks/feed/useInflatedUrl.ts

@@ -18,6 +18,7 @@ import {
 } from "@applicaster/zapp-pipes-v2-client";
 import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
 import { ENDPOINT_TAGS } from "../../types";
+import { isNilOrEmpty } from "../../reactUtils/helpers";
 
 /**
  * will match any occurrence in a string of one or more word characters
@@ -75,15 +76,19 @@ export const getInflatedDataSourceUrl: GetInflatedDataSourceUrl = ({
    * https://foo.com/shows/A1234
    */
 
-  if (!source) {
-    // eslint-disable-next-line no-console
-    console.error("source is empty", {
-      source,
-      contexts,
-      mapping,
-    });
+  if (!isNilOrEmpty(mapping)) {
+    if (!source) {
+      if (__DEV__) {
+        // eslint-disable-next-line no-console
+        throw new Error(
+          "getInflatedDataSourceUrl: source is empty while mapping is provided"
+        );
+      }
 
-    return null;
+      return null;
+    }
+  } else {
+    return source || null;
   }
 
   // Hack because in tv we expect to get key names instead of values from the fake entry
@@ -193,28 +198,17 @@ export function useInflatedUrl({
 
   const url = useMemo(
     () =>
-      mapping
-        ? getInflatedDataSourceUrl({
-            source: feedUrl,
-            contexts: {
-              entry: entryContext,
-              screen: screenContext,
-              search: getSearchContext(searchContext, mapping),
-            },
-            mapping,
-          })
-        : feedUrl,
-    [feedUrl, mapping]
+      getInflatedDataSourceUrl({
+        source: feedUrl,
+        contexts: {
+          entry: entryContext,
+          screen: screenContext,
+          search: getSearchContext(searchContext, mapping),
+        },
+        mapping,
+      }),
+    [entryContext, feedUrl, mapping, screenContext, searchContext]
   );
 
-  if (!feedUrl) {
-    logger.warning({
-      message: "Required parameter feedUrl is missing",
-      data: { feedUrl },
-    });
-
-    return null;
-  }
-
   return url;
 }

package/reactHooks/feed/usePipesCacheReset.ts

@@ -34,7 +34,9 @@ export const usePipesCacheReset = (riverId, riverComponents) => {
             component
           );
 
-          dispatch(clearPipesData(url, { riverId }));
+          if (url) {
+            dispatch(clearPipesData(url, { riverId }));
+          }
         }
       });
     };

package/utils/index.ts

@@ -34,4 +34,7 @@ export {
   last,
   toLower,
   isEqual as equals,
+  uniq,
+  uniqWith,
+  flowRight as compose,
 } from "lodash";

package/zappFrameworkUtils/HookCallback/callbackNavigationAction.ts

@@ -9,10 +9,23 @@ export enum NavigationCallbackOptions {
   GO_TO_SCREEN = "go_to_screen",
 }
 
-export const CALLBACK_NAVIGATION_KEY = "hook_callback_navigation";
+export enum ResultType {
+  login = "login",
+  logout = "logout",
+}
+
+export type CallbackResult = hookCallbackArgs & {
+  options?: {
+    resultType?: ResultType;
+  };
+};
+
+export type ScreenResultCallback = (args: CallbackResult) => void | undefined;
+
+export const CALLBACK_NAVIGATION_KEY = "completion_action";
 
 export const CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY =
-  "hook_callback_navigation_go_to_screen";
+  "completion_action_navigation_go_to_screen";
 
 type NavKeys = {
   action: NavigationCallbackOptions;
@@ -23,7 +36,7 @@ type General = Record<string, unknown>;
 
 const LogPrefix = "useCallbackNavigationAction:";
 
-const { log_info, log_verbose } = createLogger({
+const { log_info, log_verbose, log_debug } = createLogger({
   subsystem: "hook-navigation-callback",
 });
 
@@ -35,50 +48,75 @@ const legacyMappingKeys = {
   "quick-brick-user-account-ui-component": {
     actionType: "callbackAction",
   },
+  "quick-brick-login-multi-login-providers.login": {
+    actionType: "login_completion_action",
+    targetScreen: "navigate_to_login_screen",
+  },
+  "quick-brick-login-multi-login-providers.logout": {
+    actionType: "logout_completion_action",
+    targetScreen: "navigate_to_logout_screen",
+  },
+  "quick-brick-storefront": {
+    actionType: "purchase_completion_action",
+    targetScreen: "navigate_to_screen_after_purchase",
+  },
+  "zapp_login_plugin_oauth_tv_2_0.login": {
+    actionType: "login_completion_action",
+    targetScreen: "navigate_to_login_screen",
+  },
+  "zapp_login_plugin_oauth_tv_2_0.logout": {
+    actionType: "logout_completion_action",
+    targetScreen: "navigate_to_logout_screen",
+  },
 };
 
-const isNonEmptyString = (v: unknown): v is string =>
-  typeof v === "string" && v.trim().length > 0;
-
 const NAV_ACTIONS = Object.values(NavigationCallbackOptions) as string[];
 
 const isNavAction = (v: unknown): v is NavigationCallbackOptions =>
-  typeof v === "string" && NAV_ACTIONS.includes(v.trim());
+  typeof v === "string" && NAV_ACTIONS.includes(v);
 
 export const getNavigationKeys = (
-  item?: ZappUIComponent | ZappRiver
+  item?: ZappUIComponent | ZappRiver,
+  resultType: ResultType | null = null
 ): NavKeys => {
   const general = (item?.general ?? {}) as General;
-  const pluginIdentifier = item?.type ?? "";
-  const legacy = legacyMappingKeys[pluginIdentifier] ?? {};
+
+  const pluginIdentifier = (item as any).identifier ?? item?.type ?? "";
+
+  const legacy =
+    legacyMappingKeys[`${pluginIdentifier}.${resultType}`] ??
+    legacyMappingKeys[pluginIdentifier] ??
+    {};
+
+  const actionKey = resultType
+    ? `${resultType}_${CALLBACK_NAVIGATION_KEY}`
+    : CALLBACK_NAVIGATION_KEY;
 
   const rawAction =
-    (general as General).hook_callback_navigation ??
+    (general as General)[actionKey] ??
     (legacy.actionType ? (general as General)[legacy.actionType] : undefined);
 
-  let action: NavigationCallbackOptions | null = null;
-
-  if (isNonEmptyString(rawAction)) {
-    const trimmed = rawAction.trim();
-    action = isNavAction(trimmed) ? trimmed : null;
-  }
+  const action: NavigationCallbackOptions | null = isNavAction(rawAction)
+    ? rawAction
+    : null;
 
   if (!action) return null;
 
   let targetScreenId: string | null = null;
 
   if (action === NavigationCallbackOptions.GO_TO_SCREEN) {
+    const screenKey = resultType
+      ? `${resultType}_${CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY}`
+      : CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY;
+
     const screenId: string | null =
-      ((general as General)[CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY] as string) ??
+      ((general as General)[screenKey] as string) ??
       (legacy.targetScreen
         ? ((general as General)[legacy.targetScreen] as string)
         : undefined);
 
     if (screenId) {
-      const trimmedTargetScreenId = screenId.trim();
-
-      targetScreenId =
-        trimmedTargetScreenId.length > 0 ? trimmedTargetScreenId : null;
+      targetScreenId = screenId.length > 0 ? screenId : null;
     }
   }
 
@@ -87,10 +125,12 @@ export const getNavigationKeys = (
 
 export const useCallbackNavigationAction = (
   item?: ZappUIComponent | ZappRiver
-): hookCallback | undefined => {
+): ((
+  args: CallbackResult,
+  hookCallback?: hookCallback
+) => void | undefined) => {
   const navigation = useNavigation();
   const rivers = useRivers();
-  const enabled = Boolean(item?.general?.[CALLBACK_NAVIGATION_KEY]);
   const screenContext = useScreenContext();
 
   const overrideCallbackFromComponent = useMemo(() => {
@@ -105,11 +145,36 @@ export const useCallbackNavigationAction = (
   }
 
   const callbackAction = useCallback<hookCallback>(
-    (_args: hookCallbackArgs) => {
-      const data = getNavigationKeys(item) ?? {
-        action: NavigationCallbackOptions.DEFAULT,
-        targetScreenId: null,
-      };
+    (args: CallbackResult, hookCallback: hookCallback = null) => {
+      if (!args.success) {
+        log_debug(
+          `${LogPrefix} callback called with no success, use original callback`
+        );
+
+        hookCallback?.(args);
+
+        return;
+      }
+
+      if (args.cancelled) {
+        log_debug(
+          `${LogPrefix} callback called but cancelled, use original callback`
+        );
+
+        hookCallback?.(args);
+
+        return;
+      }
+
+      const data = getNavigationKeys(item, args.options?.resultType ?? null);
+
+      if (!data) {
+        hookCallback?.(args);
+
+        return;
+      }
+
+      hookCallback?.({ ...args, success: false, cancelled: true });
 
       switch (data.action) {
         case NavigationCallbackOptions.GO_BACK: {
@@ -160,5 +225,5 @@ export const useCallbackNavigationAction = (
     [item, navigation, rivers]
   );
 
-  return enabled ? overrideCallbackFromComponent || callbackAction : undefined;
+  return overrideCallbackFromComponent || callbackAction;
 };

package/zappFrameworkUtils/HookCallback/hookCallbackManifestExtensions.config.js

@@ -5,20 +5,32 @@ const NavigationCallbackOptions = {
   GO_TO_SCREEN: "go_to_screen",
 };
 
-const CALLBACK_NAVIGATION_KEY = "hook_callback_navigation";
+const ResultType = {
+  login: "login",
+  logout: "logout",
+};
+
+const CALLBACK_NAVIGATION_KEY = "completion_action";
 
 const CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY =
-  "hook_callback_navigation_go_to_screen";
+  "completion_action_navigation_go_to_screen";
+
+const callbackKeyPrefix = (key, prefix, keySeparator = "_") =>
+  prefix ? `${prefix}${keySeparator}${key}` : key;
 
-const extendManifestWithHookCallback = () => ({
+const extendManifestWithHookCallback = (prefix = null) => ({
   group: true,
   label: "CallBack Navigation",
   folded: true,
   fields: [
     {
       type: "select",
-      key: CALLBACK_NAVIGATION_KEY,
-      label: "Callback Navigation",
+      key: callbackKeyPrefix(CALLBACK_NAVIGATION_KEY, prefix),
+      label: callbackKeyPrefix(
+        "Callback Navigation",
+        prefix?.toUpperCase(),
+        " "
+      ),
       label_tooltip:
         "Defines what navigation action should be performed after the callback is called.",
       options: [
@@ -43,13 +55,17 @@ const extendManifestWithHookCallback = () => ({
     },
     {
       type: "screen_selector",
-      key: CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY,
-      label: "Navigate to screen",
+      key: callbackKeyPrefix(CALLBACK_NAVIGATION_GO_TO_SCREEN_KEY, prefix),
+      label: callbackKeyPrefix(
+        "Navigate to screen",
+        prefix?.toUpperCase(),
+        " "
+      ),
       label_tooltip: "Screen you wish to navigate to after success purchase",
       rules: "conditional",
       conditional_fields: [
         {
-          key: `general/${CALLBACK_NAVIGATION_KEY}`,
+          key: `general/${callbackKeyPrefix(CALLBACK_NAVIGATION_KEY, prefix)}`,
           condition_value: NavigationCallbackOptions.GO_TO_SCREEN,
         },
       ],
@@ -57,4 +73,4 @@ const extendManifestWithHookCallback = () => ({
   ],
 });
 
-module.exports = { extendManifestWithHookCallback };
+module.exports = { extendManifestWithHookCallback, ResultType };

package/zappFrameworkUtils/HookCallback/useCallbackActions.ts

@@ -1,5 +1,8 @@
 import { useCallback } from "react";
-import { useCallbackNavigationAction } from "./callbackNavigationAction";
+import {
+  CallbackResult,
+  useCallbackNavigationAction,
+} from "./callbackNavigationAction";
 
 export const useCallbackActions = (
   item?: ZappUIComponent | ZappRiver,
@@ -8,14 +11,8 @@ export const useCallbackActions = (
   const navigationAction = useCallbackNavigationAction(item);
 
   return useCallback(
-    async (data: hookCallbackArgs) => {
-      if (navigationAction && data.success) {
-        hookCallback?.({ ...data, success: false, cancelled: true });
-
-        navigationAction(data);
-      } else {
-        hookCallback?.(data);
-      }
+    async (data: CallbackResult) => {
+      navigationAction(data, hookCallback);
     },
     [navigationAction, hookCallback]
   );