@angular/forms 21.0.0-rc.2 → 21.0.0-rc.3

package/types/forms.d.ts

@@ -1,5 +1,5 @@
 /**
- * @license Angular v21.0.0-rc.2
+ * @license Angular v21.0.0-rc.3
  * (c) 2010-2025 Google LLC. https://angular.dev/
  * License: MIT
  */
@@ -4020,12 +4020,12 @@ declare class FormGroupName extends AbstractFormGroupDirective implements OnInit
  *
  * Syncs a nested `FormArray` to a DOM element.
  *
- * This directive is designed to be used with a parent `FormGroupDirective`/`FormGroupArray` (selector:
+ * This directive is designed to be used with a parent `FormGroupDirective`/`FormArrayDirective` (selector:
  * `[formGroup]`/`[formArray]`).
  *
  * It accepts the string name of the nested `FormArray` you want to link, and
  * will look for a `FormArray` registered with that name in the parent
- * `FormGroup`/`FormArray` instance you passed into `FormGroupDirective`/`FormGroupArray`.
+ * `FormGroup`/`FormArray` instance you passed into `FormGroupDirective`/`FormArrayDirective`.
  *
  * @see [Reactive Forms Guide](guide/forms/reactive-forms)
  * @see {@link AbstractControl}

package/types/signals-compat.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @license Angular v21.0.0-rc.3
+ * (c) 2010-2025 Google LLC. https://angular.dev/
+ * License: MIT
+ */
+
+import { WritableSignal } from '@angular/core';
+import { FormOptions, FieldTree, SchemaOrSchemaFn, ValidationError } from './_structure-chunk.js';
+import { AbstractControl } from '@angular/forms';
+import '@standard-schema/spec';
+
+/**
+ * Options that may be specified when creating a compat form.
+ *
+ * @category interop
+ * @experimental 21.0.0
+ */
+type CompatFormOptions = Omit<FormOptions, 'adapter'>;
+/**
+ * Creates a compatibility form wrapped around the given model data.
+ *
+ * `compatForm` is a version of the `form` function that is designed for backwards
+ * compatibility with Reactive forms by accepting Reactive controls as a part of the data.
+ *
+ * @example
+ * ```
+ * const lastName = new FormControl('lastName');
+ *
+ * const nameModel = signal({
+ *    first: '',
+ *    last: lastName
+ * });
+ *
+ * const nameForm = compatForm(nameModel, (name) => {
+ *   required(name.first);
+ * });
+ *
+ * nameForm.last().value(); // lastName, not FormControl
+ *
+ * @param model A writable signal that contains the model data for the form. The resulting field
+ * structure will match the shape of the model and any changes to the form data will be written to
+ * the model.
+
+ * @category interop
+ * @experimental 21.0.0
+ */
+declare function compatForm<TModel>(model: WritableSignal<TModel>): FieldTree<TModel>;
+/**
+ * Creates a compatibility form wrapped around the given model data.
+ *
+ * `compatForm` is a version of the `form` function that is designed for backwards
+ * compatibility with Reactive forms by accepting Reactive controls as a part of the data.
+ *
+ * @example
+ * ```
+ * const lastName = new FormControl('lastName');
+ *
+ * const nameModel = signal({
+ *    first: '',
+ *    last: lastName
+ * });
+ *
+ * const nameForm = compatForm(nameModel, (name) => {
+ *   required(name.first);
+ * });
+ *
+ * nameForm.last().value(); // lastName, not FormControl
+ *
+ * @param model A writable signal that contains the model data for the form. The resulting field
+ * structure will match the shape of the model and any changes to the form data will be written to
+ * the model.
+ * @param schemaOrOptions The second argument can be either
+ *   1. A schema or a function used to specify logic for the form (e.g. validation, disabled fields, etc.).
+ *      When passing a schema, the form options can be passed as a third argument if needed.
+ *   2. The form options (excluding adapter, since it's provided).
+ *
+ * @category interop
+ * @experimental 21.0.0
+ */
+declare function compatForm<TModel>(model: WritableSignal<TModel>, schemaOrOptions: SchemaOrSchemaFn<TModel> | CompatFormOptions): FieldTree<TModel>;
+/**
+ * Creates a compatibility form wrapped around the given model data.
+ *
+ * `compatForm` is a version of the `form` function that is designed for backwards
+ * compatibility with Reactive forms by accepting Reactive controls as a part of the data.
+ *
+ * @example
+ * ```
+ * const lastName = new FormControl('lastName');
+ *
+ * const nameModel = signal({
+ *    first: '',
+ *    last: lastName
+ * });
+ *
+ * const nameForm = compatForm(nameModel, (name) => {
+ *   required(name.first);
+ * });
+ *
+ * nameForm.last().value(); // lastName, not FormControl
+ *
+ * @param model A writable signal that contains the model data for the form. The resulting field
+ * structure will match the shape of the model and any changes to the form data will be written to
+ * the model.
+ * @param schemaOrOptions A schema or a function used to specify logic for the form (e.g. validation, disabled fields, etc.).
+ *      When passing a schema, the form options can be passed as a third argument if needed.
+ * @param options The form options (excluding adapter, since it's provided).
+ *
+ * @category interop
+ * @experimental 21.0.0
+ */
+declare function compatForm<TModel>(model: WritableSignal<TModel>, schema: SchemaOrSchemaFn<TModel>, options: CompatFormOptions): FieldTree<TModel>;
+
+/**
+ * An error used for compat errors.
+ *
+ * @experimental 21.0.0
+ * @category interop
+ */
+declare class CompatValidationError<T = unknown> implements ValidationError {
+    readonly kind: string;
+    readonly control: AbstractControl;
+    readonly field: FieldTree<unknown>;
+    readonly context: T;
+    readonly message?: string;
+    constructor({ context, kind, control }: {
+        context: T;
+        kind: string;
+        control: AbstractControl;
+    });
+}
+
+export { CompatValidationError, compatForm };
+export type { CompatFormOptions };