feat(faker): milestone 1 implemented

Author: malcolm-kee

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-basic-typed/@faker-js/faker.gen.ts

@@ -0,0 +1,17 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { faker, type Faker } from '@faker-js/faker';
+
+import type { Bar, Foo } from '../types.gen';
+
+export const fakeFoo = (options?: {
+    faker?: Faker;
+}): Foo => ({
+    name: (options?.faker ?? faker).string.sample(),
+    age: (options?.faker ?? faker).number.int(),
+    active: (options?.faker ?? faker).datatype.boolean()
+});
+
+export const fakeBar = (options?: {
+    faker?: Faker;
+}): Bar => (options?.faker ?? faker).helpers.arrayElement(['baz', 'qux']);

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-basic-typed/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type { Bar, ClientOptions, Foo } from './types.gen';

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-basic-typed/types.gen.ts

@@ -0,0 +1,13 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type Foo = {
+    name: string;
+    age: number;
+    active?: boolean;
+};
+
+export type Bar = 'baz' | 'qux';

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-basic/@faker-js/faker.gen.ts

@@ -0,0 +1,15 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { faker, type Faker } from '@faker-js/faker';
+
+export const fakeFoo = (options?: {
+    faker?: Faker;
+}) => ({
+    name: (options?.faker ?? faker).string.sample(),
+    age: (options?.faker ?? faker).number.int(),
+    active: (options?.faker ?? faker).datatype.boolean()
+});
+
+export const fakeBar = (options?: {
+    faker?: Faker;
+}) => (options?.faker ?? faker).helpers.arrayElement(['baz', 'qux']);

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-m1/@faker-js/faker.gen.ts

@@ -0,0 +1,67 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { faker, type Faker } from '@faker-js/faker';
+
+import type { Active, Anything, Nothing, NumericEnum, Pet, PetList, PetOrTag, Price, Quantity, StatusWithNull, StringOrNumber, Tag, Tags } from '../types.gen';
+
+export const fakePrice = (options?: {
+    faker?: Faker;
+}): Price => (options?.faker ?? faker).number.float();
+
+export const fakeQuantity = (options?: {
+    faker?: Faker;
+}): Quantity => (options?.faker ?? faker).number.int();
+
+export const fakeActive = (options?: {
+    faker?: Faker;
+}): Active => (options?.faker ?? faker).datatype.boolean();
+
+export const fakeNothing = (): Nothing => null;
+
+export const fakeAnything = (): Anything => undefined;
+
+export const fakeStatusWithNull = (options?: {
+    faker?: Faker;
+}): StatusWithNull => (options?.faker ?? faker).helpers.arrayElement([
+    'active',
+    'inactive',
+    null
+]);
+
+export const fakeNumericEnum = (options?: {
+    faker?: Faker;
+}): NumericEnum => (options?.faker ?? faker).helpers.arrayElement([
+    1,
+    2,
+    3
+]);
+
+export const fakeTags = (options?: {
+    faker?: Faker;
+}): Tags => (options?.faker ?? faker).helpers.multiple(() => (options?.faker ?? faker).string.sample());
+
+export const fakeTag = (options?: {
+    faker?: Faker;
+}): Tag => ({
+    id: (options?.faker ?? faker).number.int(),
+    label: (options?.faker ?? faker).string.sample()
+});
+
+export const fakePet = (options?: {
+    faker?: Faker;
+}): Pet => ({
+    name: (options?.faker ?? faker).string.sample(),
+    tag: fakeTag(options)
+});
+
+export const fakePetOrTag = (options?: {
+    faker?: Faker;
+}): PetOrTag => fakePet(options);
+
+export const fakeStringOrNumber = (options?: {
+    faker?: Faker;
+}): StringOrNumber => (options?.faker ?? faker).string.sample();
+
+export const fakePetList = (options?: {
+    faker?: Faker;
+}): PetList => (options?.faker ?? faker).helpers.multiple(() => fakePet(options));

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-m1/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type { Active, Anything, ClientOptions, Nothing, NumericEnum, Pet, PetList, PetOrTag, Price, Quantity, StatusWithNull, StringOrNumber, Tag, Tags } from './types.gen';

packages/openapi-ts-tests/faker/v1/__snapshots__/3.1.x/faker-m1/types.gen.ts

@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type Price = number;
+
+export type Quantity = number;
+
+export type Active = boolean;
+
+export type Nothing = null;
+
+export type Anything = unknown;
+
+export type StatusWithNull = 'active' | 'inactive' | null;
+
+export type NumericEnum = 1 | 2 | 3;
+
+export type Tags = Array<string>;
+
+export type Pet = {
+    name: string;
+    tag?: Tag;
+};
+
+export type Tag = {
+    id: number;
+    label: string;
+};
+
+export type PetOrTag = Pet | Tag;
+
+export type StringOrNumber = string | number;
+
+export type PetList = Array<Pet>;

packages/openapi-ts-tests/faker/v1/package.json

@@ -7,6 +7,7 @@
     "typecheck": "tsgo --noEmit"
   },
   "devDependencies": {
+    "@faker-js/faker": "^9.9.0",
     "@hey-api/openapi-ts": "workspace:*",
     "typescript": "5.9.3"
   },

packages/openapi-ts-tests/faker/v1/test/3.1.x.test.ts

@@ -22,6 +22,22 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'generates faker factories for basic schemas',
     },
+    {
+      config: createConfig({
+        input: 'faker-basic.yaml',
+        output: 'faker-basic-typed',
+        plugins: ['@hey-api/typescript', '@faker-js/faker'],
+      }),
+      description: 'generates typed faker factories when typescript plugin is active',
+    },
+    {
+      config: createConfig({
+        input: 'faker-m1.yaml',
+        output: 'faker-m1',
+        plugins: ['@hey-api/typescript', '@faker-js/faker'],
+      }),
+      description: 'handles number, null, enum-with-null, array, $ref, and union schemas',
+    },
   ];
 
   it.each(scenarios)('$description', async ({ config }) => {

packages/openapi-ts/src/plugins/@faker-js/faker/config.ts

@@ -1,7 +1,7 @@
 import { definePluginConfig, mappers } from '@hey-api/shared';
 
 import { Api } from './api';
-// import { handler } from './plugin';
+import { handler } from './plugin';
 import type { FakerJsFakerPlugin } from './types';
 
 export const defaultConfig: FakerJsFakerPlugin['Config'] = {
@@ -10,8 +10,7 @@ export const defaultConfig: FakerJsFakerPlugin['Config'] = {
     case: 'camelCase',
     includeInEntry: false,
   },
-  // handler,
-  handler: () => {},
+  handler,
   name: '@faker-js/faker',
   resolveConfig: (plugin, context) => {
     plugin.config.definitions = context.valueToObject({