refactor(forms): rename field to fieldTree in FieldContext and ValidationError

BREAKING CHANGE:

Author: mmalerba

goldens/public-api/forms/signals/compat/index.api.md

@@ -45,7 +45,7 @@ export class CompatValidationError<T = unknown> implements ValidationError {
     // (undocumented)
     readonly control: AbstractControl;
     // (undocumented)
-    readonly field: FieldTree<unknown>;
+    readonly fieldTree: FieldTree<unknown>;
     // (undocumented)
     readonly kind: string;
     // (undocumented)

goldens/public-api/forms/signals/index.api.md

@@ -99,7 +99,7 @@ export function customError<E extends Partial<ValidationError.WithField>>(obj?:
 export class CustomValidationError implements ValidationError {
     constructor(options?: ValidationErrorOptions);
     [key: PropertyKey]: unknown;
-    readonly field: FieldTree<unknown>;
+    readonly fieldTree: FieldTree<unknown>;
     readonly kind: string;
     readonly message?: string;
 }
@@ -115,7 +115,7 @@ export function disabled<TValue, TPathKind extends PathKind = PathKind.Root>(pat
 
 // @public
 export interface DisabledReason {
-    readonly field: FieldTree<unknown>;
+    readonly fieldTree: FieldTree<unknown>;
     readonly message?: string;
 }
 
@@ -469,7 +469,7 @@ export class RequiredValidationError extends _NgValidationError {
 
 // @public
 export interface RootFieldContext<TValue> {
-    readonly field: FieldTree<TValue>;
+    readonly fieldTree: FieldTree<TValue>;
     fieldTreeOf<PModel>(p: SchemaPathTree<PModel>): FieldTree<PModel>;
     readonly pathKeys: Signal<readonly string[]>;
     readonly state: FieldState<TValue>;
@@ -582,10 +582,10 @@ export interface ValidationError {
 // @public (undocumented)
 export namespace ValidationError {
     export interface WithField extends ValidationError {
-        readonly field: FieldTree<unknown>;
+        readonly fieldTree: FieldTree<unknown>;
     }
     export interface WithOptionalField extends ValidationError {
-        readonly field?: FieldTree<unknown>;
+        readonly fieldTree?: FieldTree<unknown>;
     }
     export interface WithoutField extends ValidationError {
         readonly field?: never;
@@ -603,17 +603,17 @@ export type Validator<TValue, TPathKind extends PathKind = PathKind.Root> = Logi
 
 // @public
 export type WithField<T> = T & {
-    field: FieldTree<unknown>;
+    fieldTree: FieldTree<unknown>;
 };
 
 // @public
-export type WithOptionalField<T> = Omit<T, 'field'> & {
-    field?: FieldTree<unknown>;
+export type WithOptionalField<T> = Omit<T, 'fieldTree'> & {
+    fieldTree?: FieldTree<unknown>;
 };
 
 // @public
 export type WithoutField<T> = T & {
-    field: never;
+    fieldTree: never;
 };
 
 // (No @packageDocumentation comment for this package)

packages/forms/signals/compat/src/api/compat_validation_error.ts

@@ -19,7 +19,7 @@ import {FieldTree} from '../../../src/api/types';
 export class CompatValidationError<T = unknown> implements ValidationError {
   readonly kind: string = 'compat';
   readonly control: AbstractControl;
-  readonly field!: FieldTree<unknown>;
+  readonly fieldTree!: FieldTree<unknown>;
   readonly context: T;
   readonly message?: string;
 

packages/forms/signals/src/api/rules/disabled.ts

@@ -38,8 +38,8 @@ export function disabled<TValue, TPathKind extends PathKind = PathKind.Root>(
       result = logic(ctx as FieldContext<TValue, TPathKind>);
     }
     if (typeof result === 'string') {
-      return {field: ctx.field, message: result};
+      return {fieldTree: ctx.fieldTree, message: result};
     }
-    return result ? {field: ctx.field} : undefined;
+    return result ? {fieldTree: ctx.fieldTree} : undefined;
   });
 }

packages/forms/signals/src/api/rules/validation/standard_schema.ts

@@ -113,15 +113,15 @@ export function validateStandardSchema<TSchema, TModel extends IgnoreUnknownProp
 /**
  * Converts a `StandardSchemaV1.Issue` to a `FormTreeError`.
  *
- * @param field The root field to which the issue's path is relative.
+ * @param fieldTree The root field to which the issue's path is relative.
  * @param issue The `StandardSchemaV1.Issue` to convert.
  * @returns A `ValidationError` representing the issue.
  */
 function standardIssueToFormTreeError(
-  field: FieldTree<unknown>,
+  fieldTree: FieldTree<unknown>,
   issue: StandardSchemaV1.Issue,
 ): StandardSchemaValidationError {
-  let target = field as FieldTree<Record<PropertyKey, unknown>>;
+  let target = fieldTree as FieldTree<Record<PropertyKey, unknown>>;
   for (const pathPart of issue.path ?? []) {
     const pathKey = typeof pathPart === 'object' ? pathPart.key : pathPart;
     target = target[pathKey] as FieldTree<Record<PropertyKey, unknown>>;

packages/forms/signals/src/api/rules/validation/validate.ts

@@ -38,7 +38,7 @@ export function validate<TValue, TPathKind extends PathKind = PathKind.Root>(
   const pathNode = FieldPathNode.unwrapFieldPath(path);
   pathNode.builder.addSyncErrorRule((ctx) => {
     return ensureCustomValidationResult(
-      addDefaultField(logic(ctx as FieldContext<TValue, TPathKind>), ctx.field),
+      addDefaultField(logic(ctx as FieldContext<TValue, TPathKind>), ctx.fieldTree),
     );
   });
 }

packages/forms/signals/src/api/rules/validation/validate_async.ts

@@ -143,10 +143,10 @@ export function validateAsync<TValue, TParams, TResult, TPathKind extends PathKi
           return undefined;
         }
         errors = opts.onSuccess(res.value()!, ctx as FieldContext<TValue, TPathKind>);
-        return addDefaultField(errors, ctx.field);
+        return addDefaultField(errors, ctx.fieldTree);
       case 'error':
         errors = opts.onError(res.error(), ctx as FieldContext<TValue, TPathKind>);
-        return addDefaultField(errors, ctx.field);
+        return addDefaultField(errors, ctx.fieldTree);
     }
   });
 }

packages/forms/signals/src/api/rules/validation/validate_tree.ts

@@ -31,6 +31,6 @@ export function validateTree<TValue, TPathKind extends PathKind = PathKind.Root>
 
   const pathNode = FieldPathNode.unwrapFieldPath(path);
   pathNode.builder.addSyncTreeErrorRule((ctx) =>
-    addDefaultField(logic(ctx as FieldContext<TValue, TPathKind>), ctx.field),
+    addDefaultField(logic(ctx as FieldContext<TValue, TPathKind>), ctx.fieldTree),
   );
 }

packages/forms/signals/src/api/rules/validation/validation_errors.ts

@@ -23,23 +23,23 @@ interface ValidationErrorOptions {
  *
  * @experimental 21.0.0
  */
-export type WithField<T> = T & {field: FieldTree<unknown>};
+export type WithField<T> = T & {fieldTree: FieldTree<unknown>};
 
 /**
  * A type that allows the given type `T` to optionally have a `field` property.
  * @template T The type to optionally add a `field` to.
  *
  * @experimental 21.0.0
  */
-export type WithOptionalField<T> = Omit<T, 'field'> & {field?: FieldTree<unknown>};
+export type WithOptionalField<T> = Omit<T, 'fieldTree'> & {fieldTree?: FieldTree<unknown>};
 
 /**
  * A type that ensures the given type `T` does not have a `field` property.
  * @template T The type to remove the `field` from.
  *
  * @experimental 21.0.0
  */
-export type WithoutField<T> = T & {field: never};
+export type WithoutField<T> = T & {fieldTree: never};
 
 /**
  * Create a required error associated with the target field
@@ -325,7 +325,7 @@ export declare namespace ValidationError {
    */
   export interface WithField extends ValidationError {
     /** The field associated with this error. */
-    readonly field: FieldTree<unknown>;
+    readonly fieldTree: FieldTree<unknown>;
   }
 
   /**
@@ -336,7 +336,7 @@ export declare namespace ValidationError {
    */
   export interface WithOptionalField extends ValidationError {
     /** The field associated with this error. */
-    readonly field?: FieldTree<unknown>;
+    readonly fieldTree?: FieldTree<unknown>;
   }
 
   /**
@@ -369,7 +369,7 @@ export class CustomValidationError implements ValidationError {
   readonly kind: string = '';
 
   /** The field associated with this error. */
-  readonly field!: FieldTree<unknown>;
+  readonly fieldTree!: FieldTree<unknown>;
 
   /** Human readable error message. */
   readonly message?: string;
@@ -395,7 +395,7 @@ abstract class _NgValidationError implements ValidationError {
   readonly kind: string = '';
 
   /** The field associated with this error. */
-  readonly field!: FieldTree<unknown>;
+  readonly fieldTree!: FieldTree<unknown>;
 
   /** Human readable error message. */
   readonly message?: string;

packages/forms/signals/src/api/structure.ts

@@ -400,7 +400,7 @@ function setServerErrors(
   const errorsByField = new Map<FieldNode, ValidationError.WithField[]>();
   for (const error of errors) {
     const errorWithField = addDefaultField(error, submittedField.fieldProxy);
-    const field = errorWithField.field() as FieldNode;
+    const field = errorWithField.fieldTree() as FieldNode;
     let fieldErrors = errorsByField.get(field);
     if (!fieldErrors) {
       fieldErrors = [];