@stonecrop/stonecrop 0.6.2 → 0.7.0

package/dist/stonecrop.d.ts

@@ -2,25 +2,14 @@ import type { AnyStateNodeConfig } from 'xstate';
 import { Component } from 'vue';
 import { ComputedRef } from 'vue';
 import { CSSProperties } from 'vue';
-import { HSTOperation as HSTOperation_2 } from './types';
-import { HSTOperation as HSTOperation_3 } from '..';
-import { HSTOperationInput as HSTOperationInput_2 } from './types';
-import { HSTOperationType as HSTOperationType_2 } from './types';
-import { HSTOperationType as HSTOperationType_3 } from '..';
 import { List } from 'immutable';
 import { Map as Map_2 } from 'immutable';
-import { OperationLogSnapshot as OperationLogSnapshot_2 } from './types';
-import { OperationLogSnapshot as OperationLogSnapshot_3 } from '..';
-import { OperationSource as OperationSource_2 } from './types';
-import { OperationSource as OperationSource_3 } from '..';
 import { Plugin as Plugin_2 } from 'vue';
 import { Ref } from 'vue';
 import { Router } from 'vue-router';
 import type { ShallowRef } from 'vue';
 import { Store } from 'pinia';
 import { StoreDefinition } from 'pinia';
-import { UndoRedoState as UndoRedoState_2 } from './types';
-import { UndoRedoState as UndoRedoState_3 } from '..';
 import type { UnknownMachineConfig } from 'xstate';
 import { useElementBounding } from '@vueuse/core';
 import { WritableComputedRef } from 'vue';
