struct-fakerator 2.8.9 → 3.0.0

package/src/create_generator_fn.ts

@@ -1,342 +0,0 @@
-import { faker } from "@faker-js/faker";
-import {
-  arrayConfigScheme,
-  boundedSeriesScheme,
-  objConfigScheme,
-  selectionConfigScheme,
-  tupleConfigScheme,
-  valueConfigScheme,
-} from "./config_scheme";
-import type {
-  ArrayConfig,
-  BoundedSeriesConfig,
-  ObjectConfig,
-  ObjectConfigWithFn,
-  Result,
-  SelectionConfig,
-  TupleConfig,
-  ValueConfig,
-} from "./type";
-
-type AllConfig<T> =
-  | ValueConfig<T>
-  | SelectionConfig<T>
-  | ArrayConfig<T>
-  | ObjectConfig<T>
-  | ObjectConfigWithFn<T, unknown>
-  | TupleConfig<T>
-  | TupleConfig<T, T>
-  | TupleConfig<T, T, T>
-  | TupleConfig<T, T, T, T>
-  | TupleConfig<T, T, T, T, T>
-  | TupleConfig<T, T, T, T, T, T>
-  | TupleConfig<T, T, T, T, T, T, T>
-  | TupleConfig<T, T, T, T, T, T, T, T>
-  | TupleConfig<T, T, T, T, T, T, T, T, T>
-  | TupleConfig<T, T, T, T, T, T, T, T, T, T>
-  | BoundedSeriesConfig;
-
-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, "*");
-
-// =================== generator fn ====================
-
-const _createSelectionGenerator = <T extends SelectionConfig<unknown>>(
-  config: T,
-  path: string,
-): (() => Result<T>) => {
-  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 createSelectionGenerator = <T extends SelectionConfig<unknown>>(
-  config: T,
-): (() => Result<T>) => _createSelectionGenerator(config, "*");
-
-// =================== generator fn ====================
-
-const _createObjectGenerator = <
-  T extends ObjectConfig<unknown> | ObjectConfigWithFn<unknown, unknown>,
->(
-  config: T,
-  path: string,
-  customTypeMatch?: (config: unknown, path: string) => ValueConfig<unknown>,
-): (() => Result<T>) => {
-  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, `${path}.obj[${key}]`, customTypeMatch),
-    ]);
-
-  return () => {
-    const result: Record<string, unknown> = {};
-    for (const [key, generateFn] of keyWithFns) {
-      result[key] = generateFn();
-    }
-
-    if ("transformer" in config && typeof config.transformer === "function") {
-      return config.transformer(result) as Result<T>;
-    }
-    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);
-
-// =================== generator fn ====================
-
-const _createArrayGenerator = <T extends ArrayConfig<unknown>>(
-  config: T,
-  path: string,
-  customTypeMatch?: (config: unknown, path: string) => ValueConfig<unknown>,
-): (() => Result<T>) => {
-  try {
-    arrayConfigScheme.parse(config);
-  } catch (err) {
-    throw new Error(`config path: ${path}.arr\n ${err}`);
-  }
-
-  const itemGeneratorFn = _createGeneratorByType(
-    config.item as AllConfig<unknown>,
-    `${path}.arr`,
-    customTypeMatch,
-  ) as () => Result<T>;
-
-  if (config.next) {
-    const next: (prev: Result<T>, current: Result<T>) => Result<T> =
-      config.next;
-    return () => {
-      let prev = itemGeneratorFn();
-      const result = [];
-      for (let i = 0; i < config.len; i++) {
-        const nextValue = next(prev, itemGeneratorFn());
-        result.push(nextValue);
-        prev = nextValue;
-      }
-
-      return result as Result<T>;
-    };
-  }
-
-  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);
-
-// =================== generator fn ====================
-
-const _createTupleGenerator = <
-  T extends
-    | TupleConfig<
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown
-      >
-    | TupleConfig<
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown
-      >
-    | TupleConfig<
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown
-      >
-    | TupleConfig<unknown, unknown, unknown, unknown, unknown, unknown>
-    | TupleConfig<unknown, unknown, unknown, unknown, unknown>
-    | TupleConfig<unknown, unknown, unknown, unknown>
-    | TupleConfig<unknown, unknown, unknown>
-    | TupleConfig<unknown, unknown>
-    | TupleConfig<unknown>,
->(
-  config: T,
-  path: string,
-  customTypeMatch?: (config: unknown, path?: string) => ValueConfig<unknown>,
-): (() => Result<T>) => {
-  try {
-    tupleConfigScheme.parse(config);
-  } catch (err) {
-    throw new Error(`config path: ${path}.tuple\n ${err}`);
-  }
-
-  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,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown
-      >
-    | TupleConfig<
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown
-      >
-    | TupleConfig<
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown,
-        unknown
-      >
-    | TupleConfig<unknown, unknown, unknown, unknown, unknown, unknown>
-    | 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);
-
-// =================== generator fn ====================
-
-const _createBoundedSeriesGenerator = <T extends BoundedSeriesConfig>(
-  config: T,
-  path: string,
-): (() => Result<T>) => {
-  try {
-    boundedSeriesScheme.parse(config);
-  } catch (err) {
-    throw new Error(`config path: ${path}.boundedSeries\n ${err}`);
-  }
-
-  const { upperLimit, lowerLimit, createInitValue, count } = config;
-
-  return () => {
-    let value = createInitValue();
-
-    const boundedSeries = [];
-
-    for (let i = 0; i < count; i++) {
-      value = faker.number.float({ max: upperLimit, min: lowerLimit }) * value;
-      boundedSeries.push(value);
-    }
-
-    return boundedSeries as Result<T>;
-  };
-};
-export const createBoundedSeriesGenerator = <T extends BoundedSeriesConfig>(
-  config: T,
-): (() => Result<T>) => _createBoundedSeriesGenerator(config, "*");
-
-// =================== generator fn ====================
-
-const _createGeneratorByType = <T extends AllConfig<unknown>>(
-  config: T,
-  path: string,
-  customTypeMatch?: (config: unknown, path: string) => ValueConfig<unknown>,
-): (() => Result<T>) => {
-  switch (config.type) {
-    case "obj":
-      return _createObjectGenerator(
-        config,
-        path,
-        customTypeMatch,
-      ) as () => Result<T>;
-    case "arr":
-      return _createArrayGenerator(
-        config,
-        path,
-        customTypeMatch,
-      ) as () => Result<T>;
-    case "tuple":
-      return _createTupleGenerator(
-        config,
-        path,
-        customTypeMatch,
-      ) as () => Result<T>;
-    case "select":
-      return _createSelectionGenerator(config, path) as () => Result<T>;
-    case "value":
-      return _createValueGenerator(config, path);
-    case "bounded_series":
-      return _createBoundedSeriesGenerator(config, path) as () => Result<T>;
-    default: {
-      if (customTypeMatch) {
-        return createValueGenerator(customTypeMatch(config, path));
-      }
-      throw new Error(`path: ${path}\nconfig type is not supported`);
-    }
-  }
-};
-
-export const createGeneratorByType = <T extends AllConfig<unknown>>(
-  config: T,
-  customTypeMatch?: (config: unknown, path: string) => ValueConfig<unknown>,
-): (() => Result<T>) => _createGeneratorByType(config, "*", customTypeMatch);

