@stonecrop/schema 0.14.0 → 0.16.0

package/dist/doctype.js

@@ -1,152 +0,0 @@
-import { z } from 'zod';
-import { FieldMeta } from './field';
-/**
- * Cardinality for relationship links.
- * @public
- */
-export const Cardinality = z.enum(['atMostOne', 'one', 'noneOrMany', 'atLeastOne']).meta({
-    title: 'Cardinality',
-    description: 'Cardinality for relationship links between doctypes',
-});
-/**
- * Sync fetch strategy - data is fetched in the initial query.
- * @public
- */
-export const SyncFetch = z
-    .object({
-    /** Fetch method type */
-    method: z.literal('sync'),
-    /** Optional limit on number of records to fetch */
-    limit: z.number().int().positive().optional(),
-})
-    .meta({
-    title: 'SyncFetch',
-    description: 'Sync fetch strategy - data is fetched in the initial query',
-});
-/**
- * Lazy fetch strategy - data is fetched on demand in a separate query.
- * @public
- */
-export const LazyFetch = z
-    .object({
-    /** Fetch method type */
-    method: z.literal('lazy'),
-})
-    .meta({
-    title: 'LazyFetch',
-    description: 'Lazy fetch strategy - data is fetched on demand in a separate query',
-});
-/**
- * Custom fetch strategy - uses a custom handler function.
- * @public
- */
-export const CustomFetch = z
-    .object({
-    /** Fetch method type */
-    method: z.literal('custom'),
-    /** Serialized handler function to invoke */
-    handler: z.string(),
-})
-    .meta({
-    title: 'CustomFetch',
-    description: 'Custom fetch strategy - uses a custom handler function',
-});
-/**
- * Fetch strategy for link data loading.
- * - sync: fetched in the initial query
- * - lazy: fetched on demand in a separate query
- * - custom: uses a custom handler function
- * @public
- */
-export const FetchStrategy = z.discriminatedUnion('method', [SyncFetch, LazyFetch, CustomFetch]).meta({
-    title: 'FetchStrategy',
-    description: 'Fetch strategy for link data loading',
-});
-/**
- * Link declaration - describes a relationship from one doctype to another.
- * @public
- */
-export const LinkDeclaration = z
-    .object({
-    /** Target doctype slug */
-    target: z.string().min(1),
-    /** Cardinality of the relationship */
-    cardinality: Cardinality,
-    /** Backlink fieldname on the target doctype that points back to this link */
-    backlink: z.string().optional(),
-    /** Override default rendering component (AForm for 1:1, ATable for 1:many) */
-    component: z.string().optional(),
-    /** Fieldname of the corresponding Link field in the fields array */
-    fieldname: z.string().min(1).optional(),
-    /** Fetch strategy for loading nested data */
-    fetch: FetchStrategy.optional(),
-    /** Whether to block workflow actions until nested data is loaded (default: true) */
-    blockWorkflows: z.boolean().optional(),
-})
-    .meta({
-    title: 'LinkDeclaration',
-    description: 'Declares a relationship from one doctype to another',
-});
-/**
- * Action definition within a workflow
- * @public
- */
-export const ActionDefinition = z
-    .object({
-    /** Display label for the action */
-    label: z.string().min(1),
-    /** Handler function name or path */
-    handler: z.string().min(1),
-    /** Fields that must have values before action can execute */
-    requiredFields: z.array(z.string()).optional(),
-    /** Workflow states where this action is available */
-    allowedStates: z.array(z.string()).optional(),
-    /** Whether to show a confirmation dialog */
-    confirm: z.boolean().optional(),
-    /** Additional arguments for the action */
-    args: z.record(z.string(), z.unknown()).optional(),
-})
-    .meta({
-    title: 'ActionDefinition',
-    description: 'Action definition within a workflow',
-});
-/**
- * Workflow metadata - states and actions for a doctype
- * @public
- */
-export const WorkflowMeta = z
-    .object({
-    /** List of workflow states */
-    states: z.array(z.string()).optional(),
-    /** Actions available in this workflow */
-    actions: z.record(z.string(), ActionDefinition).optional(),
-})
-    .meta({
-    title: 'WorkflowMeta',
-    description: 'Workflow metadata - states and actions for a doctype',
-});
-/**
- * Doctype metadata - complete definition of a doctype
- * @public
- */
-export const DoctypeMeta = z
-    .object({
-    /** Display name of the doctype */
-    name: z.string().min(1),
-    /** URL-friendly slug (kebab-case) */
-    slug: z.string().min(1).optional(),
-    /** Database table name */
-    tableName: z.string().optional(),
-    /** Field definitions (including link fields with fieldtype: 'Link') */
-    fields: z.array(FieldMeta),
-    /** Relationship links to other doctypes */
-    links: z.record(z.string(), LinkDeclaration).optional(),
-    /** Workflow configuration */
-    workflow: WorkflowMeta.optional(),
-    /** Parent doctype for inheritance */
-    inherits: z.string().optional(),
-})
-    .meta({
-    title: 'DoctypeMeta',
-    description: 'Doctype metadata - complete definition of a doctype',
-});

