@stonecrop/aform 0.13.8 → 0.13.9

package/README.md

@@ -1,6 +1,6 @@
 # @stonecrop/aform
 
-Schema-driven form components for the Stonecrop framework. Renders a `SchemaTypes[]` array into a form, wiring field values to a `data` object via `v-model:data`.
+Schema-driven form components for the Stonecrop framework. Renders a `ResolvedField[]` array (produced by `registry.resolveSchema()`) into a form, wiring field values to a `data` object via `v-model:data`.
 
 ## Components
 

package/dist/aform.d.ts

@@ -15,10 +15,11 @@ import ANumericInput from './components/form/ANumericInput.vue';
 import type { App } from 'vue';
 import ATextInput from './components/form/ATextInput.vue';
 import type { ColumnSchema } from '@stonecrop/schema';
+import type { FieldValidation } from '@stonecrop/schema';
+import { InteractionMode } from '@stonecrop/schema';
 import Login from './components/utilities/Login.vue';
-import type { TableColumn } from '@stonecrop/atable';
-import type { TableConfig } from '@stonecrop/atable';
-import type { TableRow } from '@stonecrop/atable';
+import type { TableViewConfig } from '@stonecrop/schema';
+import type { ValueField } from '@stonecrop/schema';
 
 export { ACheckbox }
 
@@ -64,6 +65,7 @@ export declare interface AFormLinkValue {
     id: string | number;
     /** Display text shown in the input. Falls back to `String(id)` if omitted. */
     displayText?: string;
+    /** Additional properties passed through to the underlying input component */
     [extra: string]: any;
 }
 
@@ -71,39 +73,6 @@ export { ANumericInput }
 
 export { ATextInput }
 
-/**
- * Basic field structure for AForm schemas
- * @public
- */
-export declare type BaseSchema = {
-    /**
-     * The fieldname for the schema field
-     * @public
-     */
-    fieldname: string;
-    /**
-     * The component to render
-     *
-     * @remarks
-     * This must be a string that represents the component to render. The registration of the component
-     * should be done in the main application.
-     *
-     * @public
-     */
-    component?: string;
-    /**
-     * Per-field rendering mode override; takes precedence over the AForm-level `mode` prop
-     * @public
-     */
-    mode?: FormMode;
-    /**
-     * Hide the field from the form UI while keeping it in the data model.
-     * Consumed by AForm — not passed down to field components.
-     * @public
-     */
-    hidden?: boolean;
-};
-
 /**
  * Defined props for AForm components
  * @public
@@ -113,7 +82,7 @@ export declare type ComponentProps = {
      * The schema object to pass to the component
      * @public
      */
-    schema?: SchemaTypes;
+    schema?: ResolvedField;
     /**
      * The label to display in the component
      * @public
@@ -137,7 +106,7 @@ export declare type ComponentProps = {
      * The rendering mode for the component
      * @public
      */
-    mode?: FormMode;
+    mode?: InteractionMode;
     /**
      * Set a unique identifier for elements inside the component
      * @public
@@ -174,127 +143,116 @@ export declare type ComponentProps = {
 export declare function deserializeFunction<T extends (...args: any[]) => any>(source: string): T;
 
 /**
- * Schema structure for defining fieldsets inside AForm
+ * Install all AForm components
+ * @param app - Vue app instance
  * @public
  */
-export declare type FieldsetSchema = BaseSchema & {
-    /**
-     * The label to display in the fieldset
-     * @public
-     */
-    label?: string;
-    /**
-     * The schemas to be rendered inside the fieldset
-     * @public
-     */
-    schema?: SchemaTypes[];
-    /**
-     * Indicate whether the fieldset is collapsible
-     * @public
-     */
-    collapsible?: boolean;
-};
+export declare function install(app: App): void;
+
+export { InteractionMode }
+
+export { Login }
 
 /**
- * The rendering mode for AForm components
+ * The discriminated union of all resolved field types — what AForm consumes
+ * after `resolveSchema()` has transformed the authoring `DoctypeField[]`.
+ * Narrowed by `kind`: `'field'` | `'link'` | `'table'` | `'fieldset'`.
  * @public
  */
-export declare type FormMode = 'edit' | 'read' | 'display';
+export declare type ResolvedField = ResolvedScalar | ResolvedLink | ResolvedTable | ResolvedFieldset;
 
 /**
- * Schema structure for defining forms inside AForm
+ * A resolved fieldset — groups child fields inside an AFieldset component.
  * @public
  */
