@rilaykit/core 12.0.0 → 13.0.0

package/dist/index.d.mts

@@ -291,6 +291,116 @@ interface ComponentRenderProps<TProps = any> {
     isValidating?: boolean;
     [key: string]: any;
 }
+/**
+ * Property editor definition for builder property panel
+ * Generic and extensible to support any custom editor type
+ */
+interface PropertyEditorDefinition<TValue = any> {
+    /** Property key in component props */
+    readonly key: string;
+    /** Display label in property panel */
+    readonly label: string;
+    /**
+     * Editor type - can be any string to support custom editors
+     * Built-in types: 'text', 'number', 'boolean', 'select', 'multiselect', 'color', 'textarea', 'json'
+     * Custom types: 'phone', 'currency', 'location', 'rating', 'file-upload', etc.
+     */
+    readonly editorType: string;
+    /** Optional description/help text */
+    readonly helpText?: string;
+    /** Default value for this property */
+    readonly defaultValue?: TValue;
+    /** Options for select/multiselect editors */
+    readonly options?: Array<{
+        label: string;
+        value: any;
+        [key: string]: any;
+    }>;
+    /** Validation function for the property value */
+    readonly validate?: (value: TValue) => boolean | string | Promise<boolean | string>;
+    /** Group/section for organizing properties */
+    readonly group?: string;
+    /** Whether this property is required */
+    readonly required?: boolean;
+    /** Placeholder text for input fields */
+    readonly placeholder?: string;
+    /** Custom editor component for advanced use cases */
+    readonly customEditor?: React__default.ComponentType<PropertyEditorProps<TValue>>;
+    /** Additional configuration specific to the editor type */
+    readonly editorConfig?: Record<string, any>;
+    /** Dependencies - other properties that affect this one */
+    readonly dependencies?: string[];
+    /** Conditional rendering based on other property values */
+    readonly visible?: (props: Record<string, any>) => boolean;
+    /** Transform value before saving */
+    readonly transform?: (value: TValue) => any;
+    /** Parse value when loading */
+    readonly parse?: (value: any) => TValue;
+}
+/**
+ * Props passed to custom property editors
+ */
+interface PropertyEditorProps<TValue = any> {
+    /** Current property value */
+    readonly value: TValue;
+    /** Callback to update the value */
+    readonly onChange: (value: TValue) => void;
+    /** Property definition */
+    readonly definition: PropertyEditorDefinition<TValue>;
+    /** All current property values (for dependencies) */
+    readonly allValues: Record<string, any>;
+    /** Whether the field is disabled */
+    readonly disabled?: boolean;
+    /** Validation errors */
+    readonly errors?: string[];
+}
+/**
+ * Builder metadata for visual editing capabilities
+ * This is optional and only used by @rilaykit/builder
+ * Fully generic to support any component type and configuration
+ */
+interface ComponentBuilderMetadata<TProps = any> {
+    /** Category for grouping in component palette (e.g., 'Input', 'Layout', 'Advanced') */
+    readonly category?: string;
+    /** Icon identifier (e.g., 'text', 'email', 'calendar') */
+    readonly icon?: string;
+    /** Whether this component should be hidden from the builder palette */
+    readonly hidden?: boolean;
+    /** Preview component or description for the palette */
+    readonly preview?: React__default.ReactNode;
+    /** Editable properties configuration for property panel */
+    readonly editableProps?: PropertyEditorDefinition[];
+    /** Tags for search and filtering */
+    readonly tags?: string[];
+    /**
+     * Custom field schema for advanced type systems
+     * Allows defining complex field types with their own validation and structure
+     */
+    readonly fieldSchema?: FieldSchemaDefinition<TProps>;
+}
+/**
+ * Field schema definition for complex field types
+ * Supports defining custom field types with validation, defaults, and metadata
+ */
+interface FieldSchemaDefinition<TProps = any> {
+    /** Field type identifier (e.g., 'location', 'phone', 'currency') */
+    readonly type: string;
+    /** Schema validation (Zod, Yup, or any Standard Schema) */
+    readonly schema?: any;
+    /** Default configuration for this field type */
+    readonly defaultConfig?: Partial<TProps>;
+    /** Sub-fields for complex types (e.g., Location has address, city, country) */
+    readonly subFields?: Array<{
+        key: string;
+        label: string;
+        type: string;
+        required?: boolean;
+    }>;
+    /** Custom serialization for complex data structures */
+    readonly serialize?: (value: any) => any;
+    /** Custom deserialization for complex data structures */
+    readonly deserialize?: (value: any) => any;
+}
 interface ComponentConfig<TProps = any> {
     readonly id: string;
     readonly type: string;
@@ -300,6 +410,8 @@ interface ComponentConfig<TProps = any> {
     readonly defaultProps?: Partial<TProps>;
     readonly useFieldRenderer?: boolean;
     readonly validation?: FieldValidationConfig;
+    /** Optional builder metadata for visual editing (only used by @rilaykit/builder) */
+    readonly builder?: ComponentBuilderMetadata;
 }
 interface ConditionalBehavior {
     readonly visible?: ConditionConfig;
@@ -956,4 +1068,4 @@ declare class DevelopmentAdapter implements MonitoringAdapter {
     private logErrorSummary;
 }
 
-export { type ComponentConfig, type ComponentPerformanceMetrics, type ComponentRenderProps, type ComponentRenderer, type ComponentRendererBaseProps, ComponentRendererWrapper, type ComponentRendererWrapperProps, type ConditionBuilder as Condition, type ConditionBuilder, type ConditionConfig, type ConditionEvaluator, type ConditionOperator, type ConditionValue, type ConditionalBehavior, ConsoleAdapter, type ConsoleMonitoringAdapter, type CustomStepRenderer, DevelopmentAdapter, type EnhancedFormAnalytics, type EnhancedWorkflowAnalytics, type ErrorMonitoringEvent, type FieldRenderer, type FieldRendererProps, type FieldValidationConfig, type FieldValidator, type FormBodyRenderer, type FormBodyRendererProps, type FormComponentRendererProps, type FormConfiguration, type FormFieldConfig, type FormFieldRow, type FormPerformanceMetrics, type FormRenderConfig, type FormRowRenderer, type FormRowRendererProps, type FormSubmitButtonRenderer, type FormSubmitButtonRendererProps, type FormValidationConfig, type FormValidator, IdGenerator, type InferInput, type InferOutput, LocalStorageAdapter, type LogicalOperator, type MonitoringAdapter, type MonitoringConfig, type MonitoringContext, type MonitoringEvent, type MonitoringEventType, type PerformanceMetrics, type PerformanceProfiler, type PerformanceThresholds, type PerformanceWarningEvent, RemoteAdapter, type RemoteMonitoringAdapter, type RendererChildrenFunction, type RilayInstance, type RilayLicenseConfig, RilayMonitor, type StandardSchema, type StepConditionalBehavior, type StepConfig, type StepDataHelper, type ValidationContext, type ValidationError, type ValidationResult, type WorkflowAnalytics, type WorkflowComponentRendererBaseProps, type WorkflowConfig, type WorkflowContext, type WorkflowNextButtonRenderer, type WorkflowNextButtonRendererProps, type WorkflowPerformanceMetrics, type WorkflowPlugin, type WorkflowPreviousButtonRenderer, type WorkflowPreviousButtonRendererProps, type WorkflowRenderConfig, type WorkflowSkipButtonRenderer, type WorkflowSkipButtonRendererProps, type WorkflowStepperRenderer, type WorkflowStepperRendererProps, async, combine, combineSchemas, configureObject, createErrorResult, createStandardValidator, createSuccessResult, createValidationContext, createValidationResult, custom, deepClone, destroyGlobalMonitoring, email, ensureUnique, evaluateCondition, getGlobalMonitor, getSchemaInfo, hasSchemaTypes, hasUnifiedValidation, initializeMonitoring, isStandardSchema, isValidationRule, max, maxLength, mergeInto, min, minLength, normalizeToArray, normalizeValidationRules, number, pattern, required, resolveRendererChildren, ril, url, validateFormWithUnifiedConfig, validateRequired, validateWithStandardSchema, validateWithUnifiedConfig, when };
+export { type ComponentBuilderMetadata, type ComponentConfig, type ComponentPerformanceMetrics, type ComponentRenderProps, type ComponentRenderer, type ComponentRendererBaseProps, ComponentRendererWrapper, type ComponentRendererWrapperProps, type ConditionBuilder as Condition, type ConditionBuilder, type ConditionConfig, type ConditionEvaluator, type ConditionOperator, type ConditionValue, type ConditionalBehavior, ConsoleAdapter, type ConsoleMonitoringAdapter, type CustomStepRenderer, DevelopmentAdapter, type EnhancedFormAnalytics, type EnhancedWorkflowAnalytics, type ErrorMonitoringEvent, type FieldRenderer, type FieldRendererProps, type FieldSchemaDefinition, type FieldValidationConfig, type FieldValidator, type FormBodyRenderer, type FormBodyRendererProps, type FormComponentRendererProps, type FormConfiguration, type FormFieldConfig, type FormFieldRow, type FormPerformanceMetrics, type FormRenderConfig, type FormRowRenderer, type FormRowRendererProps, type FormSubmitButtonRenderer, type FormSubmitButtonRendererProps, type FormValidationConfig, type FormValidator, IdGenerator, type InferInput, type InferOutput, LocalStorageAdapter, type LogicalOperator, type MonitoringAdapter, type MonitoringConfig, type MonitoringContext, type MonitoringEvent, type MonitoringEventType, type PerformanceMetrics, type PerformanceProfiler, type PerformanceThresholds, type PerformanceWarningEvent, type PropertyEditorDefinition, type PropertyEditorProps, RemoteAdapter, type RemoteMonitoringAdapter, type RendererChildrenFunction, type RilayInstance, type RilayLicenseConfig, RilayMonitor, type StandardSchema, type StepConditionalBehavior, type StepConfig, type StepDataHelper, type ValidationContext, type ValidationError, type ValidationResult, type WorkflowAnalytics, type WorkflowComponentRendererBaseProps, type WorkflowConfig, type WorkflowContext, type WorkflowNextButtonRenderer, type WorkflowNextButtonRendererProps, type WorkflowPerformanceMetrics, type WorkflowPlugin, type WorkflowPreviousButtonRenderer, type WorkflowPreviousButtonRendererProps, type WorkflowRenderConfig, type WorkflowSkipButtonRenderer, type WorkflowSkipButtonRendererProps, type WorkflowStepperRenderer, type WorkflowStepperRendererProps, async, combine, combineSchemas, configureObject, createErrorResult, createStandardValidator, createSuccessResult, createValidationContext, createValidationResult, custom, deepClone, destroyGlobalMonitoring, email, ensureUnique, evaluateCondition, getGlobalMonitor, getSchemaInfo, hasSchemaTypes, hasUnifiedValidation, initializeMonitoring, isStandardSchema, isValidationRule, max, maxLength, mergeInto, min, minLength, normalizeToArray, normalizeValidationRules, number, pattern, required, resolveRendererChildren, ril, url, validateFormWithUnifiedConfig, validateRequired, validateWithStandardSchema, validateWithUnifiedConfig, when };

package/dist/index.d.ts

@@ -291,6 +291,116 @@ interface ComponentRenderProps<TProps = any> {
     isValidating?: boolean;
     [key: string]: any;
 }
+/**
+ * Property editor definition for builder property panel
+ * Generic and extensible to support any custom editor type
+ */
+interface PropertyEditorDefinition<TValue = any> {
+    /** Property key in component props */
+    readonly key: string;
+    /** Display label in property panel */
+    readonly label: string;
+    /**
+     * Editor type - can be any string to support custom editors
+     * Built-in types: 'text', 'number', 'boolean', 'select', 'multiselect', 'color', 'textarea', 'json'
+     * Custom types: 'phone', 'currency', 'location', 'rating', 'file-upload', etc.
+     */
+    readonly editorType: string;
+    /** Optional description/help text */
+    readonly helpText?: string;
+    /** Default value for this property */
+    readonly defaultValue?: TValue;
+    /** Options for select/multiselect editors */
+    readonly options?: Array<{
+        label: string;
+        value: any;
+        [key: string]: any;
+    }>;
+    /** Validation function for the property value */
+    readonly validate?: (value: TValue) => boolean | string | Promise<boolean | string>;
+    /** Group/section for organizing properties */
+    readonly group?: string;
+    /** Whether this property is required */
+    readonly required?: boolean;
+    /** Placeholder text for input fields */
+    readonly placeholder?: string;
+    /** Custom editor component for advanced use cases */
+    readonly customEditor?: React__default.ComponentType<PropertyEditorProps<TValue>>;
+    /** Additional configuration specific to the editor type */
+    readonly editorConfig?: Record<string, any>;
+    /** Dependencies - other properties that affect this one */
+    readonly dependencies?: string[];
+    /** Conditional rendering based on other property values */
+    readonly visible?: (props: Record<string, any>) => boolean;
+    /** Transform value before saving */
+    readonly transform?: (value: TValue) => any;
+    /** Parse value when loading */
+    readonly parse?: (value: any) => TValue;
+}
+/**
+ * Props passed to custom property editors
+ */
+interface PropertyEditorProps<TValue = any> {
+    /** Current property value */
+    readonly value: TValue;
+    /** Callback to update the value */
+    readonly onChange: (value: TValue) => void;
+    /** Property definition */
+    readonly definition: PropertyEditorDefinition<TValue>;
+    /** All current property values (for dependencies) */
+    readonly allValues: Record<string, any>;
+    /** Whether the field is disabled */
+    readonly disabled?: boolean;
+    /** Validation errors */
+    readonly errors?: string[];
+}
+/**
+ * Builder metadata for visual editing capabilities
+ * This is optional and only used by @rilaykit/builder
+ * Fully generic to support any component type and configuration
+ */
+interface ComponentBuilderMetadata<TProps = any> {
+    /** Category for grouping in component palette (e.g., 'Input', 'Layout', 'Advanced') */
+    readonly category?: string;
+    /** Icon identifier (e.g., 'text', 'email', 'calendar') */
+    readonly icon?: string;
+    /** Whether this component should be hidden from the builder palette */
+    readonly hidden?: boolean;
+    /** Preview component or description for the palette */
+    readonly preview?: React__default.ReactNode;
+    /** Editable properties configuration for property panel */
+    readonly editableProps?: PropertyEditorDefinition[];
+    /** Tags for search and filtering */
+    readonly tags?: string[];
+    /**
+     * Custom field schema for advanced type systems
+     * Allows defining complex field types with their own validation and structure
+     */
+    readonly fieldSchema?: FieldSchemaDefinition<TProps>;
+}
+/**
+ * Field schema definition for complex field types
+ * Supports defining custom field types with validation, defaults, and metadata
+ */
+interface FieldSchemaDefinition<TProps = any> {
+    /** Field type identifier (e.g., 'location', 'phone', 'currency') */
+    readonly type: string;
+    /** Schema validation (Zod, Yup, or any Standard Schema) */
+    readonly schema?: any;
+    /** Default configuration for this field type */
+    readonly defaultConfig?: Partial<TProps>;
+    /** Sub-fields for complex types (e.g., Location has address, city, country) */
+    readonly subFields?: Array<{
+        key: string;
+        label: string;
+        type: string;
+        required?: boolean;
+    }>;
+    /** Custom serialization for complex data structures */
+    readonly serialize?: (value: any) => any;
+    /** Custom deserialization for complex data structures */
+    readonly deserialize?: (value: any) => any;
+}
 interface ComponentConfig<TProps = any> {
     readonly id: string;
     readonly type: string;
@@ -300,6 +410,8 @@ interface ComponentConfig<TProps = any> {
     readonly defaultProps?: Partial<TProps>;
     readonly useFieldRenderer?: boolean;
     readonly validation?: FieldValidationConfig;
+    /** Optional builder metadata for visual editing (only used by @rilaykit/builder) */
+    readonly builder?: ComponentBuilderMetadata;
 }
 interface ConditionalBehavior {
     readonly visible?: ConditionConfig;
@@ -956,4 +1068,4 @@ declare class DevelopmentAdapter implements MonitoringAdapter {
     private logErrorSummary;
 }
 
-export { type ComponentConfig, type ComponentPerformanceMetrics, type ComponentRenderProps, type ComponentRenderer, type ComponentRendererBaseProps, ComponentRendererWrapper, type ComponentRendererWrapperProps, type ConditionBuilder as Condition, type ConditionBuilder, type ConditionConfig, type ConditionEvaluator, type ConditionOperator, type ConditionValue, type ConditionalBehavior, ConsoleAdapter, type ConsoleMonitoringAdapter, type CustomStepRenderer, DevelopmentAdapter, type EnhancedFormAnalytics, type EnhancedWorkflowAnalytics, type ErrorMonitoringEvent, type FieldRenderer, type FieldRendererProps, type FieldValidationConfig, type FieldValidator, type FormBodyRenderer, type FormBodyRendererProps, type FormComponentRendererProps, type FormConfiguration, type FormFieldConfig, type FormFieldRow, type FormPerformanceMetrics, type FormRenderConfig, type FormRowRenderer, type FormRowRendererProps, type FormSubmitButtonRenderer, type FormSubmitButtonRendererProps, type FormValidationConfig, type FormValidator, IdGenerator, type InferInput, type InferOutput, LocalStorageAdapter, type LogicalOperator, type MonitoringAdapter, type MonitoringConfig, type MonitoringContext, type MonitoringEvent, type MonitoringEventType, type PerformanceMetrics, type PerformanceProfiler, type PerformanceThresholds, type PerformanceWarningEvent, RemoteAdapter, type RemoteMonitoringAdapter, type RendererChildrenFunction, type RilayInstance, type RilayLicenseConfig, RilayMonitor, type StandardSchema, type StepConditionalBehavior, type StepConfig, type StepDataHelper, type ValidationContext, type ValidationError, type ValidationResult, type WorkflowAnalytics, type WorkflowComponentRendererBaseProps, type WorkflowConfig, type WorkflowContext, type WorkflowNextButtonRenderer, type WorkflowNextButtonRendererProps, type WorkflowPerformanceMetrics, type WorkflowPlugin, type WorkflowPreviousButtonRenderer, type WorkflowPreviousButtonRendererProps, type WorkflowRenderConfig, type WorkflowSkipButtonRenderer, type WorkflowSkipButtonRendererProps, type WorkflowStepperRenderer, type WorkflowStepperRendererProps, async, combine, combineSchemas, configureObject, createErrorResult, createStandardValidator, createSuccessResult, createValidationContext, createValidationResult, custom, deepClone, destroyGlobalMonitoring, email, ensureUnique, evaluateCondition, getGlobalMonitor, getSchemaInfo, hasSchemaTypes, hasUnifiedValidation, initializeMonitoring, isStandardSchema, isValidationRule, max, maxLength, mergeInto, min, minLength, normalizeToArray, normalizeValidationRules, number, pattern, required, resolveRendererChildren, ril, url, validateFormWithUnifiedConfig, validateRequired, validateWithStandardSchema, validateWithUnifiedConfig, when };
+export { type ComponentBuilderMetadata, type ComponentConfig, type ComponentPerformanceMetrics, type ComponentRenderProps, type ComponentRenderer, type ComponentRendererBaseProps, ComponentRendererWrapper, type ComponentRendererWrapperProps, type ConditionBuilder as Condition, type ConditionBuilder, type ConditionConfig, type ConditionEvaluator, type ConditionOperator, type ConditionValue, type ConditionalBehavior, ConsoleAdapter, type ConsoleMonitoringAdapter, type CustomStepRenderer, DevelopmentAdapter, type EnhancedFormAnalytics, type EnhancedWorkflowAnalytics, type ErrorMonitoringEvent, type FieldRenderer, type FieldRendererProps, type FieldSchemaDefinition, type FieldValidationConfig, type FieldValidator, type FormBodyRenderer, type FormBodyRendererProps, type FormComponentRendererProps, type FormConfiguration, type FormFieldConfig, type FormFieldRow, type FormPerformanceMetrics, type FormRenderConfig, type FormRowRenderer, type FormRowRendererProps, type FormSubmitButtonRenderer, type FormSubmitButtonRendererProps, type FormValidationConfig, type FormValidator, IdGenerator, type InferInput, type InferOutput, LocalStorageAdapter, type LogicalOperator, type MonitoringAdapter, type MonitoringConfig, type MonitoringContext, type MonitoringEvent, type MonitoringEventType, type PerformanceMetrics, type PerformanceProfiler, type PerformanceThresholds, type PerformanceWarningEvent, type PropertyEditorDefinition, type PropertyEditorProps, RemoteAdapter, type RemoteMonitoringAdapter, type RendererChildrenFunction, type RilayInstance, type RilayLicenseConfig, RilayMonitor, type StandardSchema, type StepConditionalBehavior, type StepConfig, type StepDataHelper, type ValidationContext, type ValidationError, type ValidationResult, type WorkflowAnalytics, type WorkflowComponentRendererBaseProps, type WorkflowConfig, type WorkflowContext, type WorkflowNextButtonRenderer, type WorkflowNextButtonRendererProps, type WorkflowPerformanceMetrics, type WorkflowPlugin, type WorkflowPreviousButtonRenderer, type WorkflowPreviousButtonRendererProps, type WorkflowRenderConfig, type WorkflowSkipButtonRenderer, type WorkflowSkipButtonRendererProps, type WorkflowStepperRenderer, type WorkflowStepperRendererProps, async, combine, combineSchemas, configureObject, createErrorResult, createStandardValidator, createSuccessResult, createValidationContext, createValidationResult, custom, deepClone, destroyGlobalMonitoring, email, ensureUnique, evaluateCondition, getGlobalMonitor, getSchemaInfo, hasSchemaTypes, hasUnifiedValidation, initializeMonitoring, isStandardSchema, isValidationRule, max, maxLength, mergeInto, min, minLength, normalizeToArray, normalizeValidationRules, number, pattern, required, resolveRendererChildren, ril, url, validateFormWithUnifiedConfig, validateRequired, validateWithStandardSchema, validateWithUnifiedConfig, when };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rilaykit/core",
-  "version": "12.0.0",
+  "version": "13.0.0",
   "description": "Core types, configurations, and utilities for the RilayKit form library",
   "main": "dist/index.js",
   "module": "dist/index.mjs",