struct-fakerator 2.6.9 → 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/airline-BUwgrfsj.d.ts

@@ -0,0 +1,26 @@
+import * as _faker_js_faker__ from '@faker-js/faker/.';
+import { V as ValueConfig } from './type-C8Ny1fB6.js';
+
+/** Airline [aircraftType](https://fakerjs.dev/api/airline.html#aircraftType) */
+declare const aircraftType: () => ValueConfig<"narrowbody" | "regional" | "widebody">;
+/** Airline [flightNumber](https://fakerjs.dev/api/airline.html#flightNumber) */
+declare const flightNumber: (options?: {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    addLeadingZeros?: boolean;
+}) => ValueConfig<string>;
+/** Airline [seat](https://fakerjs.dev/api/airline.html#seat) */
+declare const seat: (options?: {
+    aircraftType?: _faker_js_faker__.AircraftType;
+}) => ValueConfig<string>;
+
+declare const airline_aircraftType: typeof aircraftType;
+declare const airline_flightNumber: typeof flightNumber;
+declare const airline_seat: typeof seat;
+declare namespace airline {
+  export { airline_aircraftType as aircraftType, airline_flightNumber as flightNumber, airline_seat as seat };
+}
+
+export { airline as a, aircraftType as b, flightNumber as f, seat as s };

package/dist/airline-C0ManYED.d.mts

@@ -0,0 +1,26 @@
+import * as _faker_js_faker__ from '@faker-js/faker/.';
+import { V as ValueConfig } from './type-C8Ny1fB6.mjs';
+
+/** Airline [aircraftType](https://fakerjs.dev/api/airline.html#aircraftType) */
+declare const aircraftType: () => ValueConfig<"narrowbody" | "regional" | "widebody">;
+/** Airline [flightNumber](https://fakerjs.dev/api/airline.html#flightNumber) */
+declare const flightNumber: (options?: {
+    length?: number | {
+        min: number;
+        max: number;
+    };
+    addLeadingZeros?: boolean;
+}) => ValueConfig<string>;
+/** Airline [seat](https://fakerjs.dev/api/airline.html#seat) */
+declare const seat: (options?: {
+    aircraftType?: _faker_js_faker__.AircraftType;
+}) => ValueConfig<string>;
+
+declare const airline_aircraftType: typeof aircraftType;
+declare const airline_flightNumber: typeof flightNumber;
+declare const airline_seat: typeof seat;
+declare namespace airline {
+  export { airline_aircraftType as aircraftType, airline_flightNumber as flightNumber, airline_seat as seat };
+}
+
+export { airline as a, aircraftType as b, flightNumber as f, seat as s };

package/dist/animal-arG64NM6.d.mts

