@developer_tribe/react-builder 1.2.45 → 1.2.47

package/src/build-components/GlobalProvider/globalProviderUtils.ts

@@ -0,0 +1,204 @@
+import type { NodeData } from '../../types/Node';
+import type { GlobalPage } from './GlobalContext';
+
+/** Maps node type to a canonical page key when no explicit pageKey attribute is provided. */
+const TYPE_KEY_MAP: Record<string, string> = {
+  TermsProvider: 'terms',
+  OnboardProvider: 'onboard',
+  PaywallProvider: 'paywall',
+  FormProvider: 'form',
+  CarouselProvider: 'carousel',
+};
+
+/**
+ * Derives a stable and unique page key for a child node.
+ * Priority: node.key → TYPE_KEY_MAP → "${type}-${index}"
+ */
+export function derivePageKey(
+  node: NodeData,
+  index: number,
+  existingKeys: Set<string>,
+): string {
+  let baseKey = '';
+  if (typeof node.key === 'string' && node.key.trim()) {
+    baseKey = node.key.trim();
+  } else {
+    baseKey = TYPE_KEY_MAP[node.type] || node.type?.toLowerCase?.() || 'page';
+  }
+
+  let finalKey = baseKey;
+  let counter = 1;
+
+  // Ensure uniqueness among siblings
+  while (existingKeys.has(finalKey)) {
+    finalKey = `${baseKey}-${index + counter}`;
+    counter++;
+  }
+
+  existingKeys.add(finalKey);
+  return finalKey;
+}
+
+/** Runtime shape of a SkipConditionEntry (mirrors the types block in pattern.json). */
+export interface SkipConditionEntry {
+  pageKey: string;
+  conditionKey: string;
+}
+
+/**
+ * Converts SkipConditionEntry[] (from pattern schema) to a lookup map for fast access.
+ */
+export function normalizeSkipConditions(raw: unknown): Record<string, string> {
+  if (!Array.isArray(raw)) return {};
+  const result: Record<string, string> = {};
+  for (const entry of raw) {
+    if (
+      entry &&
+      typeof entry === 'object' &&
+      typeof (entry as SkipConditionEntry).pageKey === 'string' &&
+      typeof (entry as SkipConditionEntry).conditionKey === 'string'
+    ) {
+      result[(entry as SkipConditionEntry).pageKey] = (
+        entry as SkipConditionEntry
+      ).conditionKey;
+    }
+  }
+  return result;
+}
+
+/**
+ * Builds the page list for GlobalProvider.
+ */
+export function buildPages(
+  children: NodeData[],
+  skipConditions: Record<string, string> = {},
+): GlobalPage[] {
+  const existingKeys = new Set<string>();
+  return children.map((node, index) => {
+    const key = derivePageKey(node, index, existingKeys);
+    const skipIf = skipConditions[key] ?? undefined;
+    const animation =
+      typeof (node.attributes as Record<string, unknown>)?.animation ===
+      'string'
+        ? (node.attributes as Record<string, string>).animation
+        : undefined;
+    return {
+      key,
+      node,
+      skipIf,
+      animation,
+      index,
+    };
+  });
+}
+
+/** Returns the first non-skipped page key, starting from the requested key. */
+export function resolveEffectivePage(
+  targetKey: string,
+  pages: GlobalPage[],
+  conditions: Record<string, boolean>,
+): string | null {
+  const targetIdx = pages.findIndex((p) => p.key === targetKey);
+  if (targetIdx === -1) {
+    // If target not found, start from the first non-skipped page
+    return resolveFirstNonSkippedPage(pages, conditions);
+  }
+
+  // Walk forward from target, skipping pages whose condition is met
+  for (let i = targetIdx; i < pages.length; i++) {
+    const page = pages[i];
+    if (!page) break;
+    if (page.skipIf && conditions[page.skipIf] === true) {
+      continue;
+    }
+    return page.key;
+  }
+
+  // If all remaining pages are skipped, return null instead of falling back to the last page.
+  // This allows the caller to handle the "no available pages" state explicitly.
+  return null;
+}
+
+function resolveFirstNonSkippedPage(
+  pages: GlobalPage[],
+  conditions: Record<string, boolean>,
+): string | null {
+  for (const page of pages) {
+    if (!(page.skipIf && conditions[page.skipIf] === true)) {
+      return page.key;
+    }
+  }
+  return null;
+}
+
+const STORAGE_KEY_PREFIX = 'global-provider-progress';
+
+/**
+ * Internal storage abstraction. In a real RN environment, this would be swapped
+ * for AsyncStorage. For now, it defaults to localStorage with safe checks.
+ */
+const storage = {
+  getItem: (key: string) => {
+    try {
+      return typeof localStorage !== 'undefined'
+        ? localStorage.getItem(key)
+        : null;
+    } catch {
+      return null;
+    }
+  },
+  setItem: (key: string, value: string) => {
+    try {
+      if (typeof localStorage !== 'undefined') localStorage.setItem(key, value);
+    } catch {
+      // ignore
+    }
+  },
+  removeItem: (key: string) => {
+    try {
+      if (typeof localStorage !== 'undefined') localStorage.removeItem(key);
+    } catch {
+      // ignore
+    }
+  },
+};
+
+export function persistProgress(
+  storageKey: string,
+  currentPageKey: string,
+  conditions: Record<string, boolean>,
+): void {
+  storage.setItem(
+    `${STORAGE_KEY_PREFIX}-${storageKey}`,
+    JSON.stringify({ currentPageKey, conditions }),
+  );
+}
+
+export function loadProgress(storageKey: string): {
+  currentPageKey: string;
+  conditions: Record<string, boolean>;
+} | null {
+  const raw = storage.getItem(`${STORAGE_KEY_PREFIX}-${storageKey}`);
+  if (!raw) return null;
+  try {
+    const parsed = JSON.parse(raw) as unknown;
+    if (
+      parsed &&
+      typeof parsed === 'object' &&
+      !Array.isArray(parsed) &&
+      typeof (parsed as Record<string, unknown>).currentPageKey === 'string'
+    ) {
+      return parsed as {
+        currentPageKey: string;
+        conditions: Record<string, boolean>;
+      };
+    }
+  } catch {
+    // parse error
+  }
+  return null;
+}
+
+export function clearProgress(storageKey: string): void {
+  storage.removeItem(`${STORAGE_KEY_PREFIX}-${storageKey}`);
+}

