@rilaykit/workflow 1.2.0 → 2.0.0

package/dist/index.d.mts

@@ -1,17 +1,127 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as react from 'react';
-import react__default from 'react';
-import { WorkflowConfig, WorkflowContext, ValidationError, StepConfig, FormConfiguration, ValidationResult, ril, StepLifecycleHooks, StepPermissions, CustomStepRenderer, DynamicStepConfig, ConditionalBranch, NavigationConfig, PersistenceConfig, WorkflowAnalytics, WorkflowOptimizations, WorkflowVersion, CompletionConfig, WorkflowPlugin } from '@rilaykit/core';
+import { ril, FormConfiguration, StepLifecycleHooks, StepPermissions, CustomStepRenderer, DynamicStepConfig, NavigationConfig, PersistenceConfig, WorkflowAnalytics, CompletionConfig, WorkflowPlugin, StepConfig, WorkflowConfig, WorkflowContext, ValidationError, ValidationResult, RendererChildrenFunction, WorkflowNextButtonRendererProps, WorkflowPreviousButtonRendererProps, WorkflowSkipButtonRendererProps, WorkflowStepperRendererProps } from '@rilaykit/core';
 export * from '@rilaykit/core';
 export { createZodValidator, ril } from '@rilaykit/core';
+import { form } from '@rilaykit/forms';
 export { form } from '@rilaykit/forms';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import react__default from 'react';