@@ -0,0 +1,53 @@
+import { V as ValueConfig } from './type-C8Ny1fB6.mjs';
+
+/** Animal [bear](https://fakerjs.dev/api/animal.html#bear) */
+declare const bear: () => ValueConfig<string>;
+/** Animal [bird](https://fakerjs.dev/api/animal.html#bird) */
+declare const bird: () => ValueConfig<string>;
+/** Animal [cat](https://fakerjs.dev/api/animal.html#cat) */
+declare const cat: () => ValueConfig<string>;
+/** Animal [cetacean](https://fakerjs.dev/api/animal.html#cetacean) */
+declare const cetacean: () => ValueConfig<string>;
+/** Animal [cow](https://fakerjs.dev/api/animal.html#cow) */
+declare const cow: () => ValueConfig<string>;
+/** Animal [crocodilia](https://fakerjs.dev/api/animal.html#crocodilia) */
+declare const crocodilia: () => ValueConfig<string>;
+/** Animal [dog](https://fakerjs.dev/api/animal.html#dog) */
+declare const dog: () => ValueConfig<string>;
+/** Animal [fish](https://fakerjs.dev/api/animal.html#fish) */
+declare const fish: () => ValueConfig<string>;
+/** Animal [horse](https://fakerjs.dev/api/animal.html#horse) */
+declare const horse: () => ValueConfig<string>;
+/** Animal [insect](https://fakerjs.dev/api/animal.html#insect) */
+declare const insect: () => ValueConfig<string>;
+/** Animal [lion](https://fakerjs.dev/api/animal.html#lion) */
+declare const lion: () => ValueConfig<string>;
+/** Animal [rabbit](https://fakerjs.dev/api/animal.html#rabbit) */
+declare const rabbit: () => ValueConfig<string>;
+/** Animal [rodent](https://fakerjs.dev/api/animal.html#rodent) */
+declare const rodent: () => ValueConfig<string>;
+/** Animal [snake](https://fakerjs.dev/api/animal.html#snake) */
+declare const snake: () => ValueConfig<string>;
+/** Animal [type](https://fakerjs.dev/api/animal.html#type) */
+declare const type: () => ValueConfig<string>;
+
+declare const animal_bear: typeof bear;
+declare const animal_bird: typeof bird;
+declare const animal_cat: typeof cat;
+declare const animal_cetacean: typeof cetacean;
+declare const animal_cow: typeof cow;
+declare const animal_crocodilia: typeof crocodilia;
+declare const animal_dog: typeof dog;
+declare const animal_fish: typeof fish;
+declare const animal_horse: typeof horse;
+declare const animal_insect: typeof insect;
+declare const animal_lion: typeof lion;
+declare const animal_rabbit: typeof rabbit;
+declare const animal_rodent: typeof rodent;
+declare const animal_snake: typeof snake;
+declare const animal_type: typeof type;
+declare namespace animal {
+  export { animal_bear as bear, animal_bird as bird, animal_cat as cat, animal_cetacean as cetacean, animal_cow as cow, animal_crocodilia as crocodilia, animal_dog as dog, animal_fish as fish, animal_horse as horse, animal_insect as insect, animal_lion as lion, animal_rabbit as rabbit, animal_rodent as rodent, animal_snake as snake, animal_type as type };
+}
+
+export { animal as a, bear as b, bird as c, cat as d, cetacean as e, cow as f, crocodilia as g, dog as h, fish as i, horse as j, insect as k, lion as l, rodent as m, rabbit as r, snake as s, type as t };

package/dist/animal-erAZXs_d.d.ts

