struct-fakerator 2.6.8 → 2.7.9

package/README.md

@@ -3,12 +3,12 @@
 - [假資料結構產生器](#假資料結構產生器)
   - [Wrapping fakerjs Functions](#wrapping-fakerjs-functions)
   - [用途](#用途)
-    - [createValueGenerator](#createvaluegenerator)
-    - [createSelectionGenerator](#createselectiongenerator)
-    - [createObjectGenerator](#createobjectgenerator)
+    - [Value](#value)
+    - [Selection](#selection)
+    - [Object](#object)
     - [createArrayGenerator](#createarraygenerator)
     - [createTupleGenerator](#createtuplegenerator)
-    - [createBoundedSeriesGenerator](#createboundedseriesgenerator)
+    - [BoundedSeries](#boundedseries)
   - [擴充](#擴充)
 
 ## Wrapping fakerjs Functions
@@ -42,146 +42,201 @@
 
 使用 faker js 時是單一純值不能產生結構，需要自己手動組合結構，此專案利用撰寫設定檔的方式來產生一個特定的假資料函數，減少手動組合結構的麻煩。
 
-```javascript
-const test = {
+```typescript
+import { StructConfig } from 'struct-fakerator'
+
+const scheme = StructConfig.object({
+  name: StructConfig.value(() => 'hello'),
+  enum: StructConfig.selection([1, 2, 3]),
+  list: StructConfig.array(StructConfig.value(() => 10), 5),
+  tuple: StructConfig.tuple([StructConfig.value(() => 'tuple1'), StructConfig.value(() => '100')])
+})
+
+// or
+import {
+  createObjectConfig,
+  createArrayConfig,
+  createValueConfig,
+  createTupleConfig,
+  createSelectionConfig
+} from 'struct-fakerator';
+
+
+const scheme = createObjectConfig({
+  name: createValueConfig(() => 'hello'),
+  enum: createSelectionConfig([1, 2, 3]),
+  list: createArrayConfig(
+    createValueConfig(() => 10),
+    5
+  ),
+  tuple: createTupleConfig([
+    createValueConfig(() => 'tuple1'),
+    createValueConfig(() => 100),
+    createValueConfig(() => false),
+  ])
+});
+
+// or
+const scheme = {
   type: 'obj',
   content: {
     name: {
       type: 'value',
       generateFn: () => 'hello',
     },
+    enum: {
+      type: 'select',
+      items: [1, 2, 3],
+    },
     list: {
       type: 'arr',
-      len: 5,
       item: {
         type: 'value',
         generateFn: () => 10,
       },
+      len: 5,
+    },
+    tuple: {
+      type: 'tuple',
+      configItems: [
+        {
+          type: 'value',
+          generateFn: () => 'tuple1',
+        },
+        {
+          type: 'value',
+          generateFn: () => 100,
+        },
+        {
+          type: 'value',
+          generateFn: () => false,
+        },
+      ],
     },
   },
 };
+```
 
-const generateFn = createGeneratorByType(test);
+```typescript
+import { StructGenerator } from 'struct-fakerator';
 
-console.log(generateFn());
+const result = StructGenerator.genFn(scheme)()
 
-/*
-{
-  name: "hello"
-  list: [10, 10, 10, 10, 10,]
-}
-*/
-```
+console.log(result);
+// {
+//   name: 'hello',
+//   enum: 1, // or 2 or 3
+//   list: [10, 10, 10, 10, 10],
+//   tuple: ['tuple1', 100, false]
+// }
 
+```
 
 
-### createValueGenerator
+### Value
 
-```javascript
-const generateFn = createValueGenerator({
-  type: 'value',
-  generateFn: () => 10,
-})
+```typescript
+const generateFn = StructGenerator.genFn(StructConfig.value(() => 10));
 
 console.log(generateFn());
-
 // 10
 ```
 
-### createSelectionGenerator
+### Selection
 
 ```javascript
-const generateFn = createSelectionGenerator({
- type: 'select',
- items: [1, 2, 3, 4, 5],
-})
+const generateFn = StructGenerator.genFn(StructConfig.select([1, 2, 3, 4, 5]))
 
 console.log(generateFn());
-
 // 1 or 2 or 3 or 4 or 5
 ```
 
-### createObjectGenerator
+### Object
 
-```javascript
-const generateFn = createObjectGenerator({
- type: 'obj',
- content: {
-   name: {
-     type: 'value',
-     generateFn: () => 'hello',
-   },
-   list: {
-     type: 'arr',
-     len: 5,
-     item: {
-       type: 'value',
-       generateFn: () => 10,
-     }
-   }
- }
-})
+```typescript
+const generateFn = StructGenerator.genFn(StructConfig.object({
+  name: StructConfig.value(() => 'hello'),
+  list: StructConfig.array(StructConfig.value(() => 10), 5),
+}));
 
 console.log(generateFn());
-
 // {
 //   name: 'hello',
 //   list: [10, 10, 10, 10, 10]
 // }
+
+// with transformer function
+const generateFn = StructGenerator.genFn(
+  StructConfig.object(
+    {
+      name: StructConfig.value(() => 'hello'),
+      list: StructConfig.array(
+        StructConfig.value(() => 10),
+        5
+      ),
+    },
+    ({ name, list }) => list.map((item) => `${name} ${item}`)
+  )
+);
+
+console.log(generateFn());
+// ["hello 10", "hello 10", "hello 10", "hello 10", "hello 10"]
 ```
+
 ### createArrayGenerator
 
-
-```javascript
-const generateFn = createArrayGenerator({
- type: 'arr',
- len: 5,
- item: {
-   type: 'value',
-   generateFn: () => 10,
- }
-})
+```typescript
+const generateFn = StructGenerator.genFn(
+  StructConfig.array(
+    StructConfig.value(() => 10),
+    5
+  )
+);
 
 console.log(generateFn());
-
 // [10, 10, 10, 10, 10]
+
+// with next function
+const generateFn = StructGenerator.genFn(
+  StructConfig.array(
+    StructConfig.value(() => 10),
+    5,
+    (prev, current) => prev + 1 + current
+  )
+);
+
+console.log(generateFn());
+// [21, 32, 43, 54, 65]
 ```
 
 ### createTupleGenerator
 
-```javascript
-const generateFn = createTupleGenerator({
- type: 'tuple',
- configItems: [
-   {
-     type: 'value',
-     generateFn: () => 10,
-   },
-   {
-     type: 'value',
-     generateFn: () => 'hello',
-   },
- ]
-})
+```typescript
+const generateFn = StructGenerator.genFn(
+  StructConfig.tuple([
+    StructConfig.value(() => 'tuple1'),
+    StructConfig.value(() => 100),
+    StructConfig.value(() => false),
+  ])
+);
 
 console.log(generateFn());
-
-// [10, 'hello']
+// ['tuple1', 100, false]
 ```
 
-### createBoundedSeriesGenerator
+### BoundedSeries
 
 ```javascript
-const generateFn = createBoundedSeriesGenerator({
- type: 'bounded_series',
- upperLimit: 1.1,
- lowerLimit: 0.9,
- createInitValue: () => 100,
- count: 20
-})
+const generateFn = StructGenerator.genFn(
+  StructConfig.boundedSeries({
+    upperLimit: 1.1,
+    lowerLimit: 0.9,
+    createInitValue: () => 100,
+    count: 20,
+  })
+);
 
 console.log(generateFn());
-
 // [100 * 0.9 <= num <= 100 * 1.1, 
 //  prev * 0.9 <= num <= prev * 1.1,
 //  prev * 0.9 <= num <= prev * 1.1,

package/dist/chunk-3E2B272L.js

@@ -0,0 +1,25 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/airline.ts
+var airline_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, airline_exports, {
+  aircraftType: () => aircraftType,
+  flightNumber: () => flightNumber,
+  seat: () => seat
+});
+var _faker = require('@faker-js/faker');
+var aircraftType = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.airline.aircraftType);
+var flightNumber = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.airline.flightNumber);
+var seat = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.airline.seat);
+
+
+
+
+
+
+exports.aircraftType = aircraftType; exports.flightNumber = flightNumber; exports.seat = seat; exports.airline_exports = airline_exports;

package/dist/chunk-3KXIZTCT.mjs

@@ -0,0 +1,20 @@
+import {
+  createValueConfig
+} from "./chunk-ZQA42PYM.mjs";
+import {
+  __export
+} from "./chunk-XGB3TDIC.mjs";
+
+// src/utils/utils.ts
+var utils_exports = {};
+__export(utils_exports, {
+  makeValueConfigFn: () => makeValueConfigFn
+});
+function makeValueConfigFn(fn) {
+  return (...options) => createValueConfig(() => fn(...options));
+}
+
+export {
+  makeValueConfigFn,
+  utils_exports
+};

package/dist/chunk-3P4RJMMV.js

@@ -0,0 +1,79 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/finance.ts
+var finance_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, finance_exports, {
+  accountName: () => accountName,
+  accountNumber: () => accountNumber,
+  amount: () => amount,
+  bic: () => bic,
+  bitcoinAddress: () => bitcoinAddress,
+  creditCardCVV: () => creditCardCVV,
+  creditCardIssuer: () => creditCardIssuer,
+  creditCardNumber: () => creditCardNumber,
+  currency: () => currency,
+  currencyCode: () => currencyCode,
+  currencySymbol: () => currencySymbol,
+  ethereumAddress: () => ethereumAddress,
+  iban: () => iban,
+  litecoinAddress: () => litecoinAddress,
+  maskedNumber: () => maskedNumber,
+  pin: () => pin,
+  routingNumber: () => routingNumber,
+  transactionDescription: () => transactionDescription,
+  transactionType: () => transactionType
+});
+var _faker = require('@faker-js/faker');
+var accountName = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.accountName);
+var accountNumber = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.accountNumber);
+var amount = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.amount);
+var bic = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.bic);
+var bitcoinAddress = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.bitcoinAddress);
+var creditCardCVV = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.creditCardCVV);
+var creditCardIssuer = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, 
+  _faker.faker.finance.creditCardIssuer
+);
+var creditCardNumber = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, 
+  _faker.faker.finance.creditCardNumber
+);
+var currency = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.currency);
+var currencyCode = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.currencyCode);
+var currencySymbol = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.currencySymbol);
+var ethereumAddress = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.ethereumAddress);
+var iban = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.iban);
+var litecoinAddress = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.litecoinAddress);
+var maskedNumber = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.maskedNumber);
+var pin = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.pin);
+var routingNumber = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.routingNumber);
+var transactionDescription = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, 
+  _faker.faker.finance.transactionDescription
+);
+var transactionType = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.finance.transactionType);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+exports.accountName = accountName; exports.accountNumber = accountNumber; exports.amount = amount; exports.bic = bic; exports.bitcoinAddress = bitcoinAddress; exports.creditCardCVV = creditCardCVV; exports.creditCardIssuer = creditCardIssuer; exports.creditCardNumber = creditCardNumber; exports.currency = currency; exports.currencyCode = currencyCode; exports.currencySymbol = currencySymbol; exports.ethereumAddress = ethereumAddress; exports.iban = iban; exports.litecoinAddress = litecoinAddress; exports.maskedNumber = maskedNumber; exports.pin = pin; exports.routingNumber = routingNumber; exports.transactionDescription = transactionDescription; exports.transactionType = transactionType; exports.finance_exports = finance_exports;

package/dist/chunk-3SVV5GDL.js

@@ -0,0 +1,22 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/science.ts
+var science_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, science_exports, {
+  chemicalElement: () => chemicalElement,
+  unit: () => unit
+});
+var _faker = require('@faker-js/faker');
+var chemicalElement = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.science.chemicalElement);
+var unit = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.science.unit);
+
+
+
+
+
+exports.chemicalElement = chemicalElement; exports.unit = unit; exports.science_exports = science_exports;

package/dist/chunk-3WINWLTB.js

@@ -0,0 +1,34 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/number.ts
+var number_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, number_exports, {
+  bigInt: () => bigInt,
+  binary: () => binary,
+  float: () => float,
+  hex: () => hex,
+  int: () => int,
+  octal: () => octal
+});
+var _faker = require('@faker-js/faker');
+var bigInt = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.number.bigInt);
+var binary = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.number.binary);
+var float = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.number.float);
+var hex = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.number.hex);
+var int = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.number.int);
+var octal = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.number.octal);
+
+
+
+
+
+
+
+
+
+exports.bigInt = bigInt; exports.binary = binary; exports.float = float; exports.hex = hex; exports.int = int; exports.octal = octal; exports.number_exports = number_exports;

package/dist/chunk-5LCWZUVP.mjs

@@ -0,0 +1,19 @@
+import {
+  makeValueConfigFn
+} from "./chunk-3KXIZTCT.mjs";
+import {
+  __export
+} from "./chunk-XGB3TDIC.mjs";
+
+// src/utils/datatype.ts
+var datatype_exports = {};
+__export(datatype_exports, {
+  boolean: () => boolean
+});
+import { faker } from "@faker-js/faker";
+var boolean = makeValueConfigFn(faker.datatype.boolean);
+
+export {
+  boolean,
+  datatype_exports
+};

package/dist/chunk-62MDIAG3.js

@@ -0,0 +1,19 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/datatype.ts
+var datatype_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, datatype_exports, {
+  boolean: () => boolean
+});
+var _faker = require('@faker-js/faker');
+var boolean = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.datatype.boolean);
+
+
+
+
+exports.boolean = boolean; exports.datatype_exports = datatype_exports;

package/dist/chunk-6QXR4Q23.js

@@ -0,0 +1,43 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/food.ts
+var food_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, food_exports, {
+  adjective: () => adjective,
+  description: () => description,
+  dish: () => dish,
+  ethnicCategory: () => ethnicCategory,
+  fruit: () => fruit,
+  ingredient: () => ingredient,
+  meat: () => meat,
+  spice: () => spice,
+  vegetable: () => vegetable
+});
+var _faker = require('@faker-js/faker');
+var adjective = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.adjective);
+var description = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.description);
+var dish = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.dish);
+var ethnicCategory = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.ethnicCategory);
+var fruit = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.fruit);
+var ingredient = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.ingredient);
+var meat = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.meat);
+var spice = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.spice);
+var vegetable = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.food.vegetable);
+
+
+
+
+
+
+
+
+
+
+
+
+exports.adjective = adjective; exports.description = description; exports.dish = dish; exports.ethnicCategory = ethnicCategory; exports.fruit = fruit; exports.ingredient = ingredient; exports.meat = meat; exports.spice = spice; exports.vegetable = vegetable; exports.food_exports = food_exports;

package/dist/chunk-7QCNINQB.js

@@ -0,0 +1,43 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+
+
+var _chunk4VNS5WPMjs = require('./chunk-4VNS5WPM.js');
+
+// src/utils/lorem.ts
+var lorem_exports = {};
+_chunk4VNS5WPMjs.__export.call(void 0, lorem_exports, {
+  lines: () => lines,
+  paragraph: () => paragraph,
+  paragraphs: () => paragraphs,
+  sentence: () => sentence,
+  sentences: () => sentences,
+  slug: () => slug,
+  text: () => text,
+  word: () => word,
+  words: () => words
+});
+var _faker = require('@faker-js/faker');
+var lines = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.lines);
+var paragraph = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.paragraph);
+var paragraphs = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.paragraphs);
+var sentence = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.sentence);
+var sentences = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.sentences);
+var slug = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.slug);
+var text = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.text);
+var word = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.word);
+var words = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _faker.faker.lorem.words);
+
+
+
+
+
+
+
+
+
+
+
+
+exports.lines = lines; exports.paragraph = paragraph; exports.paragraphs = paragraphs; exports.sentence = sentence; exports.sentences = sentences; exports.slug = slug; exports.text = text; exports.word = word; exports.words = words; exports.lorem_exports = lorem_exports;