@sonata-innovations/fiber-fbre 2.0.0

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+import { Component } from '@sonata-innovations/fiber-types';
+import { ComponentData } from '@sonata-innovations/fiber-types';
+import { ComponentDisplayProperties } from '@sonata-innovations/fiber-types';
+import { ComponentDividerProperties } from '@sonata-innovations/fiber-types';
+import { ComponentFileUploadProperties } from '@sonata-innovations/fiber-types';
+import { ComponentGroupProperties } from '@sonata-innovations/fiber-types';
+import { ComponentInputProperties } from '@sonata-innovations/fiber-types';
+import { ComponentOptionProperties } from '@sonata-innovations/fiber-types';
+import { ComponentProperties } from '@sonata-innovations/fiber-types';
+import { ComponentRatingProperties } from '@sonata-innovations/fiber-types';
+import { ComponentSliderProperties } from '@sonata-innovations/fiber-types';
+import { ComponentSwitchProperties } from '@sonata-innovations/fiber-types';
+import { ConditionGroup } from '@sonata-innovations/fiber-types';
+import { ConditionOperator } from '@sonata-innovations/fiber-types';
+import { ConditionRule } from '@sonata-innovations/fiber-types';
+import { ControlsConfig } from '@sonata-innovations/fiber-types';
+import { FC } from 'react';
+import { FileUploadBase64Data } from '@sonata-innovations/fiber-types';
+import { FileUploadData } from '@sonata-innovations/fiber-types';
+import { FileUploadS3Data } from '@sonata-innovations/fiber-types';
+import { Flow } from '@sonata-innovations/fiber-types';
+import { FlowCalculation } from '@sonata-innovations/fiber-types';
+import { FlowConditionConfig } from '@sonata-innovations/fiber-types';
+import { FlowConfiguration } from '@sonata-innovations/fiber-types';
+import { FlowData } from '@sonata-innovations/fiber-types';
+import { FlowMetadata } from '@sonata-innovations/fiber-types';
+import { FlowScreen } from '@sonata-innovations/fiber-types';
+import { FlowValidationConfig } from '@sonata-innovations/fiber-types';
+import { NavigationConfig } from '@sonata-innovations/fiber-types';
+import { ScreenData } from '@sonata-innovations/fiber-types';
+import { StoreApi } from 'zustand';
+import { ThemeConfig } from '@sonata-innovations/fiber-types';
+
+export declare const addFBREEventListener: (type: string, callback: EventCallback) => void;
+
+export declare class ApiError extends Error {
+    status: number;
+    code?: string;
+    validationErrors?: Record<string, string[]>;
+    constructor(message: string, status: number, code?: string, validationErrors?: Record<string, string[]>);
+}
+
+export { Component }
+
+export { ComponentData }
+
+export { ComponentDisplayProperties }
+
+export { ComponentDividerProperties }
+
+export { ComponentFileUploadProperties }
+
+export { ComponentGroupProperties }
+
+export { ComponentInputProperties }
+
+export { ComponentOptionProperties }
+
+export { ComponentProperties }
+
+export { ComponentRatingProperties }
+
+export { ComponentSliderProperties }
+
+export { ComponentSwitchProperties }
+
+/**
+ * Condition dependency entry — one per target that depends on a source.
+ * The key in conditionsByDependency is the source UUID.
+ */
+export declare type ConditionDependency = {
+    /** UUID of the target component or screen */
+    target: string;
+    /** Whether the target is a "component" or "screen" */
+    type: "component" | "screen";
+    /** Full condition config for the target */
+    config: FlowConditionConfig;
+};
+
+export { ConditionGroup }
+
+export { ConditionOperator }
+
+export { ConditionRule }
+
+export { ControlsConfig }
+
+declare type EventCallback = (id: string, data: any) => void;
+
+export declare const FBRE: FC<FBREProps>;
+
+export declare interface FBREApiConfig {
+    apiEndpoint: string;
+    apiKey?: string;
+    /** Fetch timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+
+declare interface FBREApiContextValue {
+    config: FBREApiConfig;
+    flowId: string;
+    flowVersionId: string;
+    tenantId: string;
+}
+
+declare interface FBRECallbackProps {
+    theme?: ThemeConfig;
+    navigation?: NavigationConfig;
+    controls?: ControlsConfig;
+    screenIndex?: number;
+    context?: Record<string, string | boolean | number>;
+    storeRef?: React.MutableRefObject<StoreApi<FBREStoreState> | null>;
+    onFlowComplete: (data: any) => void | Promise<void>;
+    onScreenChange?: (index: number, data: any) => void;
+    onScreenValidationChange?: (index: number, data: any) => void;
+}
+
+export declare interface FBRELocalProps extends FBRECallbackProps {
+    flow: Flow;
+    data?: FlowData;
+    flowId?: never;
+    apiEndpoint?: never;
+    apiKey?: never;
+    sessionEndpoint?: never;
+}
+
+export declare type FBREProps = FBRELocalProps | FBRERemoteProps | FBREServerDrivenModeProps;
+
+export declare interface FBRERemoteProps extends FBRECallbackProps {
+    flow?: never;
+    data?: FlowData;
+    flowId: string;
+    apiEndpoint: string;
+    apiKey?: string;
+    sessionEndpoint?: never;
+}
+
+export declare interface FBREServerDrivenModeProps {
+    sessionEndpoint: string;
+    flowId: string;
+    apiKey?: string;
+    theme?: ThemeConfig;
+    context?: Record<string, string | boolean | number>;
+    onFlowComplete: (data: any) => void;
+    onScreenChange?: (screenNumber: number) => void;
+}
+
+export declare type FBREStoreState = {
+    flowUUID: string;
+    metadata: FlowMetadata;
+    config: FlowConfiguration;
+    externalContext: Record<string, string | boolean | number>;
+    screenOrder: string[];
+    screens: Record<string, FlowScreen>;
+    screenValidity: Record<string, boolean>;
+    components: Record<string, Component>;
+    groupComponentMap: Record<string, string>;
+    templateComponentMap: Record<string, string>;
+    /** Source UUID → list of targets that depend on it */
+    conditionsByDependency: Record<string, ConditionDependency[]>;
+    /** Target UUID → boolean (true = condition met) — runtime only, never serialised */
+    conditionResults: Record<string, boolean>;
+    /** Component UUID → array of error message strings */
+    validationErrors: Record<string, string[]>;
+    /** Source UUID → list of targets with matchesField rules depending on it */
+    validationsByDependency: Record<string, ValidationDependency[]>;
+    /** All flow calculations */
+    calculations: FlowCalculation[];
+    /** Calculation UUID → computed numeric result (null if unresolvable) */
+    calculationResults: Record<string, number | null>;
+    /** Source UUID → list of calculation UUIDs that depend on it */
+    calculationsByDependency: Record<string, string[]>;
+    /** Source template UUID → list of computed component template UUIDs that depend on it */
+    computedByDependency: Record<string, string[]>;
+    loadFlow: (flow: Flow, data?: FlowData, context?: Record<string, string | boolean | number>) => void;
+    updateComponentValue: (uuid: string, value: any) => void;
+    addGroupIteration: (groupUUID: string) => Component[][] | undefined;
+    addRepeaterIteration: (repeaterUUID: string) => Component[][] | undefined;
+    removeRepeaterIteration: (repeaterUUID: string, iterIndex: number) => void;
+    getFlowData: () => FlowData;
+    getScreenByIndex: (index: number) => FlowScreen | null;
+    getScreenValidity: (index: number) => boolean;
+    getValidationErrors: (uuid: string) => string[];
+    updateContext: (context: Record<string, string | boolean | number>) => void;
+    evaluateFlowValidation: () => boolean;
+    getMaxScreenCount: () => number;
+    getCalculationResult: (uuid: string) => number | null;
+};
+
+export { FileUploadBase64Data }
+
+export { FileUploadData }
+
+export { FileUploadS3Data }
+
+export { Flow }
+
+export { FlowConditionConfig }
+
+export { FlowConfiguration }
+
+export { FlowData }
+
+export { FlowMetadata }
+
+export { FlowScreen }
+
+export { NavigationConfig }
+
+export declare const removeFBREEventListener: (type: string, callback: EventCallback) => void;
+
+export { ScreenData }
+
+export { ThemeConfig }
+
+export declare class TimeoutError extends ApiError {
+    constructor(url: string, timeoutMs: number);
+}
+
+export declare function useFBREApi(): FBREApiContextValue | null;
+
+export declare function useFBREStore<T>(selector: (state: FBREStoreState) => T): T;
+
+export declare const useFBREStoreApi: () => StoreApi<FBREStoreState>;
+
+/**
+ * A validation dependency entry — one per target that depends on a source field.
+ * The key in validationsByDependency is the source UUID.
+ */
+declare type ValidationDependency = {
+    /** UUID of the target component that has the matchesField rule */
+    target: string;
+    /** Full validation config for the target */
+    config: FlowValidationConfig;
+};
+
+export { }