package/dist/field.js

@@ -1,110 +0,0 @@
-import { z } from 'zod';
-import { StonecropFieldType } from './fieldtype';
-/**
- * Field options - flexible bag for type-specific configuration.
- *
- * Usage by fieldtype:
- * - Link/Doctype: target doctype slug as string ("customer", "sales-order-item")
- * - Select: array of choices (["Draft", "Submitted", "Cancelled"])
- * - Decimal: config object (\{ precision: 10, scale: 2 \})
- * - Code: config object (\{ language: "python" \})
- *
- * @public
- */
-export const FieldOptions = z
-    .union([
-    z.string(), // Link/Doctype target: "customer"
-    z.array(z.string()), // Select choices: ["A", "B", "C"]
-    z.record(z.string(), z.unknown()), // Config: \{ precision: 10, scale: 2 \}
-])
-    .meta({
-    title: 'FieldOptions',
-    description: 'Field options - flexible bag for type-specific configuration',
-});
-/**
- * Validation configuration for form fields
- * @public
- */
-export const FieldValidation = z
-    .looseObject({
-    /** Error message to display when validation fails */
-    errorMessage: z.string(),
-})
-    .meta({
-    title: 'FieldValidation',
-    description: 'Validation configuration for form fields',
-});
-/**
- * Unified field metadata - the single source of truth for field definitions.
- * Works for both forms (AForm) and tables (ATable).
- *
- * Core principle: "Text" is "Text" regardless of rendering context.
- *
- * @public
- */
-export const FieldMeta = z
-    .object({
-    // === CORE (required) ===
-    /** Unique identifier for the field within its doctype */
-    fieldname: z.string().min(1),
-    /** Semantic field type - determines behavior and default component */
-    fieldtype: StonecropFieldType,
-    // === COMPONENT (optional - derived from fieldtype when not specified) ===
-    /** Vue component to render this field. If not specified, derived from TYPE_MAP */
-    component: z.string().optional(),
-    // === DISPLAY ===
-    /** Human-readable label for the field */
-    label: z.string().optional(),
-    /** Width of the field (CSS value, e.g., "40ch", "200px") */
-    width: z.string().optional(),
-    /** Text alignment within the field */
-    align: z.enum(['left', 'center', 'right', 'start', 'end']).optional(),
-    // === BEHAVIOR ===
-    /** Whether the field is required */
-    required: z.boolean().optional(),
-    /** Whether the field is read-only */
-    readOnly: z.boolean().optional(),
-    /** Whether the field is editable (for table cells) */
-    edit: z.boolean().optional(),
-    /** Whether the field is hidden from the UI */
-    hidden: z.boolean().optional(),
-    // === VALUE ===
-    /** Current value of the field */
-    value: z.unknown().optional(),
-    /** Default value for new records */
-    default: z.unknown().optional(),
-    // === TYPE-SPECIFIC ===
-    /**
-     * Type-specific options:
-     * - Link: target doctype slug ("customer")
-     * - Doctype: child doctype slug ("sales-order-item")
-     * - Select: choices array (["Draft", "Submitted"])
-     * - Decimal: \{ precision, scale \}
-     * - Code: \{ language \}
-     */
-    options: FieldOptions.optional(),
-    /**
-     * Cardinality for Doctype fields:
-     * - 'one': exactly 1 (default)
-     * - 'atMostOne': 0 or 1
-     * - 'noneOrMany': 0 or more
-     * - 'atLeastOne': 1 or more
-     */
-    cardinality: z.enum(['one', 'atMostOne', 'noneOrMany', 'atLeastOne']).optional(),
-    /**
-     * Input mask pattern. Accepts either a plain mask string or a stringified
-     * arrow function that receives `locale` and returns a mask string.
-     *
-     * Plain pattern: `"##/##/####"`
-     *
-     * Function pattern: `"(locale) => locale === 'en-US' ? '(###) ###-####' : '####-######'"`
-     */
-    mask: z.string().optional(),
-    // === VALIDATION ===
-    /** Validation configuration */
-    validation: FieldValidation.optional(),
-})
-    .meta({
-    title: 'FieldMeta',
-    description: 'Unified field metadata - the single source of truth for field definitions, works for both forms (AForm) and tables (ATable)',
-});

