@stonecrop/aform 0.10.11 → 0.10.13

package/dist/aform.d.ts

@@ -114,12 +114,72 @@ export declare type ComponentProps = {
 };
 
 /**
- * Schema structure for defining nested doctype fields inside AForm
+ * Schema structure for a 1:many child table field 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.
+ * When a field has `fieldtype: 'Doctype'` with `cardinality: 'many'`, it represents
+ * a 1:many child 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 DoctypeManySchema = BaseSchema & {
+    /**
+     * The field type - must be 'Doctype' for nested doctype fields
+     * @public
+     */
+    fieldtype: 'Doctype';
+    /**
+     * The slug of the child doctype in the registry
+     * @public
+     */
+    options: string;
+    /**
+     * The label to display above the table section
+     * @public
+     */
+    label?: string;
+    /**
+     * The cardinality of the relationship — `'many'` means 1:many child table
+     * @public
+     */
+    cardinality: 'many';
+    /**
+     * 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[];
+    /**
+     * The component to render — defaults to `'ATable'` when resolved
+     * @public
+     */
+    component?: string;
+};
+
+/**
+ * Schema structure for a 1:1 nested doctype field inside AForm
+ *
+ * @remarks
+ * When a field has `fieldtype: 'Doctype'` without `cardinality: 'many'`, it represents
+ * a 1:1 nested form. 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...] }`
@@ -128,7 +188,7 @@ export declare type ComponentProps = {
  *
  * @public
  */
-export declare type DoctypeSchema = BaseSchema & {
+export declare type DoctypeOneSchema = BaseSchema & {
     /**
      * The field type - must be 'Doctype' for nested doctype fields
      * @public
@@ -144,6 +204,11 @@ export declare type DoctypeSchema = BaseSchema & {
      * @public
      */
     label?: string;
+    /**
+     * The cardinality of the relationship — `'one'` or omitted means 1:1 nested form
+     * @public
+     */
+    cardinality?: 'one';
     /**
      * The resolved child schema fields, populated by `registry.resolveSchema()`
      * or provided manually for standalone usage
@@ -152,6 +217,17 @@ export declare type DoctypeSchema = BaseSchema & {
     schema?: SchemaTypes[];
 };
 
+/**
+ * Discriminated union for Doctype fields — either 1:1 nested form or 1:many child table
+ *
+ * @remarks
+ * Use `isDoctypeMany()` type guard to narrow to `DoctypeManySchema`.
+ * When `cardinality` is `'many'` or omitted, the field is a 1:1 nested form.
+ *
+ * @public
+ */
+export declare type DoctypeSchema = DoctypeOneSchema | DoctypeManySchema;
+
 /**
  * Schema structure for defining fieldsets inside AForm
  * @public
@@ -232,61 +308,22 @@ export declare type FormSchema = BaseSchema & {
  */
 export declare function install(app: App): void;
 
-export { Login }
-
 /**
- * Superset of all schema types for AForm
+ * Type guard that checks whether a Doctype schema field has `cardinality: 'many'`
+ *
+ * @param field - A DoctypeSchema field to check
+ * @returns `true` if the field has `cardinality: 'many'`
  * @public
  */
-export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema | DoctypeSchema | TableDoctypeSchema;
+export declare function isDoctypeMany(field: DoctypeSchema): field is DoctypeManySchema;
+
+export { Login }
 
 /**
- * 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).
- *
+ * Superset of all schema types for AForm
  * @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[];
-};
+export declare type SchemaTypes = FormSchema | TableSchema | FieldsetSchema | DoctypeSchema;
 
 /**
  * Schema structure for defining tables inside AForm

package/dist/aform.js

@@ -3836,7 +3836,10 @@ const ms = { class: "aform_form-element" }, hs = { class: "aform_display-value"
   }
 }), Ps = /* @__PURE__ */ Te(Hs, [["__scopeId", "data-v-d9ffd0a7"]]);
 function Os(e) {
-  e.use(Tl), e.component("ACheckbox", Ol), e.component("ACombobox", Bl), e.component("ADate", Gl), e.component("ADropdown", fa), e.component("ADatePicker", Fa), e.component("AFieldset", Ya), e.component("AFileAttach", ns), e.component("AForm", In), e.component("ANumericInput", us), e.component("ATextInput", xs);
+  return e.cardinality === "many";
+}
+function Bs(e) {
+  e.use(Tl), e.component("ACheckbox", Ol), e.component("AComboBox", Bl), e.component("ADate", Gl), e.component("ADropdown", fa), e.component("ADatePicker", Fa), e.component("AFieldset", Ya), e.component("AFileAttach", ns), e.component("AForm", In), e.component("ANumericInput", us), e.component("ATextInput", xs);
 }
 export {
   Ol as ACheckbox,
@@ -3850,6 +3853,7 @@ export {
   us as ANumericInput,
   xs as ATextInput,
   Ps as Login,
-  Os as install
+  Bs as install,
+  Os as isDoctypeMany
 };
 //# sourceMappingURL=aform.js.map