@nice2dev/ui-designers 1.0.10

package/dist/index.d.ts

@@ -0,0 +1,667 @@
+import { default as default_2 } from 'react';
+import { NiceBaseProps } from '@nice2dev/ui';
+import { NiceThemeBuilder } from '@nice2dev/ui';
+import { NiceThemeBuilderProps } from '@nice2dev/ui';
+import { NiceThemeBuilderSection } from '@nice2dev/ui';
+import { NiceThemeDesigner } from '@nice2dev/ui';
+import { NiceThemeDesignerProps } from '@nice2dev/ui';
+import { NiceThemeDesignerSection } from '@nice2dev/ui';
+
+/**
+ * Action node
+ */
+export declare interface ActionNode extends WorkflowNodeBase {
+    category: 'action';
+    actionType: ActionType;
+    config: {
+        url?: string;
+        method?: string;
+        headers?: Record<string, string>;
+        body?: any;
+        language?: 'javascript' | 'python' | 'sql';
+        code?: string;
+        to?: string;
+        subject?: string;
+        template?: string;
+        [key: string]: any;
+    };
+}
+
+/**
+ * Action types
+ */
+export declare type ActionType = 'http-request' | 'script' | 'transform' | 'email' | 'notification' | 'delay' | 'log' | 'set-variable' | 'database-query' | 'file-operation';
+
+/**
+ * Condition node
+ */
+export declare interface ConditionNode extends WorkflowNodeBase {
+    category: 'condition';
+    conditionType: ConditionType;
+    config: {
+        expression?: string;
+        cases?: {
+            label: string;
+            condition: string;
+            portId: string;
+        }[];
+        defaultCase?: string;
+    };
+}
+
+/**
+ * Condition types
+ */
+export declare type ConditionType = 'if' | 'switch' | 'filter' | 'router';
+
+/**
+ * Node configuration schema (for dynamic forms)
+ */
+export declare interface ConfigField {
+    name: string;
+    label: string;
+    type: 'text' | 'number' | 'boolean' | 'select' | 'json' | 'code' | 'expression' | 'keyvalue';
+    required?: boolean;
+    defaultValue?: any;
+    options?: {
+        label: string;
+        value: any;
+    }[];
+    placeholder?: string;
+    description?: string;
+    validation?: {
+        pattern?: string;
+        min?: number;
+        max?: number;
+        minLength?: number;
+        maxLength?: number;
+    };
+}
+
+/**
+ * Control node
+ */
+export declare interface ControlNode extends WorkflowNodeBase {
+    category: 'control';
+    controlType: ControlType;
+    config: {
+        maxRetries?: number;
+        retryDelay?: number;
+        errorHandling?: 'continue' | 'stop' | 'retry';
+    };
+}
+
+/**
+ * Control types
+ */
+export declare type ControlType = 'start' | 'end' | 'error-handler' | 'retry' | 'merge' | 'split';
+
+export declare function createDefaultWorkflow(): WorkflowSchema;
+
+/**
+ * Complete dashboard schema
+ */
+export declare interface DashboardSchema {
+    /** Schema version */
+    version: string;
+    /** Dashboard ID */
+    id: string;
+    /** Dashboard title */
+    title: string;
+    /** Description */
+    description?: string;
+    /** Grid columns */
+    columns: number;
+    /** Row height (px) */
+    rowHeight: number;
+    /** Gap between widgets (px) */
+    gap: number;
+    /** Widgets */
+    widgets: WidgetDefinition[];
+    /** Theme */
+    theme?: DashboardTheme;
+    /** Responsive layouts */
+    responsiveLayouts?: ResponsiveLayouts;
+    /** Auto-refresh interval (ms) */
+    refreshInterval?: number;
+    /** Meta information */
+    meta?: {
+        createdAt?: string;
+        updatedAt?: string;
+        author?: string;
+    };
+}
+
+/**
+ * Dashboard theme
+ */
+export declare interface DashboardTheme {
+    /** Background color */
+    background?: string;
+    /** Widget background */
+    widgetBackground?: string;
+    /** Widget border */
+    widgetBorder?: string;
+    /** Widget shadow */
+    widgetShadow?: string;
+    /** Widget border radius */
+    widgetRadius?: string;
+    /** Header background */
+    headerBackground?: string;
+    /** Text color */
+    textColor?: string;
+    /** Accent color */
+    accentColor?: string;
+}
+
+export declare function deserializeView(json: string): NiceViewDefinition;
+
+export declare function generateCellId(): string;
+
+/**
+ * Generate dashboard HTML for embedding
+ */
+export declare function generateDashboardHTML(schema: DashboardSchema): string;
+
+export declare function generateRowId(): string;
+
+/**
+ * Loop node
+ */
+export declare interface LoopNode extends WorkflowNodeBase {
+    category: 'loop';
+    loopType: LoopType;
+    config: {
+        collection?: string;
+        condition?: string;
+        maxIterations?: number;
+        parallelCount?: number;
+    };
+}
+
+/**
+ * Loop types
+ */
+export declare type LoopType = 'foreach' | 'while' | 'repeat' | 'parallel';
+
+export declare const NiceControlConfigurator: default_2.ForwardRefExoticComponent<NiceControlConfiguratorProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for the {@link NiceControlConfigurator} component — a live property editor with a control preview panel. */
+export declare interface NiceControlConfiguratorProps extends NiceBaseProps {
+    /** Registry key identifying the control type (e.g. "NiceButton", "NiceTextInput") */
+    controlType: string;
+    /** Descriptors for all configurable props */
+    propDescriptors: NicePropDescriptor[];
+    /** Current prop values */
+    value: Record<string, unknown>;
+    /** Called when any prop value changes */
+    onChange: (props: Record<string, unknown>) => void;
+    /** Render function that creates the control preview from current props */
+    renderPreview: (props: Record<string, unknown>) => default_2.ReactNode;
+    /** Layout: side-by-side or stacked */
+    layout?: 'horizontal' | 'vertical';
+}
+
+/** An entry in the control palette for the {@link NiceViewBuilder}. */
+declare interface NiceControlRegistryEntry {
+    type: string;
+    label: string;
+    /** Optional palette grouping. */
+    category?: string;
+    icon?: string;
+    /** Optional list of editable prop descriptors. */
+    propDescriptors?: NicePropDescriptor[];
+    defaultProps: Record<string, unknown>;
+}
+
+export declare function NiceDashboardDesigner({ initialSchema, widgets, onChange, onExport, onPreview, className, style, }: NiceDashboardDesignerProps): JSX.Element;
+
+export declare interface NiceDashboardDesignerProps {
+    /** Initial dashboard schema */
+    initialSchema?: DashboardSchema;
+    /** Convenience flat list of widgets — wrapped into a default schema if `initialSchema` is omitted. Accepts `x`/`y`/`w`/`h` shortcuts that get folded into the widget layout. */
+    widgets?: Array<Partial<WidgetDefinition> & {
+        id: string;
+        type: string;
+        x?: number;
+        y?: number;
+        w?: number;
+        h?: number;
+    }>;
+    /** Called when schema changes */
+    onChange?: (schema: DashboardSchema) => void;
+    /** Called when export is requested */
+    onExport?: (schema: DashboardSchema) => void;
+    /** Called when preview is requested */
+    onPreview?: (schema: DashboardSchema) => void;
+    /** Custom class */
+    className?: string;
+    /** Style */
+    style?: default_2.CSSProperties;
+}
+
+/** Describes one configurable property in the {@link NiceControlConfigurator}. */
+export declare interface NicePropDescriptor {
+    /** Property name (matches the component prop key). */
+    name: string;
+    /** Display label. Falls back to `name` when omitted. */
+    label?: string;
+    /** Editor type. */
+    type: NicePropType;
+    /** Default value. */
+    defaultValue?: unknown;
+    /** Select / enum options. Plain strings are treated as `{ value: s, label: s }`. */
+    options?: Array<{
+        value: string;
+        label: string;
+    } | string>;
+    /** Minimum for number editor. */
+    min?: number;
+    /** Maximum for number editor. */
+    max?: number;
+    /** Step for number editor. */
+    step?: number;
+    /** Grouping section name. */
+    group?: string;
+}
+
+/** Supported property editor types for the {@link NiceControlConfigurator}. */
+declare type NicePropType = 'string' | 'number' | 'boolean' | 'select' | 'color' | 'size' | 'variant' | 'json';
+
+export { NiceThemeBuilder }
+
+export { NiceThemeBuilderProps }
+
+export { NiceThemeBuilderSection }
+
+export { NiceThemeDesigner }
+
+export { NiceThemeDesignerProps }
+
+export { NiceThemeDesignerSection }
+
+export declare const NiceViewBuilder: default_2.ForwardRefExoticComponent<NiceViewBuilderProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for the {@link NiceViewBuilder} component — a drag-and-drop page / view layout designer with palette, canvas, and property panel. */
+export declare interface NiceViewBuilderProps extends NiceBaseProps {
+    /** Available controls that can be placed on the canvas */
+    controlRegistry: NiceControlRegistryEntry[];
+    /** Render function to preview a control given its type and props */
+    renderControl: (controlType: string, props: Record<string, unknown>) => default_2.ReactNode;
+    /** Initial view definition */
+    value?: NiceViewDefinition;
+    /** Called when view changes */
+    onChange?: (view: NiceViewDefinition) => void;
+    /** Called when user clicks Save */
+    onSave?: (view: NiceViewDefinition) => void;
+}
+
+/** A single cell (control instance) in a {@link NiceViewRowDefinition}. */
+declare interface NiceViewCellDefinition {
+    id: string;
+    controlType: string;
+    props: Record<string, unknown>;
+    colSpan?: number;
+    rowSpan?: number;
+}
+
+/** The full serializable definition of a view (page layout). */
+declare interface NiceViewDefinition {
+    id: string;
+    name: string;
+    columns?: number;
+    rows?: NiceViewRowDefinition[];
+    /** Convenience flat list of controls (alternative to filling `rows` manually). */
+    controls?: Array<{
+        id: string;
+        type: string;
+        props?: Record<string, unknown>;
+        x?: number;
+        y?: number;
+        w?: number;
+        h?: number;
+    }>;
+    meta?: Record<string, unknown>;
+}
+
+/** A row in a {@link NiceViewDefinition} layout grid. */
+declare interface NiceViewRowDefinition {
+    id: string;
+    cells: NiceViewCellDefinition[];
+    height?: string;
+}
+
+export declare function NiceWorkflowDesigner({ initialWorkflow, nodes, edges, onChange, onNodeSelect, className, style, readOnly, height, }: NiceWorkflowDesignerProps): JSX.Element;
+
+export declare interface NiceWorkflowDesignerProps {
+    /** Initial workflow schema */
+    initialWorkflow?: WorkflowSchema;
+    /** Convenience flat list of nodes — wrapped into a default workflow if `initialWorkflow` is omitted. */
+    nodes?: Array<Partial<WorkflowNode> & {
+        id: string;
+        type: string;
+    }>;
+    /** Convenience flat list of edges/connections (alias `edges` accepted as well). Accepts `from`/`to` shortcuts. */
+    edges?: Array<Partial<WorkflowConnection> & {
+        id?: string;
+        sourceNodeId?: string;
+        targetNodeId?: string;
+        source?: string;
+        target?: string;
+        from?: string;
+        to?: string;
+    }>;
+    /** Callback when workflow changes */
+    onChange?: (workflow: WorkflowSchema) => void;
+    /** Callback when node is selected */
+    onNodeSelect?: (node: WorkflowNode | null) => void;
+    /** Custom class */
+    className?: string;
+    /** Style */
+    style?: default_2.CSSProperties;
+    /** Read-only mode */
+    readOnly?: boolean;
+    /** Height */
+    height?: string | number;
+}
+
+export declare const NODE_TEMPLATES: NodeTemplate[];
+
+declare interface NodeTemplate {
+    id: string;
+    category: WorkflowNodeCategory;
+    type: string;
+    label: string;
+    description: string;
+    icon: string;
+    color: string;
+    defaultPorts: WorkflowPort[];
+    configSchema: ConfigField[];
+    defaultConfig: Record<string, any>;
+}
+
+/**
+ * Dashboard layout for different breakpoints
+ */
+export declare interface ResponsiveLayouts {
+    lg?: WidgetLayout[];
+    md?: WidgetLayout[];
+    sm?: WidgetLayout[];
+    xs?: WidgetLayout[];
+}
+
+export declare function serializeView(view: NiceViewDefinition): string;
+
+/**
+ * Trigger node
+ */
+export declare interface TriggerNode extends WorkflowNodeBase {
+    category: 'trigger';
+    triggerType: TriggerType;
+    config: {
+        cron?: string;
+        timezone?: string;
+        path?: string;
+        method?: string;
+        eventName?: string;
+        filter?: string;
+        [key: string]: any;
+    };
+}
+
+/**
+ * Trigger types
+ */
+export declare type TriggerType = 'manual' | 'schedule' | 'webhook' | 'event' | 'email' | 'file-change' | 'database-change' | 'api-request';
+
+export declare function useWorkflowDesigner(): WorkflowDesignerContextValue;
+
+/**
+ * Validate dashboard schema
+ */
+export declare function validateDashboardSchema(schema: DashboardSchema): {
+    valid: boolean;
+    errors: string[];
+};
+
+export declare function validateWorkflow(workflow: WorkflowSchema): {
+    valid: boolean;
+    errors: string[];
+};
+
+/**
+ * Data types for variables
+ */
+declare type VariableType = 'string' | 'number' | 'boolean' | 'object' | 'array' | 'date' | 'any';
+
+/**
+ * Widget data source configuration
+ */
+export declare interface WidgetDataSource {
+    /** Data source type */
+    type: 'static' | 'rest' | 'graphql' | 'websocket' | 'signal';
+    /** API endpoint or data */
+    endpoint?: string;
+    /** Static data */
+    data?: any;
+    /** Refresh interval (ms) */
+    refreshInterval?: number;
+    /** Transform function name */
+    transform?: string;
+}
+
+/**
+ * Widget definition
+ */
+export declare interface WidgetDefinition {
+    /** Unique ID */
+    id: string;
+    /** Widget type */
+    type: WidgetType;
+    /** Display title */
+    title: string;
+    /** Description */
+    description?: string;
+    /** Layout settings */
+    layout: WidgetLayout;
+    /** Data source */
+    dataSource?: WidgetDataSource;
+    /** Widget-specific configuration */
+    config: Record<string, any>;
+    /** Custom CSS class */
+    className?: string;
+    /** Custom styles */
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * Widget position and size
+ */
+export declare interface WidgetLayout {
+    /** X position (grid units) */
+    x: number;
+    /** Y position (grid units) */
+    y: number;
+    /** Width (grid units) */
+    w: number;
+    /** Height (grid units) */
+    h: number;
+    /** Minimum width */
+    minW?: number;
+    /** Minimum height */
+    minH?: number;
+    /** Maximum width */
+    maxW?: number;
+    /** Maximum height */
+    maxH?: number;
+    /** Is static (cannot be moved/resized) */
+    static?: boolean;
+}
+
+/**
+ * Widget types
+ */
+export declare type WidgetType = 'chart' | 'chart-line' | 'chart-bar' | 'chart-pie' | 'chart-area' | 'chart-scatter' | 'chart-radar' | 'kpi' | 'kpi-trend' | 'gauge' | 'progress' | 'data-grid' | 'pivot-grid' | 'tree-view' | 'calendar' | 'scheduler' | 'map' | 'heatmap' | 'treemap' | 'timeline' | 'text' | 'image' | 'iframe' | 'clock' | 'weather' | 'list' | 'card' | 'custom';
+
+/**
+ * Workflow connection
+ */
+export declare interface WorkflowConnection {
+    id: string;
+    sourceNodeId: string;
+    sourcePortId: string;
+    targetNodeId: string;
+    targetPortId: string;
+    label?: string;
+    condition?: string;
+    style?: {
+        color?: string;
+        animated?: boolean;
+        dashed?: boolean;
+    };
+}
+
+declare interface WorkflowDesignerContextValue {
+    workflow: WorkflowSchema;
+    selectedNodeIds: Set<string>;
+    selectedConnectionIds: Set<string>;
+    zoom: number;
+    panX: number;
+    panY: number;
+    isDragging: boolean;
+    isConnecting: boolean;
+    executionLog: WorkflowLogEntry[];
+    setWorkflow: (workflow: WorkflowSchema) => void;
+    addNode: (templateId: string, x: number, y: number) => WorkflowNode;
+    updateNode: (nodeId: string, updates: Partial<WorkflowNode>) => void;
+    removeNodes: (nodeIds: string[]) => void;
+    addConnection: (conn: Omit<WorkflowConnection, 'id'>) => void;
+    removeConnections: (connIds: string[]) => void;
+    selectNode: (nodeId: string, addToSelection?: boolean) => void;
+    selectConnection: (connId: string, addToSelection?: boolean) => void;
+    clearSelection: () => void;
+    setZoom: (zoom: number) => void;
+    setPan: (x: number, y: number) => void;
+    addVariable: (variable: Omit<WorkflowVariable, 'id'>) => void;
+    removeVariable: (varId: string) => void;
+    undo: () => void;
+    redo: () => void;
+    validate: () => {
+        valid: boolean;
+        errors: string[];
+    };
+    exportJSON: () => string;
+    exportYAML: () => string;
+    importJSON: (json: string) => void;
+}
+
+/**
+ * Workflow execution log entry
+ */
+export declare interface WorkflowLogEntry {
+    id: string;
+    nodeId: string;
+    timestamp: string;
+    status: 'running' | 'success' | 'error' | 'skipped';
+    input?: any;
+    output?: any;
+    error?: string;
+    duration?: number;
+}
+
+/**
+ * Union type for all workflow nodes
+ */
+export declare type WorkflowNode = TriggerNode | ActionNode | ConditionNode | LoopNode | ControlNode | WorkflowNodeBase;
+
+/**
+ * Base workflow node
+ */
+declare interface WorkflowNodeBase {
+    id: string;
+    category: WorkflowNodeCategory;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    label: string;
+    description?: string;
+    ports: WorkflowPort[];
+    config: Record<string, any>;
+    disabled?: boolean;
+    breakpoint?: boolean;
+    notes?: string;
+    style?: {
+        color?: string;
+        backgroundColor?: string;
+        borderColor?: string;
+        icon?: string;
+    };
+}
+
+/**
+ * Workflow node categories
+ */
+export declare type WorkflowNodeCategory = 'trigger' | 'action' | 'condition' | 'loop' | 'control' | 'integration' | 'data' | 'custom';
+
+/**
+ * Port type for workflow nodes
+ */
+export declare interface WorkflowPort {
+    id: string;
+    type: 'input' | 'output' | 'error';
+    label?: string;
+    position: 'top' | 'right' | 'bottom' | 'left';
+    dataType?: VariableType;
+    required?: boolean;
+    multiple?: boolean;
+}
+
+/**
+ * Complete workflow schema
+ */
+export declare interface WorkflowSchema {
+    version: string;
+    id: string;
+    name: string;
+    description?: string;
+    nodes: WorkflowNode[];
+    connections: WorkflowConnection[];
+    variables: WorkflowVariable[];
+    settings: {
+        timeout?: number;
+        errorHandling?: 'stop' | 'continue';
+        logging?: 'all' | 'errors' | 'none';
+        concurrency?: number;
+    };
+    canvas: {
+        width: number;
+        height: number;
+        zoom: number;
+        panX: number;
+        panY: number;
+        gridSize?: number;
+        showGrid?: boolean;
+    };
+    meta?: {
+        createdAt?: string;
+        updatedAt?: string;
+        author?: string;
+        version?: string;
+        tags?: string[];
+    };
+}
+
+/**
+ * Variable definition
+ */
+export declare interface WorkflowVariable {
+    id: string;
+    name: string;
+    type: VariableType;
+    defaultValue?: any;
+    description?: string;
+    scope: 'global' | 'local';
+}
+
+export { }