struct-fakerator 2.0.0 → 2.1.1

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "struct-fakerator",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "exports": {
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.js"
+  },
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "test": "vitest src"
@@ -18,7 +24,7 @@
     "@faker-js/faker": "^8.4.1",
     "tsup": "^8.1.0",
     "typescript": "^5.5.3",
-    "vitest": "^1.6.0"
+    "vitest": "^2.0.3"
   },
   "dependencies": {
     "zod": "^3.23.8"

package/src/create_generator_fn.test.ts

@@ -14,6 +14,7 @@ import {
   createObjectConfig,
   createArrayConfig,
 } from "./create_config";
+import type { ObjectConfig } from "./type";
 
 describe("createValueGenerator", () => {
   test("normal", () => {
@@ -155,6 +156,20 @@ describe("createGeneratorByType", () => {
     });
   });
 
+  test("test error config", () => {
+    const config = {
+      type: "obj",
+      content: {
+        name: {
+          type: "123",
+          generateFn: "John",
+        },
+      },
+    } as ObjectConfig<unknown>;
+
+    expect(() => createGeneratorByType(config)).toThrowError();
+  });
+
   test("with custom type match", () => {
     const createIntValueConfig = (option) => createValueConfig(() => 50);
     const createEmailValueConfig = (option) =>

package/src/create_generator_fn.ts

@@ -17,7 +17,6 @@ import type {
   Result,
   BoundedSeriesConfig,
 } from "./type";
-import { createObjectConfig, createValueConfig } from "./create_config";
 
 type AllConfig<T> =
   | ValueConfig<T>
@@ -31,33 +30,60 @@ type AllConfig<T> =
   | TupleConfig<T, T, T, T, T>
   | BoundedSeriesConfig;
 
-// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-export const createValueGenerator = <R = unknown>(config: any): (() => R) => {
-  valueConfigScheme.parse(config);
+const _createValueGenerator = <R = unknown>(
+  config: ValueConfig<unknown>,
+  path: string,
+): (() => R) => {
+  try {
+    valueConfigScheme.parse(config);
+  } catch (err) {
+    throw new Error(`config path: ${path}.value\n${err}`);
+  }
 
   return config.generateFn as () => R;
 };
+export const createValueGenerator = <R = unknown>(
+  config: ValueConfig<unknown>,
+): (() => R) => _createValueGenerator(config, "*");
 
-export const createSelectionGenerator = <T extends SelectionConfig<unknown>>(
+// =================== generator fn ====================
+
+const _createSelectionGenerator = <T extends SelectionConfig<unknown>>(
   config: T,
+  path: string,
 ): (() => Result<T>) => {
-  selectionConfigScheme.parse(config);
+  try {
+    selectionConfigScheme.parse(config);
+  } catch (err) {
+    throw new Error(`config path: ${path}.select\n${err}`);
+  }
 
   const { items } = config;
 
   return (() => items[faker.number.int(items.length - 1)]) as () => Result<T>;
 };
 
-export const createObjectGenerator = <T extends ObjectConfig<unknown>>(
+export const createSelectionGenerator = <T extends SelectionConfig<unknown>>(
   config: T,
-  customTypeMatch?: (config: unknown) => ValueConfig<unknown>,
+): (() => Result<T>) => _createSelectionGenerator(config, "*");
+
+// =================== generator fn ====================
+
+const _createObjectGenerator = <T extends ObjectConfig<unknown>>(
+  config: T,
+  path: string,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
 ): (() => Result<T>) => {
-  objConfigScheme.parse(config);
+  try {
+    objConfigScheme.parse(config);
+  } catch (err) {
+    throw new Error(`config path: ${path}.obj\n ${err}`);
+  }
 
   const keyWithFns: [string, () => Result<AllConfig<unknown>>][] =
     Object.entries(config.content as object).map(([key, subConfig]) => [
       key,
-      createGeneratorByType(subConfig, customTypeMatch),
+      _createGeneratorByType(subConfig, `${path}.obj[${key}]`, customTypeMatch),
     ]);
 
   return () => {
@@ -68,23 +94,41 @@ export const createObjectGenerator = <T extends ObjectConfig<unknown>>(
     return result as Result<T>;
   };
 };
+export const createObjectGenerator = <T extends ObjectConfig<unknown>>(
+  config: T,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
+): (() => Result<T>) => _createObjectGenerator(config, "*", customTypeMatch);
 
-export const createArrayGenerator = <T extends ArrayConfig<unknown>>(
+// =================== generator fn ====================
+
+const _createArrayGenerator = <T extends ArrayConfig<unknown>>(
   config: T,
-  customTypeMatch?: (config: unknown) => ValueConfig<unknown>,
+  path: string,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
 ): (() => Result<T>) => {
-  arrayConfigScheme.parse(config);
+  try {
+    arrayConfigScheme.parse(config);
+  } catch (err) {
+    throw new Error(`config path: ${path}.arr\n ${err}`);
+  }
 
-  const itemGeneratorFn = createGeneratorByType(
+  const itemGeneratorFn = _createGeneratorByType(
     config.item as AllConfig<unknown>,
+    `${path}.arr`,
     customTypeMatch,
   );
 
   return () =>
     Array.from({ length: config.len ?? 0 }, itemGeneratorFn) as Result<T>;
 };
+export const createArrayGenerator = <T extends ArrayConfig<unknown>>(
+  config: T,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
+): (() => Result<T>) => _createArrayGenerator(config, "*", customTypeMatch);
 
-export const createTupleGenerator = <
+// =================== generator fn ====================
+
+const _createTupleGenerator = <
   T extends
     | TupleConfig<unknown, unknown, unknown, unknown, unknown>
     | TupleConfig<unknown, unknown, unknown, unknown>
@@ -93,21 +137,48 @@ export const createTupleGenerator = <
     | TupleConfig<unknown>,
 >(
   config: T,
-  customTypeMatch?: (config: unknown) => ValueConfig<unknown>,
+  path: string,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
 ): (() => Result<T>) => {
-  tupleConfigScheme.parse(config);
+  try {
+    tupleConfigScheme.parse(config);
+  } catch (err) {
+    throw new Error(`config path: ${path}.tuple\n ${err}`);
+  }
 
-  const itemsFns = config.configItems.map((configItem) =>
-    createGeneratorByType(configItem as AllConfig<unknown>, customTypeMatch),
+  const itemsFns = config.configItems.map((configItem, index) =>
+    _createGeneratorByType(
+      configItem as AllConfig<unknown>,
+      `${path}.tuple[${index}]`,
+      customTypeMatch,
+    ),
   );
 
   return () => itemsFns.map((generateFn) => generateFn()) as Result<T>;
 };
+export const createTupleGenerator = <
+  T extends
+    | TupleConfig<unknown, unknown, unknown, unknown, unknown>
+    | TupleConfig<unknown, unknown, unknown, unknown>
+    | TupleConfig<unknown, unknown, unknown>
+    | TupleConfig<unknown, unknown>
+    | TupleConfig<unknown>,
+>(
+  config: T,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
+): (() => Result<T>) => _createTupleGenerator(config, "*", customTypeMatch);
 
-export const createBoundedSeriesGenerator = <T extends BoundedSeriesConfig>(
+// =================== generator fn ====================
+
+const _createBoundedSeriesGenerator = <T extends BoundedSeriesConfig>(
   config: T,
+  path: string,
 ): (() => Result<T>) => {
-  boundedSeriesScheme.parse(config);
+  try {
+    boundedSeriesScheme.parse(config);
+  } catch (err) {
+    throw new Error(`config path: ${path}.boundedSeries\n ${err}`);
+  }
 
   const { upperLimit, lowerLimit, createInitValue, count } = config;
 
@@ -124,37 +195,52 @@ export const createBoundedSeriesGenerator = <T extends BoundedSeriesConfig>(
     return boundedSeries as Result<T>;
   };
 };
+export const createBoundedSeriesGenerator = <T extends BoundedSeriesConfig>(
+  config: T,
+): (() => Result<T>) => _createBoundedSeriesGenerator(config, "*");
 
-export const createGeneratorByType = <T extends AllConfig<unknown>>(
+// =================== generator fn ====================
+
+const _createGeneratorByType = <T extends AllConfig<unknown>>(
   config: T,
-  customTypeMatch?: (config: unknown) => ValueConfig<unknown>,
+  path: string,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
 ): (() => Result<T>) => {
   switch (config.type) {
     case "obj":
-      return createObjectGenerator(config, customTypeMatch) as () => Result<T>;
+      return _createObjectGenerator(
+        config,
+        path,
+        customTypeMatch,
+      ) as () => Result<T>;
     case "arr":
-      return createArrayGenerator(config, customTypeMatch) as () => Result<T>;
+      return _createArrayGenerator(
+        config,
+        path,
+        customTypeMatch,
+      ) as () => Result<T>;
     case "tuple":
-      return createTupleGenerator(config, customTypeMatch) as () => Result<T>;
+      return _createTupleGenerator(
+        config,
+        path,
+        customTypeMatch,
+      ) as () => Result<T>;
     case "select":
-      return createSelectionGenerator(config) as () => Result<T>;
+      return _createSelectionGenerator(config, path) as () => Result<T>;
     case "value":
-      return createValueGenerator(config);
+      return _createValueGenerator(config, path);
     case "bounded_series":
-      return createBoundedSeriesGenerator(config) as () => Result<T>;
+      return _createBoundedSeriesGenerator(config, path) as () => Result<T>;
     default: {
       if (customTypeMatch) {
-        return createValueGenerator(customTypeMatch(config));
+        return createValueGenerator(customTypeMatch(config, path));
       }
-      throw Error(`config type "${config}" is not supported`);
+      throw new Error(`path: ${path}\nconfig type is not supported`);
     }
   }
 };
 
-const config = createObjectConfig({
-  a: createObjectConfig({
-    b: createValueConfig(() => 1),
-  }),
-});
-
-const fn = createGeneratorByType(config);
+export const createGeneratorByType = <T extends AllConfig<unknown>>(
+  config: T,
+  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
+): (() => Result<T>) => _createGeneratorByType(config, "*", customTypeMatch);

package/.babelrc

@@ -1,5 +0,0 @@
-{
-    "ignore": [
-        "src/*.test.js"
-    ]
-}

package/dist/index.d.mts

@@ -1,87 +0,0 @@
-type ValueConfig<T> = {
-    type: "value";
-    generateFn: () => T;
-};
-type SelectionConfig<T> = {
-    type: "select";
-    items: T[];
-};
-type BoundedSeriesConfig = {
-    type: "bounded_series";
-    upperLimit: number;
-    lowerLimit: number;
-    createInitValue: () => number;
-    count: number;
-};
-type ArrayConfig<T> = {
-    type: "arr";
-    item: T;
-    len: number;
-};
-type ObjectConfig<T> = {
-    type: "obj";
-    content: T;
-};
-type TupleConfig<A, B = undefined, C = undefined, D = undefined, E = undefined> = {
-    type: "tuple";
-    configItems: E extends undefined ? D extends undefined ? C extends undefined ? B extends undefined ? [A] : [A, B] : [A, B, C] : [A, B, C, D] : [A, B, C, D, E];
-};
-type Result<T> = T extends ValueConfig<infer U> ? U : T extends SelectionConfig<infer S> ? S : T extends BoundedSeriesConfig ? number[] : T extends ArrayConfig<infer W> ? Array<Result<W>> : T extends ObjectConfig<infer O> ? {
-    [K in keyof O]: Result<O[K]>;
-} : T extends TupleConfig<infer A, infer B, infer C, infer D, infer E> ? E extends undefined ? D extends undefined ? C extends undefined ? B extends undefined ? [Result<A>] : [Result<A>, Result<B>] : [Result<A>, Result<B>, Result<C>] : [Result<A>, Result<B>, Result<C>, Result<D>] : [Result<A>, Result<B>, Result<C>, Result<D>, Result<E>] : never;
-
-/**
- * value
- * @param {function} generateFn - The function used to generate the value.
- * @return {ValueConfig} The configuration object with the type "value" and the provided generate function.
- */
-declare const createValueConfig: <T>(generateFn: () => T) => ValueConfig<T>;
-/**
- * selection
- * @param {Array} items - The array of items to choose from.
- * @return {SelectionConfig} The configuration object with the type "select" and the provided items.
- */
-declare const createSelectionConfig: <T>(items: T[]) => SelectionConfig<T>;
-/**
- * object
- * @param {object} content
- * @return {ObjectConfig}
- */
-declare const createObjectConfig: <T extends object>(content: T) => ObjectConfig<T>;
-/**
- * array
- * @param {object} item
- * @param {number} len
- * @return {ArrayConfig}
- */
-declare const createArrayConfig: <T>(item: T, len: number) => ArrayConfig<T>;
-/**
- * tuple
- * @param {Array} configItems
- * @return {TupleConfig}
- */
-interface CreateTupleConfig {
-    <A, B, C, D, E>(configItems: [A, B, C, D, E]): TupleConfig<A, B, C, D, E>;
-    <A, B, C, D>(configItems: [A, B, C, D]): TupleConfig<A, B, C, D>;
-    <A, B, C>(configItems: [A, B, C]): TupleConfig<A, B, C>;
-    <A, B>(configItems: [A, B]): TupleConfig<A, B>;
-    <A>(configItems: [A]): TupleConfig<A>;
-}
-declare const createTupleConfig: CreateTupleConfig;
-/**
- * bounded series
- * @param {{ upperLimit: number, lowerLimit: number, createInitValue: () => number, count: number }} config
- * @return {BoundedSeriesConfig}
- */
-declare const createBoundedSeriesConfig: (config: Omit<BoundedSeriesConfig, "type">) => BoundedSeriesConfig;
-
-type AllConfig<T> = ValueConfig<T> | SelectionConfig<T> | ArrayConfig<T> | ObjectConfig<T> | TupleConfig<T> | TupleConfig<T, T> | TupleConfig<T, T, T> | TupleConfig<T, T, T, T> | TupleConfig<T, T, T, T, T> | BoundedSeriesConfig;
-declare const createValueGenerator: <R = unknown>(config: any) => (() => R);
-declare const createSelectionGenerator: <T extends SelectionConfig<unknown>>(config: T) => (() => Result<T>);
-declare const createObjectGenerator: <T extends ObjectConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-declare const createArrayGenerator: <T extends ArrayConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-declare const createTupleGenerator: <T extends TupleConfig<unknown, unknown, unknown, unknown, unknown> | TupleConfig<unknown, unknown, unknown, unknown> | TupleConfig<unknown, unknown, unknown> | TupleConfig<unknown, unknown> | TupleConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-declare const createBoundedSeriesGenerator: <T extends BoundedSeriesConfig>(config: T) => (() => Result<T>);
-declare const createGeneratorByType: <T extends AllConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-
-export { type ArrayConfig, type BoundedSeriesConfig, type ObjectConfig, type Result, type SelectionConfig, type TupleConfig, type ValueConfig, createArrayConfig, createArrayGenerator, createBoundedSeriesConfig, createBoundedSeriesGenerator, createGeneratorByType, createObjectConfig, createObjectGenerator, createSelectionConfig, createSelectionGenerator, createTupleConfig, createTupleGenerator, createValueConfig, createValueGenerator };

package/dist/index.d.ts

@@ -1,87 +0,0 @@
-type ValueConfig<T> = {
-    type: "value";
-    generateFn: () => T;
-};
-type SelectionConfig<T> = {
-    type: "select";
-    items: T[];
-};
-type BoundedSeriesConfig = {
-    type: "bounded_series";
-    upperLimit: number;
-    lowerLimit: number;
-    createInitValue: () => number;
-    count: number;
-};
-type ArrayConfig<T> = {
-    type: "arr";
-    item: T;
-    len: number;
-};
-type ObjectConfig<T> = {
-    type: "obj";
-    content: T;
-};
-type TupleConfig<A, B = undefined, C = undefined, D = undefined, E = undefined> = {
-    type: "tuple";
-    configItems: E extends undefined ? D extends undefined ? C extends undefined ? B extends undefined ? [A] : [A, B] : [A, B, C] : [A, B, C, D] : [A, B, C, D, E];
-};
-type Result<T> = T extends ValueConfig<infer U> ? U : T extends SelectionConfig<infer S> ? S : T extends BoundedSeriesConfig ? number[] : T extends ArrayConfig<infer W> ? Array<Result<W>> : T extends ObjectConfig<infer O> ? {
-    [K in keyof O]: Result<O[K]>;
-} : T extends TupleConfig<infer A, infer B, infer C, infer D, infer E> ? E extends undefined ? D extends undefined ? C extends undefined ? B extends undefined ? [Result<A>] : [Result<A>, Result<B>] : [Result<A>, Result<B>, Result<C>] : [Result<A>, Result<B>, Result<C>, Result<D>] : [Result<A>, Result<B>, Result<C>, Result<D>, Result<E>] : never;
-
-/**
- * value
- * @param {function} generateFn - The function used to generate the value.
- * @return {ValueConfig} The configuration object with the type "value" and the provided generate function.
- */
-declare const createValueConfig: <T>(generateFn: () => T) => ValueConfig<T>;
-/**
- * selection
- * @param {Array} items - The array of items to choose from.
- * @return {SelectionConfig} The configuration object with the type "select" and the provided items.
- */
-declare const createSelectionConfig: <T>(items: T[]) => SelectionConfig<T>;
-/**
- * object
- * @param {object} content
- * @return {ObjectConfig}
- */
-declare const createObjectConfig: <T extends object>(content: T) => ObjectConfig<T>;
-/**
- * array
- * @param {object} item
- * @param {number} len
- * @return {ArrayConfig}
- */
-declare const createArrayConfig: <T>(item: T, len: number) => ArrayConfig<T>;
-/**
- * tuple
- * @param {Array} configItems
- * @return {TupleConfig}
- */
-interface CreateTupleConfig {
-    <A, B, C, D, E>(configItems: [A, B, C, D, E]): TupleConfig<A, B, C, D, E>;
-    <A, B, C, D>(configItems: [A, B, C, D]): TupleConfig<A, B, C, D>;
-    <A, B, C>(configItems: [A, B, C]): TupleConfig<A, B, C>;
-    <A, B>(configItems: [A, B]): TupleConfig<A, B>;
-    <A>(configItems: [A]): TupleConfig<A>;
-}
-declare const createTupleConfig: CreateTupleConfig;
-/**
- * bounded series
- * @param {{ upperLimit: number, lowerLimit: number, createInitValue: () => number, count: number }} config
- * @return {BoundedSeriesConfig}
- */
-declare const createBoundedSeriesConfig: (config: Omit<BoundedSeriesConfig, "type">) => BoundedSeriesConfig;
-
-type AllConfig<T> = ValueConfig<T> | SelectionConfig<T> | ArrayConfig<T> | ObjectConfig<T> | TupleConfig<T> | TupleConfig<T, T> | TupleConfig<T, T, T> | TupleConfig<T, T, T, T> | TupleConfig<T, T, T, T, T> | BoundedSeriesConfig;
-declare const createValueGenerator: <R = unknown>(config: any) => (() => R);
-declare const createSelectionGenerator: <T extends SelectionConfig<unknown>>(config: T) => (() => Result<T>);
-declare const createObjectGenerator: <T extends ObjectConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-declare const createArrayGenerator: <T extends ArrayConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-declare const createTupleGenerator: <T extends TupleConfig<unknown, unknown, unknown, unknown, unknown> | TupleConfig<unknown, unknown, unknown, unknown> | TupleConfig<unknown, unknown, unknown> | TupleConfig<unknown, unknown> | TupleConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-declare const createBoundedSeriesGenerator: <T extends BoundedSeriesConfig>(config: T) => (() => Result<T>);
-declare const createGeneratorByType: <T extends AllConfig<unknown>>(config: T, customTypeMatch?: (config: unknown) => ValueConfig<unknown>) => (() => Result<T>);
-
-export { type ArrayConfig, type BoundedSeriesConfig, type ObjectConfig, type Result, type SelectionConfig, type TupleConfig, type ValueConfig, createArrayConfig, createArrayGenerator, createBoundedSeriesConfig, createBoundedSeriesGenerator, createGeneratorByType, createObjectConfig, createObjectGenerator, createSelectionConfig, createSelectionGenerator, createTupleConfig, createTupleGenerator, createValueConfig, createValueGenerator };