@kubb/plugin-faker 0.0.0-canary-20241104172400

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?: Partial<CreatePetsMutationRequest>) {
+    return {
+        ...{ "name": faker.string.alpha(), "tag": faker.string.alpha() },
+        ...data || {}
+    };
+}
+
+ export function createPetsMutationResponse(data?: Partial<CreatePetsMutationResponse>) {
+    return faker.helpers.arrayElement<any>([createPets201()]) || data;
+}

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?: Partial<CreatePetsMutationRequest>) {
+    faker.seed([222]);
+    return {
+        ...{ "name": faker.string.alpha(), "tag": faker.string.alpha() },
+        ...data || {}
+    };
+}
+
+ export function createPetsMutationResponse(data?: Partial<CreatePetsMutationResponse>) {
+    faker.seed([222]);
+    return faker.helpers.arrayElement<any>([createPets201()]) || data;
+}

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?: Partial<CreatePetsMutationRequest>) {
+    return {
+        ...{ "name": faker.string.alpha(), "tag": faker.string.alpha() },
+        ...data || {}
+    };
+}
+
+ export function createPetsMutationResponse(data?: Partial<CreatePetsMutationResponse>) {
+    return faker.helpers.arrayElement<any>([createPets201()]) || data;
+}

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,26 @@
+import { faker } from "@faker-js/faker";
+
+ export function listPetsQueryParams(data?: 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();
+}
+
+ export function listPetsQueryResponse(data?: Partial<ListPetsQueryResponse>) {
+    return faker.helpers.arrayElement<any>([listPets200()]) || data;
+}

package/src/generators/__snapshots__/pet.ts

