@travetto/schema 7.0.0-rc.0 → 7.0.0-rc.2

package/src/service/registry-adapter.ts

@@ -8,13 +8,13 @@ import {
 } from './types';
 
 const classToDiscriminatedType = (cls: Class): string => cls.name
-  .replace(/([A-Z])([A-Z][a-z])/g, (all, l, r) => `${l}_${r.toLowerCase()}`)
-  .replace(/([a-z]|\b)([A-Z])/g, (all, l, r) => l ? `${l}_${r.toLowerCase()}` : r.toLowerCase())
+  .replace(/([A-Z])([A-Z][a-z])/g, (all, left, right) => `${left}_${right.toLowerCase()}`)
+  .replace(/([a-z]|\b)([A-Z])/g, (all, left, right) => left ? `${left}_${right.toLowerCase()}` : right.toLowerCase())
   .toLowerCase();
 
 function assignMetadata<T>(key: symbol, base: SchemaCoreConfig, data: Partial<T>[]): T {
-  const md = base.metadata ??= {};
-  const out = md[key] ??= {};
+  const metadata = base.metadata ??= {};
+  const out = metadata[key] ??= {};
   for (const d of data) {
     safeAssign(out, d);
   }
@@ -92,8 +92,8 @@ function combineClassWithParent<T extends SchemaClassConfig>(base: T, parent: T)
     case 'Required':
     case 'Partial': {
       base.fields = Object.fromEntries(
-        Object.entries(base.fields).map(([k, v]) => [k, {
-          ...v,
+        Object.entries(parent.fields).map(([key, value]) => [key, {
+          ...value,
           required: {
             active: base.mappedOperation === 'Required'
           }
@@ -105,8 +105,8 @@ function combineClassWithParent<T extends SchemaClassConfig>(base: T, parent: T)
     case 'Omit': {
       const keys = new Set<string>(base.mappedFields ?? []);
       base.fields = Object.fromEntries(
-        Object.entries(parent.fields).filter(([k]) =>
-          base.mappedOperation === 'Pick' ? keys.has(k) : !keys.has(k)
+        Object.entries(parent.fields).filter(([key]) =>
+          base.mappedOperation === 'Pick' ? keys.has(key) : !keys.has(key)
         )
       );
       break;
@@ -145,7 +145,7 @@ export class SchemaRegistryAdapter implements RegistryAdapter<SchemaClassConfig>
   }
 
   register(...data: Partial<SchemaClassConfig>[]): SchemaClassConfig {
-    const cfg = this.#config ??= {
+    const config = this.#config ??= {
       methods: {},
       class: this.#cls,
       views: {},
@@ -153,38 +153,38 @@ export class SchemaRegistryAdapter implements RegistryAdapter<SchemaClassConfig>
       interfaces: [],
       fields: {},
     };
-    return combineClasses(cfg, data);
+    return combineClasses(config, data);
   }
 
   registerMetadata<T>(key: symbol, ...data: Partial<T>[]): T {
-    const cfg = this.register({});
-    return assignMetadata(key, cfg, data);
+    const config = this.register({});
+    return assignMetadata(key, config, data);
   }
 
   getMetadata<T>(key: symbol): T | undefined {
-    const md = this.#config?.metadata;
-    return castTo<T>(md?.[key]);
+    const metadata = this.#config?.metadata;
+    return castTo<T>(metadata?.[key]);
   }
 
-  registerField(field: string | symbol, ...data: Partial<SchemaFieldConfig>[]): SchemaFieldConfig {
-    const config = this.register({});
-    const cfg = config.fields[field] ??= { name: field, owner: this.#cls, type: null! };
-    const combined = combineInputs(cfg, data);
+  registerField(field: string, ...data: Partial<SchemaFieldConfig>[]): SchemaFieldConfig {
+    const classConfig = this.register({});
+    const config = classConfig.fields[field] ??= { name: field, owner: this.#cls, type: null! };
+    const combined = combineInputs(config, data);
     return combined;
   }
 
-  registerFieldMetadata<T>(field: string | symbol, key: symbol, ...data: Partial<T>[]): T {
-    const cfg = this.registerField(field);
-    return assignMetadata(key, cfg, data);
+  registerFieldMetadata<T>(field: string, key: symbol, ...data: Partial<T>[]): T {
+    const config = this.registerField(field);
+    return assignMetadata(key, config, data);
   }
 
-  getFieldMetadata<T>(field: string | symbol, key: symbol): T | undefined {
-    const md = this.#config?.fields[field]?.metadata;
-    return castTo<T>(md?.[key]);
+  getFieldMetadata<T>(field: string, key: symbol): T | undefined {
+    const metadata = this.#config?.fields[field]?.metadata;
+    return castTo<T>(metadata?.[key]);
   }
 
-  registerClass({ methods, ...cfg }: Partial<SchemaClassConfig> = {}): SchemaClassConfig {
-    this.register({ ...cfg });
+  registerClass({ methods, ...config }: Partial<SchemaClassConfig> = {}): SchemaClassConfig {
+    this.register({ ...config });
     if (methods?.[CONSTRUCTOR_PROPERTY]) {
       const { parameters, ...rest } = methods[CONSTRUCTOR_PROPERTY];
       this.registerMethod(CONSTRUCTOR_PROPERTY, rest);
@@ -195,36 +195,36 @@ export class SchemaRegistryAdapter implements RegistryAdapter<SchemaClassConfig>
     return this.#config;
   }
 
-  registerMethod(method: string | symbol, ...data: Partial<SchemaMethodConfig>[]): SchemaMethodConfig {
-    const config = this.register();
-    const cfg = config.methods[method] ??= { parameters: [], validators: [] };
-    return combineMethods(cfg, data);
+  registerMethod(method: string, ...data: Partial<SchemaMethodConfig>[]): SchemaMethodConfig {
+    const classConfig = this.register();
+    const config = classConfig.methods[method] ??= { parameters: [], validators: [] };
+    return combineMethods(config, data);
   }
 
-  registerMethodMetadata<T>(method: string | symbol, key: symbol, ...data: Partial<T>[]): T {
-    const cfg = this.registerMethod(method);
-    return assignMetadata(key, cfg, data);
+  registerMethodMetadata<T>(method: string, key: symbol, ...data: Partial<T>[]): T {
+    const config = this.registerMethod(method);
+    return assignMetadata(key, config, data);
   }
 
-  getMethodMetadata<T>(method: string | symbol, key: symbol): T | undefined {
-    const md = this.#config?.methods[method]?.metadata;
-    return castTo<T>(md?.[key]);
+  getMethodMetadata<T>(method: string, key: symbol): T | undefined {
+    const metadata = this.#config?.methods[method]?.metadata;
+    return castTo<T>(metadata?.[key]);
   }
 
-  registerParameter(method: string | symbol, idx: number, ...data: Partial<SchemaParameterConfig>[]): SchemaParameterConfig {
+  registerParameter(method: string, idx: number, ...data: Partial<SchemaParameterConfig>[]): SchemaParameterConfig {
     const params = this.registerMethod(method, {}).parameters;
-    const cfg = params[idx] ??= { method, index: idx, owner: this.#cls, array: false, type: null! };
-    return combineInputs(cfg, data);
+    const config = params[idx] ??= { method, index: idx, owner: this.#cls, array: false, type: null! };
+    return combineInputs(config, data);
   }
 
-  registerParameterMetadata<T>(method: string | symbol, idx: number, key: symbol, ...data: Partial<T>[]): T {
-    const cfg = this.registerParameter(method, idx);
-    return assignMetadata(key, cfg, data);
+  registerParameterMetadata<T>(method: string, idx: number, key: symbol, ...data: Partial<T>[]): T {
+    const config = this.registerParameter(method, idx);
+    return assignMetadata(key, config, data);
   }
 
-  getParameterMetadata<T>(method: string | symbol, idx: number, key: symbol): T | undefined {
-    const md = this.#config?.methods[method]?.parameters[idx]?.metadata;
-    return castTo<T>(md?.[key]);
+  getParameterMetadata<T>(method: string, idx: number, key: symbol): T | undefined {
+    const metadata = this.#config?.methods[method]?.parameters[idx]?.metadata;
+    return castTo<T>(metadata?.[key]);
   }
 
   finalize(parent?: SchemaClassConfig): void {
@@ -256,13 +256,13 @@ export class SchemaRegistryAdapter implements RegistryAdapter<SchemaClassConfig>
       const fields = config.views[view];
       const withoutSet = 'without' in fields ? new Set<string>(fields.without) : undefined;
       const fieldList = withoutSet ?
-        Object.keys(config.fields).filter(x => !withoutSet.has(x)) :
+        Object.keys(config.fields).filter(field => !withoutSet.has(field)) :
         ('with' in fields ? fields.with : []);
 
       this.#views.set(view,
-        fieldList.reduce<SchemaFieldMap>((acc, v) => {
-          acc[v] = config.fields[v];
-          return acc;
+        fieldList.reduce<SchemaFieldMap>((map, value) => {
+          map[value] = config.fields[value];
+          return map;
         }, {})
       );
     }
@@ -278,23 +278,23 @@ export class SchemaRegistryAdapter implements RegistryAdapter<SchemaClassConfig>
     return this.#config;
   }
 
-  getField(field: string | symbol): SchemaFieldConfig {
+  getField(field: string): SchemaFieldConfig {
     return this.#config.fields[field];
   }
 
-  getMethod(method: string | symbol): SchemaMethodConfig {
-    const res = this.#config.methods[method];
-    if (!res) {
+  getMethod(method: string): SchemaMethodConfig {
+    const methodConfig = this.#config.methods[method];
+    if (!methodConfig) {
       throw new AppError(`Unknown method ${String(method)} on class ${this.#cls.Ⲑid}`);
     }
-    return res;
+    return methodConfig;
   }
 
-  getMethodReturnType(method: string | symbol): Class {
+  getMethodReturnType(method: string): Class {
     return this.getMethod(method).returnType!.type;
   }
 
-  getSchema(view?: string): SchemaFieldMap {
+  getFields(view?: string): SchemaFieldMap {
     if (!view) {
       return this.#config.fields;
     }
@@ -321,13 +321,13 @@ export class SchemaRegistryAdapter implements RegistryAdapter<SchemaClassConfig>
   /**
    * Ensure type is set properly
    */
-  ensureInstanceTypeField<T>(o: T): T {
+  ensureInstanceTypeField<T>(value: T): T {
     const config = this.getDiscriminatedConfig();
     if (config) {
       const typeField = castKey<T>(config.discriminatedField);
-      o[typeField] ??= castTo(config.discriminatedType); // Assign if missing
+      value[typeField] ??= castTo(config.discriminatedType); // Assign if missing
     }
-    return o;
+    return value;
   }
 
   getDiscriminatedConfig(): Required<Pick<SchemaClassConfig, 'discriminatedType' | 'discriminatedField' | 'discriminatedBase'>> | undefined {

package/src/service/registry-index.ts

@@ -1,7 +1,7 @@
 import { ChangeEvent, RegistrationMethods, RegistryIndex, RegistryIndexStore, Registry } from '@travetto/registry';
 import { AppError, castKey, castTo, Class, classConstruct, getParentClass, Util } from '@travetto/runtime';
 
-import { SchemaFieldConfig, SchemaClassConfig, SchemaFieldMap, SchemaMethodConfig } from './types.ts';
+import { SchemaFieldConfig, SchemaClassConfig } from './types.ts';
 import { SchemaRegistryAdapter } from './registry-adapter.ts';
 import { SchemaChangeListener } from './changes.ts';
 
@@ -24,14 +24,6 @@ export class SchemaRegistryIndex implements RegistryIndex {
     return this.#instance.store.get(cls).getDiscriminatedConfig();
   }
 
-  static getFieldMap(cls: Class, view?: string): SchemaFieldMap {
-    return this.#instance.store.get(cls).getSchema(view);
-  }
-
-  static getMethodConfig(cls: Class, method: string | symbol): SchemaMethodConfig {
-    return this.#instance.store.get(cls).getMethod(method);
-  }
-
   static has(cls: Class): boolean {
     return this.#instance.store.has(cls);
   }
@@ -44,8 +36,8 @@ export class SchemaRegistryIndex implements RegistryIndex {
     return this.#instance.getDiscriminatedTypes(cls);
   }
 
-  static resolveInstanceType<T>(cls: Class<T>, o: T): Class {
-    return this.#instance.resolveInstanceType(cls, o);
+  static resolveInstanceType<T>(cls: Class<T>, item: T): Class {
+    return this.#instance.resolveInstanceType(cls, item);
   }
 
   static visitFields<T>(cls: Class<T>, onField: (field: SchemaFieldConfig, path: SchemaFieldConfig[]) => void): void {
@@ -64,8 +56,8 @@ export class SchemaRegistryIndex implements RegistryIndex {
     return this.#instance.store.get(cls);
   }
 
-  static getOptionalConfig(cls: Class): SchemaClassConfig | undefined {
-    return this.#instance.store.getOptional(cls)?.get();
+  static getOptional(cls: Class): Omit<SchemaRegistryAdapter, RegistrationMethods> | undefined {
+    return this.#instance.store.getOptional(cls);
   }
 
   static getClasses(): Class[] {
@@ -96,21 +88,21 @@ export class SchemaRegistryIndex implements RegistryIndex {
     Util.queueMacroTask().then(() => {
       SchemaChangeListener.emitFieldChanges({
         type: 'changed',
-        curr: this.getClassConfig(event.curr),
-        prev: this.getClassConfig(event.prev)
+        current: this.getClassConfig(event.current),
+        previous: this.getClassConfig(event.previous)
       });
     });
   }
 
   #onRemoving(event: ChangeEvent<Class> & { type: 'removing' }): void {
-    SchemaChangeListener.clearSchemaDependency(event.prev);
+    SchemaChangeListener.clearSchemaDependency(event.previous);
   }
 
   #onAdded(event: ChangeEvent<Class> & { type: 'added' }): void {
     Util.queueMacroTask().then(() => {
       SchemaChangeListener.emitFieldChanges({
         type: 'added',
-        curr: this.getClassConfig(event.curr)
+        current: this.getClassConfig(event.current)
       });
     });
   }
@@ -128,8 +120,8 @@ export class SchemaRegistryIndex implements RegistryIndex {
 
     // Rebuild indices after every "process" batch
     this.#byDiscriminatedTypes.clear();
-    for (const el of this.store.getClasses()) {
-      this.#registerDiscriminatedTypes(el);
+    for (const cls of this.store.getClasses()) {
+      this.#registerDiscriminatedTypes(cls);
     }
   }
 
@@ -142,15 +134,15 @@ export class SchemaRegistryIndex implements RegistryIndex {
    */
   getBaseClass(cls: Class): Class {
     if (!this.#baseSchema.has(cls)) {
-      let conf = this.getClassConfig(cls);
+      let config = this.getClassConfig(cls);
       let parent: Class | undefined = cls;
-      while (parent && conf.discriminatedType && !conf.discriminatedBase) {
+      while (parent && config.discriminatedType && !config.discriminatedBase) {
         parent = getParentClass(parent);
         if (parent) {
-          conf = this.store.getOptional(parent)?.get() ?? conf;
+          config = this.store.getOptional(parent)?.get() ?? config;
         }
       }
-      this.#baseSchema.set(cls, conf.class);
+      this.#baseSchema.set(cls, config.class);
     }
     return this.#baseSchema.get(cls)!;
   }
@@ -158,18 +150,16 @@ export class SchemaRegistryIndex implements RegistryIndex {
   /**
    * Find the resolved type for a given instance
    * @param cls Class for instance
-   * @param o Actual instance
+   * @param item Actual instance
    */
-  resolveInstanceType<T>(requestedCls: Class<T>, o: T): Class {
-    const cls = this.store.getClassById(requestedCls.Ⲑid); // Resolve by id to handle any stale references
-    const adapter = this.store.get(cls);
-    const { discriminatedField, discriminatedType } = adapter.get();
+  resolveInstanceType<T>(cls: Class<T>, item: T): Class {
+    const { discriminatedField, discriminatedType, class: targetClass } = this.store.get(cls).get();
     if (!discriminatedField) {
-      return cls;
+      return targetClass;
     } else {
-      const base = this.getBaseClass(cls);
+      const base = this.getBaseClass(targetClass);
       const map = this.#byDiscriminatedTypes.get(base);
-      const type = castTo<string>(o[castKey<T>(discriminatedField)]) ?? discriminatedType;
+      const type = castTo<string>(item[castKey<T>(discriminatedField)]) ?? discriminatedType;
       if (!type) {
         throw new AppError(`Unable to resolve discriminated type for class ${base.name} without a type`);
       }
@@ -177,8 +167,8 @@ export class SchemaRegistryIndex implements RegistryIndex {
         throw new AppError(`Unable to resolve discriminated type '${type}' for class ${base.name}`);
       }
       const requested = map.get(type)!;
-      if (!(classConstruct(requested) instanceof requestedCls)) {
-        throw new AppError(`Resolved discriminated type '${type}' for class ${base.name} is not an instance of requested type ${requestedCls.name}`);
+      if (!(classConstruct(requested) instanceof targetClass)) {
+        throw new AppError(`Resolved discriminated type '${type}' for class ${base.name} is not an instance of requested type ${targetClass.name}`);
       }
       return requested;
     }
@@ -187,13 +177,13 @@ export class SchemaRegistryIndex implements RegistryIndex {
   /**
    * Track changes to schemas, and track the dependent changes
    * @param cls The root class of the hierarchy
-   * @param curr The new class
+   * @param current The new class
    * @param path The path within the object hierarchy
    */
-  trackSchemaDependencies(cls: Class, curr: Class = cls, path: SchemaFieldConfig[] = []): void {
-    const config = this.getClassConfig(curr);
+  trackSchemaDependencies(cls: Class, current: Class = cls, path: SchemaFieldConfig[] = []): void {
+    const config = this.getClassConfig(current);
 
-    SchemaChangeListener.trackSchemaDependency(curr, cls, path, this.getClassConfig(cls));
+    SchemaChangeListener.trackSchemaDependency(current, cls, path, this.getClassConfig(cls));
 
     // Read children
     for (const field of Object.values(config.fields)) {

package/src/service/types.ts

@@ -3,7 +3,7 @@ import { Any, Class, Primitive } from '@travetto/runtime';
 import { MethodValidatorFn, ValidatorFn } from '../validate/types.ts';
 
 type TemplateLiteralPart = string | NumberConstructor | StringConstructor | BooleanConstructor;
-export type TemplateLiteral = { op: 'and' | 'or', values: (TemplateLiteralPart | TemplateLiteral)[] };
+export type TemplateLiteral = { operation: 'and' | 'or', values: (TemplateLiteralPart | TemplateLiteral)[] };
 
 export const CONSTRUCTOR_PROPERTY = 'CONSTRUCTOR';
 
@@ -83,7 +83,7 @@ export interface SchemaFieldMap {
   /**
    * List of all fields
    */
-  [key: string | symbol]: SchemaFieldConfig;
+  [key: string]: SchemaFieldConfig;
 }
 
 /**
@@ -121,7 +121,7 @@ export interface SchemaClassConfig extends SchemaCoreConfig {
   /**
    * Method configs
    */
-  methods: Record<string | symbol, SchemaMethodConfig>;
+  methods: Record<string, SchemaMethodConfig>;
   /**
    * Interfaces that the class implements
    */
@@ -209,7 +209,7 @@ export interface SchemaParameterConfig extends SchemaInputConfig {
   /**
    * Method the parameter belongs to
    */
-  method: string | symbol;
+  method: string;
   /**
    * Source text for the parameter
    */
@@ -223,7 +223,7 @@ export interface SchemaFieldConfig extends SchemaInputConfig {
   /**
    * Field name
    */
-  name: string | symbol;
+  name: string;
   /**
    * Is the field readonly, or write only?, defaults to no restrictions
    */

package/src/types.ts

@@ -3,6 +3,6 @@ export class UnknownType { }
 /**
  * Geometric Point as [number,number] with validation and binding support
  *
- * @concrete ./internal/types.ts#PointImpl
+ * @concrete ./internal/types.ts#PointImplementation
  */
 export type Point = [number, number];

package/src/validate/error.ts

@@ -22,6 +22,6 @@ export class TypeMismatchError extends AppError {
   }
 }
 
-export function isValidationError(err: unknown): err is ValidationError {
-  return !!err && err instanceof Error && 'path' in err;
+export function isValidationError(error: unknown): error is ValidationError {
+  return !!error && error instanceof Error && 'path' in error;
 }

package/src/validate/regexp.ts

@@ -15,8 +15,8 @@ export const CommonRegExp = {
 export const CommonRegExpToName = new Map<RegExp, string>();
 
 // Rebind regexes
-for (const k of TypedObject.keys(CommonRegExp)) {
-  const name = `[[:${k}:]]`;
-  CommonRegExpToName.set(CommonRegExp[k], name);
-  Messages.set(name, Messages.get(k)!);
+for (const key of TypedObject.keys(CommonRegExp)) {
+  const name = `[[:${key}:]]`;
+  CommonRegExpToName.set(CommonRegExp[key], name);
+  Messages.set(name, Messages.get(key)!);
 }