@kubb/plugin-faker 4.29.1 → 4.31.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-faker",
-  "version": "4.29.1",
+  "version": "4.31.1",
   "description": "Faker.js data generator plugin for Kubb, creating realistic mock data from OpenAPI specifications for development and testing.",
   "keywords": [
     "faker",
@@ -60,7 +60,8 @@
     "src",
     "dist",
     "!/**/**.test.**",
-    "!/**/__tests__/**"
+    "!/**/__tests__/**",
+    "!/**/__snapshots__/**"
   ],
   "size-limit": [
     {
@@ -70,11 +71,11 @@
     }
   ],
   "dependencies": {
-    "@kubb/react-fabric": "0.13.1",
-    "@kubb/core": "4.29.1",
-    "@kubb/oas": "4.29.1",
-    "@kubb/plugin-oas": "4.29.1",
-    "@kubb/plugin-ts": "4.29.1"
+    "@kubb/react-fabric": "0.13.3",
+    "@kubb/core": "4.31.1",
+    "@kubb/oas": "4.31.1",
+    "@kubb/plugin-oas": "4.31.1",
+    "@kubb/plugin-ts": "4.31.1"
   },
   "engines": {
     "node": ">=20"

package/dist/types-DpNAdZTi.d.ts

@@ -1,133 +0,0 @@
-import { Exclude, Include, Override, ResolvePathOptions, Schema } from "@kubb/plugin-oas";
-import { Group, Output, PluginFactoryOptions, ResolveNameParams } from "@kubb/core";
-import { Oas, SchemaObject, contentType } from "@kubb/oas";
-import { Generator } from "@kubb/plugin-oas/generators";
-
-//#region \0rolldown/runtime.js
-//#endregion
-//#region src/types.d.ts
-type Options = {
-  /**
-   * Specify the export location for the files and define the behavior of the output
-   * @default { path: 'handlers', barrelType: 'named' }
-   */
-  output?: Output<Oas>;
-  /**
-   * Define which contentType should be used.
-   * By default, the first JSON valid mediaType is used
-   */
-  contentType?: contentType;
-  /**
-   * Group the Faker mocks based on the provided name.
-   */
-  group?: Group;
-  /**
-   * 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.
-   * - 'string' represents dates as string values.
-   * - 'date' represents dates as JavaScript Date objects.
-   * @default 'string'
-   */
-  dateType?: 'string' | 'date';
-  /**
-   * Choose to use `number` or `bigint` for integer fields with `int64` format.
-   * - 'number' uses the JavaScript `number` type (matches JSON.parse() runtime behavior).
-   * - 'bigint' uses the JavaScript `bigint` type (accurate for values exceeding Number.MAX_SAFE_INTEGER).
-   * @note in v5 of Kubb 'bigint' will become the default to better align with OpenAPI's int64 specification.
-   * @default 'number'
-   */
-  integerType?: 'number' | 'bigint';
-  /**
-   * Which parser should be used when dateType is set to string.
-   * - 'faker' uses faker's built-in date formatting methods.
-   * - 'dayjs' uses dayjs for date formatting with custom patterns.
-   * - 'moment' uses moment for date formatting with custom patterns.
-   * @default 'faker'
-   */
-  dateParser?: 'faker' | 'dayjs' | 'moment' | (string & {});
-  /**
-   * Which type to use when the Swagger/OpenAPI file is not providing more information.
-   * - 'any' allows any value.
-   * - 'unknown' requires type narrowing before use.
-   * - 'void' represents no value.
-   * @default 'any'
-   */
-  unknownType?: 'any' | 'unknown' | 'void';
-  /**
-   * Which type to use for empty schema values.
-   * - 'any' allows any value.
-   * - 'unknown' requires type narrowing before use.
-   * - 'void' represents no value.
-   * @default `unknownType`
-   */
-  emptySchemaType?: 'any' | 'unknown' | 'void';
-  /**
-   * Choose which generator to use when using Regexp.
-   * - 'faker' uses faker.helpers.fromRegExp for generating values from regex patterns.
-   * - 'randexp' uses RandExp library for generating values from regex patterns.
-   * @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[];
-  /**
-   * Transform parameter names to a specific casing format.
-   * When set to 'camelcase', parameter names in path, query, and header params will be transformed to camelCase.
-   * This should match the paramsCasing setting used in @kubb/plugin-ts.
-   * @default undefined
-   */
-  paramsCasing?: 'camelcase';
-  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(propertyName) and return FakerMeta array
-     * TODO TODO add docs
-     * @beta
-     */
-    schema?: (props: {
-      schema: SchemaObject | null;
-      name: string | null;
-      parentName: string | null;
-    }, defaultSchemas: Schema[]) => Schema[] | undefined;
-  };
-  /**
-   * Define some generators next to the faker generators
-   */
-  generators?: Array<Generator<PluginFaker>>;
-};
-type ResolvedOptions = {
-  output: Output<Oas>;
-  group: Options['group'];
-  override: NonNullable<Options['override']>;
-  dateType: NonNullable<Options['dateType']>;
-  integerType: NonNullable<Options['integerType']>;
-  dateParser: NonNullable<Options['dateParser']>;
-  unknownType: NonNullable<Options['unknownType']>;
-  emptySchemaType: NonNullable<Options['emptySchemaType']>;
-  transformers: NonNullable<Options['transformers']>;
-  seed: NonNullable<Options['seed']> | undefined;
-  mapper: NonNullable<Options['mapper']>;
-  regexGenerator: NonNullable<Options['regexGenerator']>;
-  paramsCasing: Options['paramsCasing'];
-};
-type PluginFaker = PluginFactoryOptions<'plugin-faker', Options, ResolvedOptions, never, ResolvePathOptions>;
-//#endregion
-export { PluginFaker as n, __name as r, Options as t };
-//# sourceMappingURL=types-DpNAdZTi.d.ts.map