package/src/generator_fn.ts

@@ -1,9 +0,0 @@
-export {
-  createArrayGenerator as genArrayFn,
-  createBoundedSeriesGenerator as genBoundedSeriesFn,
-  createGeneratorByType as genFn,
-  createObjectGenerator as genObjectFn,
-  createSelectionGenerator as genSelectFn,
-  createTupleGenerator as genTupleFn,
-  createValueGenerator as genValueFn,
-} from "./create_generator_fn";

package/src/index.ts

@@ -1,5 +0,0 @@
-export * as StructConfig from "./config";
-export * from "./create_config";
-export * from "./create_generator_fn";
-export * as StructGenerator from "./generator_fn";
-export * from "./type";

package/src/type.ts

@@ -1,167 +0,0 @@
-export type ValueConfig<T> = {
-  type: "value";
-  generateFn: () => T;
-};
-
-export type SelectionConfig<T> = {
-  type: "select";
-  items: T[];
-};
-
-export type BoundedSeriesConfig = {
-  type: "bounded_series";
-  upperLimit: number;
-  lowerLimit: number;
-  createInitValue: () => number;
-  count: number;
-};
-
-export type ArrayConfig<T> = {
-  type: "arr";
-  item: T;
-  len: number;
-  next?: (prev: Result<T>, current: Result<T>) => Result<T>;
-};
-
-export type ObjectConfig<T> = {
-  type: "obj";
-  content: T;
-};
-
-export type ObjectConfigWithFn<T, R> = {
-  type: "obj";
-  content: T;
-  transformer: (v: { [K in keyof T]: Result<T[K]> }) => R;
-};
-
-export type TupleItems<A, B, C, D, E, F, G, H, I, J> = J extends undefined
-  ? I extends undefined
-    ? H extends undefined
-      ? G extends undefined
-        ? F extends undefined
-          ? 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]
-          : [A, B, C, D, E, F]
-        : [A, B, C, D, E, F, G]
-      : [A, B, C, D, E, F, G, H]
-    : [A, B, C, D, E, F, G, H, I]
-  : [A, B, C, D, E, F, G, H, I, J];
-
-export type TupleConfig<
-  A,
-  B = undefined,
-  C = undefined,
-  D = undefined,
-  E = undefined,
-  F = undefined,
-  G = undefined,
-  H = undefined,
-  I = undefined,
-  J = undefined,
-> = {
-  type: "tuple";
-  configItems: TupleItems<A, B, C, D, E, F, G, H, I, J>;
-};
-
-export 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 ObjectConfigWithFn<infer _, infer R>
-          ? R
-          : 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,
-                  infer F,
-                  infer G,
-                  infer H,
-                  infer I,
-                  infer J
-                >
-              ? J extends undefined
-                ? I extends undefined
-                  ? H extends undefined
-                    ? G extends undefined
-                      ? F extends undefined
-                        ? 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>,
-                            ]
-                        : [
-                            Result<A>,
-                            Result<B>,
-                            Result<C>,
-                            Result<D>,
-                            Result<E>,
-                            Result<F>,
-                          ]
-                      : [
-                          Result<A>,
-                          Result<B>,
-                          Result<C>,
-                          Result<D>,
-                          Result<E>,
-                          Result<F>,
-                          Result<G>,
-                        ]
-                    : [
-                        Result<A>,
-                        Result<B>,
-                        Result<C>,
-                        Result<D>,
-                        Result<E>,
-                        Result<F>,
-                        Result<G>,
-                        Result<H>,
-                      ]
-                  : [
-                      Result<A>,
-                      Result<B>,
-                      Result<C>,
-                      Result<D>,
-                      Result<E>,
-                      Result<F>,
-                      Result<G>,
-                      Result<H>,
-                      Result<I>,
-                    ]
-                : [
-                    Result<A>,
-                    Result<B>,
-                    Result<C>,
-                    Result<D>,
-                    Result<E>,
-                    Result<F>,
-                    Result<G>,
-                    Result<H>,
-                    Result<I>,
-                    Result<J>,
-                  ]
-              : never;

