@applicaster/zapp-react-native-utils 15.0.0-alpha.1456157166 → 15.0.0-alpha.1615225514

package/zappFrameworkUtils/HookCallback/callbackNavigationAction.ts

@@ -1,6 +1,6 @@
 import { useNavigation, useRivers, useScreenContext } from "../../reactHooks";
 import { createLogger } from "../../logger";
-import { useCallback, useMemo } from "react";
+import { useCallback, useMemo, useRef, useEffect } from "react";
 
 export enum NavigationCallbackOptions {
   DEFAULT = "default",
@@ -9,10 +9,24 @@ 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;
+    navigator?: QuickBrickAppNavigator;
+  };
+};
+
+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 +37,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",
 });
 
@@ -32,53 +46,81 @@ const legacyMappingKeys = {
     actionType: "login_completion_action",
     targetScreen: "navigate_to_login_screen",
   },
-  "quick-brick-user-account-ui-component": {
+  "quick-brick-user-account-ui-component.login": {
     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 NAV_ACTIONS = (
+  Object.values(NavigationCallbackOptions) as string[]
+).filter((value) => value !== NavigationCallbackOptions.DEFAULT);
 
 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 ?? item?.component_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,12 +129,20 @@ 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 navigationRef = useRef(navigation);
+
+  useEffect(() => {
+    navigationRef.current = navigation;
+  }, [navigation]);
+
   const overrideCallbackFromComponent = useMemo(() => {
     log_verbose(`${LogPrefix}: overridden callbackAction by component`);
 
@@ -105,16 +155,56 @@ 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;
+      }
+
+      let data = getNavigationKeys(item, args.options?.resultType ?? null);
+
+      if (!data) {
+        const isScreen = !hookCallback;
+
+        if (isScreen && args.options?.resultType === ResultType.login) {
+          log_debug(
+            `${LogPrefix} no navigation data found, applying GO BACK for login screen`
+          );
+
+          data = {
+            action: NavigationCallbackOptions.GO_BACK,
+            targetScreenId: null,
+          };
+        } else {
+          hookCallback?.(args);
+
+          return;
+        }
+      }
+
+      hookCallback?.({ ...args, success: false, cancelled: true });
+      const currentNavigation = navigationRef.current;
 
       switch (data.action) {
         case NavigationCallbackOptions.GO_BACK: {
-          if (navigation.canGoBack()) {
-            navigation.goBack();
+          if (currentNavigation.canGoBack()) {
+            currentNavigation.goBack();
+
             log_info(`${LogPrefix} performing 'GO BACK' action`);
           } else {
             log_info(`${LogPrefix} cannot perform 'GO BACK' action — ignoring`);
@@ -124,7 +214,7 @@ export const useCallbackNavigationAction = (
         }
 
         case NavigationCallbackOptions.GO_HOME: {
-          navigation.goHome();
+          currentNavigation.goHome();
           log_info(`${LogPrefix} performing 'GO HOME' action`);
           break;
         }
@@ -140,7 +230,7 @@ export const useCallbackNavigationAction = (
           const screen = rivers[screenId];
 
           if (screen) {
-            navigation.replace(screen);
+            currentNavigation.replace(screen);
 
             log_info(
               `${LogPrefix} performing 'GO TO SCREEN' action to screen: ${screenId}`
@@ -157,8 +247,8 @@ export const useCallbackNavigationAction = (
         }
       }
     },
-    [item, navigation, rivers]
+    [item, 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",
+  label: `CallBack Navigation: ${prefix}`,
   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]
   );