package/package.json

@@ -0,0 +1,56 @@
+{
+	"name": "@sonata-innovations/fiber-fbre",
+	"version": "2.0.0",
+	"description": "Fiber Render Engine — renders Flow JSON forms with conditional logic, validation, and screen transitions",
+	"keywords": ["fiber", "form-builder", "form-renderer", "react", "flow-json", "data-collection"],
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/sonata-innovations/fiber.git",
+		"directory": "fbre"
+	},
+	"bugs": { "url": "https://github.com/sonata-innovations/fiber/issues" },
+	"homepage": "https://github.com/sonata-innovations/fiber",
+	"type": "module",
+	"main": "dist/fiber-fbre.cjs",
+	"module": "dist/fiber-fbre.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/fiber-fbre.js",
+			"require": "./dist/fiber-fbre.cjs"
+		},
+		"./styles": "./dist/fiber-fbre.css"
+	},
+	"files": [
+		"dist"
+	],
+	"sideEffects": ["./dist/*.css"],
+	"scripts": {
+		"dev": "vite",
+		"build": "tsc --noEmit && vite build",
+		"preview": "vite preview"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"peerDependencies": {
+		"react": "^18.0.0 || ^19.0.0",
+		"react-dom": "^18.0.0 || ^19.0.0"
+	},
+	"dependencies": {
+		"@sonata-innovations/fiber-shared": "^1.0.0",
+		"@sonata-innovations/fiber-types": "^1.0.0",
+		"zustand": "^5.0.0"
+	},
+	"devDependencies": {
+		"@types/react": "^19.0.0",
+		"@types/react-dom": "^19.0.0",
+		"react": "^19.0.0",
+		"react-dom": "^19.0.0",
+		"typescript": "^5.7.0",
+		"vite": "^6.0.0",
+		"vite-plugin-dts": "^4.3.0"
+	}
+}