@@ -0,0 +1,8 @@
+import { faker } from "@faker-js/faker";
+
+ export function pet(data?: 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,8 @@
+import { faker } from "@faker-js/faker";
+
+ export function pet(data?: 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,9 @@
+import dayjs from "dayjs";
+import { faker } from "@faker-js/faker";
+
+ export function pet(data?: 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,8 @@
+import { faker } from "@faker-js/faker";
+
+ export function pet(data?: 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,9 @@
+import RandExp from "randexp";
+import { faker } from "@faker-js/faker";
+
+ export function pet(data?: 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,8 @@
+import { faker } from "@faker-js/faker";
+
+ export function pets(data?: Partial<Pets>) {
+    return [
+        ...faker.helpers.multiple(() => (pet())) as any,
+        ...data || []
+    ];
+}

package/src/generators/__snapshots__/showPetById.ts

@@ -0,0 +1,26 @@
+import { faker } from "@faker-js/faker";
+
+ export function showPetByIdPathParams(data?: 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();
+}
+
+ export function showPetByIdQueryResponse(data?: Partial<ShowPetByIdQueryResponse>) {
+    return faker.helpers.arrayElement<any>([showPetById200()]) || data;
+}

package/src/generators/fakerGenerator.tsx

@@ -0,0 +1,140 @@
+import { type OperationSchema as OperationSchemaType, SchemaGenerator, createReactGenerator, schemaKeywords } from '@kubb/plugin-oas'
+import { Oas } from '@kubb/plugin-oas/components'
+import { useOas, useOperationManager, useSchemaManager } from '@kubb/plugin-oas/hooks'
+import { pluginTsName } from '@kubb/plugin-ts'
+import { File, useApp } from '@kubb/react'
+import { Faker } from '../components'
+import type { PluginFaker } from '../types'
+
+export const fakerGenerator = createReactGenerator<PluginFaker>({
+  name: 'faker',
+  Operation({ operation, options }) {
+    const { dateParser, regexGenerator, seed, mapper } = options
+
+    const { plugin, pluginManager, mode } = useApp<PluginFaker>()
+    const oas = useOas()
+    const { getSchemas, getFile } = useOperationManager()
+    const schemaManager = useSchemaManager()
+
+    const file = getFile(operation)
+    const schemas = getSchemas(operation)
+    const schemaGenerator = new SchemaGenerator(options, {
+      oas,
+      plugin,
+      pluginManager,
+      mode,
+      override: options.override,
+    })
+
+    const operationSchemas = [schemas.pathParams, schemas.queryParams, schemas.headerParams, schemas.statusCodes, schemas.request, schemas.response]
+      .flat()
+      .filter(Boolean)
+
+    const mapOperationSchema = ({ name, schema, description, ...options }: OperationSchemaType, i: number) => {
+      const tree = schemaGenerator.parse({ schema, name })
+      const imports = schemaManager.getImports(tree)
+
+      const faker = {
+        name: schemaManager.getName(name, { type: 'function' }),
+        file: schemaManager.getFile(name),
+      }
+
+      const type = {
+        name: schemaManager.getName(name, { type: 'type', pluginKey: [pluginTsName] }),
+        file: schemaManager.getFile(options.operationName || name, { pluginKey: [pluginTsName], tag: options.operation?.getTags()[0]?.name }),
+      }
+
+      const canOverride = tree.some(
+        ({ keyword }) =>
+          keyword === schemaKeywords.array ||
+          keyword === schemaKeywords.and ||
+          keyword === schemaKeywords.object ||
+          keyword === schemaKeywords.union ||
+          keyword === schemaKeywords.tuple,
+      )
+
+      return (
+        <Oas.Schema key={i} name={name} value={schema} tree={tree}>
+          {canOverride && <File.Import isTypeOnly root={file.path} path={type.file.path} name={[type.name]} />}
+          {imports.map((imp, index) => (
+            <File.Import key={index} root={file.path} path={imp.path} name={imp.name} />
+          ))}
+          <Faker
+            name={faker.name}
+            typeName={type.name}
+            description={description}
+            tree={tree}
+            regexGenerator={regexGenerator}
+            dateParser={dateParser}
+            mapper={mapper}
+            seed={seed}
+            canOverride={canOverride}
+          />
+        </Oas.Schema>
+      )
+    }
+
+    return (
+      <File baseName={file.baseName} path={file.path} meta={file.meta} banner={plugin.options.output?.banner} footer={plugin.options.output?.footer}>
+        <File.Import name={['faker']} path="@faker-js/faker" />
+        {regexGenerator === 'randexp' && <File.Import name={'RandExp'} path={'randexp'} />}
+        {dateParser !== 'faker' && <File.Import path={dateParser} name={dateParser} />}
+        {operationSchemas.map(mapOperationSchema)}
+      </File>
+    )
+  },
+  Schema({ schema, options }) {
+    const { dateParser, regexGenerator, seed, mapper } = options
+
+    const { getName, getFile, getImports } = useSchemaManager()
+    const {
+      plugin: {
+        options: { output },
+      },
+    } = useApp<PluginFaker>()
+    const imports = getImports(schema.tree)
+
+    const faker = {
+      name: getName(schema.name, { type: 'function' }),
+      file: getFile(schema.name),
+    }
+
+    const type = {
+      name: getName(schema.name, { type: 'type', pluginKey: [pluginTsName] }),
+      file: getFile(schema.name, { pluginKey: [pluginTsName] }),
+    }
+
+    const canOverride = schema.tree.some(
+      ({ keyword }) =>
+        keyword === schemaKeywords.array ||
+        keyword === schemaKeywords.and ||
+        keyword === schemaKeywords.object ||
+        keyword === schemaKeywords.union ||
+        keyword === schemaKeywords.tuple,
+    )
+
+    return (
+      <File baseName={faker.file.baseName} path={faker.file.path} meta={faker.file.meta} banner={output?.banner} footer={output?.footer}>
+        <File.Import name={['faker']} path="@faker-js/faker" />
+        {regexGenerator === 'randexp' && <File.Import name={'RandExp'} path={'randexp'} />}
+        {dateParser !== 'faker' && <File.Import path={dateParser} name={dateParser} />}
+        <File.Import isTypeOnly root={faker.file.path} path={type.file.path} name={[type.name]} />
+        {imports.map((imp, index) => (
+          <File.Import key={index} root={faker.file.path} path={imp.path} name={imp.name} />
+        ))}
+
+        <Faker
+          name={faker.name}
+          typeName={type.name}
+          description={schema.value.description}
+          tree={schema.tree}
+          regexGenerator={regexGenerator}
+          dateParser={dateParser}
+          mapper={mapper}
+          seed={seed}
+          canOverride={canOverride}
+        />
+      </File>
+    )
+  },
+})

package/src/generators/index.ts

@@ -0,0 +1 @@
+export { fakerGenerator } from './fakerGenerator.tsx'

package/src/index.ts

@@ -0,0 +1,2 @@
+export { pluginFaker, pluginFakerName } from './plugin.ts'
+export type { PluginFaker } from './types.ts'