@kubb/plugin-faker 3.0.0-alpha.14 → 3.0.0-alpha.16

package/dist/types-DrJPCRvZ.d.cts

@@ -0,0 +1,125 @@
+import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
+import * as KubbFile from '@kubb/fs/types';
+import { SchemaObject } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override, Schema } from '@kubb/plugin-oas';
+
+type Options = {
+    output?: {
+        /**
+         * Relative path to save the Faker mocks.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'mocks'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+        /**
+         * Define what needs to exported, here you can also disable the export of barrel files
+         * @default `'barrel'`
+         */
+        exportType?: 'barrel' | 'barrelNamed' | false;
+    };
+    /**
+     * Group the Faker mocks based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped Faker mocks.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `mocks/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './`
+         * @default `"{{tag}}Mocks"`
+         */
+        exportAs?: string;
+    };
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Which parser should be used when dateType is set to 'string'.
+     * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * * @default 'faker'
+     */
+    dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
+    /**
+     * Which type to use when the Swagger/OpenAPI file is not providing more information
+     * @default 'any'
+     */
+    unknownType?: 'any' | 'unknown';
+    /**
+     * Choose which generator to use when using Regexp.
+     *
+     * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
+     * `'randexp'` will use `new RandExp(/test/).gen()`
+     * @default 'faker'
+     */
+    regexGenerator?: 'faker' | 'randexp';
+    mapper?: Record<string, string>;
+    /**
+     * The use of Seed is intended to allow for consistent values in a test.
+     */
+    seed?: number | number[];
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+        /**
+         * Receive schema and baseName(propertName) and return FakerMeta array
+         * TODO TODO add docs
+         * @beta
+         */
+        schema?: (props: {
+            schema?: SchemaObject;
+            name?: string;
+            parentName?: string;
+        }, defaultSchemas: Schema[]) => Schema[] | undefined;
+    };
+};
+type ResolvedOptions = {
+    override: NonNullable<Options['override']>;
+    dateType: NonNullable<Options['dateType']>;
+    dateParser: NonNullable<Options['dateParser']>;
+    unknownType: NonNullable<Options['unknownType']>;
+    transformers: NonNullable<Options['transformers']>;
+    seed: NonNullable<Options['seed']> | undefined;
+    mapper: NonNullable<Options['mapper']>;
+    regexGenerator: NonNullable<Options['regexGenerator']>;
+};
+type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginFaker as P };

package/dist/types-DrJPCRvZ.d.ts