@@ -0,0 +1,53 @@
+import { V as ValueConfig } from './type-C8Ny1fB6.js';
+
+/** Animal [bear](https://fakerjs.dev/api/animal.html#bear) */
+declare const bear: () => ValueConfig<string>;
+/** Animal [bird](https://fakerjs.dev/api/animal.html#bird) */
+declare const bird: () => ValueConfig<string>;
+/** Animal [cat](https://fakerjs.dev/api/animal.html#cat) */
+declare const cat: () => ValueConfig<string>;
+/** Animal [cetacean](https://fakerjs.dev/api/animal.html#cetacean) */
+declare const cetacean: () => ValueConfig<string>;
+/** Animal [cow](https://fakerjs.dev/api/animal.html#cow) */
+declare const cow: () => ValueConfig<string>;
+/** Animal [crocodilia](https://fakerjs.dev/api/animal.html#crocodilia) */
+declare const crocodilia: () => ValueConfig<string>;
+/** Animal [dog](https://fakerjs.dev/api/animal.html#dog) */
+declare const dog: () => ValueConfig<string>;
+/** Animal [fish](https://fakerjs.dev/api/animal.html#fish) */
+declare const fish: () => ValueConfig<string>;
+/** Animal [horse](https://fakerjs.dev/api/animal.html#horse) */
+declare const horse: () => ValueConfig<string>;
+/** Animal [insect](https://fakerjs.dev/api/animal.html#insect) */
+declare const insect: () => ValueConfig<string>;
+/** Animal [lion](https://fakerjs.dev/api/animal.html#lion) */
+declare const lion: () => ValueConfig<string>;
+/** Animal [rabbit](https://fakerjs.dev/api/animal.html#rabbit) */
+declare const rabbit: () => ValueConfig<string>;
+/** Animal [rodent](https://fakerjs.dev/api/animal.html#rodent) */
+declare const rodent: () => ValueConfig<string>;
+/** Animal [snake](https://fakerjs.dev/api/animal.html#snake) */
+declare const snake: () => ValueConfig<string>;
+/** Animal [type](https://fakerjs.dev/api/animal.html#type) */
+declare const type: () => ValueConfig<string>;
+
+declare const animal_bear: typeof bear;
+declare const animal_bird: typeof bird;
+declare const animal_cat: typeof cat;
+declare const animal_cetacean: typeof cetacean;
+declare const animal_cow: typeof cow;
+declare const animal_crocodilia: typeof crocodilia;
+declare const animal_dog: typeof dog;
+declare const animal_fish: typeof fish;
+declare const animal_horse: typeof horse;
+declare const animal_insect: typeof insect;
+declare const animal_lion: typeof lion;
+declare const animal_rabbit: typeof rabbit;
+declare const animal_rodent: typeof rodent;
+declare const animal_snake: typeof snake;
+declare const animal_type: typeof type;
+declare namespace animal {
+  export { animal_bear as bear, animal_bird as bird, animal_cat as cat, animal_cetacean as cetacean, animal_cow as cow, animal_crocodilia as crocodilia, animal_dog as dog, animal_fish as fish, animal_horse as horse, animal_insect as insect, animal_lion as lion, animal_rabbit as rabbit, animal_rodent as rodent, animal_snake as snake, animal_type as type };
+}
+
+export { animal as a, bear as b, bird as c, cat as d, cetacean as e, cow as f, crocodilia as g, dog as h, fish as i, horse as j, insect as k, lion as l, rodent as m, rabbit as r, snake as s, type as t };

package/dist/{chunk-EMCK2BLM.js → chunk-25HDDMTE.js}

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkIOXGSFEUjs = require('./chunk-IOXGSFEU.js');
+var _chunk6QZF75LHjs = require('./chunk-6QZF75LH.js');
 
 
 var _chunkTZ2RKEBFjs = require('./chunk-TZ2RKEBF.js');
@@ -21,15 +21,15 @@ _chunk4VNS5WPMjs.__export.call(void 0, vehicle_exports, {
   vin: () => vin,
   vrm: () => vrm
 });
-var bicycle = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.bicycle);
-var color = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.color);
-var fuel = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.fuel);
-var manufacturer = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.manufacturer);
-var model = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.model);
-var type = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.type);
-var vehicle = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.vehicle);
-var vin = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.vin);
-var vrm = _chunkIOXGSFEUjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.vrm);
+var bicycle = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.bicycle);
+var color = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.color);
+var fuel = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.fuel);
+var manufacturer = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.manufacturer);
+var model = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.model);
+var type = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.type);
+var vehicle = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.vehicle);
+var vin = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.vin);
+var vrm = _chunk6QZF75LHjs.makeValueConfigFn.call(void 0, _chunkTZ2RKEBFjs.f.vehicle.vrm);
 
 
 

package/dist/{chunk-TXAOQHVV.mjs → chunk-266JLHQ7.mjs}

@@ -1,6 +1,6 @@
 import {
   makeValueConfigFn
-} from "./chunk-3KXIZTCT.mjs";
+} from "./chunk-7POVLKQR.mjs";
 import {
   f
 } from "./chunk-3U6BNHWG.mjs";

package/dist/{chunk-JGY3KVDU.mjs → chunk-266W7TLD.mjs}

@@ -1,6 +1,6 @@
 import {
   makeValueConfigFn
-} from "./chunk-3KXIZTCT.mjs";
+} from "./chunk-ZPQ6LVKQ.mjs";
 import {
   f
 } from "./chunk-3U6BNHWG.mjs";