@pushframe/sdk 0.1.1 → 0.1.2

package/dist/index.d.mts

@@ -127,15 +127,23 @@ declare class ComponentRegistry {
 }
 
 interface SchemaNode {
+    id?: string;
     type: string;
     props?: Record<string, unknown>;
     children?: SchemaNode[];
+    /** Per-item render template for flatlist nodes. */
+    itemTemplate?: SchemaNode;
     actions?: Action[];
-    if?: string;
+    /**
+     * Conditional render expression. String values are resolved against the
+     * context via {{}} binding syntax. Non-string values (boolean, number, null)
+     * are coerced directly. Falsy → node is hidden.
+     */
+    if?: unknown;
 }
 interface FlatListSchemaNode extends SchemaNode {
     type: 'flatlist';
-    renderItem: SchemaNode;
+    itemTemplate: SchemaNode;
 }
 interface Action {
     trigger: string;
@@ -179,17 +187,22 @@ interface PushFrameTextProps extends TextProps {
     /** Pushframe: converted to handlers by RecursiveRenderer before component renders. */
     actions?: Action[];
     /**
-     * Text content via binding. If provided, takes precedence over children.
-     * Pushframe-specific — resolved to a string by the time the component renders.
+     * Text content. Takes precedence over `children`.
+     * Pushframe schema convention: use `value`.
      */
     value?: string;
+    /**
+     * Alias for `value`. The transformer outputs the Craft editor's `content`
+     * field here. `value` takes precedence when both are present.
+     */
+    content?: string;
 }
 /**
  * Thin wrapper over React Native Text.
- * Strips `if`, `actions` before forwarding to RN.
- * `value` takes precedence over `children` when both are present.
+ * Strips `if`, `actions`, `content` before forwarding to RN.
+ * Display priority: value > content > children (children remain in rest).
  */
-declare function Text({ if: _if, actions: _actions, value, children, ...rest }: PushFrameTextProps): react_jsx_runtime.JSX.Element;
+declare function Text({ if: _if, actions: _actions, value, content, ...rest }: PushFrameTextProps): react_jsx_runtime.JSX.Element;
 
 interface PushFrameViewProps extends ViewProps {
     if?: string;
@@ -331,11 +344,18 @@ declare function KeyboardAvoidingView({ if: _if, actions: _actions, ...rest }: P
 interface PushFrameSafeAreaViewProps extends ViewProps {
     if?: string;
     actions?: Action[];
+    /**
+     * Edges to apply safe-area insets on.
+     * Forwarded to react-native-safe-area-context's SafeAreaView when available.
+     * Example: ['top', 'bottom']
+     */
+    edges?: string[];
 }
 /**
  * Thin wrapper over SafeAreaView.
  * Uses react-native-safe-area-context when available, RN core otherwise.
- * Strips `if`, `actions` before forwarding to the underlying component.
+ * Strips `if`, `actions` before forwarding; passes `edges` through to
+ * react-native-safe-area-context (ignored gracefully in the RN core fallback).
  */
 declare function SafeAreaView({ if: _if, actions: _actions, ...rest }: PushFrameSafeAreaViewProps): react_jsx_runtime.JSX.Element;
 
@@ -365,9 +385,12 @@ interface RecursiveRendererProps {
 /**
  * Stateless recursive renderer. Evaluates schema nodes and produces React elements.
  *
- * - Evaluates `if` expression; returns null when falsy
- * - Handles FlatList nodes with per-item context injection
+ * - Evaluates `if` expression (string or non-string); returns null when falsy
+ * - Handles `visible` prop: returns null when visible resolves to false
+ * - Handles FlatList nodes with per-item context injection via `itemTemplate`
+ * - Supports `data` (transformer) and `items` (legacy) as FlatList data source
  * - Resolves all prop bindings against current context
+ * - Merges `_propValues` into child context (custom component prop injection)
  * - Wires actions to component event handler props
  * - Looks up component in registry; renders fallback or null when not found
  * - Recurses into children
@@ -407,9 +430,13 @@ declare function resolveDeep(value: unknown, context: Record<string, unknown>):
  * Returns false → node (and its entire subtree) should be skipped
  *
  * Falsy values: false, null, undefined, 0, "" all hide the node.
- * When `ifExpr` is undefined the node always renders.
+ * When `ifExpr` is undefined/null the node always renders.
+ *
+ * Accepts `unknown` to match the transformer's `if?: unknown` output:
+ *   - String values are resolved as {{}} binding expressions
+ *   - Non-string values (boolean, number, null) are coerced directly
  */
-declare function evaluateIf(ifExpr: string | undefined, context: Record<string, unknown>): boolean;
+declare function evaluateIf(ifExpr: unknown, context: Record<string, unknown>): boolean;
 
 interface PushFrameScrollViewProps extends ScrollViewProps {
     if?: string;
@@ -422,6 +449,55 @@ interface PushFrameScrollViewProps extends ScrollViewProps {
  */
 declare const ScrollView: React__default.ForwardRefExoticComponent<PushFrameScrollViewProps & React__default.RefAttributes<ScrollView$1>>;
 
+/**
+ * Craft.js → PushFrame SDUI transformer
+ *
+ * Converts a Craft.js editor schema (produced by the dashboard) into the
+ * SDUINode tree consumed by the SDK's RecursiveRenderer at runtime.
+ *
+ * This module is intended for use by the backend/service layer or the
+ * dashboard — it is NOT executed inside the React Native app at runtime.
+ */
+
+type CraftNode = {
+    type: {
+        resolvedName: string;
+    };
+    props?: Record<string, unknown>;
+    nodes?: string[];
+    parent?: string;
+};
+type CraftSchema = Record<string, CraftNode>;
+/**
+ * The SDUI node shape produced by this transformer and consumed by the SDK's
+ * RecursiveRenderer. Aligned with `SchemaNode` from the SDK context.
+ */
+interface SDUINode extends SchemaNode {
+    id: string;
+    type: string;
+    props: Record<string, unknown>;
+    children?: SDUINode[];
+    /** FlatList per-item render template. */
+    itemTemplate?: SDUINode;
+    /** Conditional render expression. Falsy → node is hidden. */
+    if?: unknown;
+    actions?: Action[];
+}
+interface CustomComponentDef {
+    rootNodeId: string;
+    nodes: CraftSchema;
+}
+type CustomComponentsMap = Record<string, CustomComponentDef>;
+/**
+ * Convert a Craft.js editor schema into an SDUINode tree ready for the SDK's
+ * RecursiveRenderer.
+ *
+ * @param craftJson   - The full Craft.js node map (keyed by node ID, must include "ROOT").
+ * @param customComponents - Optional map of reusable component definitions.
+ * @returns The root SDUINode.
+ */
+declare function transformCraftToSDUI(craftJson: CraftSchema, customComponents?: CustomComponentsMap): SDUINode;
+
 /**
  * The PushFrame namespace. Import this as the single entry-point for the SDK.
  *
@@ -455,4 +531,4 @@ declare const PushFrame: {
     readonly StatusBar: typeof StatusBar;
 };
 
-export { type Action, ActivityIndicator, type BottomSheetPayload, ComponentRegistry, type DispatchAction, FlatList, type FlatListSchemaNode, Image, KeyboardAvoidingView, Modal, Pressable, PushFrame, type PushFrameActivityIndicatorProps, PushFrameComponent, PushFrameContext, type PushFrameContextValue, type PushFrameFlatListProps, type PushFrameImageProps, type PushFrameKeyboardAvoidingViewProps, type PushFrameModalProps, type PushFramePressableProps, PushFrameProvider, type PushFrameProviderProps, type PushFrameSafeAreaViewProps, PushFrameScreen, type PushFrameScrollViewProps, type PushFrameSlotProps, type PushFrameStatusBarProps, type PushFrameSwitchProps, type PushFrameTextInputProps, type PushFrameTextProps, type PushFrameViewProps, RecursiveRenderer, type RecursiveRendererProps, SafeAreaView, type SchemaNode, type ScrollToPayload, ScrollView, StatusBar, Switch, Text, TextInput, type ToastPayload, View, evaluateIf, resolveDeep, resolveProps, resolveValue, usePushFrameContext };
+export { type Action, ActivityIndicator, type BottomSheetPayload, ComponentRegistry, type CraftNode, type CraftSchema, type CustomComponentDef, type CustomComponentsMap, type DispatchAction, FlatList, type FlatListSchemaNode, Image, KeyboardAvoidingView, Modal, Pressable, PushFrame, type PushFrameActivityIndicatorProps, PushFrameComponent, PushFrameContext, type PushFrameContextValue, type PushFrameFlatListProps, type PushFrameImageProps, type PushFrameKeyboardAvoidingViewProps, type PushFrameModalProps, type PushFramePressableProps, PushFrameProvider, type PushFrameProviderProps, type PushFrameSafeAreaViewProps, PushFrameScreen, type PushFrameScrollViewProps, type PushFrameSlotProps, type PushFrameStatusBarProps, type PushFrameSwitchProps, type PushFrameTextInputProps, type PushFrameTextProps, type PushFrameViewProps, RecursiveRenderer, type RecursiveRendererProps, type SDUINode, SafeAreaView, type SchemaNode, type ScrollToPayload, ScrollView, StatusBar, Switch, Text, TextInput, type ToastPayload, View, evaluateIf, resolveDeep, resolveProps, resolveValue, transformCraftToSDUI, usePushFrameContext };

package/dist/index.d.ts

@@ -127,15 +127,23 @@ declare class ComponentRegistry {
 }
 
 interface SchemaNode {
+    id?: string;
     type: string;
     props?: Record<string, unknown>;
     children?: SchemaNode[];
+    /** Per-item render template for flatlist nodes. */
+    itemTemplate?: SchemaNode;
     actions?: Action[];
-    if?: string;
+    /**
+     * Conditional render expression. String values are resolved against the
+     * context via {{}} binding syntax. Non-string values (boolean, number, null)
+     * are coerced directly. Falsy → node is hidden.
+     */
+    if?: unknown;
 }
 interface FlatListSchemaNode extends SchemaNode {
     type: 'flatlist';
-    renderItem: SchemaNode;
+    itemTemplate: SchemaNode;
 }
 interface Action {
     trigger: string;
@@ -179,17 +187,22 @@ interface PushFrameTextProps extends TextProps {
     /** Pushframe: converted to handlers by RecursiveRenderer before component renders. */
     actions?: Action[];
     /**
-     * Text content via binding. If provided, takes precedence over children.
-     * Pushframe-specific — resolved to a string by the time the component renders.
+     * Text content. Takes precedence over `children`.
+     * Pushframe schema convention: use `value`.
      */
     value?: string;
+    /**
+     * Alias for `value`. The transformer outputs the Craft editor's `content`
+     * field here. `value` takes precedence when both are present.
+     */
+    content?: string;
 }
 /**
  * Thin wrapper over React Native Text.
- * Strips `if`, `actions` before forwarding to RN.
- * `value` takes precedence over `children` when both are present.
+ * Strips `if`, `actions`, `content` before forwarding to RN.
+ * Display priority: value > content > children (children remain in rest).
  */
-declare function Text({ if: _if, actions: _actions, value, children, ...rest }: PushFrameTextProps): react_jsx_runtime.JSX.Element;
+declare function Text({ if: _if, actions: _actions, value, content, ...rest }: PushFrameTextProps): react_jsx_runtime.JSX.Element;
 
 interface PushFrameViewProps extends ViewProps {
     if?: string;
@@ -331,11 +344,18 @@ declare function KeyboardAvoidingView({ if: _if, actions: _actions, ...rest }: P
 interface PushFrameSafeAreaViewProps extends ViewProps {
     if?: string;
     actions?: Action[];
+    /**
+     * Edges to apply safe-area insets on.
+     * Forwarded to react-native-safe-area-context's SafeAreaView when available.
+     * Example: ['top', 'bottom']
+     */
+    edges?: string[];
 }
 /**
  * Thin wrapper over SafeAreaView.
  * Uses react-native-safe-area-context when available, RN core otherwise.
- * Strips `if`, `actions` before forwarding to the underlying component.
+ * Strips `if`, `actions` before forwarding; passes `edges` through to
+ * react-native-safe-area-context (ignored gracefully in the RN core fallback).
  */
 declare function SafeAreaView({ if: _if, actions: _actions, ...rest }: PushFrameSafeAreaViewProps): react_jsx_runtime.JSX.Element;
 
@@ -365,9 +385,12 @@ interface RecursiveRendererProps {
 /**
  * Stateless recursive renderer. Evaluates schema nodes and produces React elements.
  *
- * - Evaluates `if` expression; returns null when falsy
- * - Handles FlatList nodes with per-item context injection
+ * - Evaluates `if` expression (string or non-string); returns null when falsy
+ * - Handles `visible` prop: returns null when visible resolves to false
+ * - Handles FlatList nodes with per-item context injection via `itemTemplate`
+ * - Supports `data` (transformer) and `items` (legacy) as FlatList data source
  * - Resolves all prop bindings against current context
+ * - Merges `_propValues` into child context (custom component prop injection)
  * - Wires actions to component event handler props
  * - Looks up component in registry; renders fallback or null when not found
  * - Recurses into children
@@ -407,9 +430,13 @@ declare function resolveDeep(value: unknown, context: Record<string, unknown>):
  * Returns false → node (and its entire subtree) should be skipped
  *
  * Falsy values: false, null, undefined, 0, "" all hide the node.
- * When `ifExpr` is undefined the node always renders.
+ * When `ifExpr` is undefined/null the node always renders.
+ *
+ * Accepts `unknown` to match the transformer's `if?: unknown` output:
+ *   - String values are resolved as {{}} binding expressions
+ *   - Non-string values (boolean, number, null) are coerced directly
  */
-declare function evaluateIf(ifExpr: string | undefined, context: Record<string, unknown>): boolean;
+declare function evaluateIf(ifExpr: unknown, context: Record<string, unknown>): boolean;
 
 interface PushFrameScrollViewProps extends ScrollViewProps {
     if?: string;
@@ -422,6 +449,55 @@ interface PushFrameScrollViewProps extends ScrollViewProps {
  */
 declare const ScrollView: React__default.ForwardRefExoticComponent<PushFrameScrollViewProps & React__default.RefAttributes<ScrollView$1>>;
 
+/**
+ * Craft.js → PushFrame SDUI transformer
+ *
+ * Converts a Craft.js editor schema (produced by the dashboard) into the
+ * SDUINode tree consumed by the SDK's RecursiveRenderer at runtime.
+ *
+ * This module is intended for use by the backend/service layer or the
+ * dashboard — it is NOT executed inside the React Native app at runtime.
+ */
+
+type CraftNode = {
+    type: {
+        resolvedName: string;
+    };
+    props?: Record<string, unknown>;
+    nodes?: string[];
+    parent?: string;
+};
+type CraftSchema = Record<string, CraftNode>;
+/**
+ * The SDUI node shape produced by this transformer and consumed by the SDK's
+ * RecursiveRenderer. Aligned with `SchemaNode` from the SDK context.
+ */
+interface SDUINode extends SchemaNode {
+    id: string;
+    type: string;
+    props: Record<string, unknown>;
+    children?: SDUINode[];
+    /** FlatList per-item render template. */
+    itemTemplate?: SDUINode;
+    /** Conditional render expression. Falsy → node is hidden. */
+    if?: unknown;
+    actions?: Action[];
+}
+interface CustomComponentDef {
+    rootNodeId: string;
+    nodes: CraftSchema;
+}
+type CustomComponentsMap = Record<string, CustomComponentDef>;
+/**
+ * Convert a Craft.js editor schema into an SDUINode tree ready for the SDK's
+ * RecursiveRenderer.
+ *
+ * @param craftJson   - The full Craft.js node map (keyed by node ID, must include "ROOT").
+ * @param customComponents - Optional map of reusable component definitions.
+ * @returns The root SDUINode.
+ */
+declare function transformCraftToSDUI(craftJson: CraftSchema, customComponents?: CustomComponentsMap): SDUINode;
+
 /**
  * The PushFrame namespace. Import this as the single entry-point for the SDK.
  *
@@ -455,4 +531,4 @@ declare const PushFrame: {
     readonly StatusBar: typeof StatusBar;
 };
 
-export { type Action, ActivityIndicator, type BottomSheetPayload, ComponentRegistry, type DispatchAction, FlatList, type FlatListSchemaNode, Image, KeyboardAvoidingView, Modal, Pressable, PushFrame, type PushFrameActivityIndicatorProps, PushFrameComponent, PushFrameContext, type PushFrameContextValue, type PushFrameFlatListProps, type PushFrameImageProps, type PushFrameKeyboardAvoidingViewProps, type PushFrameModalProps, type PushFramePressableProps, PushFrameProvider, type PushFrameProviderProps, type PushFrameSafeAreaViewProps, PushFrameScreen, type PushFrameScrollViewProps, type PushFrameSlotProps, type PushFrameStatusBarProps, type PushFrameSwitchProps, type PushFrameTextInputProps, type PushFrameTextProps, type PushFrameViewProps, RecursiveRenderer, type RecursiveRendererProps, SafeAreaView, type SchemaNode, type ScrollToPayload, ScrollView, StatusBar, Switch, Text, TextInput, type ToastPayload, View, evaluateIf, resolveDeep, resolveProps, resolveValue, usePushFrameContext };
+export { type Action, ActivityIndicator, type BottomSheetPayload, ComponentRegistry, type CraftNode, type CraftSchema, type CustomComponentDef, type CustomComponentsMap, type DispatchAction, FlatList, type FlatListSchemaNode, Image, KeyboardAvoidingView, Modal, Pressable, PushFrame, type PushFrameActivityIndicatorProps, PushFrameComponent, PushFrameContext, type PushFrameContextValue, type PushFrameFlatListProps, type PushFrameImageProps, type PushFrameKeyboardAvoidingViewProps, type PushFrameModalProps, type PushFramePressableProps, PushFrameProvider, type PushFrameProviderProps, type PushFrameSafeAreaViewProps, PushFrameScreen, type PushFrameScrollViewProps, type PushFrameSlotProps, type PushFrameStatusBarProps, type PushFrameSwitchProps, type PushFrameTextInputProps, type PushFrameTextProps, type PushFrameViewProps, RecursiveRenderer, type RecursiveRendererProps, type SDUINode, SafeAreaView, type SchemaNode, type ScrollToPayload, ScrollView, StatusBar, Switch, Text, TextInput, type ToastPayload, View, evaluateIf, resolveDeep, resolveProps, resolveValue, transformCraftToSDUI, usePushFrameContext };