package/src/generators/__snapshots__/createPet.ts

@@ -1,30 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-/**
- * @description Null response
- */
-export function createPets201() {
-  return undefined
-}
-
-/**
- * @description unexpected error
- */
-export function createPetsError(data?: Partial<CreatePetsError>): CreatePetsError {
-  return error(data)
-}
-
-export function createPetsMutationRequest(data?: Partial<CreatePetsMutationRequest>): CreatePetsMutationRequest {
-  return {
-    ...{ name: faker.string.alpha(), tag: faker.string.alpha() },
-    ...(data || {}),
-  }
-}
-
-export function createPetsMutationResponse(data?: Partial<CreatePetsMutationResponse>): CreatePetsMutationResponse {
-  return data || faker.helpers.arrayElement<any>([createPets201()])
-}

package/src/generators/__snapshots__/createPetSeed.ts

@@ -1,34 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-/**
- * @description Null response
- */
-export function createPets201() {
-  faker.seed([222])
-  return undefined
-}
-
-/**
- * @description unexpected error
- */
-export function createPetsError(data?: Partial<CreatePetsError>): CreatePetsError {
-  faker.seed([222])
-  return error(data)
-}
-
-export function createPetsMutationRequest(data?: Partial<CreatePetsMutationRequest>): CreatePetsMutationRequest {
-  faker.seed([222])
-  return {
-    ...{ name: faker.string.alpha(), tag: faker.string.alpha() },
-    ...(data || {}),
-  }
-}
-
-export function createPetsMutationResponse(data?: Partial<CreatePetsMutationResponse>): CreatePetsMutationResponse {
-  faker.seed([222])
-  return data || faker.helpers.arrayElement<any>([createPets201()])
-}

package/src/generators/__snapshots__/createPetUnknownTypeAny.ts

@@ -1,30 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-/**
- * @description Null response
- */
-export function createPets201() {
-  return undefined
-}
-
-/**
- * @description unexpected error
- */
-export function createPetsError(data?: Partial<CreatePetsError>): CreatePetsError {
-  return error(data)
-}
-
-export function createPetsMutationRequest(data?: Partial<CreatePetsMutationRequest>): CreatePetsMutationRequest {
-  return {
-    ...{ name: faker.string.alpha(), tag: faker.string.alpha() },
-    ...(data || {}),
-  }
-}
-
-export function createPetsMutationResponse(data?: Partial<CreatePetsMutationResponse>): CreatePetsMutationResponse {
-  return data || faker.helpers.arrayElement<any>([createPets201()])
-}

package/src/generators/__snapshots__/deletePet.ts