package/dist/fieldtype.js

@@ -1,97 +0,0 @@
-import { z } from 'zod';
-/**
- * The complete list of field types built into Stonecrop.
- * User apps can use any string as a fieldtype; this const is the exhaustive set of types
- * that Stonecrop provides default components for.
- * @public
- */
-export const BUILTIN_FIELD_TYPES = [
-    'Data', // Short text, varchar
-    'Text', // Long text
-    'Int', // Integer
-    'Float', // Floating point (IEEE 754)
-    'Decimal', // Arbitrary precision decimal
-    'Check', // Boolean/checkbox
-    'Date', // Date only
-    'Time', // Time only
-    'Datetime', // Date and time
-    'Duration', // Time interval
-    'DateRange', // Date range
-    'JSON', // JSON data
-    'Code', // Code/source (with syntax highlighting)
-    'Link', // Reference to another doctype
-    'Attach', // File attachment
-    'Currency', // Currency value
-    'Quantity', // Quantity with unit
-    'Select', // Dropdown selection
-];
-/**
- * Stonecrop field type — any non-empty string is valid; Stonecrop provides default components
- * for the builtin types listed in {@link BUILTIN_FIELD_TYPES}. Custom fieldtypes are supported
- * by supplying an explicit `component` on the field definition.
- * @public
- */
-export const StonecropFieldType = z.string().min(1).meta({
-    title: 'StonecropFieldType',
-    description: 'Semantic field types for Stonecrop doctypes, consistent across forms and tables',
-});
-/**
- * Returns `true` when `fieldtype` is one of the builtin types Stonecrop ships with.
- * @public
- */
-export function isBuiltinFieldType(fieldtype) {
-    return BUILTIN_FIELD_TYPES.includes(fieldtype);
-}
-/**
- * Mapping from builtin fieldtypes to their default Vue component.
- * Components can be overridden in the field definition.
- * @public
- */
-export const TYPE_MAP = {
-    // Text
-    Data: { component: 'ATextInput', fieldtype: 'Data' },
-    Text: { component: 'ATextInput', fieldtype: 'Text' },
-    // Numeric
-    Int: { component: 'ANumericInput', fieldtype: 'Int' },
-    Float: { component: 'ANumericInput', fieldtype: 'Float' },
-    Decimal: { component: 'ADecimalInput', fieldtype: 'Decimal' },
-    // Boolean
-    Check: { component: 'ACheckbox', fieldtype: 'Check' },
-    // Date/Time
-    Date: { component: 'ADate', fieldtype: 'Date' },
-    Time: { component: 'ATimeInput', fieldtype: 'Time' },
-    Datetime: { component: 'ADatetimePicker', fieldtype: 'Datetime' },
-    Duration: { component: 'ADurationInput', fieldtype: 'Duration' },
-    DateRange: { component: 'ADateRangePicker', fieldtype: 'DateRange' },
-    // Structured
-    JSON: { component: 'ACodeEditor', fieldtype: 'JSON' },
-    Code: { component: 'ACodeEditor', fieldtype: 'Code' },
-    // Relational
-    Link: { component: 'ALink', fieldtype: 'Link' },
-    // Files
-    Attach: { component: 'AFileAttach', fieldtype: 'Attach' },
-    // Specialized
-    Currency: { component: 'ACurrencyInput', fieldtype: 'Currency' },
-    Quantity: { component: 'AQuantityInput', fieldtype: 'Quantity' },
-    Select: { component: 'ADropdown', fieldtype: 'Select' },
-};
-/**
- * Get the default component for a builtin field type.
- * For an open-string fieldtype that may be custom, use {@link resolveComponent} instead.
- * @param fieldtype - A builtin field type
- * @returns The default component name
- * @public
- */
-export function getDefaultComponent(fieldtype) {
-    return TYPE_MAP[fieldtype]?.component ?? 'ATextInput';
-}
-/**
- * Resolve the component name for any fieldtype string, falling back to `'ATextInput'`
- * for unknown custom types.
- * @param fieldtype - Any fieldtype string (builtin or custom)
- * @returns The component name to use for rendering
- * @public
- */
-export function resolveComponent(fieldtype) {
-    return isBuiltinFieldType(fieldtype) ? getDefaultComponent(fieldtype) : 'ATextInput';
-}