package/src/build-components/GlobalProvider/pattern.json

@@ -0,0 +1,55 @@
+{
+  "schemaVersion": 2,
+  "types": {
+    "SkipConditionEntry": {
+      "pageKey": "string",
+      "conditionKey": "string"
+    }
+  },
+  "pattern": {
+    "type": "GlobalProvider",
+    "title": "title",
+    "description": "description",
+    "children": "node",
+    "extends": "View",
+    "attributes": {
+      "initialPage": "string",
+      "persistProgress": "boolean",
+      "skipConditions": "SkipConditionEntry[]"
+    }
+  },
+  "defaults": {
+    "styles": {
+      "flex": 1
+    }
+  },
+  "meta": {
+    "desiredParent": ["root"],
+    "label": "Global Provider",
+    "description": "Top-level provider that manages multi-page flow (Terms → Onboard → Paywall). Each direct child is treated as a page.",
+    "attributes": {
+      "initialPage": {
+        "label": "Initial Page Key",
+        "description": "The page key to show first. Defaults to the first child.",
+        "category": "other",
+        "specialCategory": null,
+        "sort": 1
+      },
+      "persistProgress": {
+        "label": "Persist Progress",
+        "description": "Save current page and conditions to localStorage so the user continues from where they left off.",
+        "category": "other",
+        "specialCategory": null,
+        "sort": 2
+      },
+      "skipConditions": {
+        "label": "Skip Conditions",
+        "description": "List of page skip rules. Each entry maps a pageKey to a conditionKey: when conditions[conditionKey] is true, that page is skipped on navigate.",
+        "category": "other",
+        "specialCategory": null,
+        "sort": 3
+      }
+    },
+    "styles": {}
+  }
+}

package/src/build-components/GlobalProvider/useGlobalNavigation.ts