package/src/utils/airline.ts

@@ -1,11 +0,0 @@
-import { faker } from "@faker-js/faker";
-import { makeValueConfigFn } from "./utils";
-
-/** Airline [aircraftType](https://fakerjs.dev/api/airline.html#aircraftType) */
-export const aircraftType = makeValueConfigFn(faker.airline.aircraftType);
-
-/** Airline [flightNumber](https://fakerjs.dev/api/airline.html#flightNumber) */
-export const flightNumber = makeValueConfigFn(faker.airline.flightNumber);
-
-/** Airline [seat](https://fakerjs.dev/api/airline.html#seat) */
-export const seat = makeValueConfigFn(faker.airline.seat);

package/src/utils/animal.ts

@@ -1,47 +0,0 @@
-import { faker } from "@faker-js/faker";
-import { makeValueConfigFn } from "./utils";
-
-/** Animal [bear](https://fakerjs.dev/api/animal.html#bear) */
-export const bear = makeValueConfigFn(faker.animal.bear);
-
-/** Animal [bird](https://fakerjs.dev/api/animal.html#bird) */
-export const bird = makeValueConfigFn(faker.animal.bird);
-
-/** Animal [cat](https://fakerjs.dev/api/animal.html#cat) */
-export const cat = makeValueConfigFn(faker.animal.cat);
-
-/** Animal [cetacean](https://fakerjs.dev/api/animal.html#cetacean) */
-export const cetacean = makeValueConfigFn(faker.animal.cetacean);
-
-/** Animal [cow](https://fakerjs.dev/api/animal.html#cow) */
-export const cow = makeValueConfigFn(faker.animal.cow);
-
-/** Animal [crocodilia](https://fakerjs.dev/api/animal.html#crocodilia) */
-export const crocodilia = makeValueConfigFn(faker.animal.crocodilia);
-
-/** Animal [dog](https://fakerjs.dev/api/animal.html#dog) */
-export const dog = makeValueConfigFn(faker.animal.dog);
-
-/** Animal [fish](https://fakerjs.dev/api/animal.html#fish) */
-export const fish = makeValueConfigFn(faker.animal.fish);
-
-/** Animal [horse](https://fakerjs.dev/api/animal.html#horse) */
-export const horse = makeValueConfigFn(faker.animal.horse);
-
-/** Animal [insect](https://fakerjs.dev/api/animal.html#insect) */
-export const insect = makeValueConfigFn(faker.animal.insect);
-
-/** Animal [lion](https://fakerjs.dev/api/animal.html#lion) */
-export const lion = makeValueConfigFn(faker.animal.lion);
-
-/** Animal [rabbit](https://fakerjs.dev/api/animal.html#rabbit) */
-export const rabbit = makeValueConfigFn(faker.animal.rabbit);
-
-/** Animal [rodent](https://fakerjs.dev/api/animal.html#rodent) */
-export const rodent = makeValueConfigFn(faker.animal.rodent);
-
-/** Animal [snake](https://fakerjs.dev/api/animal.html#snake) */
-export const snake = makeValueConfigFn(faker.animal.snake);
-
-/** Animal [type](https://fakerjs.dev/api/animal.html#type) */
-export const type = makeValueConfigFn(faker.animal.type);

