@travetto/schema 5.0.12 → 5.0.14

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ArcSine Technologies
+Copyright (c) 2020 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -63,28 +63,28 @@ User:
 
 ### Fields
 This schema provides a powerful base for data binding and validation at runtime.  Additionally there may be types that cannot be detected, or some information that the programmer would like to override. Below are the supported field decorators:
-   *  [@Field](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L30) defines a field that will be serialized.
-   *  [@Required](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L70) defines a that field should be required
-   *  [@Enum](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L77) defines the allowable values that a field can have
-   *  [@Match](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L98) defines a regular expression that the field value should match
-   *  [@MinLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L106) enforces min length of a string
-   *  [@MaxLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L116) enforces max length of a string
-   *  [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L106) enforces min value for a date or a number
-   *  [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L116) enforces max value for a date or a number
-   *  [@Email](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L143) ensures string field matches basic email regex
-   *  [@Telephone](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L150) ensures string field matches basic telephone regex
-   *  [@Url](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L157) ensures string field matches basic url regex
-   *  [@Ignore](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L196) exclude from auto schema registration
-   *  [@Integer](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L171) ensures number passed in is only a whole number
-   *  [@Float](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L177) ensures number passed in allows fractional values
-   *  [@Currency](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L189) provides support for standard currency
-   *  [@Text](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L85) indicates that a field is expecting natural language input, not just discrete values
-   *  [@LongText](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L90) same as text, but expects longer form content
-   *  [@Readonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L57) defines a that field should not be bindable external to the class
-   *  [@Writeonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L51) defines a that field should not be exported in serialization, but that it can be bound to
-   *  [@Secret](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L63) marks a field as being sensitive.  This is used by certain logging activities to ensure sensitive information is not logged out.
-   *  [@Specifier](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L205) attributes additional specifiers to a field, allowing for more specification beyond just the field's type.
-   *  [@SubTypeField](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L211) allows for promoting a given field as the owner of the sub type discriminator (defaults to `type`).
+   *  [@Field](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L25) defines a field that will be serialized.
+   *  [@Required](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L65) defines a that field should be required
+   *  [@Enum](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L72) defines the allowable values that a field can have
+   *  [@Match](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L93) defines a regular expression that the field value should match
+   *  [@MinLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L101) enforces min length of a string
+   *  [@MaxLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L111) enforces max length of a string
+   *  [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L101) enforces min value for a date or a number
+   *  [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L111) enforces max value for a date or a number
+   *  [@Email](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L138) ensures string field matches basic email regex
+   *  [@Telephone](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L145) ensures string field matches basic telephone regex
+   *  [@Url](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L152) ensures string field matches basic url regex
+   *  [@Ignore](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L191) exclude from auto schema registration
+   *  [@Integer](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L166) ensures number passed in is only a whole number
+   *  [@Float](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L172) ensures number passed in allows fractional values
+   *  [@Currency](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L184) provides support for standard currency
+   *  [@Text](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L80) indicates that a field is expecting natural language input, not just discrete values
+   *  [@LongText](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L85) same as text, but expects longer form content
+   *  [@Readonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L52) defines a that field should not be bindable external to the class
+   *  [@Writeonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L46) defines a that field should not be exported in serialization, but that it can be bound to
+   *  [@Secret](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L58) marks a field as being sensitive.  This is used by certain logging activities to ensure sensitive information is not logged out.
+   *  [@Specifier](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L200) attributes additional specifiers to a field, allowing for more specification beyond just the field's type.
+   *  [@SubTypeField](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L206) allows for promoting a given field as the owner of the sub type discriminator (defaults to `type`).
 Additionally, schemas can be nested to form more complex data structures that are able to bound and validated. 
 
 Just like the class, all fields can be defined with