@@ -1,8 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-
-export function deletePetsPetidMutationResponse(data?: Partial<DeletePetsPetidMutationResponse>): DeletePetsPetidMutationResponse {
-  return undefined
-}

package/src/generators/__snapshots__/enumNames.ts

@@ -1,9 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function enumNamesType(data?: Partial<EnumNamesType>): EnumNamesType {
-  return data || faker.helpers.arrayElement<EnumNamesType>([0, 1])
-}

package/src/generators/__snapshots__/enumVarNames.ts

@@ -1,9 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function enumVarNamesType(data?: Partial<EnumVarNamesType>): EnumVarNamesType {
-  return data || faker.helpers.arrayElement<EnumVarNamesType>([0, 1])
-}

package/src/generators/__snapshots__/float.ts

@@ -1,9 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function float(data?: number): number {
-  return data ?? faker.number.float()
-}

package/src/generators/__snapshots__/getPets.ts

@@ -1,33 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function listPetsQueryParams(data?: Partial<ListPetsQueryParams>): ListPetsQueryParams {
-  return {
-    ...{ limit: faker.string.alpha() },
-    ...(data || {}),
-  }
-}
-
-/**
- * @description A paged array of pets
- */
-export function listPets200(data?: Partial<ListPets200>): ListPets200 {
-  return {
-    ...{ ...pagination(), ...pets() },
-    ...(data || {}),
-  }
-}
-
-/**
- * @description unexpected error
- */
-export function listPetsError(data?: Partial<ListPetsError>): ListPetsError {
-  return error(data)
-}
-
-export function listPetsQueryResponse(data?: Partial<ListPetsQueryResponse>): ListPetsQueryResponse {
-  return data || faker.helpers.arrayElement<any>([listPets200()])
-}

package/src/generators/__snapshots__/integer.ts

@@ -1,9 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function integer(data?: number): number {
-  return data ?? faker.number.int()
-}

package/src/generators/__snapshots__/node.ts

