@object-ui/types 0.3.0

package/dist/crud.d.ts

@@ -0,0 +1,457 @@
+/**
+ * @object-ui/types - CRUD Component Schemas
+ *
+ * Type definitions for Create, Read, Update, Delete operations.
+ * These schemas enable building complete data management interfaces.
+ *
+ * @module crud
+ * @packageDocumentation
+ */
+import type { BaseSchema, SchemaNode } from './base';
+import type { FormField } from './form';
+import type { TableColumn } from './data-display';
+/**
+ * Action button configuration for CRUD operations
+ */
+export interface ActionSchema extends BaseSchema {
+    type: 'action';
+    /**
+     * Action label
+     */
+    label: string;
+    /**
+     * Action type/level
+     * @default 'default'
+     */
+    level?: 'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'info' | 'default';
+    /**
+     * Icon to display (lucide-react icon name)
+     */
+    icon?: string;
+    /**
+     * Action variant
+     */
+    variant?: 'default' | 'outline' | 'ghost' | 'link';
+    /**
+     * Whether action is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Action type
+     */
+    actionType?: 'button' | 'link' | 'dropdown';
+    /**
+     * API endpoint to call
+     */
+    api?: string;
+    /**
+     * HTTP method
+     * @default 'POST'
+     */
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /**
+     * Confirmation message before execution
+     */
+    confirmText?: string;
+    /**
+     * Success message after execution
+     */
+    successMessage?: string;
+    /**
+     * Whether to reload data after action
+     * @default true
+     */
+    reload?: boolean;
+    /**
+     * Whether to close dialog/modal after action
+     * @default true
+     */
+    close?: boolean;
+    /**
+     * Custom click handler
+     */
+    onClick?: () => void | Promise<void>;
+    /**
+     * Redirect URL after success
+     */
+    redirect?: string;
+}
+/**
+ * CRUD operation configuration
+ */
+export interface CRUDOperation {
+    /**
+     * Operation type
+     */
+    type: 'create' | 'read' | 'update' | 'delete' | 'export' | 'import' | 'custom';
+    /**
+     * Operation label
+     */
+    label?: string;
+    /**
+     * Operation icon
+     */
+    icon?: string;
+    /**
+     * Whether operation is enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * API endpoint for this operation
+     */
+    api?: string;
+    /**
+     * HTTP method
+     */
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    /**
+     * Confirmation message
+     */
+    confirmText?: string;
+    /**
+     * Success message
+     */
+    successMessage?: string;
+    /**
+     * Visibility condition
+     */
+    visibleOn?: string;
+    /**
+     * Disabled condition
+     */
+    disabledOn?: string;
+}
+/**
+ * Filter configuration for CRUD components
+ */
+export interface CRUDFilter {
+    /**
+     * Filter name (field name)
+     */
+    name: string;
+    /**
+     * Filter label
+     */
+    label?: string;
+    /**
+     * Filter type
+     */
+    type?: 'input' | 'select' | 'date-picker' | 'date-range' | 'number-range';
+    /**
+     * Filter operator
+     * @default 'equals'
+     */
+    operator?: 'equals' | 'contains' | 'startsWith' | 'endsWith' | 'gt' | 'gte' | 'lt' | 'lte' | 'between' | 'in';
+    /**
+     * Options for select filter
+     */
+    options?: Array<{
+        label: string;
+        value: string | number;
+    }>;
+    /**
+     * Placeholder text
+     */
+    placeholder?: string;
+    /**
+     * Default value
+     */
+    defaultValue?: any;
+}
+/**
+ * Toolbar configuration for CRUD components
+ */
+export interface CRUDToolbar {
+    /**
+     * Show create button
+     * @default true
+     */
+    showCreate?: boolean;
+    /**
+     * Show refresh button
+     * @default true
+     */
+    showRefresh?: boolean;
+    /**
+     * Show export button
+     * @default false
+     */
+    showExport?: boolean;
+    /**
+     * Show import button
+     * @default false
+     */
+    showImport?: boolean;
+    /**
+     * Show filter toggle
+     * @default true
+     */
+    showFilter?: boolean;
+    /**
+     * Show search box
+     * @default true
+     */
+    showSearch?: boolean;
+    /**
+     * Custom actions
+     */
+    actions?: ActionSchema[];
+}
+/**
+ * CRUD pagination configuration
+ */
+export interface CRUDPagination {
+    /**
+     * Whether pagination is enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Default page size
+     * @default 10
+     */
+    pageSize?: number;
+    /**
+     * Page size options
+     * @default [10, 20, 50, 100]
+     */
+    pageSizeOptions?: number[];
+    /**
+     * Show total count
+     * @default true
+     */
+    showTotal?: boolean;
+    /**
+     * Show page size selector
+     * @default true
+     */
+    showSizeChanger?: boolean;
+}
+/**
+ * Complete CRUD component
+ * Provides full Create, Read, Update, Delete functionality
+ */
+export interface CRUDSchema extends BaseSchema {
+    type: 'crud';
+    /**
+     * CRUD title
+     */
+    title?: string;
+    /**
+     * Resource name (singular)
+     * @example 'user', 'product', 'order'
+     */
+    resource?: string;
+    /**
+     * API endpoint for list/search
+     */
+    api?: string;
+    /**
+     * Table columns configuration
+     */
+    columns: TableColumn[];
+    /**
+     * Form fields for create/edit
+     */
+    fields?: FormField[];
+    /**
+     * Enabled operations
+     */
+    operations?: {
+        create?: boolean | CRUDOperation;
+        read?: boolean | CRUDOperation;
+        update?: boolean | CRUDOperation;
+        delete?: boolean | CRUDOperation;
+        export?: boolean | CRUDOperation;
+        import?: boolean | CRUDOperation;
+        [key: string]: boolean | CRUDOperation | undefined;
+    };
+    /**
+     * Toolbar configuration
+     */
+    toolbar?: CRUDToolbar;
+    /**
+     * Filter configuration
+     */
+    filters?: CRUDFilter[];
+    /**
+     * Pagination configuration
+     */
+    pagination?: CRUDPagination;
+    /**
+     * Default sort field
+     */
+    defaultSort?: string;
+    /**
+     * Default sort order
+     * @default 'asc'
+     */
+    defaultSortOrder?: 'asc' | 'desc';
+    /**
+     * Row selection mode
+     */
+    selectable?: boolean | 'single' | 'multiple';
+    /**
+     * Batch actions for selected rows
+     */
+    batchActions?: ActionSchema[];
+    /**
+     * Row actions (displayed in each row)
+     */
+    rowActions?: ActionSchema[];
+    /**
+     * Custom empty state
+     */
+    emptyState?: SchemaNode;
+    /**
+     * Whether to show loading state
+     * @default true
+     */
+    loading?: boolean;
+    /**
+     * Custom loading component
+     */
+    loadingComponent?: SchemaNode;
+    /**
+     * Table layout mode
+     * @default 'table'
+     */
+    mode?: 'table' | 'grid' | 'list' | 'kanban';
+    /**
+     * Grid columns (for grid mode)
+     * @default 3
+     */
+    gridColumns?: number;
+    /**
+     * Card template (for grid/list mode)
+     */
+    cardTemplate?: SchemaNode;
+    /**
+     * Kanban columns (for kanban mode)
+     */
+    kanbanColumns?: Array<{
+        id: string;
+        title: string;
+        color?: string;
+    }>;
+    /**
+     * Kanban group field
+     */
+    kanbanGroupField?: string;
+}
+/**
+ * Detail view component
+ * Displays detailed information about a single record
+ */
+export interface DetailSchema extends BaseSchema {
+    type: 'detail';
+    /**
+     * Detail title
+     */
+    title?: string;
+    /**
+     * API endpoint to fetch detail data
+     */
+    api?: string;
+    /**
+     * Resource ID to display
+     */
+    resourceId?: string | number;
+    /**
+     * Field groups for organized display
+     */
+    groups?: Array<{
+        title?: string;
+        description?: string;
+        fields: Array<{
+            name: string;
+            label?: string;
+            type?: 'text' | 'image' | 'link' | 'badge' | 'date' | 'datetime' | 'json' | 'html' | 'custom';
+            format?: string;
+            render?: SchemaNode;
+        }>;
+    }>;
+    /**
+     * Actions available in detail view
+     */
+    actions?: ActionSchema[];
+    /**
+     * Tabs for additional content
+     */
+    tabs?: Array<{
+        key: string;
+        label: string;
+        content: SchemaNode | SchemaNode[];
+    }>;
+    /**
+     * Show back button
+     * @default true
+     */
+    showBack?: boolean;
+    /**
+     * Custom back action
+     */
+    onBack?: () => void;
+    /**
+     * Whether to show loading state
+     * @default true
+     */
+    loading?: boolean;
+}
+/**
+ * CRUD Dialog/Modal component for CRUD operations
+ * Note: For general dialog usage, use DialogSchema from overlay module
+ */
+export interface CRUDDialogSchema extends BaseSchema {
+    type: 'crud-dialog';
+    /**
+     * Dialog title
+     */
+    title?: string;
+    /**
+     * Dialog description
+     */
+    description?: string;
+    /**
+     * Dialog content
+     */
+    content?: SchemaNode | SchemaNode[];
+    /**
+     * Dialog size
+     * @default 'default'
+     */
+    size?: 'sm' | 'default' | 'lg' | 'xl' | 'full';
+    /**
+     * Dialog actions/buttons
+     */
+    actions?: ActionSchema[];
+    /**
+     * Whether dialog is open
+     */
+    open?: boolean;
+    /**
+     * Close handler
+     */
+    onClose?: () => void;
+    /**
+     * Whether clicking outside closes dialog
+     * @default true
+     */
+    closeOnOutsideClick?: boolean;
+    /**
+     * Whether pressing Escape closes dialog
+     * @default true
+     */
+    closeOnEscape?: boolean;
+    /**
+     * Show close button
+     * @default true
+     */
+    showClose?: boolean;
+}
+/**
+ * Union type of all CRUD schemas
+ */
+export type CRUDComponentSchema = ActionSchema | CRUDSchema | DetailSchema | CRUDDialogSchema;
+//# sourceMappingURL=crud.d.ts.map

package/dist/crud.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crud.d.ts","sourceRoot":"","sources":["../src/crud.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IACxF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;IACnD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;IAC5C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACrD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC/E;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACrD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,aAAa,GAAG,YAAY,GAAG,cAAc,CAAC;IAC1E;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;IAC9G;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;QACjC,IAAI,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;QAC/B,MAAM,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;QACjC,MAAM,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;QACjC,MAAM,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;QACjC,MAAM,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;QACjC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,GAAG,SAAS,CAAC;KACpD,CAAC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAC7C;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC;IAC9B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,KAAK,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;YAC9F,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,MAAM,CAAC,EAAE,UAAU,CAAC;SACrB,CAAC,CAAC;KACJ,CAAC,CAAC;IACH;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;KACpC,CAAC,CAAC;IACH;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACpC;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,gBAAgB,CAAC"}

package/dist/crud.js

@@ -0,0 +1,10 @@
+/**
+ * @object-ui/types - CRUD Component Schemas
+ *
+ * Type definitions for Create, Read, Update, Delete operations.
+ * These schemas enable building complete data management interfaces.
+ *
+ * @module crud
+ * @packageDocumentation
+ */
+export {};