@travetto/schema 3.0.3 → 3.1.0-rc.0

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.0",
   "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/service/registry.ts

@@ -233,7 +233,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
       const { fields, schema } = this.getViewSchema(cls);
       const out = [];
       for (const el of fields) {
-        if (el.startsWith(`${method}.`)) {
+        if (el.startsWith(`${method}.`) && schema[el].forMethod) {
           out.push(schema[el]);
         }
       }
@@ -302,6 +302,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
   registerPendingParamConfig(target: Class, method: string, idx: number, type: ClassList, conf?: Partial<FieldConfig>): Class {
     conf ??= {};
     conf.index = idx;
+    conf.forMethod = true;
     return this.registerPendingFieldConfig(target, `${method}.${idx}`, type, conf);
   }
 

package/src/service/types.ts

@@ -160,6 +160,10 @@ export interface FieldConfig extends DescribableConfig {
    * Is this field a getter or setter
    */
   accessor?: string;
+  /**
+   * Is the field for a method
+   */
+  forMethod?: boolean;
 }
 
 export type ViewFieldsConfig<T> = { with: Extract<(keyof T), string>[] } | { without: Extract<(keyof T), string>[] };

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

@@ -40,7 +40,7 @@ export class SchemaValidator {
 
     const fields = TypedObject.keys<SchemaConfig>(schema);
     for (const field of fields) {
-      if (schema[field].access !== 'readonly') { // Do not validate readonly fields
+      if (schema[field].access !== 'readonly' && !schema[field].forMethod) { // Do not validate readonly fields
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         errors = errors.concat(this.#validateFieldSchema(schema[field], o[field as keyof T], relative));
       }
@@ -202,6 +202,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 +312,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);