refactor(forms): remove customError()

Remove the `customError` function and `CustomValidationError` type.

These were made obsolete by support for returning plain object literals
as custom errors.

This also catches few `field` properties that were missed in the
renaming to `fieldTree`.

Author: leonsenft

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

@@ -89,21 +89,6 @@ export function createMetadataKey<TWrite>(): MetadataKey<Signal<TWrite | undefin
 // @public
 export function createMetadataKey<TWrite, TAcc>(reducer: MetadataReducer<TAcc, TWrite>): MetadataKey<Signal<TAcc>, TWrite, TAcc>;
 
-// @public
-export function customError<E extends Partial<ValidationError.WithField>>(obj: WithField<E>): CustomValidationError;
-
-// @public
-export function customError<E extends Partial<ValidationError.WithField>>(obj?: E): WithoutField<CustomValidationError>;
-
-// @public
-export class CustomValidationError implements ValidationError {
-    constructor(options?: ValidationErrorOptions);
-    [key: PropertyKey]: unknown;
-    readonly fieldTree: FieldTree<unknown>;
-    readonly kind: string;
-    readonly message?: string;
-}
-
 // @public
 export function debounce<TValue, TPathKind extends PathKind = PathKind.Root>(path: SchemaPath<TValue, SchemaPathRules.Supported, TPathKind>, durationOrDebouncer: number | Debouncer<TValue, TPathKind>): void;
 
@@ -613,7 +598,7 @@ export namespace ValidationError {
         readonly fieldTree?: FieldTree<unknown>;
     }
     export interface WithoutField extends ValidationError {
-        readonly field?: never;
+        readonly fieldTree?: never;
     }
 }
 

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

@@ -6,9 +6,8 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {isArray} from '../../../util/type_guards';
-import {LogicFn, OneOrMany, PathKind, ValidationResult, type FieldContext} from '../../types';
-import {customError, ValidationError} from './validation_errors';
+import {LogicFn, OneOrMany, PathKind, type FieldContext} from '../../types';
+import {ValidationError} from './validation_errors';
 
 /** Represents a value that has a length or size, such as an array or string, or set. */
 export type ValueWithLengthOrSize = {length: number} | {size: number};
@@ -59,43 +58,3 @@ export function isEmpty(value: unknown): boolean {
   }
   return value === '' || value === false || value == null;
 }
-
-/**
- * Whether the value is a plain object, as opposed to being an instance of Validation error.
- * @param error An error that could be a plain object, or an instance of a class implementing ValidationError.
- */
-function isPlainError(error: ValidationError) {
-  return (
-    typeof error === 'object' &&
-    (Object.getPrototypeOf(error) === Object.prototype || Object.getPrototypeOf(error) === null)
-  );
-}
-
-/**
- * If the value provided is a plain object, it wraps it into a custom error.
- * @param error An error that could be a plain object, or an instance of a class implementing ValidationError.
- */
-function ensureCustomValidationError(error: ValidationError.WithField): ValidationError.WithField {
-  if (isPlainError(error)) {
-    return customError(error);
-  }
-  return error;
-}
-
-/**
- * Makes sure every provided error is wrapped as a custom error.
- * @param result Validation result with a field.
- */
-export function ensureCustomValidationResult(
-  result: ValidationResult<ValidationError.WithField>,
-): ValidationResult<ValidationError.WithField> {
-  if (result === null || result === undefined) {
-    return result;
-  }
-
-  if (isArray(result)) {
-    return result.map(ensureCustomValidationError);
-  }
-
-  return ensureCustomValidationError(result);
-}

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

@@ -16,7 +16,6 @@ import type {
   SchemaPath,
   SchemaPathRules,
 } from '../../types';
-import {ensureCustomValidationResult} from './util';
 
 /**
  * Adds logic to a field to determine if the field has validation errors.
@@ -37,8 +36,6 @@ 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.fieldTree),
-    );
+    return addDefaultField(logic(ctx as FieldContext<TValue, TPathKind>), ctx.fieldTree);
   });
 }

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

@@ -272,32 +272,6 @@ export function standardSchemaError(
   return new StandardSchemaValidationError(issue, options);
 }
 
-/**
- * Create a custom error associated with the target field
- * @param obj The object to create an error from
- *
- * @category validation
- * @experimental 21.0.0
- */
-export function customError<E extends Partial<ValidationError.WithField>>(
-  obj: WithField<E>,
-): CustomValidationError;
-/**
- * Create a custom error
- * @param obj The object to create an error from
- *
- * @category validation
- * @experimental 21.0.0
- */
-export function customError<E extends Partial<ValidationError.WithField>>(
-  obj?: E,
-): WithoutField<CustomValidationError>;
-export function customError<E extends Partial<ValidationError.WithField>>(
-  obj?: E,
-): WithOptionalField<CustomValidationError> {
-  return new CustomValidationError(obj);
-}
-
 /**
  * Common interface for all validation errors.
  *
@@ -348,38 +322,7 @@ export declare namespace ValidationError {
    */
   export interface WithoutField extends ValidationError {
     /** The field associated with this error. */
-    readonly field?: never;
-  }
-}
-
-/**
- * A custom error that may contain additional properties
- *
- * @category validation
- * @experimental 21.0.0
- */
-export class CustomValidationError implements ValidationError {
-  /** Brand the class to avoid Typescript structural matching */
-  private __brand = undefined;
-
-  /**
-   * Allow the user to attach arbitrary other properties.
-   */
-  [key: PropertyKey]: unknown;
-
-  /** Identifies the kind of error. */
-  readonly kind: string = '';
-
-  /** The field associated with this error. */
-  readonly fieldTree!: FieldTree<unknown>;
-
-  /** Human readable error message. */
-  readonly message?: string;
-
-  constructor(options?: ValidationErrorOptions) {
-    if (options) {
-      Object.assign(this, options);
-    }
+    readonly fieldTree?: never;
   }
 }
 

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

