@stonecrop/schema 0.14.0 → 0.16.0

package/dist/src/jsonschema.d.ts

@@ -1,95 +0,0 @@
-import type { DoctypeMeta } from './doctype';
-/**
- * JSON Schema representation for a doctype
- * @public
- */
-export interface DoctypeJSONSchema {
-    /** JSON Schema for the doctype structure */
-    schema: Record<string, unknown>;
-    /** Metadata from the doctype definition */
-    meta: {
-        name: string;
-        slug?: string;
-        tableName?: string;
-        inherits?: string;
-        listDoctype?: string;
-        parentDoctype?: string;
-    };
-    /** Workflow metadata if present */
-    workflow?: {
-        states?: string[];
-        actions?: Record<string, Record<string, unknown>>;
-    };
-}
-/**
- * Convert a DoctypeMeta to JSON Schema
- *
- * @param doctype - The doctype definition to convert
- * @returns JSON Schema representation of the doctype
- *
- * @example
- * ```typescript
- * import { DoctypeMeta, toJSONSchema } from '@stonecrop/schema'
- *
- * const taskDoctype = DoctypeMeta.parse({
- *   name: 'Task',
- *   fields: [
- *     { fieldname: 'title', fieldtype: 'Data', required: true },
- *     { fieldname: 'status', fieldtype: 'Select', options: ['Open', 'Closed'] }
- *   ]
- * })
- *
- * const jsonSchema = toJSONSchema(taskDoctype)
- * // => {
- * //   schema: { type: 'object', properties: { title: {...}, status: {...} }, required: ['title'] },
- * //   meta: { name: 'Task' }
- * // }
- * ```
- *
- * @public
- */
-export declare function toJSONSchema(doctype: DoctypeMeta): DoctypeJSONSchema;
-/**
- * Generate a collection of JSON Schemas from multiple doctypes
- *
- * @param doctypes - Array of doctype definitions
- * @returns Map of doctype name to JSON Schema
- *
- * @example
- * ```typescript
- * import { DoctypeMeta, toSchemasCollection } from '@stonecrop/schema'
- *
- * const doctypes = [
- *   DoctypeMeta.parse({ name: 'Task', fields: [...] }),
- *   DoctypeMeta.parse({ name: 'Customer', fields: [...] }),
- * ]
- *
- * const collection = toSchemasCollection(doctypes)
- * // => { Task: {...}, Customer: {...} }
- * ```
- *
- * @public
- */
-export declare function toSchemasCollection(doctypes: DoctypeMeta[]): Record<string, DoctypeJSONSchema>;
-/**
- * Generate OpenAPI schema components from doctypes
- *
- * @param doctypes - Array of doctype definitions
- * @returns OpenAPI 3.1 compatible components object
- *
- * @example
- * ```typescript
- * import { DoctypeMeta, toOpenAPIComponents } from '@stonecrop/schema'
- *
- * const doctypes = [DoctypeMeta.parse({ name: 'Task', fields: [...] })]
- *
- * const components = toOpenAPIComponents(doctypes)
- * // => { schemas: { Task: {...} } }
- * ```
- *
- * @public
- */
-export declare function toOpenAPIComponents(doctypes: DoctypeMeta[]): {
-    schemas: Record<string, Record<string, unknown>>;
-};
-//# sourceMappingURL=jsonschema.d.ts.map

package/dist/src/jsonschema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jsonschema.d.ts","sourceRoot":"","sources":["../../src/jsonschema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAkC,MAAM,WAAW,CAAA;AAI5E;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE/B,2CAA2C;IAC3C,IAAI,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,aAAa,CAAC,EAAE,MAAM,CAAA;KACtB,CAAA;IAED,mCAAmC;IACnC,QAAQ,CAAC,EAAE;QACV,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;KACjD,CAAA;CACD;AAuGD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,iBAAiB,CAmDpE;AAsBD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAQ9F;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,WAAW,EAAE,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAAE,CASjH"}

package/dist/src/schema-field.d.ts