@@ -184,7 +173,7 @@ export declare type ComponentProps = {
      * Indicate whether elements inside the component are read-only
      * @public
      */
-    readonly?: boolean;
+    readOnly?: boolean;
     /**
      * Set a unique identifier for elements inside the component
      * @public
@@ -318,7 +307,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -342,7 +331,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -612,7 +601,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -636,7 +625,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -906,7 +895,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -930,7 +919,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -1196,6 +1185,15 @@ updateGanttBar: (event: GanttDragEvent) => void;
 updateRows: (newRows: TableRow[]) => void;
 }, "clearFilter" | "closeModal" | "createConnection" | "deleteConnection" | "getCellData" | "getCellDisplayValue" | "getConnectionsForBar" | "getFormattedValue" | "getHandlesForBar" | "getHeaderCellStyle" | "getIndent" | "getRowExpandSymbol" | "isRowGantt" | "isRowVisible" | "registerConnectionHandle" | "registerGanttBar" | "resizeColumn" | "setCellData" | "setCellText" | "setFilter" | "sortByColumn" | "toggleRowExpand" | "unregisterConnectionHandle" | "unregisterGanttBar" | "updateGanttBar" | "updateRows">>;
 
+/**
+ * Creates a validator with the given registry
+ * @param registry - Registry instance
+ * @param options - Additional validator options
+ * @returns SchemaValidator instance
+ * @public
+ */
+export declare function createValidator(registry: Registry, options?: Partial<ValidatorOptions>): SchemaValidator;
+
 /**
  * Cross-tab message payload
  * @public
@@ -2172,6 +2170,48 @@ export declare type Schema = {
  */
 export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;
 
+/**
+ * Schema validator class
+ * @public
+ */
+export declare class SchemaValidator {
+    private options;
+    /**
+     * Creates a new SchemaValidator instance
+     * @param options - Validator configuration options
+     */
+    constructor(options?: ValidatorOptions);
+    /**
+     * Validates a complete doctype schema
+     * @param doctype - Doctype name
+     * @param schema - Schema fields (List or Array)
+     * @param workflow - Optional workflow configuration
+     * @param actions - Optional actions map
+     * @returns Validation result
+     */
+    validate(doctype: string, schema: List<SchemaTypes> | SchemaTypes[] | undefined, workflow?: AnyStateNodeConfig, actions?: Map_2<string, string[]> | Map<string, string[]>): ValidationResult;
+    /**
+     * Validates that required schema properties are present
+     * @internal
+     */
+    private validateRequiredProperties;
+    /**
+     * Validates Link field targets exist in registry
+     * @internal
+     */
+    private validateLinkFields;
+    /**
+     * Validates workflow state machine configuration
+     * @internal
+     */
+    private validateWorkflow;
+    /**
+     * Validates that actions are registered in the FieldTriggerEngine
+     * @internal
+     */
+    private validateActionRegistration;
+}
+
 /**
  * Configure rollback behavior for a specific field trigger
  * @param doctype - The doctype name
@@ -2204,7 +2244,7 @@ export declare class Stonecrop {
     getOperationLogStore(): Store<"hst-operation-log", Pick<{
     operations: Ref<    {
     id: string;
-    type: HSTOperationType_2;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -2212,7 +2252,7 @@ export declare class Stonecrop {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_2 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -2226,9 +2266,9 @@ export declare class Stonecrop {
     metadata?: Record<string, any> | undefined;
     parentOperationId?: string | undefined;
     childOperationIds?: string[] | undefined;
-    }[], HSTOperation_2[] | {
+    }[], HSTOperation[] | {
     id: string;
-    type: HSTOperationType_2;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -2236,7 +2276,7 @@ export declare class Stonecrop {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_2 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -2259,7 +2299,7 @@ export declare class Stonecrop {
     enablePersistence?: boolean | undefined;
     persistenceKeyPrefix?: string | undefined;
     userId?: string | undefined;
-    operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
+    operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
     }, OperationLogConfig | {
     maxOperations?: number | undefined;
     enableCrossTabSync?: boolean | undefined;
@@ -2267,30 +2307,30 @@ export declare class Stonecrop {
     enablePersistence?: boolean | undefined;
     persistenceKeyPrefix?: string | undefined;
     userId?: string | undefined;
-    operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
+    operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
     }>;
     clientId: Ref<string, string>;
-    undoRedoState: ComputedRef<UndoRedoState_2>;
+    undoRedoState: ComputedRef<UndoRedoState>;
     canUndo: ComputedRef<boolean>;
     canRedo: ComputedRef<boolean>;
     undoCount: ComputedRef<number>;
     redoCount: ComputedRef<number>;
     configure: (options: Partial<OperationLogConfig>) => void;
-    addOperation: (operation: HSTOperationInput_2, source?: OperationSource_2) => string;
+    addOperation: (operation: HSTOperationInput, source?: OperationSource) => string;
     startBatch: () => void;
     commitBatch: (description?: string) => string | null;
     cancelBatch: () => void;
     undo: (store: HSTNode) => boolean;
     redo: (store: HSTNode) => boolean;
     clear: () => void;
-    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_2[];
-    getSnapshot: () => OperationLogSnapshot_2;
+    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
+    getSnapshot: () => OperationLogSnapshot;
     markIrreversible: (operationId: string, reason: string) => void;
     logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
     }, "operations" | "clientId" | "currentIndex" | "config">, Pick<{
     operations: Ref<    {
     id: string;
-    type: HSTOperationType_2;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -2298,7 +2338,7 @@ export declare class Stonecrop {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_2 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -2312,9 +2352,9 @@ export declare class Stonecrop {
     metadata?: Record<string, any> | undefined;
     parentOperationId?: string | undefined;
     childOperationIds?: string[] | undefined;
-    }[], HSTOperation_2[] | {
+    }[], HSTOperation[] | {
     id: string;
-    type: HSTOperationType_2;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -2322,7 +2362,7 @@ export declare class Stonecrop {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_2 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -2345,7 +2385,7 @@ export declare class Stonecrop {
     enablePersistence?: boolean | undefined;
     persistenceKeyPrefix?: string | undefined;
     userId?: string | undefined;
-    operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
+    operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
     }, OperationLogConfig | {
     maxOperations?: number | undefined;
     enableCrossTabSync?: boolean | undefined;
@@ -2353,30 +2393,30 @@ export declare class Stonecrop {
     enablePersistence?: boolean | undefined;
     persistenceKeyPrefix?: string | undefined;
     userId?: string | undefined;
-    operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
+    operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
     }>;
     clientId: Ref<string, string>;
-    undoRedoState: ComputedRef<UndoRedoState_2>;
+    undoRedoState: ComputedRef<UndoRedoState>;
     canUndo: ComputedRef<boolean>;
     canRedo: ComputedRef<boolean>;
     undoCount: ComputedRef<number>;
     redoCount: ComputedRef<number>;
     configure: (options: Partial<OperationLogConfig>) => void;
-    addOperation: (operation: HSTOperationInput_2, source?: OperationSource_2) => string;
+    addOperation: (operation: HSTOperationInput, source?: OperationSource) => string;
     startBatch: () => void;
     commitBatch: (description?: string) => string | null;
     cancelBatch: () => void;
     undo: (store: HSTNode) => boolean;
     redo: (store: HSTNode) => boolean;
     clear: () => void;
-    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_2[];
-    getSnapshot: () => OperationLogSnapshot_2;
+    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
+    getSnapshot: () => OperationLogSnapshot;
     markIrreversible: (operationId: string, reason: string) => void;
     logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
     }, "undoRedoState" | "canUndo" | "canRedo" | "undoCount" | "redoCount">, Pick<{
     operations: Ref<    {
     id: string;
-    type: HSTOperationType_2;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -2384,7 +2424,7 @@ export declare class Stonecrop {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_2 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -2398,9 +2438,9 @@ export declare class Stonecrop {
     metadata?: Record<string, any> | undefined;
     parentOperationId?: string | undefined;
     childOperationIds?: string[] | undefined;
-    }[], HSTOperation_2[] | {
+    }[], HSTOperation[] | {
     id: string;
-    type: HSTOperationType_2;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -2408,7 +2448,7 @@ export declare class Stonecrop {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_2 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -2431,7 +2471,7 @@ export declare class Stonecrop {
     enablePersistence?: boolean | undefined;
     persistenceKeyPrefix?: string | undefined;
     userId?: string | undefined;
-    operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
+    operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
     }, OperationLogConfig | {
     maxOperations?: number | undefined;
     enableCrossTabSync?: boolean | undefined;
@@ -2439,24 +2479,24 @@ export declare class Stonecrop {
     enablePersistence?: boolean | undefined;
     persistenceKeyPrefix?: string | undefined;
     userId?: string | undefined;
-    operationFilter?: ((operation: HSTOperation_2) => boolean) | undefined;
+    operationFilter?: ((operation: HSTOperation) => boolean) | undefined;
     }>;
     clientId: Ref<string, string>;
-    undoRedoState: ComputedRef<UndoRedoState_2>;
+    undoRedoState: ComputedRef<UndoRedoState>;
     canUndo: ComputedRef<boolean>;
     canRedo: ComputedRef<boolean>;
     undoCount: ComputedRef<number>;
     redoCount: ComputedRef<number>;
     configure: (options: Partial<OperationLogConfig>) => void;
-    addOperation: (operation: HSTOperationInput_2, source?: OperationSource_2) => string;
+    addOperation: (operation: HSTOperationInput, source?: OperationSource) => string;
     startBatch: () => void;
     commitBatch: (description?: string) => string | null;
     cancelBatch: () => void;
     undo: (store: HSTNode) => boolean;
     redo: (store: HSTNode) => boolean;
     clear: () => void;
-    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_2[];
-    getSnapshot: () => OperationLogSnapshot_2;
+    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
+    getSnapshot: () => OperationLogSnapshot;
     markIrreversible: (operationId: string, reason: string) => void;
     logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
     }, "undo" | "redo" | "configure" | "addOperation" | "startBatch" | "commitBatch" | "cancelBatch" | "clear" | "getOperationsFor" | "getSnapshot" | "markIrreversible" | "logAction">>;
@@ -2581,15 +2621,12 @@ export declare interface TableColumn {
      */
     label?: string;
     /**
-     * The data-type of the column. Possible values:
-     * - `Data` - the column contains text data
-     * - `Select` - the column contains a select input
-     * - `Date` - the column contains a date input
-     * - `component` - the column contains a custom component
+     * The semantic field type of the column. Uses the same StonecropFieldType enum as forms.
+     * Common values: 'Data', 'Text', 'Int', 'Float', 'Date', 'Select', 'Link', 'Check', etc.
      *
-     * @beta
+     * @public
      */
-    type?: string;
+    fieldtype?: string;
     /**
      * The width of the column. This can be a number (in pixels) or a string (in CSS units).
      *
@@ -3079,7 +3116,7 @@ export declare interface UndoRedoState {
 export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
     operations: Ref<    {
     id: string;
-    type: HSTOperationType_3;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -3087,7 +3124,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_3 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -3101,9 +3138,9 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
     metadata?: Record<string, any> | undefined;
     parentOperationId?: string | undefined;
     childOperationIds?: string[] | undefined;
-    }[], HSTOperation_3[] | {
+    }[], HSTOperation[] | {
     id: string;
-    type: HSTOperationType_3;
+    type: HSTOperationType;
     path: string;
     fieldname: string;
     beforeValue: any;
@@ -3111,7 +3148,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
     doctype: string;
     recordId?: string | undefined;
     timestamp: Date;
-    source?: OperationSource_3 | undefined;
+    source?: OperationSource | undefined;
     reversible: boolean;
     irreversibleReason?: string | undefined;
     transition?: string | undefined;
@@ -3127,7 +3164,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
     childOperationIds?: string[] | undefined;
     }[]>;
     currentIndex: Ref<number, number>;
-    undoRedoState: ComputedRef<UndoRedoState_3>;
+    undoRedoState: ComputedRef<UndoRedoState>;
     canUndo: ComputedRef<boolean>;
     canRedo: ComputedRef<boolean>;
     undoCount: ComputedRef<number>;
@@ -3138,8 +3175,8 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
     commitBatch: (description?: string) => string | null;
     cancelBatch: () => void;
     clear: () => void;
-    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation_3[];
-    getSnapshot: () => OperationLogSnapshot_3;
+    getOperationsFor: (doctype: string, recordId?: string) => HSTOperation[];
+    getSnapshot: () => OperationLogSnapshot;
     markIrreversible: (operationId: string, reason: string) => void;
     logAction: (doctype: string, actionName: string, recordIds?: string[], result?: "success" | "failure" | "pending", error?: string) => string;
     configure: (options: Partial<OperationLogConfig>) => void;
@@ -3154,7 +3191,7 @@ export declare function useOperationLog(config?: Partial<OperationLogConfig>): {
 export declare const useOperationLogStore: StoreDefinition<"hst-operation-log", Pick<{
 operations: Ref<    {
 id: string;
-type: HSTOperationType_3;
+type: HSTOperationType;
 path: string;
 fieldname: string;
 beforeValue: any;
@@ -3178,7 +3215,7 @@ parentOperationId?: string | undefined;
 childOperationIds?: string[] | undefined;
 }[], HSTOperation[] | {
 id: string;
-type: HSTOperationType_3;
+type: HSTOperationType;
 path: string;
 fieldname: string;
 beforeValue: any;
@@ -3240,7 +3277,7 @@ logAction: (doctype: string, actionName: string, recordIds?: string[], result?:
 }, "operations" | "clientId" | "currentIndex" | "config">, Pick<{
 operations: Ref<    {
 id: string;
-type: HSTOperationType_3;
+type: HSTOperationType;
 path: string;
 fieldname: string;
 beforeValue: any;
@@ -3264,7 +3301,7 @@ parentOperationId?: string | undefined;
 childOperationIds?: string[] | undefined;
 }[], HSTOperation[] | {
 id: string;
-type: HSTOperationType_3;
+type: HSTOperationType;
 path: string;
 fieldname: string;
 beforeValue: any;
@@ -3326,7 +3363,7 @@ logAction: (doctype: string, actionName: string, recordIds?: string[], result?:
 }, "undoRedoState" | "canUndo" | "canRedo" | "undoCount" | "redoCount">, Pick<{
 operations: Ref<    {
 id: string;
-type: HSTOperationType_3;
+type: HSTOperationType;
 path: string;
 fieldname: string;
 beforeValue: any;
@@ -3350,7 +3387,7 @@ parentOperationId?: string | undefined;
 childOperationIds?: string[] | undefined;
 }[], HSTOperation[] | {
 id: string;
-type: HSTOperationType_3;
+type: HSTOperationType;
 path: string;
 fieldname: string;
 beforeValue: any;
@@ -3452,6 +3489,84 @@ export declare function useStonecrop(options: {
  */
 export declare function useUndoRedoShortcuts(hstStore: HSTNode, enabled?: boolean): void;
 
+/**
+ * Quick validation helper
+ * @param doctype - Doctype name
+ * @param schema - Schema fields
+ * @param registry - Registry instance
+ * @param workflow - Optional workflow configuration
+ * @param actions - Optional actions map
+ * @returns Validation result
+ * @public
+ */
+export declare function validateSchema(doctype: string, schema: List<SchemaTypes> | SchemaTypes[] | undefined, registry: Registry, workflow?: AnyStateNodeConfig, actions?: Map_2<string, string[]> | Map<string, string[]>): ValidationResult;
+
+/**
+ * Validation issue
+ * @public
+ */
+export declare interface ValidationIssue {
+    /** Severity level */
+    severity: ValidationSeverity;
+    /** Validation rule that failed */
+    rule: string;
+    /** Human-readable message */
+    message: string;
+    /** Doctype name */
+    doctype?: string;
+    /** Field name if applicable */
+    fieldname?: string;
+    /** Additional context */
+    context?: Record<string, unknown>;
+}
+
+/**
+ * Validation result
+ * @public
+ */
+export declare interface ValidationResult {
+    /** Whether validation passed (no blocking errors) */
+    valid: boolean;
+    /** List of validation issues */
+    issues: ValidationIssue[];
+    /** Count of errors */
+    errorCount: number;
+    /** Count of warnings */
+    warningCount: number;
+    /** Count of info messages */
+    infoCount: number;
+}
+
+/**
+ * Validation severity levels
+ * @public
+ */
+export declare enum ValidationSeverity {
+    /** Blocking error that prevents save */
+    ERROR = "error",
+    /** Advisory warning that allows save */
+    WARNING = "warning",
+    /** Informational message */
+    INFO = "info"
+}
+
+/**
+ * Schema validator options
+ * @public
+ */
+export declare interface ValidatorOptions {
+    /** Registry instance for doctype lookups */
+    registry?: Registry;
+    /** Whether to validate Link field targets */
+    validateLinkTargets?: boolean;
+    /** Whether to validate workflow reachability */
+    validateWorkflows?: boolean;
+    /** Whether to validate action registration */
+    validateActions?: boolean;
+    /** Whether to validate required schema properties */
+    validateRequiredProperties?: boolean;
+}
+
 /**
  * Batch operation helper
  * Wraps a function execution in a batch operation