@travetto/schema 3.1.0-rc.4 → 3.1.0-rc.6

package/README.md

@@ -81,6 +81,8 @@ This schema provides a powerful base for data binding and validation at runtime.
    *  [@LongText](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L91) same as text, but expects longer form content
    *  [@Readonly](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L58) 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#L52) 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#L64) 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#L206) attributes additional specifiers to a field, allowing for more specification beyond just the field's 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

package/package.json

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

package/src/decorator/field.ts

@@ -44,12 +44,6 @@ export function Field(type: ClassList, ...config: Partial<FieldConfig>[]) {
  * @augments `@travetto/schema:Field`
  */
 export function Alias(...aliases: string[]): PropType<unknown> { return prop({ aliases }); }
-/**
- * Specifier for the field
- * @param specifier The specifier for a field
- * @augments `@travetto/schema:Field`
- */
-export function Specifier(specifier: string): PropType<unknown> { return prop({ specifier }); }
 /**
  * Mark a field as writeonly
  * @param active This determines if this field is readonly or not.
@@ -89,12 +83,12 @@ export function Enum(values: string[], message?: string): PropType<string | numb
  * Mark the field as indicating it's storing textual data
  * @augments `@travetto/schema:Field`
  */
-export function Text(): PropType<string | string[]> { return prop({ specifier: 'text' }); }
+export function Text(): PropType<string | string[]> { return prop({ specifiers: ['text'] }); }
 /**
  * Mark the field to indicate it's for long form text
  * @augments `@travetto/schema:Field`
  */
-export function LongText(): PropType<string | string[]> { return prop({ specifier: 'text-long' }); }
+export function LongText(): PropType<string | string[]> { return prop({ specifiers: ['text', 'long'] }); }
 
 /**
  * Require the field to match a specific RegExp
@@ -203,3 +197,10 @@ export function Currency(): PropType<number> { return Precision(13, 2); }
 export function Ignore(): PropertyDecorator {
   return (target: Object, property: string | symbol) => { };
 }
+
+/**
+ * Specifier for the field
+ * @param specifiers The specifiers for a field
+ * @augments `@travetto/schema:Field`
+ */
+export function Specifier(...specifiers: string[]): PropType<unknown> { return prop({ specifiers }); }

package/src/service/registry.ts

@@ -253,6 +253,14 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
   registerPendingParamFacet(target: Class, method: string, idx: number, config: Partial<FieldConfig>): Class {
     const methods = this.getOrCreatePending(target)!.methods!;
     const params = (methods[method] ??= []);
+
+    if (config.aliases) {
+      config.aliases = [...params[idx]?.aliases ?? [], ...config.aliases];
+    }
+    if (config.specifiers) {
+      config.specifiers = [...params[idx]?.specifiers ?? [], ...config.specifiers];
+    }
+
     params[idx] = {
       // @ts-expect-error
       name: `${method}.${idx}`,
@@ -279,6 +287,12 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       allViewConf.schema[prop] = {} as FieldConfig;
     }
+    if (config.aliases) {
+      config.aliases = [...allViewConf.schema[prop].aliases ?? [], ...config.aliases];
+    }
+    if (config.specifiers) {
+      config.specifiers = [...allViewConf.schema[prop].specifiers ?? [], ...config.specifiers];
+    }
 
     Object.assign(allViewConf.schema[prop], config);
 

package/src/service/types.ts

@@ -115,7 +115,7 @@ export interface FieldConfig extends DescribableConfig {
   /**
    * Does the field have a specialization
    */
-  specifier?: string;
+  specifiers?: string[];
   /**
    * The numeric precision
    */

package/support/transform-util.ts

@@ -13,7 +13,7 @@ export class SchemaTransformUtil {
   static toConcreteType(state: TransformerState, type: AnyType, node: ts.Node, root: ts.Node = node): ts.Expression {
     switch (type.key) {
       case 'pointer': return this.toConcreteType(state, type.target, node, root);
-      case 'external': return state.getOrImport(type);
+      case 'managed': return state.getOrImport(type);
       case 'tuple': return state.fromLiteral(type.subTypes.map(x => this.toConcreteType(state, x, node, root)!));
       case 'literal': {
         if ((type.ctor === Array) && type.typeArguments?.length) {
@@ -60,6 +60,7 @@ export class SchemaTransformUtil {
         }
         break;
       }
+      case 'foreign':
       case 'unknown':
       default: {
         // Object
@@ -148,7 +149,7 @@ export class SchemaTransformUtil {
       if (args.length > 0) {
         params.push(args[0]);
       }
-      params.push(state.extendObjectLiteral(state.factory.createObjectLiteralExpression(attrs)));
+      params.push(state.factory.createObjectLiteralExpression(attrs));
       if (args.length > 1) {
         params.push(...args.slice(1));
       }
@@ -208,7 +209,7 @@ export class SchemaTransformUtil {
   static ensureType(state: TransformerState, anyType: AnyType, target: ts.Node): Record<string, unknown> {
     const { out, type } = this.unwrapType(anyType);
     switch (type?.key) {
-      case 'external': out.type = state.typeToIdentifier(type); break;
+      case 'managed': out.type = state.typeToIdentifier(type); break;
       case 'shape': out.type = SchemaTransformUtil.toConcreteType(state, type, target); break;
       case 'literal': {
         if (type.ctor) {
@@ -233,7 +234,7 @@ export class SchemaTransformUtil {
     const { type } = this.unwrapType(state.resolveReturnType(node));
     let cls;
     switch (type?.key) {
-      case 'external': {
+      case 'managed': {
         const [dec] = DeclarationUtil.getDeclarations(type.original!);
         cls = dec && ts.isClassDeclaration(dec) ? dec : undefined;
         break;