@developer_tribe/react-builder 1.2.42 → 1.2.44-test.1

package/src/build-components/GlobalProvider/GlobalProviderProps.generated.ts

@@ -0,0 +1,78 @@
+/* AUTO-GENERATED FILE - DO NOT EDIT */
+
+import type { NodeData } from '../../types/Node';
+
+export type FlexDirectionOptionType = 'row' | 'column';
+export type FlexWrapOptionType = 'nowrap' | 'wrap' | 'wrap-reverse';
+export type AlignItemsOptionType =
+  | 'flex-start'
+  | 'center'
+  | 'flex-end'
+  | 'stretch'
+  | 'baseline';
+export type JustifyContentOptionType =
+  | 'flex-start'
+  | 'center'
+  | 'flex-end'
+  | 'space-between'
+  | 'space-around'
+  | 'space-evenly';
+export type PositionOptionType = 'relative' | 'absolute';
+
+export interface SkipConditionEntryGenerated {
+  pageKey?: string;
+  conditionKey?: string;
+}
+
+export interface GlobalProviderStyleGenerated {
+  flexDirection?: FlexDirectionOptionType;
+  flexWrap?: FlexWrapOptionType;
+  alignItems?: AlignItemsOptionType;
+  justifyContent?: JustifyContentOptionType;
+  gap?: string;
+  padding?: string;
+  paddingHorizontal?: string;
+  paddingVertical?: string;
+  paddingTop?: string;
+  paddingBottom?: string;
+  paddingLeft?: string;
+  paddingRight?: string;
+  margin?: string;
+  marginHorizontal?: string;
+  marginVertical?: string;
+  marginTop?: string;
+  marginBottom?: string;
+  marginLeft?: string;
+  marginRight?: string;
+  backgroundColor?: string;
+  borderRadius?: string;
+  width?: string;
+  minWidth?: string;
+  maxWidth?: string;
+  height?: string;
+  minHeight?: string;
+  maxHeight?: string;
+  flex?: number;
+  position?: PositionOptionType;
+  top?: string;
+  bottom?: string;
+  left?: string;
+  right?: string;
+  zIndex?: number;
+}
+
+export interface GlobalProviderPropsGenerated {
+  child: string;
+  attributes: {
+    styles?: GlobalProviderStyleGenerated;
+    scrollable?: boolean;
+    testID?: string;
+    initialPage?: string;
+    persistProgress?: boolean;
+    skipConditions?: SkipConditionEntryGenerated[];
+  };
+}
+
+export interface GlobalProviderComponentProps {
+  node: NodeData<GlobalProviderPropsGenerated['attributes']>;
+}

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