@@ -155,7 +155,7 @@ export function form<TModel>(
  * ```ts
  * const nameForm = form(signal({first: '', last: ''}), (name) => {
  *   required(name.first);
- *   validate(name.last, ({value}) => !/^[a-z]+$/i.test(value()) ? customError({kind: 'alphabet-only'}) : undefined);
+ *   validate(name.last, ({value}) => !/^[a-z]+$/i.test(value()) ? {kind: 'alphabet-only'} : undefined);
  * });
  * nameForm().valid(); // false
  * nameForm().value.set({first: 'John', last: 'Doe'});

packages/forms/signals/test/node/api/hidden.spec.ts

@@ -8,7 +8,7 @@
 
 import {Injector, signal} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
-import {customError, form, hidden, validate} from '@angular/forms/signals';
+import {form, hidden, validate} from '@angular/forms/signals';
 
 describe('hidden', () => {
   it('should initially be false', () => {
@@ -70,7 +70,7 @@ describe('hidden', () => {
         });
 
         validate(p.name, () => {
-          return customError({kind: 'dog'});
+          return {kind: 'dog'};
         });
       },
       {injector: TestBed.inject(Injector)},

packages/forms/signals/test/node/api/validators/email.spec.ts

@@ -9,7 +9,7 @@
 import {Injector, signal} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
 import {email, form} from '../../../../public_api';
-import {customError, emailError} from '../../../../src/api/rules/validation/validation_errors';
+import {emailError} from '../../../../src/api/rules/validation/validation_errors';
 
 describe('email validator', () => {
   it('returns requiredTrue error when the value is false', () => {
@@ -35,7 +35,7 @@ describe('email validator', () => {
       cat,
       (p) => {
         email(p.email, {
-          error: (ctx) => customError({kind: `special-email-${ctx.valueOf(p.name)}`}),
+          error: (ctx) => ({kind: `special-email-${ctx.valueOf(p.name)}`}),
         });
       },
       {
@@ -44,10 +44,10 @@ describe('email validator', () => {
     );
 
     expect(f.email().errors()).toEqual([
-      customError({
+      {
         kind: 'special-email-pirojok-the-cat',
         fieldTree: f.email,
-      }),
+      },
     ]);
   });
 

packages/forms/signals/test/node/api/validators/max.spec.ts

@@ -8,7 +8,7 @@
 
 import {Injector, signal} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
-import {customError, form, max, maxError} from '../../../../public_api';
+import {form, max, maxError} from '../../../../public_api';
 
 describe('max validator', () => {
   it('returns max error when the value is larger', () => {
@@ -58,19 +58,19 @@ describe('max validator', () => {
         (p) => {
           max(p.age, 5, {
             error: ({value}) => {
-              return customError({kind: 'special-max', message: value()?.toString()});
+              return {kind: 'special-max', message: value()?.toString()};
             },
           });
         },
         {injector: TestBed.inject(Injector)},
       );
 
       expect(f.age().errors()).toEqual([
-        customError({
+        {
           kind: 'special-max',
           message: '6',
           fieldTree: f.age,
-        }),
+        },
       ]);
     });
 
@@ -103,16 +103,14 @@ describe('max validator', () => {
             error: ({value, valueOf}) => {
               return valueOf(p.name) === 'disabled'
                 ? []
-                : customError({kind: 'special-max', message: value()?.toString()});
+                : {kind: 'special-max', message: value()?.toString()};
             },
           });
         },
         {injector: TestBed.inject(Injector)},
       );
 
-      expect(f.age().errors()).toEqual([
-        customError({kind: 'special-max', message: '6', fieldTree: f.age}),
-      ]);
+      expect(f.age().errors()).toEqual([{kind: 'special-max', message: '6', fieldTree: f.age}]);
       f.name().value.set('disabled');
       expect(f.age().errors()).toEqual([]);
     });
@@ -154,7 +152,7 @@ describe('max validator', () => {
         (p) => {
           max(p.age, 5, {
             error: ({value}) => {
-              return customError({kind: 'special-max', message: value()?.toString()});
+              return {kind: 'special-max', message: value()?.toString()};
             },
           });
         },

packages/forms/signals/test/node/api/validators/max_length.spec.ts

@@ -8,7 +8,7 @@
 
 import {Injector, signal} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
-import {customError, form, maxLength, maxLengthError} from '../../../../public_api';
+import {form, maxLength, maxLengthError} from '../../../../public_api';
 
 describe('maxLength validator', () => {
   it('returns maxLength error when the length is larger for strings', () => {
@@ -70,22 +70,22 @@ describe('maxLength validator', () => {
       (p) => {
         maxLength(p.text, 5, {
           error: ({value}) => {
-            return customError({
+            return {
               kind: 'special-maxLength',
               message: `Length is ${value().length}`,
-            });
+            };
           },
         });
       },
       {injector: TestBed.inject(Injector)},
     );
 
     expect(f.text().errors()).toEqual([
-      customError({
+      {
         kind: 'special-maxLength',
         message: 'Length is 6',
         fieldTree: f.text,
-      }),
+      },
     ]);
   });
 
@@ -145,10 +145,10 @@ describe('maxLength validator', () => {
         (p) => {
           maxLength(p.text, 5, {
             error: ({value}) => {
-              return customError({
+              return {
                 kind: 'special-maxLength',
                 message: `Length is ${value().length}`,
-              });
+              };
             },
           });
         },