@@ -0,0 +1,65 @@
+import { useCallback } from 'react';
+import { useGlobalContext } from './GlobalContext';
+import { useMockOSContext } from '../../mockOS/context/MockOSContextBase';
+import type { RouteType } from '../../mockOS/context/MockOSContextBase';
+
+/**
+ * Maps route/placement aliases to their canonical GlobalProvider page keys.
+ *
+ * Add entries here when a new alias should resolve to an existing page key.
+ * Keys are the incoming target strings (from JSON events / usePlacementButtonEvents).
+ * Values are the canonical page key that GlobalContext.navigate() will receive.
+ *
+ * Exported so other modules (e.g. a navigation-flow visualiser) can inspect
+ * which aliases exist without duplicating this logic.
+ */
+export const GLOBAL_ROUTE_ALIASES: Record<string, string> = {
+  subscription: 'paywall',
+  paywall: 'paywall',
+  onboard: 'onboard',
+  terms: 'terms',
+  home: 'home',
+};
+
+/**
+ * Returns a navigate function that first attempts to route within GlobalContext
+ * (when a GlobalProvider is active), then falls back to MockOSContext navigation.
+ *
+ * Used by SystemButton and OnboardButton so that events defined in JSON work
+ * transparently whether rendered inside a GlobalProvider or standalone.
+ */
+export function useGlobalNavigation(): (target: string) => boolean {
+  const globalCtx = useGlobalContext();
+  const mockOS = useMockOSContext();
+
+  return useCallback(
+    (target: string): boolean => {
+      if (globalCtx) {
+        // Direct page key match
+        if (globalCtx.pages.some((p) => p.key === target)) {
+          globalCtx.navigate(target);
+          return true;
+        }
+
+        // Alias resolution: map incoming target to canonical page key
+        const canonicalKey = GLOBAL_ROUTE_ALIASES[target];
+        if (
+          canonicalKey &&
+          globalCtx.pages.some((p) => p.key === canonicalKey)
+        ) {
+          globalCtx.navigate(canonicalKey);
+          return true;
+        }
+      }
+
+      // Fallback: delegate to MockOSContext
+      if (mockOS) {
+        mockOS.navigation(target as RouteType);
+        return true;
+      }
+
+      return false;
+    },
+    [globalCtx, mockOS],
+  );
+}

package/src/build-components/GlobalProvider/useGlobalProviderLogic.ts

@@ -0,0 +1,172 @@
+import { useCallback, useId, useMemo, useRef, useState } from 'react';
+import type { GlobalContextValue } from './GlobalContext';
+import {
+  buildPages,
+  loadProgress,
+  normalizeSkipConditions,
+  persistProgress,
+  resolveEffectivePage,
+} from './globalProviderUtils';
+import useNode from '../useNode';
+import type { NodeData } from '../../types/Node';
+
+export interface UseGlobalProviderLogicOptions {
+  node: NodeData;
+}
+
+export function useGlobalProviderLogic({
+  node: rawNode,
+}: UseGlobalProviderLogicOptions) {
+  const node = useNode(rawNode);
+
+  const generatedId = useId();
+  const attributeName = node.sourceType ?? node.type ?? 'GlobalProvider';
+  const attributeKey = node.key ?? generatedId;
+  const attrs = node.attributes;
+  const shouldPersist = attrs?.persistProgress === true;
+
+  const childNodes = useMemo((): NodeData[] => {
+    const raw = node.children;
+    if (!raw) return [];
+    if (Array.isArray(raw)) return raw as NodeData[];
+    return [raw as NodeData];
+  }, [node.children]);
+
+  const skipConditions = useMemo(
+    () => normalizeSkipConditions(attrs?.skipConditions),
+    [attrs?.skipConditions],
+  );
+
+  const pages = useMemo(
+    () => buildPages(childNodes, skipConditions),
+    [childNodes, skipConditions],
+  );
+
+  const storageKey = attributeKey;
+
+  const [conditions, setConditions] = useState<Record<string, boolean>>(() => {
+    if (shouldPersist) {
+      return loadProgress(storageKey)?.conditions ?? {};
+    }
+    return {};
+  });
+
+  const [pageStack, setPageStack] = useState<string[]>(() => {
+    const saved = shouldPersist ? loadProgress(storageKey) : null;
+    const initialConditions = saved?.conditions ?? {};
+
+    const firstEffective = (() => {
+      if (saved?.currentPageKey) {
+        return resolveEffectivePage(
+          saved.currentPageKey,
+          pages,
+          initialConditions,
+        );
+      }
+
+      const requestedKey =
+        typeof attrs?.initialPage === 'string'
+          ? attrs.initialPage
+          : (pages[0]?.key ?? '');
+      return resolveEffectivePage(requestedKey, pages, initialConditions);
+    })();
+    return firstEffective ? [firstEffective] : [];
+  });
+
+  const currentPageKey = pageStack[pageStack.length - 1] ?? '';
+
+  const conditionsRef = useRef(conditions);
+  conditionsRef.current = conditions;
+
+  const setCondition = useCallback(
+    (key: string, value: boolean) => {
+      setConditions((prev) => {
+        const next = { ...prev, [key]: value };
+        if (shouldPersist) {
+          const currentKey = pageStack[pageStack.length - 1] ?? '';
+          persistProgress(storageKey, currentKey, next);
+        }
+        return next;
+      });
+    },
+    [shouldPersist, storageKey, pageStack],
+  );
+
+  const navigate = useCallback(
+    (key: string) => {
+      const effective = resolveEffectivePage(key, pages, conditionsRef.current);
+      if (!effective) return;
+
+      setPageStack((prev) => {
+        const last = prev[prev.length - 1];
+        if (last === effective) return prev;
+        const next = [...prev, effective];
+        if (shouldPersist) {
+          persistProgress(storageKey, effective, conditionsRef.current);
+        }
+        return next;
+      });
+    },
+    [pages, shouldPersist, storageKey],
+  );
+
+  const goNext = useCallback(() => {
+    const currentIdx = pages.findIndex((p) => p.key === currentPageKey);
+    if (currentIdx === -1 || currentIdx >= pages.length - 1) return;
+    const nextPage = pages[currentIdx + 1];
+    if (!nextPage) return;
+    navigate(nextPage.key);
+  }, [pages, currentPageKey, navigate]);
+
+  const goBack = useCallback((): boolean => {
+    if (pageStack.length <= 1) return false;
+    setPageStack((prev) => {
+      const next = prev.slice(0, -1);
+      const prevKey = next[next.length - 1] ?? '';
+      if (shouldPersist) {
+        persistProgress(storageKey, prevKey, conditionsRef.current);
+      }
+      return next;
+    });
+    return true;
+  }, [pageStack.length, shouldPersist, storageKey]);
+
+  const activePage = useMemo(
+    () => pages.find((p) => p.key === currentPageKey),
+    [pages, currentPageKey],
+  );
+
+  const contextValue = useMemo<GlobalContextValue>(
+    () => ({
+      currentPageKey,
+      pages,
+      pageStack,
+      navigate,
+      goNext,
+      goBack,
+      conditions,
+      setCondition,
+    }),
+    [
+      currentPageKey,
+      pages,
+      pageStack,
+      navigate,
+      goNext,
+      goBack,
+      conditions,
+      setCondition,
+    ],
+  );
+
+  return {
+    node,
+    attributeName,
+    attributeKey,
+    attrs,
+    pages,
+    currentPageKey,
+    activePage,
+    contextValue,
+  };
+}

