@travetto/schema-faker 8.0.0-alpha.8 → 8.0.0

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/schema-faker
 yarn add @travetto/schema-faker
 ```
 
-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/faker-js/faker), mapping data types, and various field names into specific [faker](https://github.com/faker-js/faker) generation routines. 
+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/faker-js/faker), mapping data types, and various field names into specific [faker](https://github.com/faker-js/faker) generation routines. 
 
 By default all types are mapped as-is:
    *  `string`
@@ -41,7 +41,7 @@ static #namesToType = {
       [/^email(addr(ress)?)?$/, faker.internet.email],
       [/^(tele)?phone(num|number)?$/, faker.phone.number],
       [/^((postal|zip)code)|zip$/, faker.location.zipCode],
-      [/f(irst)?name/, faker.person.firstName],
+      [/name|fname|firstName/i, faker.person.firstName],
       [/l(ast)?name/, faker.person.lastName],
       [/^ip(add(ress)?)?$/, faker.internet.ip],
       [/^ip(add(ress)?)?(v?)6$/, faker.internet.ipv6],
@@ -62,9 +62,9 @@ static #namesToType = {
     ]),
     date: new Map([
       [/dob|birth/, (): Date => faker.date.past({ years: 60 })],
-      [/creat(e|ion)/, this.#between.bind(null, -200, -100)],
-      [/(update|modif(y|ied))/, this.#between.bind(null, -100, -50)]
-    ]),
+      [/create|creation/, this.#between.bind(null, -200, -100)],
+      [/(update|modify|modified)/, this.#between.bind(null, -100, -50)]
+    ])
   };
 ```
 