@@ -1,12 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function node(data?: Partial<Node>): Node {
-  return {
-    ...{ id: faker.string.alpha(), children: faker.helpers.multiple(() => undefined as any) },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/pet.ts

@@ -1,20 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function pet(data?: Partial<Pet>): Pet {
-  return {
-    ...{
-      id: faker.number.int(),
-      name: faker.string.alpha(),
-      tag: faker.string.alpha(),
-      code: faker.helpers.fromRegExp('\b[1-9]\b'),
-      shipDate: faker.date.anytime(),
-      shipTime: faker.date.anytime(),
-      info: { animal: faker.helpers.arrayElement<NonNullable<NonNullable<Pet>['info']>['animal']>(['dog', 'cat', 'ant']) },
-    },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/petAdoption400.ts

@@ -1,8 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-
-export function petAdoption400(data?: Partial<PetAdoption400>): PetAdoption400 {
-  return petAdoptionError(data)
-}

package/src/generators/__snapshots__/petAdoptionError.ts

@@ -1,12 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-/**
- * @description Pet adoption error codes
- */
-export function petAdoptionError(data?: Partial<PetAdoptionError>): PetAdoptionError {
-  return data || faker.helpers.arrayElement<PetAdoptionError>(['pet_not_found', 'already_adopted', 'age_restriction'])
-}

package/src/generators/__snapshots__/petWithDateString.ts

@@ -1,20 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function pet(data?: Partial<Pet>): Pet {
-  return {
-    ...{
-      id: faker.number.int(),
-      name: faker.string.alpha(),
-      tag: faker.string.alpha(),
-      code: faker.helpers.fromRegExp('\b[1-9]\b'),
-      shipDate: faker.date.anytime().toISOString().substring(0, 10),
-      shipTime: faker.date.anytime().toISOString().substring(11, 19),
-      info: { animal: faker.helpers.arrayElement<NonNullable<NonNullable<Pet>['info']>['animal']>(['dog', 'cat', 'ant']) },
-    },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/petWithDayjs.ts

@@ -1,21 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import dayjs from 'dayjs'
-import { faker } from '@faker-js/faker'
-
-export function pet(data?: Partial<Pet>): Pet {
-  return {
-    ...{
-      id: faker.number.int(),
-      name: faker.string.alpha(),
-      tag: faker.string.alpha(),
-      code: faker.helpers.fromRegExp('\b[1-9]\b'),
-      shipDate: dayjs(faker.date.anytime()).format('YYYY-MM-DD'),
-      shipTime: dayjs(faker.date.anytime()).format('HH:mm:ss'),
-      info: { animal: faker.helpers.arrayElement<NonNullable<NonNullable<Pet>['info']>['animal']>(['dog', 'cat', 'ant']) },
-    },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/petWithMapper.ts

@@ -1,20 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function pet(data?: Partial<Pet>): Pet {
-  return {
-    ...{
-      id: faker.string.fromCharacters('abc'),
-      name: faker.string.alpha({ casing: 'lower' }),
-      tag: faker.string.alpha(),
-      code: faker.helpers.fromRegExp('\b[1-9]\b'),
-      shipDate: faker.date.anytime(),
-      shipTime: faker.date.anytime(),
-      info: { animal: faker.helpers.arrayElement<NonNullable<NonNullable<Pet>['info']>['animal']>(['dog', 'cat', 'ant']) },
-    },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/petWithRandExp.ts

@@ -1,21 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import RandExp from 'randexp'
-import { faker } from '@faker-js/faker'
-
-export function pet(data?: Partial<Pet>): Pet {
-  return {
-    ...{
-      id: faker.number.int(),
-      name: faker.string.alpha(),
-      tag: faker.string.alpha(),
-      code: new RandExp('\\b[1-9]\\b').gen(),
-      shipDate: faker.date.anytime(),
-      shipTime: faker.date.anytime(),
-      info: { animal: faker.helpers.arrayElement<NonNullable<NonNullable<Pet>['info']>['animal']>(['dog', 'cat', 'ant']) },
-    },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/pets.ts

@@ -1,9 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function pets(data?: Pets): Pets {
-  return [...faker.helpers.multiple(() => pet()), ...(data || [])]
-}

package/src/generators/__snapshots__/showPetById.ts

@@ -1,30 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function showPetByIdPathParams(data?: Partial<ShowPetByIdPathParams>): ShowPetByIdPathParams {
-  return {
-    ...{ petId: faker.string.alpha(), testId: faker.string.alpha() },
-    ...(data || {}),
-  }
-}
-
-/**
- * @description Expected response to a valid request
- */
-export function showPetById200(data?: Partial<ShowPetById200>): ShowPetById200 {
-  return pet(data)
-}
-
-/**
- * @description unexpected error
- */
-export function showPetByIdError(data?: Partial<ShowPetByIdError>): ShowPetByIdError {
-  return error(data)
-}
-
-export function showPetByIdQueryResponse(data?: Partial<ShowPetByIdQueryResponse>): ShowPetByIdQueryResponse {
-  return data || faker.helpers.arrayElement<any>([showPetById200()])
-}

package/src/generators/__snapshots__/string.ts

@@ -1,9 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function string(data?: string): string {
-  return data ?? faker.string.alpha()
-}

package/src/generators/__snapshots__/treeNode.ts

@@ -1,12 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function treeNode(data?: Partial<TreeNode>): TreeNode {
-  return {
-    ...{ value: faker.string.alpha(), left: undefined as any, right: undefined as any },
-    ...(data || {}),
-  }
-}

package/src/generators/__snapshots__/updatePet.ts

@@ -1,34 +0,0 @@
-/**
- * Generated by Kubb (https://kubb.dev/).
- * Do not edit manually.
- */
-import { faker } from '@faker-js/faker'
-
-export function updatePetPathParams(data?: Partial<UpdatePetPathParams>): UpdatePetPathParams {
-  return {
-    ...{ petId: faker.number.int() },
-    ...(data || {}),
-  }
-}
-
-/**
- * @description Pet updated
- */
-export function updatePet200(data?: Partial<UpdatePet200>): UpdatePet200 {
-  return pet(data)
-}
-
-/**
- * @description unexpected error
- */
-export function updatePetError(data?: Partial<UpdatePetError>): UpdatePetError {
-  return error(data)
-}
-
-export function updatePetMutationRequest(data?: Partial<UpdatePetMutationRequest>): UpdatePetMutationRequest {
-  return pet(data)
-}
-
-export function updatePetMutationResponse(data?: Partial<UpdatePetMutationResponse>): UpdatePetMutationResponse {
-  return data || faker.helpers.arrayElement<any>([updatePet200()])
-}