package/src/build-components/OnboardButton/OnboardButton.tsx

@@ -12,6 +12,8 @@ import {
   usePlacementButtonEvents,
   type PlacementEventObject,
 } from '../SystemButton/usePlacementButtonEvents';
+import { useGlobalNavigation } from '../GlobalProvider/useGlobalNavigation';
+import { useGlobalContext } from '../GlobalProvider/GlobalContext';
 
 export function OnboardButton({ node }: OnboardButtonComponentProps) {
   useLogRender('OnboardButton');
@@ -21,6 +23,8 @@ export function OnboardButton({ node }: OnboardButtonComponentProps) {
   const { selectedTheme: theme, projectColors } = useBuilderParams();
   const context = useMockOSContext();
   const mockPermissionManager = useMockPermission(context);
+  const globalNavigate = useGlobalNavigation();
+  const globalCtx = useGlobalContext();
   const generatedId = useId();
   const attributeKey = node.key ?? generatedId;
   const attrs = node.attributes;
@@ -39,6 +43,7 @@ export function OnboardButton({ node }: OnboardButtonComponentProps) {
         return true;
       }
       if (e.navigate_to && typeof e.navigate_to === 'string') {
+        if (globalNavigate(e.navigate_to)) return true;
         if (context) {
           context.navigation(
             e.navigate_to as
@@ -56,7 +61,7 @@ export function OnboardButton({ node }: OnboardButtonComponentProps) {
       }
       return false;
     },
-    [emblaApi, context],
+    [emblaApi, context, globalNavigate],
   );
 
   const handleClick = usePlacementButtonEvents(attrs?.events, {
@@ -64,6 +69,8 @@ export function OnboardButton({ node }: OnboardButtonComponentProps) {
     requestPermission: (permission) =>
       mockPermissionManager.requestPermission(permission),
     onNavigateWithoutPlacement,
+    globalNavigate,
+    setCondition: globalCtx?.setCondition,
   });
 
   return (

package/src/build-components/OnboardButton/OnboardButtonProps.generated.ts

@@ -2,7 +2,28 @@
 
 import type { NodeData } from '../../types/Node';
 
-export type TypeOptionType = 'Permission' | 'Navigate' | 'Placement';
+export type TypeOptionType =
+  | 'Permission'
+  | 'Navigate'
+  | 'Placement'
+  | 'SetCondition';
+export type PermissionOptionType =
+  | 'notification'
+  | 'camera'
+  | 'microphone'
+  | 'location'
+  | 'photos'
+  | 'contacts'
+  | 'att'
+  | 'rating'
+  | 'GDPR';
+export type PlacementKeyOptionType =
+  | 'terms'
+  | 'onboard'
+  | 'paywall'
+  | 'subscription'
+  | 'home';
+export type ConditionKeyOptionType = 'termsAccepted';
 export type TestIDOptionType = 'onboardSkip' | 'onboardNext';
 export type AnimationOptionType =
   | 'simple-animation'
@@ -29,10 +50,12 @@ export type PositionOptionType = 'relative' | 'absolute';
 
 export interface EventObjectGenerated {
   type?: TypeOptionType;
-  permission?: string;
+  permission?: PermissionOptionType;
   navigate_to?: string;
   targetIndex?: number;
-  placementKey?: string;
+  placementKey?: PlacementKeyOptionType;
+  conditionKey?: ConditionKeyOptionType;
+  value?: boolean;
 }
 
 export interface OnboardButtonStyleGenerated {

package/src/build-components/OnboardButton/pattern.json

@@ -32,11 +32,13 @@
   },
   "types": {
     "EventObject": {
-      "type": ["Permission", "Navigate", "Placement"],
-      "permission": "string",
+      "type": "$ref:event-constants.eventTypes",
+      "permission": "$ref:event-constants.permissionTypes",
       "navigate_to": "string",
       "targetIndex": "number",
-      "placementKey": "string"
+      "placementKey": "$ref:event-constants.placementKeys",
+      "conditionKey": "$ref:event-constants.conditionKeys",
+      "value": "boolean"
     }
   },
   "meta": {

package/src/build-components/OnboardProvider/OnboardProviderProps.generated.ts

@@ -3,6 +3,17 @@
 import type { NodeData } from '../../types/Node';
 
 export type ThemeOptionType = 'light' | 'dark' | 'all';
+export type AnimationOptionType =
+  | 'default'
+  | 'fade'
+  | 'fade_from_bottom'
+  | 'fade_from_right'
+  | 'reveal_from_bottom'
+  | 'scale_from_center'
+  | 'slide_from_right'
+  | 'slide_from_left'
+  | 'slide_from_bottom'
+  | 'none';
 export type FlexDirectionOptionType = 'row' | 'column';
 export type FlexWrapOptionType = 'nowrap' | 'wrap' | 'wrap-reverse';
 export type AlignItemsOptionType =
@@ -65,6 +76,7 @@ export interface OnboardProviderPropsGenerated {
     testID?: string;
     theme?: ThemeOptionType;
     borderRadius?: never;
+    animation?: AnimationOptionType;
   };
 }
 

package/src/build-components/OnboardProvider/pattern.json

@@ -8,7 +8,8 @@
     "extends": "View",
     "attributes": {
       "theme": ["light", "dark", "all"],
-      "borderRadius": "never"
+      "borderRadius": "never",
+      "animation": ["default", "fade", "fade_from_bottom", "fade_from_right", "reveal_from_bottom", "scale_from_center", "slide_from_right", "slide_from_left", "slide_from_bottom", "none"]
     }
   },
   "defaults": {
@@ -30,6 +31,13 @@
         "specialCategory": null,
         "sort": -10
       },
+      "animation": {
+        "label": "Page transition animation",
+        "description": "When this component is a GlobalProvider page: animation used when navigating to this screen.",
+        "category": "other",
+        "specialCategory": null,
+        "sort": 2
+      },
       "styles": {
         "paddingTop": {
           "label": "Padding Top",

package/src/build-components/PaywallProvider/PaywallProviderProps.generated.ts

@@ -2,6 +2,17 @@
 
 import type { NodeData } from '../../types/Node';
 
+export type AnimationOptionType =
+  | 'default'
+  | 'fade'
+  | 'fade_from_bottom'
+  | 'fade_from_right'
+  | 'reveal_from_bottom'
+  | 'scale_from_center'
+  | 'slide_from_right'
+  | 'slide_from_left'
+  | 'slide_from_bottom'
+  | 'none';
 export type FlexDirectionOptionType = 'row' | 'column';
 export type FlexWrapOptionType = 'nowrap' | 'wrap' | 'wrap-reverse';
 export type AlignItemsOptionType =
@@ -63,6 +74,7 @@ export interface PaywallProviderPropsGenerated {
     scrollable?: boolean;
     testID?: string;
     delay?: number;
+    animation?: AnimationOptionType;
   };
 }