-export declare type FormSchema = BaseSchema & {
-    /**
-     * Align the field in the form
-     * @beta
-     */
-    align?: CanvasTextAlign;
-    /**
-     * Indicate whether the field is editable
-     * @beta
-     */
-    edit?: boolean;
-    /**
-     * The field type for the schema field
-     * @public
-     */
-    fieldtype?: string;
-    /**
-     * The label to display in the form
-     * @public
-     */
+export declare interface ResolvedFieldset {
+    /** Discriminator */
+    kind: 'fieldset';
+    /** Field identifier */
+    fieldname: string;
+    /** Component to render; defaults to `'AFieldset'` */
+    component?: string;
+    /** Human-readable label for the legend */
     label?: string;
-    /**
-     * The unique identifier for the field
-     * @beta
-     */
-    name?: string;
-    /**
-     * CSS width for the field's flex item in the AForm grid.
-     * Applied as `flex-basis` and `width` on the rendered component element.
-     * Use `"100%"` to make the field span the full form row.
-     */
-    width?: string;
-    /**
-     * The mask to apply to the field. Accepts either a plain mask string
-     * (e.g. `"##/##/####"`) or a stringified arrow function that receives `locale`
-     * and returns a mask string
-     * (e.g. `"(locale) => locale === 'en-US' ? '(###) ###-####' : '####-######'"`).
-     * @public
-     */
-    mask?: string;
-};
+    /** Whether the fieldset can be collapsed */
+    collapsible?: boolean;
+    /** Interaction mode for all children */
+    mode?: InteractionMode;
+    /** Resolved child fields */
+    schema: ResolvedField[];
+}
 
 /**
- * Install all AForm components
- * @param app - Vue app instance
+ * A resolved Link field with cardinality `one` or `atMostOne` — embedded as a nested form.
  * @public
  */
-export declare function install(app: App): void;
-
-export { Login }
+export declare interface ResolvedLink {
+    /** Discriminator */
+    kind: 'link';
+    /** Field identifier */
+    fieldname: string;
+    /** Component to render; defaults to `'AForm'` */
+    component: string;
+    /** Human-readable label */
+    label?: string;
+    /** Interaction mode */
+    mode?: InteractionMode;
+    /** Resolved child fields */
+    schema: ResolvedField[];
+    /** Preserved from the original ValueField */
+    required?: boolean;
+    /** Preserved from the original ValueField */
+    readOnly?: boolean;
+    /** Preserved from the original ValueField */
+    hidden?: boolean;
+    /** Preserved from the original ValueField */
+    default?: unknown;
+    /** Preserved from the original ValueField */
+    validation?: FieldValidation;
+}
 
 /**
- * Superset of all schema types for AForm
+ * A resolved scalar field. Derived from ValueField with `cardinality` omitted
+ * (consumed by resolveSchema) and an optional `doctype` added for unresolved Link fields.
  * @public
  */
-export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;
+export declare type ResolvedScalar = Omit<ValueField, 'cardinality'> & {
+    /** Doctype slug for unresolved Link fields — added by resolveSchema when AFormLink is available */
+    doctype?: string;
+};
 
 /**
- * Schema structure for defining tables inside AForm.
- *
- * Two mutually exclusive forms:
- * - **Columns-based** (no `kind`): caller provides `columns` directly
- * - **Schema-delegated** (`kind: 'table'`): caller provides `schema`; ATable runs
- *   `schemaToColumns` to derive columns at render time
- *
+ * A resolved table — either from a Link with `noneOrMany`/`atLeastOne` cardinality,
+ * or from an inline TableField. ATable receives columns via `:schema` (ColumnSchema[])
+ * and row data via `:rows` from formData at render time.
  * @public
  */
-export declare type TableSchema = BaseSchema & {
-    /**
-     * The configuration for the table
-     * @public
-     */
-    config?: TableConfig;
-    /**
-     * The rows to display in the table
-     * @public
-     */
-    rows?: TableRow[];
-} & ({
-    /** Explicit column definitions; `schema` and `kind` must not be set */
-    columns?: TableColumn[];
-    kind?: never;
-    schema?: never;
-} | {
-    /** Marks this entry as schema-delegated; ATable derives columns from `schema` */
+export declare interface ResolvedTable {
+    /** Discriminator */
     kind: 'table';
-    /** Child schema passed to ATable's `schema` prop */
+    /** Field identifier */
+    fieldname: string;
+    /** Component to render; defaults to `'ATable'` */
+    component: string;
+    /** Human-readable label */
+    label?: string;
+    /** Interaction mode for all cells */
+    mode?: InteractionMode;
+    /** Column definitions — passed to ATable's `:schema` prop */
     schema: ColumnSchema[];
-    columns?: never;
-});
+    /** View configuration — always present; defaults to `{ view: 'list' }` */
+    config: TableViewConfig;
+    /** Preserved from the original ValueField or TableField */
+    required?: boolean;
+    /** Preserved from the original ValueField or TableField */
+    readOnly?: boolean;
+    /** Preserved from the original ValueField or TableField */
+    hidden?: boolean;
+    /** Preserved from the original ValueField or TableField */
+    default?: unknown;
+    /** Preserved from the original ValueField or TableField */
+    validation?: FieldValidation;
+}
 
 
 export * from "@stonecrop/atable/types";