package/src/utils/color.ts

@@ -1,41 +0,0 @@
-import { faker } from "@faker-js/faker";
-import { makeValueConfigFn } from "./utils";
-
-/** Color [cmyk](https://fakerjs.dev/api/color.html#cmyk) */
-export const cmyk = makeValueConfigFn(faker.color.cmyk);
-
-/** Color [colorByCSSColorSpace](https://fakerjs.dev/api/color.html#colorByCSSColorSpace) */
-export const colorByCSSColorSpace = makeValueConfigFn(
-  faker.color.colorByCSSColorSpace,
-);
-
-/** Color [cssSupportedFunction](https://fakerjs.dev/api/color.html#cssSupportedFunction) */
-export const cssSupportedFunction = makeValueConfigFn(
-  faker.color.cssSupportedFunction,
-);
-
-/** Color [cssSupportedSpace](https://fakerjs.dev/api/color.html#cssSupportedSpace) */
-export const cssSupportedSpace = makeValueConfigFn(
-  faker.color.cssSupportedSpace,
-);
-
-/** Color [hsl](https://fakerjs.dev/api/color.html#hsl) */
-export const hsl = makeValueConfigFn(faker.color.hsl);
-
-/** Color [human](https://fakerjs.dev/api/color.html#human) */
-export const human = makeValueConfigFn(faker.color.human);
-
-/** Color [hwb](https://fakerjs.dev/api/color.html#hwb) */
-export const hwb = makeValueConfigFn(faker.color.hwb);
-
-/** Color [lab](https://fakerjs.dev/api/color.html#lab) */
-export const lab = makeValueConfigFn(faker.color.lab);
-
-/** Color [lch](https://fakerjs.dev/api/color.html#lch) */
-export const lch = makeValueConfigFn(faker.color.lch);
-
-/** Color [rgb](https://fakerjs.dev/api/color.html#rgb) */
-export const rgb = makeValueConfigFn(faker.color.rgb);
-
-/** Color [space](https://fakerjs.dev/api/color.html#space) */
-export const space = makeValueConfigFn(faker.color.space);

