@stonecrop/stonecrop 0.7.9 → 0.8.0

package/dist/stonecrop.d.ts

@@ -1280,6 +1280,50 @@ export declare class DoctypeMeta {
     get slug(): string;
 }
 
+/**
+ * Schema structure for defining nested doctype fields inside AForm
+ *
+ * @remarks
+ * When a field has `fieldtype: 'Doctype'`, the `options` property contains the slug
+ * of the referenced doctype. The `schema` property is populated by the framework's
+ * `registry.resolveSchema()` method with the resolved child schema fields.
+ *
+ * Before resolution: `{ fieldname: 'address', fieldtype: 'Doctype', options: 'address' }`
+ * After resolution: `{ fieldname: 'address', fieldtype: 'Doctype', options: 'address', schema: [...resolved fields...] }`
+ *
+ * Users can also manually provide the `schema` property without using the framework registry.
+ *
+ * @public
+ */
+export declare type DoctypeSchema = BaseSchema & {
+    /**
+     * The field type - must be 'Doctype' for nested doctype fields
+     * @public
+     */
+    fieldtype: 'Doctype';
+    /**
+     * The slug of the referenced doctype in the registry
+     * @public
+     */
+    options: string;
+    /**
+     * The label to display above the nested form section
+     * @public
+     */
+    label?: string;
+    /**
+     * The resolved child schema fields, populated by `registry.resolveSchema()`
+     * or provided manually for standalone usage
+     * @public
+     */
+    schema?: SchemaTypes[];
+    /**
+     * Indicate whether the nested form is read-only
+     * @public
+     */
+    readOnly?: boolean;
+};
+
 /**
  * Supported action types for field triggers
  * @public
@@ -1918,6 +1962,13 @@ export declare type HSTStonecropReturn = BaseStonecropReturn & {
     handleHSTChange: (changeData: HSTChangeData) => void;
     hstStore: Ref<HSTNode | undefined>;
     formData: Ref<Record<string, any>>;
+    resolvedSchema: Ref<SchemaTypes[]>;
+    loadNestedData: (parentPath: string, childDoctype: DoctypeMeta, recordId?: string) => Record<string, any>;
+    saveRecursive: (doctype: DoctypeMeta, recordId: string) => Promise<Record<string, any>>;
+    createNestedContext: (basePath: string, childDoctype: DoctypeMeta) => {
+        provideHSTPath: (fieldname: string) => string;
+        handleHSTChange: (changeData: HSTChangeData) => void;
+    };
 };
 
 /**
@@ -2142,6 +2193,64 @@ export declare class Registry {
      * @see {@link DoctypeMeta}
      */
     addDoctype(doctype: DoctypeMeta): void;
+    /**
+     * Resolve nested Doctype and Table fields in a schema by embedding child schemas inline.
+     *
+     * @remarks
+     * Walks the schema array and for each field with `fieldtype: 'Doctype'` and a string
+     * `options` value, looks up the referenced doctype in the registry and embeds its schema
+     * as the field's `schema` property. Recurses for deeply nested doctypes.
+     *
+     * For fields with `fieldtype: 'Table'`, looks up the referenced child doctype and
+     * auto-derives `columns` from its schema fields (unless columns are already provided).
+     * Also sets sensible defaults for `component` (`'ATable'`) and `config` (`{ view: 'list' }`).
+     * Row data is expected to come from the parent form's data model at `data[fieldname]`.
+     *
+     * Returns a new array — does not mutate the original schema.
+     *
+     * @param schema - The schema array to resolve
+     * @returns A new schema array with nested Doctype fields resolved
+     *
+     * @example
+     * ```ts
+     * registry.addDoctype(addressDoctype)
+     * registry.addDoctype(customerDoctype)
+     *
+     * // Before: customer schema has { fieldname: 'address', fieldtype: 'Doctype', options: 'address' }
+     * const resolved = registry.resolveSchema(customerSchema)
+     * // After: address field now has schema: [...address fields...]
+     * ```
+     *
+     * @public
+     */
+    resolveSchema(schema: SchemaTypes[], visited?: Set<string>): SchemaTypes[];
+    /**
+     * Initialize a new record with default values based on a schema.
+     *
+     * @remarks
+     * Creates a plain object with keys from the schema's fieldnames and default values
+     * derived from each field's `fieldtype`:
+     * - Data, Text → `''`
+     * - Check → `false`
+     * - Int, Float, Decimal, Currency, Quantity → `0`
+     * - Table → `[]`
+     * - JSON, Doctype → `{}`
+     * - All others → `null`
+     *
+     * For Doctype fields with a resolved `schema` array, recursively initializes the nested record.
+     *
+     * @param schema - The schema array to derive defaults from
+     * @returns A plain object with default values for each field
+     *
+     * @example
+     * ```ts
+     * const defaults = registry.initializeRecord(addressSchema)
+     * // { street: '', city: '', state: '', zip_code: '' }
+     * ```
+     *
+     * @public
+     */
+    initializeRecord(schema: SchemaTypes[]): Record<string, any>;
 }
 
 /**
@@ -2168,7 +2277,7 @@ export declare type Schema = {
  * Superset of all schema types for AForm
  * @public
  */
-export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;
+export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema | DoctypeSchema | TableDoctypeSchema;
 
 /**
  * Schema validator class
@@ -2821,6 +2930,59 @@ export declare interface TableDisplay {
     rowModified?: boolean;
 }
 
+/**
+ * Schema structure for defining 1:many child table fields inside AForm
+ *
+ * @remarks
+ * When a field has `fieldtype: 'Table'`, the `options` property contains the slug
+ * of the child doctype whose records appear as table rows.
+ *
+ * `Registry.resolveSchema()` auto-derives `columns` from the child doctype's schema
+ * fields and sets sensible defaults for `component` (`'ATable'`) and `config` (`{ view: 'list' }`).
+ *
+ * Users can override any auto-derived property by specifying it explicitly on the schema field.
+ * Row data comes from the parent form's data model at `data[fieldname]` (an array).
+ *
+ * @public
+ */
+export declare type TableDoctypeSchema = BaseSchema & {
+    /**
+     * The field type — must be 'Table' for 1:many child table fields
+     * @public
+     */
+    fieldtype: 'Table';
+    /**
+     * The slug of the child doctype in the registry
+     * @public
+     */
+    options: string;
+    /**
+     * The label to display above the table section
+     * @public
+     */
+    label?: string;
+    /**
+     * Table columns — auto-derived from child doctype schema if not provided
+     * @public
+     */
+    columns?: TableColumn[];
+    /**
+     * Table configuration — defaults to `{ view: 'list' }` if not provided
+     * @public
+     */
+    config?: TableConfig;
+    /**
+     * Table rows — populated from the parent form's data model at `data[fieldname]`
+     * @public
+     */
+    rows?: TableRow[];
+    /**
+     * Indicate whether the table is read-only
+     * @public
+     */
+    readOnly?: boolean;
+};
+
 /**
  * Table modal definition.
  * @public