+
+interface StepDefinition {
+    id: string;
+    title: string;
+    description?: string;
+    formConfig: FormConfiguration | form;
+    allowSkip?: boolean;
+    requiredToComplete?: boolean;
+    hooks?: StepLifecycleHooks;
+    permissions?: StepPermissions;
+    renderer?: CustomStepRenderer;
+    dynamicConfig?: DynamicStepConfig;
+}
+/**
+ * Workflow builder class for creating complex multi-step workflows
+ * Simplified API with auto-build capability
+ */
+declare class flow {
+    private config;
+    private workflowId;
+    private workflowName;
+    private workflowDescription?;
+    private steps;
+    private navigation;
+    private persistence?;
+    private completion?;
+    private analytics?;
+    private plugins;
+    constructor(config: ril, workflowId: string, workflowName: string, description?: string);
+    static create(config: ril, workflowId: string, workflowName: string, description?: string): flow;
+    /**
+     * Helper method to create a step configuration from StepDefinition
+     */
+    private createStepFromDefinition;
+    /**
+     * Add a step using simplified StepDefinition object
+     */
+    addStep(stepDefinition: StepDefinition): this;
+    /**
+     * Add a dynamic step using StepDefinition with dynamicConfig
+     */
+    addDynamicStep(stepDefinition: StepDefinition & {
+        dynamicConfig: DynamicStepConfig;
+    }): this;
+    /**
+     * Add multiple steps at once
+     */
+    addSteps(stepDefinitions: StepDefinition[]): this;
+    /**
+     * Configuration setters with fluent interface
+     */
+    setNavigation(navigation: NavigationConfig): this;
+    enableBackNavigation(enabled?: boolean): this;
+    enableStepSkipping(enabled?: boolean): this;
+    setPersistence(persistence: PersistenceConfig): this;
+    setAnalytics(analytics: WorkflowAnalytics): this;
+    setCompletion(completion: CompletionConfig): this;
+    /**
+     * Plugin management
+     */
+    use(plugin: WorkflowPlugin): this;
+    private validatePluginDependencies;
+    removePlugin(pluginName: string): this;
+    /**
+     * Step management
+     */
+    updateStep(stepId: string, updates: Partial<Omit<StepConfig, 'id'>>): this;
+    removeStep(stepId: string): this;
+    getStep(stepId: string): StepConfig | undefined;
+    getSteps(): StepConfig[];
+    clearSteps(): this;
+    /**
+     * Clone the workflow builder
+     */
+    clone(newWorkflowId?: string, newWorkflowName?: string): flow;
+    /**
+     * Validate the workflow configuration
+     */
+    validate(): string[];
+    /**
+     * Get workflow statistics
+     */
+    getStats(): {
+        totalSteps: number;
+        dynamicSteps: number;
+        pluginsInstalled: number;
+        estimatedFields: number;
+        hasPersistence: boolean;
+        hasAnalytics: boolean;
+        allowBackNavigation: boolean;
+    };
+    /**
+     * Build the final workflow configuration
+     */
+    build(): WorkflowConfig;
+    /**
+     * Export/Import functionality
+     */
+    toJSON(): any;
+    fromJSON(json: any): this;
+}
+/**
+ * Factory function to create a workflow builder directly
+ */
+declare function createFlow(config: ril, workflowId: string, workflowName: string, description?: string): flow;
+declare module '@rilaykit/core' {
+    interface ril {
+        createFlow(workflowId: string, workflowName: string, description?: string): flow;
+    }
+}
 
 interface WorkflowState {
     currentStepIndex: number;
     allData: Record<string, any>;
     stepData: Record<string, any>;
     errors: Record<string, ValidationError[]>;
-    warnings: Record<string, ValidationError[]>;
     touched: Set<string>;
     isValidating: Set<string>;
     visitedSteps: Set<string>;
@@ -48,16 +158,20 @@ interface WorkflowProviderProps {
     className?: string;
     user?: any;
 }
+declare function WorkflowProvider({ children, workflowConfig, defaultValues, onStepChange, onWorkflowComplete, className, user, }: WorkflowProviderProps): react_jsx_runtime.JSX.Element;
+declare function useWorkflowContext(): WorkflowContextValue;
 
-type WorkflowProps = Omit<WorkflowProviderProps, 'children'> & {
+type WorkflowProps = Omit<WorkflowProviderProps, 'children' | 'workflowConfig'> & {
     children: react__default.ReactNode;
+    workflowConfig: WorkflowConfig | flow;
 };
 /**
  * A wrapper component for the Rilay workflow system.
  * It simplifies the API by wrapping the WorkflowProvider and providing a clean,
  * component-based interface for building workflows.
+ * Accepts both WorkflowConfig and flow builder instances.
  */
-declare function Workflow({ children, ...props }: WorkflowProps): react_jsx_runtime.JSX.Element;
+declare function Workflow({ children, workflowConfig, ...props }: WorkflowProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Renders the main content of the current workflow step.
@@ -65,232 +179,101 @@ declare function Workflow({ children, ...props }: WorkflowProps): react_jsx_runt
  */
 declare function WorkflowBody(): react_jsx_runtime.JSX.Element | null;
 
-interface WorkflowNavigationProps {
-    className?: string;
-}
-declare function WorkflowNavigation({ className }: WorkflowNavigationProps): react_jsx_runtime.JSX.Element;
-
 interface WorkflowNextButtonProps {
     className?: string;
-    children?: React.ReactNode;
+    children?: React.ReactNode | RendererChildrenFunction<WorkflowNextButtonRendererProps>;
+    renderAs?: 'default' | 'children' | boolean;
 }
-declare function WorkflowNextButton({ className, children }: WorkflowNextButtonProps): react.ReactElement<any, string | react.JSXElementConstructor<any>>;
+declare function WorkflowNextButton({ className, children, renderAs }: WorkflowNextButtonProps): react.ReactNode;
 
 interface WorkflowPreviousButtonProps {
     className?: string;
-    children?: React.ReactNode;
+    children?: React.ReactNode | RendererChildrenFunction<WorkflowPreviousButtonRendererProps>;
+    renderAs?: 'default' | 'children' | boolean;
 }
-declare function WorkflowPreviousButton({ className, children }: WorkflowPreviousButtonProps): react.ReactElement<any, string | react.JSXElementConstructor<any>>;
+declare function WorkflowPreviousButton({ className, children, renderAs, }: WorkflowPreviousButtonProps): react.ReactNode;
 
 interface WorkflowSkipButtonProps {
     className?: string;
-    children?: React.ReactNode;
+    children?: React.ReactNode | RendererChildrenFunction<WorkflowSkipButtonRendererProps>;
+    renderAs?: 'default' | 'children' | boolean;
 }
-declare function WorkflowSkipButton({ className, children }: WorkflowSkipButtonProps): react.ReactElement<any, string | react.JSXElementConstructor<any>>;
+declare function WorkflowSkipButton({ className, children, renderAs }: WorkflowSkipButtonProps): react.ReactNode;
 
 interface WorkflowStepperProps {
     onStepClick?: (stepIndex: number) => void;
     className?: string;
+    children?: React.ReactNode | RendererChildrenFunction<WorkflowStepperRendererProps>;
+    renderAs?: 'default' | 'children' | boolean;
 }
-declare function WorkflowStepper({ onStepClick, className }: WorkflowStepperProps): react.ReactElement<any, string | react.JSXElementConstructor<any>>;
+declare function WorkflowStepper({ onStepClick, className, children, renderAs, }: WorkflowStepperProps): react.ReactNode;
+
+interface LicensePayload {
+    plan: 'ARCHITECT' | 'FOUNDRY';
+    company: string;
+    customerId: string;
+    expiry: number;
+    iat: number;
+}
+interface LicenseResult {
+    valid: boolean;
+    data?: LicensePayload;
+    error?: 'EXPIRED' | 'INVALID' | 'MISSING' | 'FORMAT_INVALID' | 'SIGNATURE_INVALID';
+}
+type LicensePlan = 'ARCHITECT' | 'FOUNDRY';
 
 /**
- * Workflow builder class for creating complex multi-step workflows
- * Supports async hooks, dynamic steps, conditional branches, and much more
+ * Enhanced Rilay License Manager with Ed25519 cryptographic validation
+ * Uses @noble/ed25519 for secure and fast signature verification
  */
-declare class flow {
-    private config;
-    private workflowId;
-    private workflowName;
-    private workflowDescription?;
-    private steps;
-    private branches;
-    private navigation;
-    private persistence?;
-    private completion?;
-    private analytics?;
-    private optimizations?;
-    private version?;
-    private plugins;
-    constructor(config: ril, workflowId: string, workflowName: string, description?: string);
-    static create(config: ril, workflowId: string, workflowName: string, description?: string): flow;
-    /**
-     * Add a standard step to the workflow
-     * @param stepId - Unique step identifier
-     * @param title - Step title
-     * @param formConfig - Complete form configuration for this step
-     * @param options - Additional step options
-     * @returns flow instance for chaining
-     */
-    addStep(stepId: string, title: string, formConfig: FormConfiguration, options?: {
-        description?: string;
-        allowSkip?: boolean;
-        requiredToComplete?: boolean;
-        hooks?: StepLifecycleHooks;
-        permissions?: StepPermissions;
-        renderer?: CustomStepRenderer;
-    }): this;
-    /**
-     * Add a dynamic step that resolves form config based on previous data
-     * @param stepId - Unique step identifier
-     * @param title - Step title
-     * @param dynamicConfig - Configuration for dynamic step resolution
-     * @param fallbackFormConfig - Fallback form configuration if dynamic resolution fails
-     * @param options - Additional step options
-     * @returns flow instance for chaining
-     */
-    addDynamicStep(stepId: string, title: string, dynamicConfig: DynamicStepConfig, fallbackFormConfig: FormConfiguration, options?: {
-        description?: string;
-        allowSkip?: boolean;
-        requiredToComplete?: boolean;
-        hooks?: StepLifecycleHooks;
-        permissions?: StepPermissions;
-    }): this;
-    /**
-     * Add multiple steps at once
-     * @param stepConfigs - Array of step configurations
-     * @returns flow instance for chaining
-     */
-    addSteps(stepConfigs: Array<{
-        stepId: string;
-        title: string;
-        formConfig: FormConfiguration;
-        description?: string;
-        allowSkip?: boolean;
-        requiredToComplete?: boolean;
-        hooks?: StepLifecycleHooks;
-        permissions?: StepPermissions;
-    }>): this;
-    /**
-     * Add a conditional branch to the workflow
-     * @param branch - Conditional branch configuration
-     * @returns flow instance for chaining
-     */
-    addConditionalBranch(branch: ConditionalBranch): this;
-    /**
-     * Add multiple conditional branches
-     * @param branches - Array of conditional branches
-     * @returns flow instance for chaining
-     */
-    addConditionalBranches(branches: ConditionalBranch[]): this;
-    /**
-     * Set navigation configuration
-     * @param navigation - Navigation configuration
-     * @returns flow instance for chaining
-     */
-    setNavigation(navigation: NavigationConfig): this;
-    /**
-     * Set persistence strategy
-     * @param persistence - Persistence configuration
-     * @returns flow instance for chaining
-     */
-    setPersistence(persistence: PersistenceConfig): this;
-    /**
-     * Set analytics configuration
-     * @param analytics - Analytics configuration
-     * @returns flow instance for chaining
-     */
-    setAnalytics(analytics: WorkflowAnalytics): this;
-    /**
-     * Set performance optimizations
-     * @param optimizations - Optimization configuration
-     * @returns flow instance for chaining
-     */
-    setOptimizations(optimizations: WorkflowOptimizations): this;
-    /**
-     * Set workflow version
-     * @param version - Version configuration
-     * @returns flow instance for chaining
-     */
-    setVersion(version: WorkflowVersion): this;
-    /**
-     * Set completion configuration
-     * @param completion - Completion configuration
-     * @returns flow instance for chaining
-     */
-    setCompletion(completion: CompletionConfig): this;
-    /**
-     * Add a plugin to the workflow
-     * @param plugin - Plugin to add
-     * @returns flow instance for chaining
-     */
-    use(plugin: WorkflowPlugin): this;
-    /**
-     * Remove a plugin from the workflow
-     * @param pluginName - Name of the plugin to remove
-     * @returns flow instance for chaining
-     */
-    removePlugin(pluginName: string): this;
-    /**
-     * Update step configuration
-     * @param stepId - Step identifier
-     * @param updates - Updates to apply
-     * @returns flow instance for chaining
-     */
-    updateStep(stepId: string, updates: Partial<Omit<StepConfig, 'id'>>): this;
+declare class RilayLicenseManager {
+    private static licenseKey;
+    private static licenseResult;
+    private static isInitialized;
     /**
-     * Remove a step from the workflow
-     * @param stepId - Step identifier
-     * @returns flow instance for chaining
+     * Initialize with a license key and Ed25519 public key
      */
-    removeStep(stepId: string): this;
+    static setLicenseKey(licenseKey?: string): Promise<void>;
     /**
-     * Get step configuration by ID
-     * @param stepId - Step identifier
-     * @returns Step configuration or undefined
+     * Validate license using Ed25519 signature verification
      */
-    getStep(stepId: string): StepConfig | undefined;
+    private static validateLicense;
     /**
-     * Get all steps
-     * @returns Array of step configurations
+     * Convert compressed payload to full payload
      */
-    getSteps(): StepConfig[];
+    private static decompressPayload;
     /**
-     * Clear all steps
-     * @returns flow instance for chaining
+     * Convert hex string to Uint8Array
      */
-    clearSteps(): this;
+    private static hexToBytes;
     /**
-     * Clone the workflow builder
-     * @param newWorkflowId - ID for the cloned workflow
-     * @param newWorkflowName - Name for the cloned workflow
-     * @returns New flow instance
+     * Convert base64 string to text (browser-compatible)
      */
-    clone(newWorkflowId?: string, newWorkflowName?: string): flow;
+    private static base64ToString;
     /**
-     * Validate the workflow configuration
-     * @returns Array of validation errors
+     * Get license validation result
      */
-    validate(): string[];
+    static getLicenseResult(): LicenseResult;
     /**
-     * Get workflow statistics
-     * @returns Object with workflow statistics
+     * Check if watermark should be displayed
      */
-    getStats(): {
-        totalSteps: number;
-        dynamicSteps: number;
-        conditionalBranches: number;
-        pluginsInstalled: number;
-        estimatedFields: number;
-        hasPersistence: boolean;
-        hasAnalytics: boolean;
-    };
+    static shouldDisplayWatermark(): boolean;
     /**
-     * Build the final workflow configuration
-     * @returns Complete workflow configuration
+     * Get watermark message
      */
-    build(): WorkflowConfig;
+    static getWatermarkMessage(): string;
     /**
-     * Export workflow configuration as JSON
-     * @returns JSON representation of the workflow
+     * Display license status in console
      */
-    toJSON(): any;
+    static logLicenseStatus(): void;
     /**
-     * Import workflow configuration from JSON
-     * @param json - JSON representation of the workflow
-     * @returns flow instance for chaining
+     * Get license info
      */
-    fromJSON(json: any): this;
+    static getLicenseInfo(): Promise<{
+        plan?: string;
+        company?: string;
+        expiryDate?: string;
+    }>;
 }
 
 interface AnalyticsPluginConfig {
@@ -382,71 +365,4 @@ declare class ValidationPlugin implements WorkflowPlugin {
     private validateAsync;
 }
 
-interface LicensePayload {
-    plan: 'ARCHITECT' | 'FOUNDRY';
-    company: string;
-    customerId: string;
-    expiry: number;
-    iat: number;
-}
-interface LicenseResult {
-    valid: boolean;
-    data?: LicensePayload;
-    error?: 'EXPIRED' | 'INVALID' | 'MISSING' | 'FORMAT_INVALID' | 'SIGNATURE_INVALID';
-}
-
-/**
- * Enhanced Rilay License Manager with Ed25519 cryptographic validation
- * Uses @noble/ed25519 for secure and fast signature verification
- */
-declare class RilayLicenseManager {
-    private static licenseKey;
-    private static licenseResult;
-    private static isInitialized;
-    /**
-     * Initialize with a license key and Ed25519 public key
-     */
-    static setLicenseKey(licenseKey?: string): Promise<void>;
-    /**
-     * Validate license using Ed25519 signature verification
-     */
-    private static validateLicense;
-    /**
-     * Convert compressed payload to full payload
-     */
-    private static decompressPayload;
-    /**
-     * Convert hex string to Uint8Array
-     */
-    private static hexToBytes;
-    /**
-     * Convert base64 string to text (browser-compatible)
-     */
-    private static base64ToString;
-    /**
-     * Get license validation result
-     */
-    static getLicenseResult(): LicenseResult;
-    /**
-     * Check if watermark should be displayed
-     */
-    static shouldDisplayWatermark(): boolean;
-    /**
-     * Get watermark message
-     */
-    static getWatermarkMessage(): string;
-    /**
-     * Display license status in console
-     */
-    static logLicenseStatus(): void;
-    /**
-     * Get license info
-     */
-    static getLicenseInfo(): Promise<{
-        plan?: string;
-        company?: string;
-        expiryDate?: string;
-    }>;
-}
-
-export { AnalyticsPlugin, RilayLicenseManager, ValidationPlugin, Workflow, WorkflowBody, flow as WorkflowBuilder, type WorkflowContextValue, WorkflowNavigation, type WorkflowNavigationProps, WorkflowNextButton, type WorkflowNextButtonProps, WorkflowPreviousButton, type WorkflowPreviousButtonProps, type WorkflowProviderProps, WorkflowSkipButton, type WorkflowSkipButtonProps, WorkflowStepper, type WorkflowStepperProps, flow };
+export { AnalyticsPlugin, type LicensePayload, type LicensePlan, type LicenseResult, RilayLicenseManager, type StepDefinition, ValidationPlugin, Workflow, WorkflowBody, type WorkflowContextValue, WorkflowNextButton, type WorkflowNextButtonProps, WorkflowPreviousButton, type WorkflowPreviousButtonProps, WorkflowProvider, type WorkflowProviderProps, WorkflowSkipButton, type WorkflowSkipButtonProps, WorkflowStepper, type WorkflowStepperProps, createFlow, flow, useWorkflowContext };