@syncfusion/ej2-react-form-renderer 0.1.0-beta

package/src/json-converter.d.ts

@@ -0,0 +1,170 @@
+import type { FormSchema, FormComponent } from '../FormBuilder/types/FormSchema';
+export declare const generateId: (type: string) => string;
+export interface SplitSchema {
+    dataSchema: DataSchema;
+    uiSchema: UISchema;
+}
+export interface DataSchema {
+    version: string;
+    properties: Record<string, DataField>;
+}
+export interface DataField {
+    id: string;
+    type: 'string' | 'number' | 'boolean' | 'array' | 'any' | 'button' | 'message' | 'sign' | 'image' | 'file' | 'color' | 'grid';
+    label?: string;
+    format?: 'date' | 'date-time' | 'time' | 'email' | 'url';
+    defaultValue?: any;
+    content?: string;
+    buttonType?: string;
+    textboxType?: string;
+    options?: string[] | any[];
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    minValue?: number;
+    maxValue?: number;
+    minDate?: string;
+    maxDate?: string;
+    minTime?: string;
+    maxTime?: string;
+    pattern?: string;
+}
+export interface UISchema {
+    properties: Record<string, UIField>;
+    layout: LayoutNode[];
+}
+export interface UIField {
+    widget: string;
+    _configured?: boolean;
+    [key: string]: any;
+}
+export type LayoutNode = FieldNode | TableNode | PanelNode | TabsNode | CardNode;
+export interface FieldNode {
+    type: 'field';
+    propertyId: string;
+}
+export interface TableNode {
+    type: 'table';
+    id: string;
+    label?: string;
+    cssClass?: string;
+    hideBorders?: boolean;
+    rows: number;
+    cols: number;
+    cells: TableCell[][];
+    columnWidths?: {
+        widths: (number | null)[];
+    };
+}
+export interface TableCell {
+    row: number;
+    col: number;
+    children: LayoutNode[];
+}
+export interface PanelNode {
+    type: 'panel';
+    id: string;
+    label?: string;
+    cssClass?: string;
+    hideBorders?: boolean;
+    hideLabel?: boolean;
+    children: LayoutNode[];
+}
+export interface TabsNode {
+    type: 'tabs';
+    id: string;
+    cssClass?: string;
+    label?: string;
+    tabOptions?: string[];
+    tabs: TabItem[];
+}
+export interface TabItem {
+    header: string;
+    children: LayoutNode[];
+}
+export interface CardNode {
+    type: 'card';
+    id: string;
+    label?: string;
+    cssClass?: string;
+    hideLabel?: boolean;
+    cardTitle?: string;
+    cardSubtitle?: string;
+    enableAction?: boolean;
+    actionButtonLabel?: string;
+    actionButtonType?: 'button' | 'submit';
+    children: LayoutNode[];
+}
+/**
+ * Convert label to camelCase identifier
+ * Examples:
+ *   "First Name" → "firstName"
+ *   "Email Address" → "emailAddress"
+ *   "Date of Birth" → "dateOfBirth"
+ *   "Phone Number (Mobile)" → "phoneNumberMobile"
+ */
+export declare function labelToFieldKey(label: string, fallbackId?: string): string;
+/**
+ * Ensure field key is unique by appending a number if needed
+ */
+export declare function makeUniqueFieldKey(baseKey: string, existingKeys: Set<string>, originalId?: string): string;
+export declare function splitSchema(heartSchema: FormSchema): SplitSchema;
+/**
+ * Merge split schemas back into heart schema
+ * Supports both simple merge and fuzzy matching for re-import scenarios
+ */
+export declare function mergeSchema(split: SplitSchema, existingUISchema?: UISchema): FormSchema;
+/**
+ * Infer widget type from semantic data type
+ */
+export declare function inferWidgetFromType(type: string, format?: string, hasOptions?: boolean): string;
+export interface FieldMatchResult {
+    existingId: string;
+    newDataId: string;
+    confidence: 'exact' | 'high' | 'medium' | 'low';
+    method: 'id' | 'label-exact' | 'label-fuzzy' | 'new';
+    similarity?: number;
+}
+/**
+ * Match a new data field with existing UI schema field
+ * Preserves existing ID for stability
+ */
+export declare function matchFieldWithIDPreservation(newDataField: DataField, existingUISchema: UISchema): FieldMatchResult;
+/**
+ * Merge with ID remapping for re-import scenarios
+ * Preserves existing IDs to maintain layout stability
+ */
+export declare function mergeWithIDRemapping(newDataSchema: DataSchema, existingUISchema: UISchema): FormSchema;
+/**
+ * Extract all field IDs from layout tree
+ */
+export declare function extractFieldIdsFromLayout(layout: LayoutNode[]): Set<string>;
+/**
+ * Find unmatched fields (in data schema but not in layout)
+ */
+export declare function findUnmatchedFields(dataSchema: DataSchema, layout: LayoutNode[]): string[];
+/**
+ * Convert parser output (FormComponent[]) to DataSchema format
+ * This allows parser results to be merged with existing UI schemas
+ */
+export declare function convertComponentsToDataSchema(components: FormComponent[]): DataSchema;
+/**
+ * Convert parser output to a simple linear layout
+ * Used when no existing UI schema is present
+ */
+export declare function convertComponentsToUISchema(components: FormComponent[]): UISchema;
+/**
+ * Generate default UI properties for each data field
+ * Used by renderers when only data schema is provided
+ */
+export declare function generateUIPropertiesFromData(dataSchema: DataSchema): Record<string, UIField>;
+/**
+ * Generate sequential layout from data schema
+ * Used by renderers when only data schema is provided
+ */
+export declare function generateLayoutFromData(dataSchema: DataSchema): FieldNode[];
+/**
+ * Generate minimal data schema from UI schema
+ * Used by renderers when only UI schema is provided
+ */
+export declare function generateDataSchemaFromUI(uiSchema: UISchema): DataSchema;