@mk-kit/ui 0.41.0 → 0.43.0

package/types/mk-kit-ui-dynamic-form.d.ts

@@ -1,4 +1,5 @@
 import { ValidatorFn, AbstractControl, FormGroup, FormControl, FormArray } from '@angular/forms';
+import { Schema } from '@angular/forms/signals';
 import * as _mk_kit_ui_core from '@mk-kit/ui/core';
 import * as _angular_core from '@angular/core';
 import { TemplateRef } from '@angular/core';
@@ -154,6 +155,48 @@ declare function mkDynamicFlatten(fields: readonly MkDynamicField[], prefix?: st
 /** Column span a field takes in a grid of `columns`. */
 declare function mkDynamicSpan(field: MkDynamicField, columns: number): number;
 
+/**
+ * Converts an `mk-dynamic-form` schema into a Signal Forms `Schema`, so the
+ * same JSON definition can drive `form()` from `@angular/forms/signals`:
+ *
+ * ```ts
+ * const definition: MkDynamicSchema = { fields: [ … ] };
+ * const model = signal(mkDynamicDefaults(definition.fields));
+ * const f = form(model, mkDynamicFormToSignalSchema(definition));
+ * ```
+ *
+ * What maps:
+ * - `required` → `required()` (for `checkbox` / `switch` this means "must be
+ *   on", as Signal Forms treats `false` as empty — the `requiredTrue`
+ *   behaviour of the renderer);
+ * - `validators.min` / `max` / `minLength` / `maxLength` / `pattern` / `email`
+ *   (and `type: 'email'`) → the matching built-in rules, so the field's
+ *   `min()` / `maxLength()` / `pattern()` state is set as well;
+ * - `validators.custom` → `validate()` running each `ValidatorFn` against a
+ *   throw-away `FormControl` holding the field's value; the reactive error
+ *   keys become error `kind`s with their payload attached, so
+ *   `mk-form-field` renders them through the same i18n table;
+ * - `disabled: true` and `disabledWhen` → `disabled()`, `showWhen` →
+ *   `hidden()` — the condition is evaluated against the form value exactly as
+ *   the renderer does it (dotted paths, `and` / `or` / `not`, and inside an
+ *   array item the item's own value with the root under `$root` and the
+ *   position under `$index`);
+ * - `group` → the nested fields under the group's key, `array` → `applyEach`
+ *   over the items plus `minItems` / `maxItems` errors from `min` / `max`.
+ *
+ * What differs from the renderer: a hidden Signal Forms field is skipped for
+ * validation and touched / dirty state but **keeps its value in the model**
+ * (the model is your data — nothing is stripped), so remove hidden controls
+ * from the template with `@if (!f.company().hidden())` and drop the value
+ * yourself before saving if it must not be sent. Layout properties (`span`,
+ * `columns`), `options`, `props` and `section` entries have no schema
+ * equivalent and are ignored.
+ *
+ * @param definition The dynamic-form schema, or just its `fields`.
+ * @template TModel The model type the schema binds to (defaults to a loose record).
+ */
+declare function mkDynamicFormToSignalSchema<TModel extends object = Record<string, unknown>>(definition: MkDynamicSchema | readonly MkDynamicField[]): Schema<TModel>;
+
 /** Context handed to a custom field template. */
 interface MkDynamicFieldContext {
     $implicit: MkDynamicFieldBase;
@@ -301,5 +344,5 @@ declare class MkDynamicForm {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<MkDynamicForm, "mk-dynamic-form", never, { "schema": { "alias": "schema"; "required": true; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "labelPosition": { "alias": "labelPosition"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; "formSubmit": "formSubmit"; "invalidSubmit": "invalidSubmit"; }, ["defs"], ["*"], true, never>;
 }
 
-export { MkDynamicFieldDef, MkDynamicFields, MkDynamicForm, mkDynamicCondition, mkDynamicControl, mkDynamicDefaults, mkDynamicEmptyValue, mkDynamicFlatten, mkDynamicForm, mkDynamicGroup, mkDynamicSpan, mkDynamicValidators, mkIsArray, mkIsGroup, mkIsSection, mkIsValueField };
+export { MkDynamicFieldDef, MkDynamicFields, MkDynamicForm, mkDynamicCondition, mkDynamicControl, mkDynamicDefaults, mkDynamicEmptyValue, mkDynamicFlatten, mkDynamicForm, mkDynamicFormToSignalSchema, mkDynamicGroup, mkDynamicSpan, mkDynamicValidators, mkIsArray, mkIsGroup, mkIsSection, mkIsValueField };
 export type { MkDynamicArray, MkDynamicCondition, MkDynamicField, MkDynamicFieldBase, MkDynamicFieldContext, MkDynamicFieldType, MkDynamicGroup, MkDynamicGroup as MkDynamicGroupField, MkDynamicOption, MkDynamicSchema, MkDynamicSection, MkDynamicValidators };