@@ -0,0 +1,163 @@
+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 page key for a child node.
+ * Priority: node.key (standard NodeData field) → TYPE_KEY_MAP → "${type}-{index}"
+ *
+ * Using node.key avoids adding unknown attributes to child components that
+ * would fail builder validation.
+ */
+export function derivePageKey(node: NodeData, index: number): string {
+  if (typeof node.key === 'string' && node.key.trim()) {
+    return node.key.trim();
+  }
+  const mapped = TYPE_KEY_MAP[node.type];
+  if (mapped) {
+    return mapped;
+  }
+  const typeSlug = node.type?.toLowerCase?.() ?? 'page';
+  return `${typeSlug}-${index}`;
+}
+
+/** 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.
+ * Array format is used in pattern.json because the schema system doesn't support
+ * plain Record/object attribute types.
+ */
+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.
+ *
+ * @param children - direct child nodes of GlobalProvider
+ * @param skipConditions - lookup map of pageKey → conditionKey, already normalized
+ *   from SkipConditionEntry[] via normalizeSkipConditions().
+ */
+export function buildPages(
+  children: NodeData[],
+  skipConditions: Record<string, string> = {},
+): GlobalPage[] {
+  return children.map((node, index) => {
+    const key = derivePageKey(node, index);
+    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 {
+  const targetIdx = pages.findIndex((p) => p.key === targetKey);
+  if (targetIdx === -1) {
+    return pages[0]?.key ?? targetKey;
+  }
+
+  // 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;
+  }
+
+  // All remaining pages are skipped — return last page key anyway
+  return pages[pages.length - 1]?.key ?? targetKey;
+}
+
+const STORAGE_KEY_PREFIX = 'global-provider-progress';
+
+export function persistProgress(
+  storageKey: string,
+  currentPageKey: string,
+  conditions: Record<string, boolean>,
+): void {
+  try {
+    localStorage.setItem(
+      `${STORAGE_KEY_PREFIX}-${storageKey}`,
+      JSON.stringify({ currentPageKey, conditions }),
+    );
+  } catch {
+    // localStorage unavailable (SSR, private browsing etc.)
+  }
+}
+
+export function loadProgress(storageKey: string): {
+  currentPageKey: string;
+  conditions: Record<string, boolean>;
+} | null {
+  try {
+    const raw = localStorage.getItem(`${STORAGE_KEY_PREFIX}-${storageKey}`);
+    if (!raw) return null;
+    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 {
+  try {
+    localStorage.removeItem(`${STORAGE_KEY_PREFIX}-${storageKey}`);
+  } catch {
+    // localStorage unavailable
+  }
+}

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,70 @@
+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
+        console.log('target', target);
+        console.log('globalCtx.pages', globalCtx.pages);
+        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];
+        console.log('canonicalKey', canonicalKey);
+        if (
+          canonicalKey &&
+          globalCtx.pages.some((p) => p.key === canonicalKey)
+        ) {
+          console.log('navigate to canonicalKey', canonicalKey);
+          globalCtx.navigate(canonicalKey);
+          return true;
+        }
+      }
+
+      console.log('fallback to MockOSContext', target);
+      // Fallback: delegate to MockOSContext
+      if (mockOS) {
+        mockOS.navigation(target as RouteType);
+        return true;
+      }
+
+      return false;
+    },
+    [globalCtx, mockOS],
+  );
+}

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

@@ -1,8 +1,5 @@
-import React, { useContext, useId, useRef } from 'react';
-import type {
-  EventObjectGenerated,
-  OnboardButtonComponentProps,
-} from './OnboardButtonProps.generated';
+import React, { useContext, useId, useCallback } from 'react';
+import type { OnboardButtonComponentProps } from './OnboardButtonProps.generated';
 import { onboardContext } from '../OnboardProvider/OnboardProvider';
 import useNode from '../useNode';
 import { useBuilderParams } from '../../components/BuilderProvider';
@@ -11,6 +8,11 @@ import { useExtractViewStyle } from '../../attribute-analyser/style/web/useExtra
 import { useMockOSContext, useMockPermission } from '../../mockOS';
 import { useLocalize } from '../../hooks/useLocalize';
 import { parseColor } from '../../utils/parseColor';