@@ -72,8 +72,8 @@ An example of this would be:
 
 **Code: More complex Schema, used with Faker**
 ```typescript
-import { SchemaFaker } from '@travetto/schema-faker';
 import { Schema } from '@travetto/schema';
+import { SchemaFaker } from '@travetto/schema-faker';
 
 @Schema()
 class Address {

package/__index__.ts

@@ -1 +1 @@
-export * from './src/faker.ts';
+export * from './src/faker.ts';

package/package.json

@@ -1,38 +1,38 @@
 {
   "name": "@travetto/schema-faker",
-  "version": "8.0.0-alpha.8",
-  "type": "module",
+  "version": "8.0.0",
   "description": "Data generation for schema-registered objects.",
   "keywords": [
+    "decorators",
     "faker",
     "schema",
-    "typescript",
     "travetto",
-    "decorators"
+    "typescript"
   ],
   "homepage": "https://travetto.io",
   "license": "MIT",
   "author": {
-    "email": "travetto.framework@gmail.com",
-    "name": "Travetto Framework"
+    "name": "Travetto Framework",
+    "email": "travetto.framework@gmail.com"
+  },
+  "repository": {
+    "url": "git+https://github.com/travetto/travetto.git",
+    "directory": "module/schema-faker"
   },
   "files": [
     "__index__.ts",
     "src"
   ],
+  "type": "module",
   "main": "__index__.ts",
-  "repository": {
-    "url": "git+https://github.com/travetto/travetto.git",
-    "directory": "module/schema-faker"
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@faker-js/faker": "^10.3.0",
-    "@travetto/schema": "^8.0.0-alpha.8"
+    "@faker-js/faker": "^10.6.0",
+    "@travetto/schema": "^8.0.0"
   },
   "travetto": {
     "displayName": "Schema Faker"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/faker.ts

@@ -1,13 +1,12 @@
 import { faker } from '@faker-js/faker';
 
-import { castTo, type Class, TimeUtil } from '@travetto/runtime';
-import { BindUtil, type SchemaFieldConfig, CommonRegex, SchemaRegistryIndex } from '@travetto/schema';
+import { type Class, castTo, TimeUtil } from '@travetto/runtime';
+import { BindUtil, CommonRegex, type SchemaFieldConfig, SchemaRegistryIndex } from '@travetto/schema';
 
 /**
  * Provide a faker utility for generating content
  */
 export class SchemaFaker {
-
   static #stringToReType = new Map<RegExp, () => string>([
     [CommonRegex.email, faker.internet.email],
     [CommonRegex.url, faker.internet.url],
@@ -25,7 +24,7 @@ export class SchemaFaker {
       [/^email(addr(ress)?)?$/, faker.internet.email],
       [/^(tele)?phone(num|number)?$/, faker.phone.number],
       [/^((postal|zip)code)|zip$/, faker.location.zipCode],
-      [/f(irst)?name/, faker.person.firstName],
+      [/name|fname|firstName/i, faker.person.firstName],
       [/l(ast)?name/, faker.person.lastName],
       [/^ip(add(ress)?)?$/, faker.internet.ip],
       [/^ip(add(ress)?)?(v?)6$/, faker.internet.ipv6],
@@ -46,9 +45,9 @@ export class SchemaFaker {
     ]),
     date: new Map([
       [/dob|birth/, (): Date => faker.date.past({ years: 60 })],
-      [/creat(e|ion)/, this.#between.bind(null, -200, -100)],
-      [/(update|modif(y|ied))/, this.#between.bind(null, -100, -50)]
-    ]),
+      [/create|creation/, this.#between.bind(null, -200, -100)],
+      [/(update|modify|modified)/, this.#between.bind(null, -100, -50)]
+    ])
   };
 
   static #between(fromDays: number, toDays: number): Date {
@@ -67,7 +66,7 @@ export class SchemaFaker {
     const max = config.maxlength ? config.maxlength.limit : 10;
     const size = faker.number.int({ min, max });
     const out: unknown[] = [];
-    for (let i = 0; i < size; i++) {
+    for (let i = 0; i < size; i += 1) {
       out.push(this.#value(config, true));
     }
     return out;
@@ -89,10 +88,10 @@ export class SchemaFaker {
     let offset = 1;
 
     if (precision !== undefined) {
-      min ??= -((10 ** precision[0]) - 1);
-      max ??= ((10 ** precision[0]) - 1);
+      min ??= -(10 ** precision[0] - 1);
+      max ??= 10 ** precision[0] - 1;
       if (precision[1] !== undefined) {
-        offset = (10 ** (precision[1] || 0));
+        offset = 10 ** (precision[1] || 0);
       }
     }
 
@@ -101,10 +100,9 @@ export class SchemaFaker {
 
     const range = (max - min) * offset;
     const result = Math.trunc(Math.random() * range);
-    return (result / offset) + min;
+    return result / offset + min;
   }
 
-
   /**
    * Get a new bigint value
    * @param config BigInt config
@@ -112,7 +110,7 @@ export class SchemaFaker {
   static #bigInt(config: SchemaFieldConfig): bigint {
     const min = config.min && typeof config.min.limit === 'bigint' ? config.min.limit : 0n;
     const max = config.max && typeof config.max.limit === 'bigint' ? config.max.limit : 1000n;
-    return faker.number.bigInt({ min, max, });
+    return faker.number.bigInt({ min, max });
   }
 
   /**
@@ -144,7 +142,7 @@ export class SchemaFaker {
     const name = config.name.toLowerCase();
 
     if (config.match) {
-      const mre = config.match && config.match.regex;
+      const mre = config.match.regex;
       for (const [regex, fn] of this.#stringToReType) {
         if (mre === regex) {
           return fn();
@@ -172,11 +170,16 @@ export class SchemaFaker {
       return faker.helpers.arrayElement(config.enum.values);
     } else {
       switch (config.type) {
-        case Number: return this.#number(config);
-        case castTo(BigInt): return this.#bigInt(config);
-        case String: return this.#string(config);
-        case Date: return this.#date(config);
-        case Boolean: return faker.datatype.boolean();
+        case Number:
+          return this.#number(config);
+        case castTo(BigInt):
+          return this.#bigInt(config);
+        case String:
+          return this.#string(config);
+        case Date:
+          return this.#date(config);
+        case Boolean:
+          return faker.datatype.boolean();
       }
       if (SchemaRegistryIndex.has(config.type)) {
         return this.generate(config.type);
@@ -194,10 +197,11 @@ export class SchemaFaker {
     const out: Record<string, unknown> = {};
 
     for (const [name, fieldConfig] of Object.entries(fields)) {
-      if (name === 'type' || name === 'id') { // Do not set primary fields
+      if (name === 'type' || name === 'id') {
+        // Do not set primary fields
         continue;
       }
-      if (fieldConfig.required?.active === false && (Math.random() < .5)) {
+      if (fieldConfig.required?.active === false && Math.random() < 0.5) {
         continue;
       }
       out[name] = this.#value(fieldConfig);
@@ -205,4 +209,4 @@ export class SchemaFaker {
 
     return BindUtil.bindSchema(cls, out, { view });
   }
-}
+}