@@ -102,7 +102,7 @@ import { Match, Min } from '@travetto/schema';
 const NAME_REGEX = /[A-Z][a-z]+(\s+[A-Z][a-z]+)*/;
 
 export class ParamUsage {
-  main(@Match(NAME_REGEX).Param name: string, @Min(20).Param age?: number) {
+  main(@Match(NAME_REGEX) name: string, @Min(20) age?: number) {
     console.log('Valid name and age!', { name, age });
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/schema",
-  "version": "5.0.12",
+  "version": "5.0.14",
   "description": "Data type registry for runtime validation, reflection and binding.",
   "keywords": [
     "schema",
@@ -27,10 +27,10 @@
     "directory": "module/schema"
   },
   "dependencies": {
-    "@travetto/registry": "^5.0.12"
+    "@travetto/registry": "^5.0.14"
   },
   "peerDependencies": {
-    "@travetto/transformer": "^5.0.10"
+    "@travetto/transformer": "^5.0.11"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/bind-util.ts

@@ -220,7 +220,7 @@ export class BindUtil {
             // Ensure its an array
             if (!Array.isArray(v) && field.array) {
               if (typeof v === 'string' && v.includes(',')) {
-                v = v.split(/\s*,\s*/);
+                v = v.split(/,/).map(x => x.trim());
               } else {
                 v = [v];
               }

package/src/data.ts

@@ -91,6 +91,9 @@ export class DataUtil {
         const retObj: Record<string, unknown> = castTo(ret);
 
         for (const key of Object.keys(bObj)) {
+          if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
+            continue;
+          }
           retObj[key] = this.#deepAssignRaw(retObj[key], bObj[key], mode);
         }
       }

package/src/decorator/field.ts

@@ -1,24 +1,19 @@
-import { Any, castTo, ClassInstance } from '@travetto/runtime';
+import { Any, ClassInstance } from '@travetto/runtime';
 
 import { SchemaRegistry } from '../service/registry';
 import { CommonRegExp } from '../validate/regexp';
 import { ClassList, FieldConfig } from '../service/types';
 
-type PropType<V> = (<T extends Partial<Record<K, V>>, K extends string>(t: T, k: K, idx?: TypedPropertyDescriptor<Any> | number) => void) & {
-  Param: (t: unknown, k: string, idx: number) => void;
-};
+type PropType<V> = (<T extends Partial<Record<K, V | Function>>, K extends string>(t: T, k: K, idx?: TypedPropertyDescriptor<Any> | number) => void);
 
 function prop<V>(obj: Partial<FieldConfig>): PropType<V> {
-  const fn = (t: ClassInstance, k: string, idx?: number | TypedPropertyDescriptor<Any>): void => {
+  return (t: ClassInstance, k: string, idx?: number | TypedPropertyDescriptor<Any>): void => {
     if (idx !== undefined && typeof idx === 'number') {
       SchemaRegistry.registerPendingParamFacet(t.constructor, k, idx, obj);
     } else {
       SchemaRegistry.registerPendingFieldFacet(t.constructor, k, obj);
     }
   };
-  fn.Param = fn;
-
-  return castTo(fn);
 }
 
 /**

package/src/decorator/schema.ts

@@ -1,9 +1,9 @@
-import { castTo, Class, DeepPartial } from '@travetto/runtime';
+import { Any, castTo, Class, ClassInstance, DeepPartial } from '@travetto/runtime';
 
 import { BindUtil } from '../bind-util';
 import { SchemaRegistry } from '../service/registry';
 import { ClassConfig, ViewFieldsConfig } from '../service/types';
-import { ValidatorFn } from '../validate/types';
+import { MethodValidatorFn, ValidatorFn } from '../validate/types';
 
 /**
  * Register a class as a Schema
@@ -26,12 +26,23 @@ export function Schema(cfg?: Partial<Pick<ClassConfig, 'subTypeName' | 'subTypeF
  *
  * @param fn The validator function
  */
-export function Validator<T>(fn: ValidatorFn<T, string>) {
-  return (target: Class<T>): void => {
+export const Validator = <T>(fn: ValidatorFn<T, string>) =>
+  (target: Class<T>, k?: string): void => {
     SchemaRegistry.getOrCreatePending(target).validators!.push(castTo(fn));
   };
+
+/**
+ * Add a custom validator for a given method
+ *
+ * @param fn The validator function
+ */
+export function MethodValidator<T extends (...args: Any[]) => Any>(fn: MethodValidatorFn<Parameters<T>>) {
+  return (target: ClassInstance, k: string, prop: TypedPropertyDescriptor<T>): void => {
+    SchemaRegistry.registerPendingMethod(target.constructor, k).validators!.push(castTo(fn));
+  };
 }
 
+
 /**
  * Register a specific view for a class
  * @param name The name of the view

package/src/service/registry.ts

@@ -1,9 +1,10 @@
-import { Class, AppError, describeFunction, castTo, classConstruct, asFull, castKey } from '@travetto/runtime';
+import { Class, AppError, describeFunction, castTo, classConstruct, asFull, castKey, Any } from '@travetto/runtime';
 import { MetadataRegistry, RootRegistry, ChangeEvent } from '@travetto/registry';
 
-import { ClassList, FieldConfig, ClassConfig, SchemaConfig, ViewFieldsConfig, ViewConfig } from './types';
+import { ClassList, FieldConfig, ClassConfig, SchemaConfig, ViewFieldsConfig, ViewConfig, SchemaMethodConfig } from './types';
 import { SchemaChangeListener } from './changes';
 import { AllViewⲐ } from '../internal/types';
+import { MethodValidatorFn } from '../validate/types';
 
 const classToSubTypeName = (cls: Class): string => cls.name
   .replace(/([A-Z])([A-Z][a-z])/g, (all, l, r) => `${l}_${r.toLowerCase()}`)
@@ -218,7 +219,16 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * @param method
    */
   getMethodSchema<T>(cls: Class<T>, method: string): FieldConfig[] {
-    return (this.get(cls)?.methods?.[method] ?? []).filter(x => !!x).sort((a, b) => a.index! - b.index!);
+    return (this.get(cls)?.methods?.[method] ?? {}).fields?.filter(x => !!x).sort((a, b) => a.index! - b.index!) ?? [];
+  }
+
+  /**
+   * Get method validators
+   * @param cls
+   * @param method
+   */
+  getMethodValidators<T>(cls: Class<T>, method: string): MethodValidatorFn<unknown[]>[] {
+    return (this.get(cls)?.methods?.[method] ?? {}).validators ?? [];
   }
 
   /**
@@ -235,6 +245,16 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
     this.#pendingViews.get(target)!.set(view, generalConfig);
   }
 
+  /**
+   * Register pending method, and establish a method config
+   * @param target
+   * @param method
+   */
+  registerPendingMethod(target: Class, method: string): SchemaMethodConfig {
+    const methods = this.getOrCreatePending(target)!.methods!;
+    return (methods[method] ??= { fields: [], validators: [] });
+  }
+
   /**
    * Register a partial config for a pending method param
    * @param target The class to target
@@ -243,8 +263,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * @param config The config to register
    */
   registerPendingParamFacet(target: Class, method: string, idx: number, config: Partial<FieldConfig>): Class {
-    const methods = this.getOrCreatePending(target)!.methods!;
-    const params = (methods[method] ??= []);
+    const params = this.registerPendingMethod(target, method).fields;
     if (config.name === '') {
       delete config.name;
     }

package/src/service/types.ts

@@ -1,7 +1,7 @@
 import { Any, Class, Primitive } from '@travetto/runtime';
 
 import { AllViewⲐ } from '../internal/types';
-import { ValidatorFn } from '../validate/types';
+import { MethodValidatorFn, ValidatorFn } from '../validate/types';
 
 export type ClassList = Class | [Class];
 
@@ -26,6 +26,14 @@ export interface DescribableConfig {
   examples?: string[];
 }
 
+/**
+ * Basic structure for a method configuration
+ */
+export interface SchemaMethodConfig {
+  fields: FieldConfig[];
+  validators: MethodValidatorFn<unknown[]>[];
+}
+
 /**
  * Schema configuration
  */
@@ -85,7 +93,7 @@ export interface ClassConfig extends DescribableConfig {
   /**
    * Method parameter configs
    */
-  methods: Record<string, FieldConfig[]>;
+  methods: Record<string, SchemaMethodConfig>;
 }
 
 /**

package/src/validate/regexp.ts

@@ -14,7 +14,7 @@ export const CommonRegExp = {
   email: /^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/,
   telephone: /^(\+?\d{1,3}(\s*-?\s*|\s+))?((\(\d{3}\))|\d{3})(\s*|-|[.])(\d{3})(\s*|-|[.])(\d{4})(\s+(x|ext[.]?)\s*\d+)?$/,
   url: /^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$/,
-  simpleName: /^([a-zA-Z\u0080-\u024F]*(?:. |-| |'))*[a-zA-Z\u0080-\u024F]+$/,
+  simpleName: /^([a-zA-Z\u0080-\u024F]{0,100}(?:. |-| |')){0,10}[a-zA-Z\u0080-\u024F]+$/,
   postalCode: /^\d{5}(?:[-\s]\d{4})?$/
 };
 

package/src/validate/types.ts

@@ -65,7 +65,14 @@ export interface ValidationResult {
   n?: number | Date;
 }
 
+type OrPromise<T> = T | Promise<T>;
+
 /**
  * Validator function
  */
-export type ValidatorFn<T, U> = (value: T, parent?: U) => ValidationError | undefined | Promise<ValidationError | undefined>;
+export type ValidatorFn<T, U> = (value: T, parent?: U) => OrPromise<ValidationError | ValidationError[] | undefined>;
+
+/**
+ * Method Validator function
+ */
+export type MethodValidatorFn<T extends unknown[]> = (...value: T) => OrPromise<ValidationError | ValidationError[] | undefined>;

package/src/validate/validator.ts

@@ -233,7 +233,11 @@ export class SchemaValidator {
       try {
         const res = await fn(o, view);
         if (res) {
-          errors.push(res);
+          if (Array.isArray(res)) {
+            errors.push(...res);
+          } else {
+            errors.push(res);
+          }
         }
       } catch (err: unknown) {
         if (isValidationError(err)) {
@@ -324,6 +328,16 @@ export class SchemaValidator {
         return x;
       }));
     }
+    for (const validator of SchemaRegistry.getMethodValidators(cls, method)) {
+      const res = await validator(...params);
+      if (res) {
+        if (Array.isArray(res)) {
+          errors.push(...res);
+        } else {
+          errors.push(res);
+        }
+      }
+    }
     if (errors.length) {
       throw new ValidationResultError(errors);
     }