implement M4: property name based faker inference

Author: malcolm-kee

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

@@ -26,7 +26,7 @@ const ensureFaker = (options?: Options): Faker => options?.faker ?? faker;
 
 export const fakeFoo = (options?: Options): Foo => ({
     name: ensureFaker(options).string.sample(),
-    age: ensureFaker(options).number.int(),
+    age: ensureFaker(options).number.int({ min: 1, max: 120 }),
     ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { active: ensureFaker(options).datatype.boolean() }
 });
 

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

@@ -24,7 +24,7 @@ const ensureFaker = (options?: Options): Faker => options?.faker ?? faker;
 
 export const fakeFoo = (options?: Options) => ({
     name: ensureFaker(options).string.sample(),
-    age: ensureFaker(options).number.int(),
+    age: ensureFaker(options).number.int({ min: 1, max: 120 }),
     ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { active: ensureFaker(options).datatype.boolean() }
 });
 

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

@@ -90,12 +90,12 @@ export const fakeObjectWithDefaultProp = (options?: Options): ObjectWithDefaultP
 export const fakeUserProfile = (options?: Options): UserProfile => ({
     id: ensureFaker(options).number.int(),
     name: ensureFaker(options).string.sample(),
-    ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { bio: ensureFaker(options).string.sample() },
-    ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { age: ensureFaker(options).number.int() }
+    ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { bio: ensureFaker(options).lorem.sentence() },
+    ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { age: ensureFaker(options).number.int({ min: 1, max: 120 }) }
 });
 
 export const fakeAddress = (options?: Options): Address => ({
-    street: ensureFaker(options).string.alpha({ length: { min: 1, max: 200 } }),
+    street: ensureFaker(options).location.streetAddress(),
     zip: fakeZipCode(options)
 });
 

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

@@ -24,7 +24,7 @@ const ensureFaker = (options?: Options): Faker => options?.faker ?? faker;
 
 export const fakePet = (options?: Options): Pet => ({
     name: ensureFaker(options).string.sample(),
-    age: ensureFaker(options).number.int()
+    age: ensureFaker(options).number.int({ min: 1, max: 120 })
 });
 
 export const fakeTag = (options?: Options): Tag => ({

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

@@ -0,0 +1,64 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { faker, type Faker } from '@faker-js/faker';
+
+import type { Company, Config, Document, PersonProfile, PersonWithConstraints, User } from '../types.gen';
+
+export type Options = {
+    faker?: Faker;
+    /**
+     * Whether to include optional properties.
+     * Provide a number between 0 and 1 to randomly include based on that probability.
+     * @default true
+     */
+    includeOptional?: boolean | number;
+    /**
+     * Whether to use schema default values instead of generating fake data.
+     * Provide a number between 0 and 1 to randomly use defaults based on that probability.
+     * @default false
+     */
+    useDefault?: boolean | number;
+};
+
+const resolveCondition = (condition: boolean | number, faker: Faker): boolean => condition === true || typeof condition === 'number' && faker.datatype.boolean({ probability: condition });
+
+const ensureFaker = (options?: Options): Faker => options?.faker ?? faker;
+
+export const fakePersonProfile = (options?: Options): PersonProfile => ({
+    firstName: ensureFaker(options).person.firstName(),
+    last_name: ensureFaker(options).person.lastName(),
+    email: ensureFaker(options).internet.email(),
+    phone: ensureFaker(options).phone.number(),
+    age: ensureFaker(options).number.int({ min: 1, max: 120 }),
+    city: ensureFaker(options).location.city(),
+    postalCode: ensureFaker(options).location.zipCode(),
+    bio: ensureFaker(options).lorem.sentence(),
+    website: ensureFaker(options).internet.url(),
+    zipCode: ensureFaker(options).helpers.fromRegExp('^\\d{5}$'),
+    username: ensureFaker(options).internet.username(),
+    someRandomField: ensureFaker(options).string.sample()
+});
+
+export const fakePersonWithConstraints = (options?: Options): PersonWithConstraints => ({
+    age: ensureFaker(options).number.int({ min: 18, max: 120 }),
+    ...!resolveCondition(options?.includeOptional ?? true, ensureFaker(options)) ? {} : { seniorAge: ensureFaker(options).number.int({ min: 65, max: 100 }) }
+});
+
+export const fakeUser = (options?: Options): User => ({
+    name: ensureFaker(options).person.fullName(),
+    email: ensureFaker(options).internet.email()
+});
+
+export const fakeCompany = (options?: Options): Company => ({
+    name: ensureFaker(options).company.name()
+});
+
+export const fakeConfig = (options?: Options): Config => ({
+    name: ensureFaker(options).string.sample()
+});
+
+export const fakeDocument = (options?: Options): Document => ({
+    id: ensureFaker(options).string.uuid(),
+    _id: ensureFaker(options).string.uuid(),
+    numericId: ensureFaker(options).number.int()
+});

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

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type { ClientOptions, Company, Config, Document, PersonProfile, PersonWithConstraints, User } from './types.gen';

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

@@ -0,0 +1,44 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type PersonProfile = {
+    firstName: string;
+    last_name: string;
+    email: string;
+    phone: string;
+    age: number;
+    city: string;
+    postalCode: string;
+    bio: string;
+    website: string;
+    zipCode: string;
+    username: string;
+    someRandomField: string;
+};
+
+export type PersonWithConstraints = {
+    age: number;
+    seniorAge?: number;
+};
+
+export type User = {
+    name: string;
+    email: string;
+};
+
+export type Company = {
+    name: string;
+};
+
+export type Config = {
+    name: string;
+};
+
+export type Document = {
+    id: string;
+    _id: string;
+    numericId: number;
+};

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

@@ -55,6 +55,15 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles union randomization, allOf intersections, and discriminated unions',
     },
+    {
+      config: createConfig({
+        input: 'faker-m4.yaml',
+        output: 'faker-m4',
+        plugins: ['@hey-api/typescript', '@faker-js/faker'],
+      }),
+      description:
+        'infers faker helpers from property names with ancestor context and constraint merging',
+    },
   ];
 
   it.each(scenarios)('$description', async ({ config }) => {