+import {
+  usePlacementButtonEvents,
+  type PlacementEventObject,
+} from '../SystemButton/usePlacementButtonEvents';
+import { useGlobalNavigation } from '../GlobalProvider/useGlobalNavigation';
 
 export function OnboardButton({ node }: OnboardButtonComponentProps) {
   useLogRender('OnboardButton');
@@ -20,7 +22,7 @@ export function OnboardButton({ node }: OnboardButtonComponentProps) {
   const { selectedTheme: theme, projectColors } = useBuilderParams();
   const context = useMockOSContext();
   const mockPermissionManager = useMockPermission(context);
-  const handledEventsRef = useRef<EventObjectGenerated[]>([]);
+  const globalNavigate = useGlobalNavigation();
   const generatedId = useId();
   const attributeKey = node.key ?? generatedId;
   const attrs = node.attributes;
@@ -30,40 +32,43 @@ export function OnboardButton({ node }: OnboardButtonComponentProps) {
   const rawTextColor = attrs?.styles?.color as string | undefined;
   const textColor = parseColor(rawTextColor, { projectColors, theme });
   const viewStyle = useExtractViewStyle(node);
-  const handleClick = async () => {
-    //TODO: any ??
-    const events: EventObjectGenerated[] = attrs?.events ?? [];
 
-    for (const e of events) {
-      // Check if event is already handled
-      if (handledEventsRef.current.includes(e)) {
-        continue;
+  const onNavigateWithoutPlacement = useCallback(
+    (e: PlacementEventObject): boolean => {
+      const eventTargetIndex = e.targetIndex;
+      if (typeof eventTargetIndex === 'number') {
+        emblaApi?.scrollTo(eventTargetIndex);
+        return true;
       }
-
-      if (e.type === 'Permission') {
-        const permission = e.permission ?? 'camera';
-        await mockPermissionManager.requestPermission(permission);
-        handledEventsRef.current.push(e);
-      } else if (e.type === 'Navigate') {
-        const eventTargetIndex = e.targetIndex;
-        if (typeof eventTargetIndex === 'number') {
-          emblaApi?.scrollTo(eventTargetIndex);
-          handledEventsRef.current.push(e);
-        } else if (e.navigate_to) {
-          const eventTarget = e.navigate_to;
-          if (typeof eventTarget === 'string') {
-            handledEventsRef.current.push(e);
-            if (context) {
-              context.navigation(eventTarget as any);
-            } else {
-              console.warn('Mock OS context not available for navigation.');
-            }
-          }
+      if (e.navigate_to && typeof e.navigate_to === 'string') {
+        if (globalNavigate(e.navigate_to)) return true;
+        if (context) {
+          context.navigation(
+            e.navigate_to as
+              | 'onboard'
+              | 'terms'
+              | 'subscription'
+              | 'app'
+              | 'home'
+              | 'launchscreen',
+          );
+        } else {
+          console.warn('Mock OS context not available for navigation.');
         }
+        return true;
       }
-    }
-    // Fallback: do nothing when there is no Navigate event
-  };
+      return false;
+    },
+    [emblaApi, context, globalNavigate],
+  );
+
+  const handleClick = usePlacementButtonEvents(attrs?.events, {
+    context,
+    requestPermission: (permission) =>
+      mockPermissionManager.requestPermission(permission),
+    onNavigateWithoutPlacement,
+    globalNavigate,
+  });
 
   return (
     <button

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

@@ -2,8 +2,7 @@
 
 import type { NodeData } from '../../types/Node';
 
-export type TypeOptionType = 'Permission' | 'Navigate';
-export type PermissionOptionType = 'att' | 'notification' | 'rating' | 'GDPR';
+export type TypeOptionType = 'Permission' | 'Navigate' | 'Placement';
 export type TestIDOptionType = 'onboardSkip' | 'onboardNext';
 export type AnimationOptionType =
   | 'simple-animation'
@@ -30,12 +29,21 @@ export type PositionOptionType = 'relative' | 'absolute';
 
 export interface EventObjectGenerated {
   type?: TypeOptionType;
-  permission?: PermissionOptionType | null;
+  permission?: string;
   navigate_to?: string;
   targetIndex?: number;
+  placementKey?: string;
 }
 
 export interface OnboardButtonStyleGenerated {
+  color?: string;
+  backgroundColor?: string;
+  height?: string;
+  borderRadius?: string;
+  fontSize?: string;
+  fontWeight?: string;
+  fontFamily?: string;
+  textAlign?: string;
   flexDirection?: FlexDirectionOptionType;
   flexWrap?: FlexWrapOptionType;
   alignItems?: AlignItemsOptionType;
@@ -55,12 +63,9 @@ export interface OnboardButtonStyleGenerated {
   marginBottom?: string;
   marginLeft?: string;
   marginRight?: string;
-  backgroundColor?: string;
-  borderRadius?: string;
   width?: string;
   minWidth?: string;
   maxWidth?: string;
-  height?: string;
   minHeight?: string;
   maxHeight?: string;
   flex?: number;
@@ -70,19 +75,21 @@ export interface OnboardButtonStyleGenerated {
   left?: string;
   right?: string;
   zIndex?: number;
-  color?: string;
 }
 
 export interface OnboardButtonPropsGenerated {
   child: string;
   attributes: {
     styles?: OnboardButtonStyleGenerated;
-    scrollable?: boolean;
-    testID?: TestIDOptionType;
     labelKey?: string;
+    events?: EventObjectGenerated[];
+    testID?: TestIDOptionType;
+    adjustsFontSizeToFit?: boolean;
+    numberOfLines?: number;
+    translateCounter?: number;
+    scrollable?: boolean;
     animation?: AnimationOptionType;
     animation_color?: string;
-    events?: EventObjectGenerated[];
   };
 }
 

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

@@ -5,7 +5,7 @@
     "title": "title",
     "description": "description",
     "children": "never",
-    "extends": "View",
+    "extends": "SystemButton",
     "attributes": {
       "labelKey": "string",
       "animation": [
@@ -32,10 +32,11 @@
   },
   "types": {
     "EventObject": {
-      "type": ["Permission", "Navigate"],
-      "permission": ["att", "notification", "rating", "GDPR", "null"],
+      "type": ["Permission", "Navigate", "Placement"],
+      "permission": "string",
       "navigate_to": "string",
-      "targetIndex": "number"
+      "targetIndex": "number",
+      "placementKey": "string"
     }
   },
   "meta": {

package/src/build-components/OnboardFooter/OnboardFooterProps.generated.ts

@@ -66,7 +66,7 @@ export interface OnboardFooterPropsGenerated {
   attributes: {
     styles?: OnboardFooterStyleGenerated;
     adjustsFontSizeToFit?: boolean;
-    showEllipsis?: boolean;
+    numberOfLines?: number;
     translateCounter?: number;
     scrollable?: boolean;
     testID?: string;

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/OnboardSubtitle/OnboardSubtitleProps.generated.ts

@@ -66,7 +66,7 @@ export interface OnboardSubtitlePropsGenerated {
   attributes: {
     styles?: OnboardSubtitleStyleGenerated;
     adjustsFontSizeToFit?: boolean;
-    showEllipsis?: boolean;
+    numberOfLines?: number;
     translateCounter?: number;
     scrollable?: boolean;
     testID?: string;

package/src/build-components/OnboardTitle/OnboardTitleProps.generated.ts

@@ -66,7 +66,7 @@ export interface OnboardTitlePropsGenerated {
   attributes: {
     styles?: OnboardTitleStyleGenerated;
     adjustsFontSizeToFit?: boolean;
-    showEllipsis?: boolean;
+    numberOfLines?: number;
     translateCounter?: number;
     scrollable?: boolean;
     testID?: string;

package/src/build-components/PaywallCloseButton/PaywallCloseButtonProps.generated.ts

@@ -69,7 +69,7 @@ export interface PaywallCloseButtonPropsGenerated {
     size?: number;
     strokeWidth?: number;
     adjustsFontSizeToFit?: boolean;
-    showEllipsis?: boolean;
+    numberOfLines?: number;
     translateCounter?: number;
     scrollable?: boolean;
     testID?: string;

package/src/build-components/PaywallFooter/PaywallFooterProps.generated.ts

@@ -66,7 +66,7 @@ export interface PaywallFooterPropsGenerated {
   attributes: {
     styles?: PaywallFooterStyleGenerated;
     adjustsFontSizeToFit?: boolean;
-    showEllipsis?: boolean;
+    numberOfLines?: number;
     translateCounter?: number;
     scrollable?: boolean;
     testID?: string;