@travetto/schema 3.0.3 → 3.1.0-rc.1

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/schema
 yarn add @travetto/schema
 ```
 
-This module's purpose is to allow for proper declaration and validation of data types, in the course of running a program.  The framework defined here, is leveraged in the [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support"), [Application](https://github.com/travetto/travetto/tree/main/module/app#readme "Application registration/management and run support."), [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module."), [OpenAPI Specification](https://github.com/travetto/travetto/tree/main/module/openapi#readme "OpenAPI integration support for the Travetto framework") and [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") modules.  The schema is the backbone of all data transfer, as it helps to provide validation on correctness of input, whether it is a rest request, command line inputs, or a configuration file. 
+This module's purpose is to allow for proper declaration and validation of data types, in the course of running a program.  The framework defined here, is leveraged in the [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support"), [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework"), [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module."), [OpenAPI Specification](https://github.com/travetto/travetto/tree/main/module/openapi#readme "OpenAPI integration support for the Travetto framework") and [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") modules.  The schema is the backbone of all data transfer, as it helps to provide validation on correctness of input, whether it is a rest request, command line inputs, or a configuration file. 
 
 This module provides a mechanism for registering classes and field level information as well the ability to apply that information at runtime.
 
@@ -203,12 +203,13 @@ Validation Failed {
   "errors": [
     {
       "kind": "type",
+      "type": "number",
       "message": "age is not a valid number",
-      "path": "age",
-      "type": "number"
+      "path": "age"
     },
     {
       "kind": "required",
+      "active": true,
       "message": "address.street2 is required",
       "path": "address.street2"
     }
@@ -269,6 +270,10 @@ export interface ValidationError {
    * Regular expression to match
    */
   re?: string;
+  /**
+   * Number to compare against
+   */
+  n?: number | Date;
   /**
    * The type of the field
    */
@@ -341,9 +346,9 @@ Validation Failed {
   "errors": [
     {
       "kind": "type",
+      "type": "PointImpl",
       "message": "point is not a valid PointImpl",
-      "path": "point",
-      "type": "PointImpl"
+      "path": "point"
     }
   ]
 }

package/package.json

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

package/src/decorator/common.ts

@@ -16,9 +16,10 @@ export function Describe(config: Partial<DescribableConfig>) {
   return (target: Class | ClassInstance, property?: string, descOrIdx?: PropertyDescriptor | number): void => {
     if (isClassInstance(target, property)) {
       if (descOrIdx !== undefined && typeof descOrIdx === 'number') {
-        property = `${property}.${descOrIdx}`;
+        SchemaRegistry.registerPendingParamFacet(target.constructor, property!, descOrIdx, config);
+      } else {
+        SchemaRegistry.registerPendingFieldFacet(target.constructor, property!, config);
       }
-      SchemaRegistry.registerPendingFieldFacet(target.constructor, property!, config);
     } else {
       SchemaRegistry.register(target, config);
     }

package/src/service/registry.ts

@@ -28,7 +28,6 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
   #subTypes = new Map<Class, Map<string, Class>>();
   #typeKeys = new Map<Class, string>();
   #pendingViews = new Map<Class, Map<string, ViewFieldsConfig<unknown>>>();
-  #methodSchemas = new Map<Class, Map<string, FieldConfig[]>>();
 
   constructor() {
     super(RootRegistry);
@@ -191,6 +190,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
       validators: [],
       subType: false,
       metadata: {},
+      methods: {},
       views: {
         [AllViewⲐ]: {
           schema: {},
@@ -225,22 +225,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * @param method
    */
   getMethodSchema<T>(cls: Class<T>, method: string): FieldConfig[] {
-    if (!this.#methodSchemas.has(cls)) {
-      this.#methodSchemas.set(cls, new Map());
-    }
-    const cache = this.#methodSchemas.get(cls)!;
-    if (!cache.has(method) && this.has(cls)) {
-      const { fields, schema } = this.getViewSchema(cls);
-      const out = [];
-      for (const el of fields) {
-        if (el.startsWith(`${method}.`)) {
-          out.push(schema[el]);
-        }
-      }
-      out.sort((a, b) => a.index! - b.index!);
-      cache.set(method, out);
-    }
-    return cache.get(method)! ?? [];
+    return (this.get(cls)?.methods?.[method] ?? []).filter(x => !!x).sort((a, b) => a.index! - b.index!);
   }
 
   /**
@@ -265,9 +250,18 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * @param idx The param index
    * @param config The config to register
    */
-  registerPendingParamFacet(target: Class, prop: string, idx: number, config: Partial<FieldConfig>): Class {
-    config.index = idx;
-    return this.registerPendingFieldFacet(target, `${prop}.${idx}`, config);
+  registerPendingParamFacet(target: Class, method: string, idx: number, config: Partial<FieldConfig>): Class {
+    const methods = this.getOrCreatePending(target)!.methods!;
+    const params = (methods[method] ??= []);
+    params[idx] = {
+      // @ts-expect-error
+      name: `${method}.${idx}`,
+      ...params[idx] ?? {},
+      owner: target,
+      index: idx,
+      ...config,
+    };
+    return target;
   }
 
   /**
@@ -300,9 +294,11 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * @param conf Extra config
    */
   registerPendingParamConfig(target: Class, method: string, idx: number, type: ClassList, conf?: Partial<FieldConfig>): Class {
-    conf ??= {};
-    conf.index = idx;
-    return this.registerPendingFieldConfig(target, `${method}.${idx}`, type, conf);
+    return this.registerPendingParamFacet(target, method, idx, {
+      ...conf,
+      array: Array.isArray(type),
+      type: Array.isArray(type) ? type[0] : type,
+    });
   }
 
   /**
@@ -334,6 +330,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
       schema: { ...dest.views[AllViewⲐ].schema, ...src.views?.[AllViewⲐ].schema },
       fields: [...dest.views[AllViewⲐ].fields, ...src.views?.[AllViewⲐ].fields ?? []]
     };
+    dest.methods = { ...src.methods ?? {}, ...dest.methods ?? {} };
     dest.metadata = { ...src.metadata ?? {}, ...dest.metadata ?? {} };
     dest.subType = src.subType || dest.subType;
     dest.title = src.title || dest.title;
@@ -410,7 +407,6 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
       // Recompute subtypes
       this.#subTypes.clear();
       this.#typeKeys.delete(cls);
-      this.#methodSchemas.delete(cls);
       this.#accessorDescriptors.delete(cls);
 
       // Recompute subtype mappings

package/src/service/types.ts

@@ -71,6 +71,10 @@ export interface ClassConfig extends DescribableConfig {
    * Metadata that is related to the schema structure
    */
   metadata?: Record<symbol, unknown>;
+  /**
+   * Method parameter configs
+   */
+  methods: Record<string, FieldConfig[]>;
 }
 
 /**

package/src/validate/types.ts

@@ -25,6 +25,10 @@ export interface ValidationError {
    * Regular expression to match
    */
   re?: string;
+  /**
+   * Number to compare against
+   */
+  n?: number | Date;
   /**
    * The type of the field
    */
@@ -55,6 +59,10 @@ export interface ValidationResult {
    * Potential regular expression for the result
    */
   re?: RegExp;
+  /**
+   * Number to compare against
+   */
+  n?: number | Date;
 }
 
 /**

package/src/validate/validator.ts

@@ -107,20 +107,24 @@ export class SchemaValidator {
   static #validateRange(field: FieldConfig, key: 'min' | 'max', value: string | number | Date): boolean {
 
     const f = field[key]!;
-    if (typeof f.n === 'number') {
+    const fn = f.n;
+    if (typeof fn === 'number') {
       if (typeof value === 'string') {
         value = parseInt(value, 10);
       }
       if (field.type === Date) {
         value = new Date(value);
       }
-      if (key === 'min' && value < f.n || key === 'max' && value > f.n) {
+      const valN = typeof value === 'number' ? value : value.getTime();
+      if (key === 'min' && valN < fn || key === 'max' && valN > fn) {
         return true;
       }
     } else {
-      const date = f.n.getTime();
+      const date = fn.getTime();
       if (typeof value === 'string') {
         value = Date.parse(value);
+      } else if (value instanceof Date) {
+        value = value.getTime();
       }
       if (key === 'min' && value < date || key === 'max' && value > date) {
         return true;
@@ -202,6 +206,7 @@ export class SchemaValidator {
     const out: ValidationError[] = [];
     for (const res of results) {
       const err: ValidationError = {
+        ...res,
         kind: res.kind,
         value: res.value,
         message: '',
@@ -311,7 +316,7 @@ export class SchemaValidator {
    * @param method The method being invoked
    * @param params The params to validate
    */
-  static validateMethod<T>(cls: Class<T>, method: string, params: unknown[]): void {
+  static async validateMethod<T>(cls: Class<T>, method: string, params: unknown[]): Promise<void> {
     const errors: ValidationError[] = [];
     for (const field of SchemaRegistry.getMethodSchema(cls, method)) {
       errors.push(...this.#validateFieldSchema(field, params[field.index!]));

package/support/transform-util.ts

@@ -128,6 +128,12 @@ export class SchemaTransformUtil {
       }
     }
 
+    const tags = ts.getJSDocTags(node);
+    const aliases = tags.filter(x => x.tagName.getText() === 'alias');
+    if (aliases.length) {
+      attrs.push(state.factory.createPropertyAssignment('aliases', state.fromLiteral(aliases.map(x => x.comment).filter(x => !!x))));
+    }
+
     const params: ts.Expression[] = [];
 
     const existing = state.findDecorator('@travetto/schema', node, 'Field', FIELD_MOD);