package/src/utils/commerce.ts

@@ -1,32 +0,0 @@
-import { faker } from "@faker-js/faker";
-import { makeValueConfigFn } from "./utils";
-
-/** Commerce [department](https://fakerjs.dev/api/commerce.html#department) */
-export const department = makeValueConfigFn(faker.commerce.department);
-
-/** Commerce [isbn](https://fakerjs.dev/api/commerce.html#isbn) */
-export const isbn = makeValueConfigFn(faker.commerce.isbn);
-
-/** Commerce [price](https://fakerjs.dev/api/commerce.html#price) */
-export const price = makeValueConfigFn(faker.commerce.price);
-
-/** Commerce [product](https://fakerjs.dev/api/commerce.html#product) */
-export const product = makeValueConfigFn(faker.commerce.product);
-
-/** Commerce [productAdjective](https://fakerjs.dev/api/commerce.html#productAdjective) */
-export const productAdjective = makeValueConfigFn(
-  faker.commerce.productAdjective,
-);
-
-/** Commerce [productDescription](https://fakerjs.dev/api/commerce.html#productDescription) */
-export const productDescription = makeValueConfigFn(
-  faker.commerce.productDescription,
-);
-
-/** Commerce [productMaterial](https://fakerjs.dev/api/commerce.html#productMaterial) */
-export const productMaterial = makeValueConfigFn(
-  faker.commerce.productMaterial,
-);
-
-/** Commerce [productName](https://fakerjs.dev/api/commerce.html#productName) */
-export const productName = makeValueConfigFn(faker.commerce.productName);

package/src/utils/common.ts

@@ -1,4 +0,0 @@
-import { createValueConfig } from "../create_config";
-
-/** Common constant */
-export const constant = <T>(value: T) => createValueConfig(() => value);

package/src/utils/company.ts

@@ -1,33 +0,0 @@
-import { faker } from "@faker-js/faker";
-import { makeValueConfigFn } from "./utils";
-
-/** Company [buzzAdjective](https://fakerjs.dev/api/company.html#buzzAdjective) */
-export const buzzAdjective = makeValueConfigFn(faker.company.buzzAdjective);
-
-/** Company [buzzNoun](https://fakerjs.dev/api/company.html#buzzNoun) */
-export const buzzNoun = makeValueConfigFn(faker.company.buzzNoun);
-
-/** Company [buzzPhrase](https://fakerjs.dev/api/company.html#buzzPhrase) */
-export const buzzPhrase = makeValueConfigFn(faker.company.buzzPhrase);
-
-/** Company [buzzVerb](https://fakerjs.dev/api/company.html#buzzVerb) */
-export const buzzVerb = makeValueConfigFn(faker.company.buzzVerb);
-
-/** Company [catchPhrase](https://fakerjs.dev/api/company.html#catchPhrase) */
-export const catchPhrase = makeValueConfigFn(faker.company.catchPhrase);
-
-/** Company [catchPhraseAdjective](https://fakerjs.dev/api/company.html#catchPhraseAdjective) */
-export const catchPhraseAdjective = makeValueConfigFn(
-  faker.company.catchPhraseAdjective,
-);
-
-/** Company [catchPhraseDescriptor](https://fakerjs.dev/api/company.html#catchPhraseDescriptor) */
-export const catchPhraseDescriptor = makeValueConfigFn(
-  faker.company.catchPhraseDescriptor,
-);
-
-/** Company [catchPhraseNoun](https://fakerjs.dev/api/company.html#catchPhraseNoun) */
-export const catchPhraseNoun = makeValueConfigFn(faker.company.catchPhraseNoun);
-
-/** Company [name](https://fakerjs.dev/api/company.html#name) */
-export const name = makeValueConfigFn(faker.company.name);