@travetto/schema 7.0.0-rc.4 → 7.0.0

package/README.md

@@ -64,7 +64,7 @@ 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#L23) defines a field that will be serialized.
+   *  [@Field](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L24) defines a field that will be serialized.
    *  [@Required](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/input.ts#L49) defines a that field should be required
    *  [@Enum](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/input.ts#L58) defines the allowable values that a field can have
    *  [@Match](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/input.ts#L84) defines a regular expression that the field value should match
@@ -81,9 +81,9 @@ This schema provides a powerful base for data binding and validation at runtime.
    *  [@Currency](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/input.ts#L187) provides support for standard currency
    *  [@Text](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/input.ts#L68) 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/input.ts#L75) same as text, but expects longer form content
-   *  [@Readonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L39) 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#L32) 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#L47) marks a field as being sensitive.  This is used by certain logging activities to ensure sensitive information is not logged out.
+   *  [@Readonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L40) 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#L33) 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#L48) 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/input.ts#L195) attributes additional specifiers to a field, allowing for more specification beyond just the field's type.
    *  [@DiscriminatorField](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/input.ts#L202) allows for promoting a given field as the owner of the sub type discriminator.
 

package/package.json

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

package/src/decorator/field.ts

@@ -18,10 +18,11 @@ function field<V>(...configs: Partial<SchemaFieldConfig>[]): PropType<V> {
  * @param type The type for the field
  * @param configs The field configuration
  * @augments `@travetto/schema:Input`
+ * @augments `@travetto/schema:Field`
  * @kind decorator
  */
-export function Field(type: Pick<SchemaFieldConfig, 'type' | 'array'>, ...configs: Partial<SchemaFieldConfig>[]): PropType<unknown> {
-  return field(type, ...configs);
+export function Field(type?: Pick<SchemaFieldConfig, 'type' | 'array'>, ...configs: Partial<SchemaFieldConfig>[]): PropType<unknown> {
+  return field(type!, ...configs);
 }
 
 /**

package/src/service/registry-adapter.ts

@@ -34,17 +34,19 @@ function combineCore<T extends SchemaCoreConfig>(base: T, config: Partial<T>): T
 
 function combineInputs<T extends SchemaInputConfig>(base: T, configs: Partial<T>[]): T {
   for (const config of configs) {
-    safeAssign(base, {
-      ...config,
-      ...config.aliases ? { aliases: [...base.aliases ?? [], ...config.aliases ?? []] } : {},
-      ...config.specifiers ? { specifiers: [...base.specifiers ?? [], ...config.specifiers ?? []] } : {},
-      ...config.enum ? {
-        enum: {
-          message: config.enum?.message ?? base.enum?.message,
-          values: (config.enum?.values ?? base.enum?.values ?? []).toSorted()
-        }
-      } : {},
-    });
+    if (config) {
+      safeAssign(base, {
+        ...config,
+        ...config.aliases ? { aliases: [...base.aliases ?? [], ...config.aliases ?? []] } : {},
+        ...config.specifiers ? { specifiers: [...base.specifiers ?? [], ...config.specifiers ?? []] } : {},
+        ...config.enum ? {
+          enum: {
+            message: config.enum?.message ?? base.enum?.message,
+            values: (config.enum?.values ?? base.enum?.values ?? []).toSorted()
+          }
+        } : {},
+      });
+    }
     combineCore(base, config);
   }
   return base;

package/support/transformer/util.ts

@@ -214,19 +214,19 @@ class ${uniqueId} extends ${type.mappedClassName} {
       params.push(state.fromLiteral(attrs));
     }
 
-    if (!existing) {
-      const resolved = this.toConcreteType(state, typeExpr, node, config?.root ?? node);
-      const type = typeExpr.key === 'foreign' ? state.getConcreteType(node) :
-        ts.isArrayLiteralExpression(resolved) ? resolved.elements[0] : resolved;
-
-      params.unshift(LiteralUtil.fromLiteral(state.factory, {
-        array: ts.isArrayLiteralExpression(resolved),
-        type
-      }));
-    } else {
+    const resolved = this.toConcreteType(state, typeExpr, node, config?.root ?? node);
+    const type = typeExpr.key === 'foreign' ? state.getConcreteType(node) :
+      ts.isArrayLiteralExpression(resolved) ? resolved.elements[0] : resolved;
+
+    params.unshift(LiteralUtil.fromLiteral(state.factory, {
+      array: ts.isArrayLiteralExpression(resolved),
+      type
+    }));
+
+    if (existing) {
       const args = DecoratorUtil.getArguments(existing) ?? [];
       if (args.length > 0) {
-        params.unshift(args[0]);
+        params[0] = args[0]; // Overwrite
       }
       if (args.length > 1) {
         params.push(...args.slice(1));

package/support/transformer.schema.ts

@@ -2,18 +2,20 @@ import ts from 'typescript';
 
 import {
   TransformerState, OnProperty, OnClass, AfterClass, DocUtil, DeclarationUtil,
-  OnGetter, OnSetter, OnMethod, DecoratorUtil, OnStaticMethod
+  OnGetter, OnSetter, OnMethod, DecoratorUtil, OnStaticMethod, type DecoratorMeta
 } from '@travetto/transformer';
 
 import { SchemaTransformUtil } from './transformer/util.ts';
 
 const CONSTRUCTOR_PROPERTY = 'CONSTRUCTOR';
-const InSchemaSymbol = Symbol();
+const InSchema = Symbol();
+const IsOptIn = Symbol();
 const AccessorsSymbol = Symbol();
 const AutoEnrollMethods = Symbol();
 
 interface AutoState {
-  [InSchemaSymbol]?: boolean;
+  [InSchema]?: boolean;
+  [IsOptIn]?: boolean;
   [AutoEnrollMethods]?: Set<string>;
   [AccessorsSymbol]?: Set<string>;
 }
@@ -23,7 +25,11 @@ interface AutoState {
  */
 export class SchemaTransformer {
 
-  static isInvisible(state: AutoState & TransformerState, node: ts.Declaration): boolean {
+  static isInvisible(state: AutoState & TransformerState, node: ts.Declaration, isStatic?: boolean): boolean {
+    if (!state[InSchema] && !isStatic) {
+      return true;
+    }
+
     const ignore = state.findDecorator(this, node, 'Ignore');
     if (ignore) {
       return true;
@@ -31,6 +37,7 @@ export class SchemaTransformer {
 
     const manuallyOpted = !!(
       state.findDecorator(this, node, 'Input') ??
+      state.findDecorator(this, node, 'Field') ??
       state.findDecorator(this, node, 'Method')
     );
     if (manuallyOpted) {
@@ -41,7 +48,7 @@ export class SchemaTransformer {
         return true;
       }
     }
-    if (!state[InSchemaSymbol] || !DeclarationUtil.isPublic(node)) {
+    if (state[IsOptIn] || !DeclarationUtil.isPublic(node)) {
       return true;
     }
     return false;
@@ -52,15 +59,17 @@ export class SchemaTransformer {
    */
   @OnClass('Schema')
   static startSchema(state: AutoState & TransformerState, node: ts.ClassDeclaration): ts.ClassDeclaration {
-    state[InSchemaSymbol] = true;
     state[AccessorsSymbol] = new Set();
     state[AutoEnrollMethods] = new Set();
+    state[InSchema] = true;
 
     // Determine auto enrol methods
     for (const item of state.getDecoratorList(node)) {
       if (item.targets?.includes('@travetto/schema:Schema')) {
-        for (const option of item.options ?? []) {
-          state[AutoEnrollMethods].add(option);
+        state[IsOptIn] ||= item.options?.includes('opt-in') ?? false;
+        const methodEnrolls = item.options?.filter(item => item.startsWith('method:'))?.map(item => item.replace('method:', '')) ?? [];
+        for (const method of methodEnrolls) {
+          state[AutoEnrollMethods].add(method);
         }
       }
     }
@@ -117,8 +126,10 @@ export class SchemaTransformer {
       params = [...params, state.fromLiteral(attrs)];
     }
 
-    delete state[InSchemaSymbol];
+    delete state[InSchema];
+    delete state[IsOptIn];
     delete state[AccessorsSymbol];
+    delete state[AutoEnrollMethods];
 
     return state.factory.updateClassDeclaration(
       node,
@@ -138,7 +149,9 @@ export class SchemaTransformer {
   @OnMethod()
   @OnStaticMethod()
   static processSchemaMethod(state: TransformerState & AutoState, node: ts.MethodDeclaration): ts.MethodDeclaration {
-    if (this.isInvisible(state, node) && !state[AutoEnrollMethods]?.has(node.name.getText())) {
+    if (
+      this.isInvisible(state, node, node.modifiers?.some(m => m.kind === ts.SyntaxKind.StaticKeyword)) &&
+      !state[AutoEnrollMethods]?.has(node.name.getText())) {
       return node;
     }