@travetto/schema 2.2.2 → 3.0.0-rc.0

package/README.md

@@ -185,7 +185,7 @@ export async function validate(): Promise<void> {
 
   const person = Person.from({
     name: 'Test',
-    // @ts-ignore
+    // @ts-expect-error
     age: 'abc',
     address: {
       street1: '1234 Fun'
@@ -284,96 +284,6 @@ export interface ValidationError {
 }
 ```
 
-## Extension - Generation
-In the course of application development, there is often a need to generate fake data on demand. Given all the information that we have about the schemas provided, translating that into data generation is fairly straightforward.  The generation utility is built upon [faker](https://github.com/marak/Faker.js/), mapping data types, and various field names into specific [faker](https://github.com/marak/Faker.js/) generation routines.
-
-By default all types are mapped as-is:
-
-   
-   *  `string`
-   *  `number`
-   *  `Date`
-   *  `boolean`
-   *  Enumerations as `string` or `number` types.
-   *  Provided regular expressions:    
-      *  email
-      *  url
-      *  telephone
-      *  postalCode
-   *  Sub-schemas as registered via [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L12) decorators.
-
-In addition to the general types, the code relies upon name matching to provide additional refinement:
-
-**Code: Supported Mappings**
-```typescript
-static #namesToType: {
-    string: [RegExp, () => string][];
-    date: [RegExp, () => Date][];
-  } = {
-      string: [
-        [/^(image|img).*url$/, (): string => faker.image.imageUrl()],
-        [/^url$/, (): string => faker.internet.url()],
-        [/^email(addr(ress)?)?$/, (): string => faker.internet.email()],
-        [/^(tele)?phone(num|number)?$/, (): string => faker.phone.phoneNumber()],
-        [/^((postal|zip)code)|zip$/, (): string => faker.address.zipCode()],
-        [/f(irst)?name/, (): string => faker.name.firstName()],
-        [/l(ast)?name/, (): string => faker.name.lastName()],
-        [/^ip(add(ress)?)?$/, (): string => faker.internet.ip()],
-        [/^ip(add(ress)?)?(v?)6$/, (): string => faker.internet.ipv6()],
-        [/^username$/, (): string => faker.internet.userName()],
-        [/^domain(name)?$/, (): string => faker.internet.domainName()],
-        [/^file(path|name)?$/, (): string => faker.system.filePath()],
-        [/^street(1)?$/, (): string => faker.address.streetAddress()],
-        [/^street2$/, (): string => faker.address.secondaryAddress()],
-        [/^county$/, (): string => faker.address.county()],
-        [/^country$/, (): string => faker.address.country()],
-        [/^state$/, (): string => faker.address.state()],
-        [/^lon(gitude)?$/, (): string => faker.address.longitude()],
-        [/^lat(itude)?$/, (): string => faker.address.latitude()],
-        [/(profile).*(image|img)/, (): string => faker.image.avatar()],
-        [/(image|img)/, (): string => faker.image.image()],
-        [/^company(name)?$/, (): string => faker.company.companyName()],
-        [/(desc|description)$/, (): string => faker.lorem.sentences(10)]
-      ],
-      date: [
-        [/dob|birth/, (): Date => faker.date.past(60)],
-        [/creat(e|ion)/, (): Date => between(-200, -100)],
-        [/(update|modif(y|ied))/, (): Date => between(-100, -50)]
-      ],
-    };
-```
-
-An example of this would be:
-
-**Code: More complex Schema, used with Faker**
-```typescript
-import { Schema, SchemaFakerUtil } from '@travetto/schema';
-
-@Schema()
-class Address {
-  street1: string;
-  street2?: string;
-  city: string;
-  state: string;
-  country: string;
-}
-
-@Schema()
-class User {
-  fName: string;
-  lName: string;
-  email: string;
-  phone: string;
-  dob?: Date;
-  address: Address;
-}
-
-export function generate(): User {
-  const user = SchemaFakerUtil.generate(User);
-  return user;
-}
-```
-
 ## Custom Types
 When working with the schema, the basic types are easily understood, but some of [Typescript](https://typescriptlang.org)'s more complex constructs are too complex to automate cleanly.
 

package/index.ts

@@ -12,6 +12,4 @@ export * from './src/validate/validator';
 export * from './src/validate/error';
 export * from './src/validate/types';
 export * from './src/bind-util';
-export * from './src/types';
-// Named export needed for proxying
-export { SchemaFakerUtil } from './src/extension/faker';
+export * from './src/types';

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@travetto/schema",
   "displayName": "Schema",
-  "version": "2.2.2",
+  "version": "3.0.0-rc.0",
   "description": "Data type registry for runtime validation, reflection and binding. ",
   "keywords": [
     "schema",
     "ast-transformations",
     "validation",
-    "faker",
     "typescript",
     "travetto",
     "decorators"
@@ -29,12 +28,8 @@
     "directory": "module/schema"
   },
   "dependencies": {
-    "@travetto/registry": "^2.2.2",
-    "@travetto/transformer": "^2.2.2"
-  },
-  "optionalPeerDependencies": {
-    "@types/faker": "^5.5.9",
-    "faker": "^5.5.3"
+    "@travetto/registry": "^3.0.0-rc.0",
+    "@travetto/transformer": "^3.0.0-rc.0"
   },
   "publishConfig": {
     "access": "public"

package/src/bind-util.ts

@@ -157,13 +157,13 @@ export class BindUtil {
       return data as T;
     } else {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const tgt = new (cls as ConcreteClass<T>)();
-      SchemaRegistry.ensureInstanceTypeField(cls, tgt);
+      const tgt = new (cls as ConcreteClass<T>)() as T;
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      SchemaRegistry.ensureInstanceTypeField(cls, tgt as T & { type?: string });
 
-      for (const [k, v] of Object.entries(tgt)) { // Do not retain undefined fields
-        if (v === undefined) {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          delete tgt[k as keyof T];
+      for (const k of Object.keys(tgt)) { // Do not retain undefined fields
+        if (tgt[k] === undefined) {
+          delete tgt[k];
         }
       }
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions

package/src/service/registry.ts

@@ -1,4 +1,4 @@
-import { Class, AppError, Util, ClassInstance } from '@travetto/base';
+import { Class, AppError, Util, ClassInstance, ConcreteClass } from '@travetto/base';
 import { MetadataRegistry, RootRegistry, ChangeEvent } from '@travetto/registry';
 
 import { ClassList, FieldConfig, ClassConfig, SchemaConfig, ViewFieldsConfig, ViewConfig } from './types';
@@ -11,6 +11,16 @@ function hasType<T>(o: unknown): o is { type: Class<T> | string } {
   return !!o && !Util.isPrimitive(o) && 'type' in (o as object) && !!(o as Record<string, string>)['type'];
 }
 
+function isWithType<T>(o: T, cfg: ClassConfig | undefined): o is T & { type?: string } {
+  return !!cfg && !!cfg.subType && 'type' in cfg.views[AllViewⲐ].schema;
+}
+
+function getConstructor<T>(o: T): ConcreteClass<T> {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return (o as unknown as ClassInstance<T>).constructor;
+}
+
+
 /**
  * Schema registry for listening to changes
  */
@@ -49,9 +59,8 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * Ensure type is set properly
    */
   ensureInstanceTypeField<T>(cls: Class, o: T): void {
-    const withType: { type?: string } = o;
-    if (this.get(cls)?.subType && 'type' in this.get(cls).views[AllViewⲐ].schema && !withType.type) {  // Do we have a type field defined
-      withType.type = this.#computeSubTypeName(cls); // Assign if missing
+    if (isWithType(o, this.get(cls)) && !o.type) {  // Do we have a type field defined
+      o.type = this.#computeSubTypeName(cls); // Assign if missing
     }
   }
 
@@ -61,8 +70,7 @@ class $SchemaRegistry extends MetadataRegistry<ClassConfig, FieldConfig> {
    * @param o Actual instance
    */
   resolveSubTypeForInstance<T>(cls: Class<T>, o: T): Class {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return this.resolveSubType(cls, hasType<T>(o) ? o.type : (o as unknown as ClassInstance<T>).constructor);
+    return this.resolveSubType(cls, hasType<T>(o) ? o.type : getConstructor(o));
   }
 
   /**

package/src/validate/validator.ts

@@ -38,7 +38,7 @@ export class SchemaValidator {
   static #validateSchema<T>(schema: SchemaConfig, o: T, relative: string): ValidationError[] {
     let errors: ValidationError[] = [];
 
-    const fields: (keyof SchemaConfig)[] = Object.keys(schema);
+    const fields = Object.keys<SchemaConfig>(schema);
     for (const field of fields) {
       if (schema[field].access !== 'readonly') { // Do not validate readonly fields
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -104,10 +104,7 @@ export class SchemaValidator {
    * @param key The bounds to check
    * @param value The value to validate
    */
-  static #validateRange(field: FieldConfig, key: 'min' | 'max', rawValue: string | number | Date | unknown): boolean {
-
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    let value = rawValue as string | number | Date;
+  static #validateRange(field: FieldConfig, key: 'min' | 'max', value: string | number | Date): boolean {
 
     const f = field[key]!;
     if (typeof f.n === 'number') {
@@ -178,11 +175,13 @@ export class SchemaValidator {
       criteria.push(['enum', field.enum]);
     }
 
-    if (field.min && this.#validateRange(field, 'min', value)) {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    if (field.min && this.#validateRange(field, 'min', value as number)) {
       criteria.push(['min', field.min]);
     }
 
-    if (field.max && this.#validateRange(field, 'max', value)) {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    if (field.max && this.#validateRange(field, 'max', value as number)) {
       criteria.push(['max', field.max]);
     }
 

package/src/extension/faker.ts

@@ -1,223 +0,0 @@
-// @file-if faker
-import * as fakerType from 'faker';
-
-import { Class } from '@travetto/base';
-
-import { CommonRegExp } from '../validate/regexp';
-import { FieldConfig } from '../service/types';
-import { SchemaRegistry } from '../service/registry';
-import { BindUtil } from '../bind-util';
-
-// Load faker on demand, as its very heavy in loading
-let faker: typeof fakerType = new Proxy(
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-  {} as typeof fakerType,
-  {
-    get: (t, prop, r) => (faker = require('faker'))[prop]
-  });
-
-const DAY_IN_MS = 24 * 60 * 60 * 1000;
-
-const between = (fromDays: number, toDays: number): Date =>
-  faker.date.between(
-    new Date(Date.now() + fromDays * DAY_IN_MS),
-    new Date(Date.now() + toDays * DAY_IN_MS)
-  );
-
-/**
- * Provide a faker utility for generating content
- */
-export class SchemaFakerUtil {
-
-  static #stringToReType: [RegExp, () => string][] = [
-    [CommonRegExp.email, (): string => faker.internet.email()],
-    [CommonRegExp.url, (): string => faker.internet.url()],
-    [CommonRegExp.telephone, (): string => faker.phone.phoneNumber()],
-    [CommonRegExp.postalCode, (): string => faker.address.zipCode()]
-  ];
-
-  /**
-   * Mapping of field types to faker utils
-   */
-  static #namesToType: {
-    string: [RegExp, () => string][];
-    date: [RegExp, () => Date][];
-  } = {
-      string: [
-        [/^(image|img).*url$/, (): string => faker.image.imageUrl()],
-        [/^url$/, (): string => faker.internet.url()],
-        [/^email(addr(ress)?)?$/, (): string => faker.internet.email()],
-        [/^(tele)?phone(num|number)?$/, (): string => faker.phone.phoneNumber()],
-        [/^((postal|zip)code)|zip$/, (): string => faker.address.zipCode()],
-        [/f(irst)?name/, (): string => faker.name.firstName()],
-        [/l(ast)?name/, (): string => faker.name.lastName()],
-        [/^ip(add(ress)?)?$/, (): string => faker.internet.ip()],
-        [/^ip(add(ress)?)?(v?)6$/, (): string => faker.internet.ipv6()],
-        [/^username$/, (): string => faker.internet.userName()],
-        [/^domain(name)?$/, (): string => faker.internet.domainName()],
-        [/^file(path|name)?$/, (): string => faker.system.filePath()],
-        [/^street(1)?$/, (): string => faker.address.streetAddress()],
-        [/^street2$/, (): string => faker.address.secondaryAddress()],
-        [/^county$/, (): string => faker.address.county()],
-        [/^country$/, (): string => faker.address.country()],
-        [/^state$/, (): string => faker.address.state()],
-        [/^lon(gitude)?$/, (): string => faker.address.longitude()],
-        [/^lat(itude)?$/, (): string => faker.address.latitude()],
-        [/(profile).*(image|img)/, (): string => faker.image.avatar()],
-        [/(image|img)/, (): string => faker.image.image()],
-        [/^company(name)?$/, (): string => faker.company.companyName()],
-        [/(desc|description)$/, (): string => faker.lorem.sentences(10)]
-      ],
-      date: [
-        [/dob|birth/, (): Date => faker.date.past(60)],
-        [/creat(e|ion)/, (): Date => between(-200, -100)],
-        [/(update|modif(y|ied))/, (): Date => between(-100, -50)]
-      ],
-    };
-
-  /**
-   * Get an array of values
-   * @param cfg Field configuration
-   */
-  static getArrayValue(cfg: FieldConfig): unknown[] {
-    const min = cfg.minlength ? cfg.minlength.n : 0;
-    const max = cfg.maxlength ? cfg.maxlength.n : 10;
-    const size = faker.datatype.number({ min, max });
-    const out = [];
-    for (let i = 0; i < size; i++) {
-      out.push(this.getValue(cfg, true));
-    }
-    return out;
-  }
-
-  /**
-   * Get a new number value
-   * @param cfg Number config
-   */
-  static getNumberValue(cfg: FieldConfig): number {
-    let min = cfg.min && typeof cfg.min.n === 'number' ? cfg.min.n : undefined;
-    let max = cfg.max && typeof cfg.max.n === 'number' ? cfg.max.n : undefined;
-    let precision = cfg.precision;
-
-    const name = cfg.name.toUpperCase();
-
-    if (/(price|amt|amount)$/.test(name)) {
-      precision = [13, 2];
-    }
-
-    let offset = 1;
-
-    if (precision !== undefined) {
-      min = min === undefined ? -((10 ** precision[0]) - 1) : min;
-      max = max === undefined ? ((10 ** precision[0]) - 1) : max;
-      if (precision[1] !== undefined) {
-        offset = (10 ** (precision[1] || 0));
-      }
-    }
-
-    max = max === undefined ? 1000 : max;
-    min = min === undefined ? 0 : min;
-
-    const range = (max - min) * offset;
-
-    const val = Math.trunc(Math.random() * range);
-
-    return (val / offset) + min;
-  }
-
-  /**
-   * Get a date value
-   * @param cfg Field config
-   */
-  static getDateValue(cfg: FieldConfig): Date {
-    const name = cfg.name.toUpperCase();
-    const min = cfg.min && typeof cfg.min.n !== 'number' ? cfg.min.n : undefined;
-    const max = cfg.max && typeof cfg.max.n !== 'number' ? cfg.max.n : undefined;
-
-    if (min !== undefined || max !== undefined) {
-      return faker.date.between(min || new Date(Date.now() - (50 * DAY_IN_MS)), max || new Date());
-    } else {
-      for (const [re, fn] of this.#namesToType.date) {
-        if (re.test(name)) {
-          return fn();
-        }
-      }
-      return faker.date.recent(50);
-    }
-  }
-
-  /**
-   * Get a string value
-   * @param cfg Field config
-   */
-  static getStringValue(cfg: FieldConfig): string {
-    const name = cfg.name.toLowerCase();
-
-    if (cfg.match) {
-      const mre = cfg.match && cfg.match.re;
-      for (const [re, fn] of this.#stringToReType) {
-        if (mre === re) {
-          return fn();
-        }
-      }
-    }
-
-    for (const [re, fn] of this.#namesToType.string) {
-      if (re.test(name)) {
-        return fn();
-      }
-    }
-
-    return faker.random.word();
-  }
-
-  /**
-   * Get a value for a field config
-   * @param cfg Field config
-   */
-  static getValue(cfg: FieldConfig, subArray = false): unknown {
-    if (!subArray && cfg.array) {
-      return this.getArrayValue(cfg);
-    } else if (cfg.enum) {
-      return faker.random.arrayElement(cfg.enum.values);
-    } else {
-
-      const typ = cfg.type;
-
-      if (typ === Number) {
-        return this.getNumberValue(cfg);
-      } else if (typ === String) {
-        return this.getStringValue(cfg);
-      } else if (typ === Date) {
-        return this.getDateValue(cfg);
-      } else if (typ === Boolean) {
-        return faker.datatype.boolean();
-      } else if (SchemaRegistry.has(typ)) {
-        return this.generate(typ);
-      }
-    }
-  }
-
-  /**
-   * Generate a new instance of a class
-   * @param cls The class to get an instance of
-   * @param view The view to define specifically
-   */
-  static generate<T>(cls: Class<T>, view?: string): T {
-    const cfg = SchemaRegistry.getViewSchema(cls, view);
-    const out: Record<string, unknown> = {};
-
-    for (const f of cfg.fields) {
-      if (f === 'type' || f === 'id') { // Do not set primary fields
-        continue;
-      }
-      const fieldConfig = cfg.schema[f];
-      if (!fieldConfig.required && (Math.random() < .5)) {
-        continue;
-      }
-      out[f] = this.getValue(fieldConfig);
-    }
-
-    return BindUtil.bindSchema(cls, out, view);
-  }
-}