@@ -1,66 +0,0 @@
-/**
- * Minimal field shape representing the intersection of form field properties
- * (fieldname, hidden, etc.) and table column properties (cellComponent, pinned, format, etc.)
- * so that a doctype's fields array can be passed directly to table components without
- * requiring callers to pre-build TableColumn objects.
- *
- * Notes on specific properties:
- * - `align` uses an explicit string union rather than CanvasTextAlign — this
- *   package is used server-side by the CLI where browser DOM types are absent.
- * - `format` is a serialized function string; the table store's getFormattedValue
- *   already handles typeof format === 'string' via Function(...).
- * - `mask` is intentionally omitted — ACell has mask commented out as a TODO
- *   and TableColumn.mask is function-typed only; including it here would create
- *   an incompatible type.
- * - `modalComponent` is string-only (no function variant) — functions cannot
- *   appear in schema JSON.
- *
- * @public
- */
-export interface ColumnSchema {
-    /** Unique identifier for the field within its doctype. Maps to `name` on `TableColumn`. */
-    fieldname: string;
-    /** Semantic field type (e.g. `'Data'`, `'Int'`, `'Date'`, `'Check'`). Fields without a `fieldtype` are treated as non-scalar (nested table/fieldset) and excluded by `schemaToColumns`. */
-    fieldtype?: string;
-    /** Human-readable column header. */
-    label?: string;
-    /** When `true`, the field is excluded from the derived columns by `schemaToColumns`. */
-    hidden?: boolean;
-    /** Horizontal text alignment for the column cell and header. */
-    align?: 'left' | 'right' | 'center' | 'start' | 'end';
-    /** Whether the column cell is editable in the table. */
-    edit?: boolean;
-    /** CSS width of the column (e.g. `'20ch'`, `'200px'`). */
-    width?: string;
-    /** When `true`, the column is pinned to the left side of the table. */
-    pinned?: boolean;
-    /** When `true`, the column can be resized by dragging the header edge. */
-    resizable?: boolean;
-    /** When `true`, clicking the column header sorts the table by this column. */
-    sortable?: boolean;
-    /** When `true`, a filter control is rendered in the column header. */
-    filterable?: boolean;
-    /** The type of filter control to render. Defaults are derived from `fieldtype` when absent. */
-    filterType?: 'text' | 'select' | 'number' | 'date' | 'dateRange' | 'checkbox' | 'component';
-    /** Static option list for `filterType: 'select'`. When absent, options are derived from unique row values. */
-    filterOptions?: any[];
-    /** Registered component name used when `filterType` is `'component'`. */
-    filterComponent?: string;
-    /** Registered component name rendered inside the table cell instead of the default display. */
-    cellComponent?: string;
-    /** Props passed to `cellComponent`. */
-    cellComponentProps?: Record<string, any>;
-    /** Registered component name rendered in the cell's modal editor. String-only — functions cannot appear in schema JSON. */
-    modalComponent?: string;
-    /** Extra props passed to `modalComponent` in addition to the standard cell props. */
-    modalComponentExtraProps?: Record<string, any>;
-    /** Serialized function string used to format the cell value for display. Deserialized at render time by the table store's `getFormattedValue`. */
-    format?: string;
-    /** When `true`, this column is treated as a Gantt bar column. */
-    isGantt?: boolean;
-    /** Registered component name used to render Gantt bars in this column. */
-    ganttComponent?: string;
-    /** Number of columns this cell spans in the table layout. */
-    colspan?: number;
-}
-//# sourceMappingURL=schema-field.d.ts.map

package/dist/src/schema-field.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema-field.d.ts","sourceRoot":"","sources":["../../src/schema-field.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,YAAY;IAC5B,2FAA2F;IAC3F,SAAS,EAAE,MAAM,CAAA;IACjB,2LAA2L;IAC3L,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wFAAwF;IACxF,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAA;IACrD,wDAAwD;IACxD,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,sEAAsE;IACtE,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,CAAA;IAC3F,8GAA8G;IAC9G,aAAa,CAAC,EAAE,GAAG,EAAE,CAAA;IACrB,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,+FAA+F;IAC/F,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uCAAuC;IACvC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACxC,2HAA2H;IAC3H,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,qFAAqF;IACrF,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC9C,kJAAkJ;IAClJ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,iEAAiE;IACjE,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB"}

package/dist/src/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.57.0"
-    }
-  ]
-}

package/dist/validation.js

@@ -1,60 +0,0 @@
-import { FieldMeta } from './field';
-import { DoctypeMeta } from './doctype';
-/**
- * Validate a field definition
- * @param data - Data to validate
- * @returns Validation result
- * @public
- */
-export function validateField(data) {
-    const result = FieldMeta.safeParse(data);
-    if (result.success) {
-        return { success: true, errors: [] };
-    }
-    return {
-        success: false,
-        errors: result.error.issues.map(issue => ({
-            path: issue.path,
-            message: issue.message,
-        })),
-    };
-}
-/**
- * Validate a doctype definition
- * @param data - Data to validate
- * @returns Validation result
- * @public
- */
-export function validateDoctype(data) {
-    const result = DoctypeMeta.safeParse(data);
-    if (result.success) {
-        return { success: true, errors: [] };
-    }
-    return {
-        success: false,
-        errors: result.error.issues.map(issue => ({
-            path: issue.path,
-            message: issue.message,
-        })),
-    };
-}
-/**
- * Parse and validate a field, throwing on failure
- * @param data - Data to parse
- * @returns Validated FieldMeta
- * @throws ZodError if validation fails
- * @public
- */
-export function parseField(data) {
-    return FieldMeta.parse(data);
-}
-/**
- * Parse and validate a doctype, throwing on failure
- * @param data - Data to parse
- * @returns Validated DoctypeMeta
- * @throws ZodError if validation fails
- * @public
- */
-export function parseDoctype(data) {
-    return DoctypeMeta.parse(data);
-}