@stonecrop/aform 0.7.9 → 0.8.0

package/dist/aform.d.ts

@@ -1138,6 +1138,50 @@ updateGanttBar: (event: GanttDragEvent) => void;
 updateRows: (newRows: TableRow[]) => void;
 }, "clearFilter" | "closeModal" | "createConnection" | "deleteConnection" | "getCellData" | "getCellDisplayValue" | "getConnectionsForBar" | "getFormattedValue" | "getHandlesForBar" | "getHeaderCellStyle" | "getIndent" | "getRowExpandSymbol" | "isRowGantt" | "isRowVisible" | "registerConnectionHandle" | "registerGanttBar" | "resizeColumn" | "setCellData" | "setCellText" | "setFilter" | "sortByColumn" | "toggleRowExpand" | "unregisterConnectionHandle" | "unregisterGanttBar" | "updateGanttBar" | "updateRows">>;
 
+/**
+ * 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;
+};
+
 /**
  * Schema structure for defining fieldsets inside AForm
  * @public
@@ -1367,7 +1411,7 @@ export { Login }
  * Superset of all schema types for AForm
  * @public
  */
-export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema;
+export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema | DoctypeSchema | TableDoctypeSchema;
 
 /**
  * Table column definition.
@@ -1603,6 +1647,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