@travetto/schema 3.0.0-rc.9 → 3.0.1-rc.1

package/README.md

@@ -6,10 +6,14 @@
 **Install: @travetto/schema**
 ```bash
 npm install @travetto/schema
+
+# or
+
+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
+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 provides a mechanism for registering classes and field level information as well the ability to apply that information at runtime.
@@ -140,14 +144,13 @@ and the output would be a `Person` instance with the following structure
 
 **Terminal: Sample data output after binding**
 ```bash
-$ trv main support/main.person-output.ts
+$ trv main doc/person-output.ts
 
 Person {
   name: 'Test',
   age: 19,
   address: Address { street1: '1234 Fun', street2: 'Unit 20' }
 }
-
 ```
 
 **Note**: Binding will attempt to convert/coerce types as much as possible to honor the pattern of Javascript and it's dynamic nature.
@@ -201,9 +204,27 @@ would produce an exception similar to following structure
 
 **Terminal: Sample error output**
 ```bash
-$ trv main support/main.person-invalid-output.ts
-
-
+$ trv main doc/person-invalid-output.ts
+
+Validation Failed {
+  "message": "Validation errors have occurred",
+  "category": "data",
+  "type": "ValidationResultError",
+  "at": "2029-03-14T04:00:00.618Z",
+  "errors": [
+    {
+      "kind": "type",
+      "message": "age is not a valid number",
+      "path": "age",
+      "type": "number"
+    },
+    {
+      "kind": "required",
+      "message": "address.street2 is required",
+      "path": "address.street2"
+    }
+  ]
+}
 ```
 
 ### Custom Validators
@@ -324,7 +345,20 @@ All that happens now, is the type is exported, and the class above is able to pr
 
 **Terminal: Custom Type Validation**
 ```bash
-$ trv main support/main.custom-type-output.ts
-
-
+$ trv main doc/custom-type-output.ts
+
+Validation Failed {
+  "message": "Validation errors have occurred",
+  "category": "data",
+  "type": "ValidationResultError",
+  "at": "2029-03-14T04:00:00.837Z",
+  "errors": [
+    {
+      "kind": "type",
+      "message": "point is not a valid PointImpl",
+      "path": "point",
+      "type": "PointImpl"
+    }
+  ]
+}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/schema",
-  "version": "3.0.0-rc.9",
+  "version": "3.0.1-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.0-rc.9"
+    "@travetto/registry": "^3.0.1-rc.1"
   },
   "peerDependencies": {
-    "@travetto/transformer": "^3.0.0-rc.9"
+    "@travetto/transformer": "^3.0.1-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/bind-util.ts

@@ -306,4 +306,15 @@ export class BindUtil {
     }
     return params;
   }
+
+  /**
+   * Coerce method parameters when possible
+   * @param cls
+   * @param method
+   * @param params
+   * @returns
+   */
+  static coerceMethodParams<T>(cls: Class<T>, method: string, params: unknown[], applyDefaults = false): unknown[] {
+    return this.coerceFields(SchemaRegistry.getMethodSchema(cls, method), params, applyDefaults);
+  }
 }

package/src/service/registry.ts

@@ -3,7 +3,6 @@ import { MetadataRegistry, RootRegistry, ChangeEvent } from '@travetto/registry'
 
 import { ClassList, FieldConfig, ClassConfig, SchemaConfig, ViewFieldsConfig, ViewConfig } from './types';
 import { SchemaChangeListener } from './changes';
-import { BindUtil } from '../bind-util';
 import { AllViewⲐ } from '../internal/types';
 
 function hasType<T>(o: unknown): o is { type: Class<T> | string } {
@@ -244,17 +243,6 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
     return cache.get(method)! ?? [];
   }
 
-  /**
-   * Coerce method parameters when possible
-   * @param cls
-   * @param method
-   * @param params
-   * @returns
-   */
-  coerceMethodParams<T>(cls: Class<T>, method: string, params: unknown[], applyDefaults = false): unknown[] {
-    return BindUtil.coerceFields(this.getMethodSchema(cls, method), params, applyDefaults);
-  }
-
   /**
    * Register a view
    * @param target The target class