@@ -0,0 +1,125 @@
+import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
+import * as KubbFile from '@kubb/fs/types';
+import { SchemaObject } from '@kubb/oas';
+import { ResolvePathOptions, Exclude, Include, Override, Schema } from '@kubb/plugin-oas';
+
+type Options = {
+    output?: {
+        /**
+         * Relative path to save the Faker mocks.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'mocks'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+        /**
+         * Define what needs to exported, here you can also disable the export of barrel files
+         * @default `'barrel'`
+         */
+        exportType?: 'barrel' | 'barrelNamed' | false;
+    };
+    /**
+     * Group the Faker mocks based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped Faker mocks.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `mocks/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './`
+         * @default `"{{tag}}Mocks"`
+         */
+        exportAs?: string;
+    };
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Which parser should be used when dateType is set to 'string'.
+     * - Schema with format 'date' will use ISO date format (YYYY-MM-DD)
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("YYYY-MM-DD")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * - Schema with format 'time' will use ISO time format (HH:mm:ss[.SSSSSS])
+     *   - `'dayjs'` will use `dayjs(faker.date.anytime()).format("HH:mm:ss")`.
+     *   - `undefined` will use `faker.date.anytime().toString()`
+     * * @default 'faker'
+     */
+    dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
+    /**
+     * Which type to use when the Swagger/OpenAPI file is not providing more information
+     * @default 'any'
+     */
+    unknownType?: 'any' | 'unknown';
+    /**
+     * Choose which generator to use when using Regexp.
+     *
+     * `'faker'` will use `faker.helpers.fromRegExp(new RegExp(/test/))`
+     * `'randexp'` will use `new RandExp(/test/).gen()`
+     * @default 'faker'
+     */
+    regexGenerator?: 'faker' | 'randexp';
+    mapper?: Record<string, string>;
+    /**
+     * The use of Seed is intended to allow for consistent values in a test.
+     */
+    seed?: number | number[];
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+        /**
+         * Receive schema and baseName(propertName) and return FakerMeta array
+         * TODO TODO add docs
+         * @beta
+         */
+        schema?: (props: {
+            schema?: SchemaObject;
+            name?: string;
+            parentName?: string;
+        }, defaultSchemas: Schema[]) => Schema[] | undefined;
+    };
+};
+type ResolvedOptions = {
+    override: NonNullable<Options['override']>;
+    dateType: NonNullable<Options['dateType']>;
+    dateParser: NonNullable<Options['dateParser']>;
+    unknownType: NonNullable<Options['unknownType']>;
+    transformers: NonNullable<Options['transformers']>;
+    seed: NonNullable<Options['seed']> | undefined;
+    mapper: NonNullable<Options['mapper']>;
+    regexGenerator: NonNullable<Options['regexGenerator']>;
+};
+type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginFaker as P };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-faker",
-  "version": "3.0.0-alpha.14",
+  "version": "3.0.0-alpha.16",
   "description": "Generator plugin-faker",
   "keywords": [
     "faker",
@@ -28,6 +28,11 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
     "./components": {
       "import": "./dist/components.js",
       "require": "./dist/components.cjs",
@@ -43,6 +48,9 @@
     "*": {
       "components": [
         "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
       ]
     }
   },
@@ -53,25 +61,25 @@
     "!/**/__tests__/**"
   ],
   "dependencies": {
-    "@kubb/core": "3.0.0-alpha.14",
-    "@kubb/fs": "3.0.0-alpha.14",
-    "@kubb/oas": "3.0.0-alpha.14",
-    "@kubb/parser-ts": "3.0.0-alpha.14",
-    "@kubb/plugin-oas": "3.0.0-alpha.14",
-    "@kubb/plugin-ts": "3.0.0-alpha.14",
-    "@kubb/react": "3.0.0-alpha.14"
+    "@kubb/core": "3.0.0-alpha.16",
+    "@kubb/fs": "3.0.0-alpha.16",
+    "@kubb/oas": "3.0.0-alpha.16",
+    "@kubb/parser-ts": "3.0.0-alpha.16",
+    "@kubb/plugin-oas": "3.0.0-alpha.16",
+    "@kubb/plugin-ts": "3.0.0-alpha.16",
+    "@kubb/react": "3.0.0-alpha.16"
   },
   "devDependencies": {
     "@types/react": "^18.3.5",
     "react": "^18.3.1",
     "tsup": "^8.2.4",
-    "typescript": "^5.5.4",
-    "@kubb/config-biome": "3.0.0-alpha.14",
-    "@kubb/config-ts": "3.0.0-alpha.14",
-    "@kubb/config-tsup": "3.0.0-alpha.14"
+    "typescript": "^5.6.2",
+    "@kubb/config-biome": "3.0.0-alpha.16",
+    "@kubb/config-ts": "3.0.0-alpha.16",
+    "@kubb/config-tsup": "3.0.0-alpha.16"
   },
   "peerDependencies": {
-    "@kubb/react": "3.0.0-alpha.14"
+    "@kubb/react": "3.0.0-alpha.16"
   },
   "engines": {
     "node": ">=20"

package/src/components/Faker.tsx

@@ -0,0 +1,80 @@
+import { File, Function, FunctionParams } from '@kubb/react'
+
+import transformers from '@kubb/core/transformers'
+import type { Schema } from '@kubb/plugin-oas'
+import type { KubbNode } from '@kubb/react/types'
+import * as parserFaker from '../parser/index.ts'
+import type { PluginFaker } from '../types.ts'
+
+type Props = {
+  name: string
+  typeName: string
+  tree: Array<Schema>
+  seed?: PluginFaker['options']['seed']
+  description?: string
+  regexGenerator?: PluginFaker['options']['regexGenerator']
+  mapper?: PluginFaker['options']['mapper']
+  dateParser?: PluginFaker['options']['dateParser']
+  canOverride: boolean
+}
+
+export function Faker({ tree, description, name, typeName, seed, regexGenerator, canOverride, mapper, dateParser }: Props): KubbNode {
+  const fakerText = parserFaker.joinItems(
+    tree
+      .map((schema) =>
+        parserFaker.parse(undefined, schema, {
+          name,
+          typeName,
+          seed,
+          regexGenerator,
+          mapper,
+          canOverride,
+          dateParser,
+        }),
+      )
+      .filter(Boolean),
+  )
+
+  let fakerDefaultOverride: '' | '[]' | '{}' | undefined = undefined
+  let fakerTextWithOverride = fakerText
+
+  if (canOverride && fakerText.startsWith('{')) {
+    fakerDefaultOverride = '{}'
+    fakerTextWithOverride = `{
+  ...${fakerText},
+  ...data
+}`
+  }
+
+  if (canOverride && fakerText.startsWith('faker.helpers.arrayElements')) {
+    fakerDefaultOverride = '[]'
+    fakerTextWithOverride = `[
+      ...${fakerText},
+      ...data
+    ]`
+  }
+
+  const params = FunctionParams.factory({
+    data: fakerDefaultOverride
+      ? {
+          type: `NonNullable<Partial<${typeName}>>`,
+          default: fakerDefaultOverride,
+        }
+      : undefined,
+  })
+
+  return (
+    <File.Source name={name} isExportable isIndexable>
+      <Function
+        export
+        name={name}
+        JSDoc={{ comments: [description ? `@description ${transformers.jsStringEscape(description)}` : undefined].filter(Boolean) }}
+        params={params.toConstructor()}
+      >
+        {seed ? `faker.seed(${JSON.stringify(seed)})` : undefined}
+        <br />
+        {`return ${fakerTextWithOverride}`}
+      </Function>
+    </File.Source>
+  )
+}

package/src/components/index.ts

@@ -1,2 +1 @@
-export { OperationSchema } from './OperationSchema.tsx'
-export { Schema } from './Schema.tsx'
+export { Faker } from './Faker.tsx'

package/src/generators/__snapshots__/createPet.ts

@@ -0,0 +1,26 @@
+import { faker } from '@faker-js/faker'
+
+/**
+ * @description Null response
+ */
+export function createPets201() {
+  return unknown
+}
+
+/**
+ * @description unexpected error
+ */
+export function createPetsError() {
+  return error()
+}
+
+export function createPetsMutationRequest(data: NonNullable<Partial<CreatePetsMutationRequest>> = {}) {
+  return {
+    ...{ name: faker.string.alpha(), tag: faker.string.alpha() },
+    ...data,
+  }
+}
+
+export function createPetsMutationResponse() {
+  return unknown
+}

package/src/generators/__snapshots__/createPetSeed.ts

@@ -0,0 +1,30 @@
+import { faker } from '@faker-js/faker'
+
+/**
+ * @description Null response
+ */
+export function createPets201() {
+  faker.seed([222])
+  return unknown
+}
+
+/**
+ * @description unexpected error
+ */
+export function createPetsError() {
+  faker.seed([222])
+  return error()
+}
+
+export function createPetsMutationRequest(data: NonNullable<Partial<CreatePetsMutationRequest>> = {}) {
+  faker.seed([222])
+  return {
+    ...{ name: faker.string.alpha(), tag: faker.string.alpha() },
+    ...data,
+  }
+}
+
+export function createPetsMutationResponse() {
+  faker.seed([222])
+  return unknown
+}

package/src/generators/__snapshots__/createPetUnknownTypeAny.ts

@@ -0,0 +1,26 @@
+import { faker } from '@faker-js/faker'
+
+/**
+ * @description Null response
+ */
+export function createPets201() {
+  return undefined
+}
+
+/**
+ * @description unexpected error
+ */
+export function createPetsError() {
+  return error()
+}
+
+export function createPetsMutationRequest(data: NonNullable<Partial<CreatePetsMutationRequest>> = {}) {
+  return {
+    ...{ name: faker.string.alpha(), tag: faker.string.alpha() },
+    ...data,
+  }
+}
+
+export function createPetsMutationResponse() {
+  return undefined
+}

package/src/generators/__snapshots__/deletePet.ts

@@ -0,0 +1,3 @@
+export function deletePetsPetidMutationResponse() {
+  return unknown
+}

package/src/generators/__snapshots__/enumNames.ts

@@ -0,0 +1,5 @@
+import { faker } from '@faker-js/faker'
+
+export function enumNamesType() {
+  return faker.helpers.arrayElement<any>(['Pending', 'Received'])
+}

package/src/generators/__snapshots__/enumVarNames.ts

@@ -0,0 +1,5 @@
+import { faker } from '@faker-js/faker'
+
+export function enumVarNamesType() {
+  return faker.helpers.arrayElement<any>(['Pending', 'Received'])
+}

package/src/generators/__snapshots__/getPets.ts

@@ -0,0 +1,29 @@
+import { faker } from '@faker-js/faker'
+
+export function listPetsQueryParams(data: NonNullable<Partial<ListPetsQueryParams>> = {}) {
+  return {
+    ...{ limit: faker.string.alpha() },
+    ...data,
+  }
+}
+
+/**
+ * @description A paged array of pets
+ */
+export function listPets200() {
+  return pets()
+}
+
+/**
+ * @description unexpected error
+ */
+export function listPetsError() {
+  return error()
+}
+
+/**
+ * @description A paged array of pets
+ */
+export function listPetsQueryResponse() {
+  return pets()
+}

package/src/generators/__snapshots__/pet.ts

@@ -0,0 +1,15 @@
+import { faker } from '@faker-js/faker'
+
+export function pet(data: NonNullable<Partial<Pet>> = {}) {
+  return {
+    ...{
+      id: faker.number.int(),
+      name: faker.string.alpha(),
+      tag: faker.string.alpha(),
+      code: faker.helpers.arrayElement<any>([faker.string.alpha(), faker.helpers.fromRegExp(new RegExp('\\b[1-9]\\b'))]),
+      shipDate: faker.date.anytime(),
+      shipTime: faker.date.anytime(),
+    },
+    ...data,
+  }
+}

package/src/generators/__snapshots__/petWithDateString.ts

@@ -0,0 +1,15 @@
+import { faker } from '@faker-js/faker'
+
+export function pet(data: NonNullable<Partial<Pet>> = {}) {
+  return {
+    ...{
+      id: faker.number.int(),
+      name: faker.string.alpha(),
+      tag: faker.string.alpha(),
+      code: faker.helpers.arrayElement<any>([faker.string.alpha(), faker.helpers.fromRegExp(new RegExp('\\b[1-9]\\b'))]),
+      shipDate: faker.date.anytime().toString(),
+      shipTime: faker.date.anytime().toString(),
+    },
+    ...data,
+  }
+}

package/src/generators/__snapshots__/petWithDayjs.ts

@@ -0,0 +1,16 @@
+import dayjs from 'dayjs'
+import { faker } from '@faker-js/faker'
+
+export function pet(data: NonNullable<Partial<Pet>> = {}) {
+  return {
+    ...{
+      id: faker.number.int(),
+      name: faker.string.alpha(),
+      tag: faker.string.alpha(),
+      code: faker.helpers.arrayElement<any>([faker.string.alpha(), faker.helpers.fromRegExp(new RegExp('\\b[1-9]\\b'))]),
+      shipDate: dayjs(faker.date.anytime()).format('YYYY-MM-DD'),
+      shipTime: dayjs(faker.date.anytime()).format('HH:mm:ss'),
+    },
+    ...data,
+  }
+}

package/src/generators/__snapshots__/petWithMapper.ts

@@ -0,0 +1,15 @@
+import { faker } from '@faker-js/faker'
+
+export function pet(data: NonNullable<Partial<Pet>> = {}) {
+  return {
+    ...{
+      id: faker.string.fromCharacters('abc'),
+      name: faker.string.alpha({ casing: 'lower' }),
+      tag: faker.string.alpha(),
+      code: faker.helpers.arrayElement<any>([faker.string.alpha(), faker.helpers.fromRegExp(new RegExp('\\b[1-9]\\b'))]),
+      shipDate: faker.date.anytime(),
+      shipTime: faker.date.anytime(),
+    },
+    ...data,
+  }
+}

package/src/generators/__snapshots__/petWithRandExp.ts

@@ -0,0 +1,16 @@
+import RandExp from 'randexp'
+import { faker } from '@faker-js/faker'
+
+export function pet(data: NonNullable<Partial<Pet>> = {}) {
+  return {
+    ...{
+      id: faker.number.int(),
+      name: faker.string.alpha(),
+      tag: faker.string.alpha(),
+      code: faker.helpers.arrayElement<any>([faker.string.alpha(), new RandExp('\\b[1-9]\\b').gen()]),
+      shipDate: faker.date.anytime(),
+      shipTime: faker.date.anytime(),
+    },
+    ...data,
+  }
+}

package/src/generators/__snapshots__/pets.ts

@@ -0,0 +1,5 @@
+import { faker } from '@faker-js/faker'
+
+export function pets(data: NonNullable<Partial<Pets>> = []) {
+  return [...(faker.helpers.arrayElements([pet()]) as any), ...data]
+}

package/src/generators/__snapshots__/showPetById.ts

@@ -0,0 +1,29 @@
+import { faker } from '@faker-js/faker'
+
+export function showPetByIdPathParams(data: NonNullable<Partial<ShowPetByIdPathParams>> = {}) {
+  return {
+    ...{ petId: faker.string.alpha(), testId: faker.string.alpha() },
+    ...data,
+  }
+}
+
+/**
+ * @description Expected response to a valid request
+ */
+export function showPetById200() {
+  return pet()
+}
+
+/**
+ * @description unexpected error
+ */
+export function showPetByIdError() {
+  return error()
+}
+
+/**
+ * @description Expected response to a valid request
+ */
+export function showPetByIdQueryResponse() {
+  return pet()
+}