initial impl

Author: malcolm-kee

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

@@ -0,0 +1,16 @@
+{
+  "name": "@test/openapi-ts-faker-v1",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "typecheck": "tsgo --noEmit"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "workspace:*",
+    "typescript": "5.9.3"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  }
+}

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

@@ -0,0 +1,42 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { createClient } from '@hey-api/openapi-ts';
+
+import { getFilePaths } from '../../../utils';
+import { snapshotsDir, tmpDir } from './constants';
+import { createConfigFactory } from './utils';
+
+const version = '3.1.x';
+
+const outputDir = path.join(tmpDir, version);
+
+describe(`OpenAPI ${version}`, () => {
+  const createConfig = createConfigFactory({ openApiVersion: version, outputDir });
+
+  const scenarios = [
+    {
+      config: createConfig({
+        input: 'faker-basic.yaml',
+        output: 'faker-basic',
+      }),
+      description: 'generates faker factories for basic schemas',
+    },
+  ];
+
+  it.each(scenarios)('$description', async ({ config }) => {
+    await createClient(config);
+
+    const outputString = config.output as string;
+    const filePaths = getFilePaths(outputString);
+
+    await Promise.all(
+      filePaths.map(async (filePath) => {
+        const fileContent = fs.readFileSync(filePath, 'utf-8');
+        await expect(fileContent).toMatchFileSnapshot(
+          path.join(snapshotsDir, version, filePath.slice(outputDir.length + 1)),
+        );
+      }),
+    );
+  });
+});

packages/openapi-ts-tests/faker/v1/test/constants.ts

@@ -0,0 +1,4 @@
+import path from 'node:path';
+
+export const snapshotsDir = path.join(__dirname, '..', '__snapshots__');
+export const tmpDir = path.join(__dirname, '..', '.tmp');

packages/openapi-ts-tests/faker/v1/test/globalTeardown.ts

@@ -0,0 +1,7 @@
+import fs from 'node:fs';
+
+import { tmpDir } from './constants';
+
+export function teardown() {
+  fs.rmSync(tmpDir, { force: true, recursive: true });
+}

packages/openapi-ts-tests/faker/v1/test/utils.ts

@@ -0,0 +1,37 @@
+import path from 'node:path';
+
+import type { UserConfig } from '@hey-api/openapi-ts';
+
+import { getSpecsPath } from '../../../utils';
+
+export function createConfigFactory({
+  openApiVersion,
+  outputDir,
+}: {
+  openApiVersion: string;
+  outputDir: string;
+}) {
+  return (userConfig: UserConfig) => {
+    const input = userConfig.input instanceof Array ? userConfig.input[0]! : userConfig.input;
+    const inputPath = path.join(
+      getSpecsPath(),
+      openApiVersion,
+      typeof input === 'string' ? input : (input.path as string),
+    );
+    const output = userConfig.output instanceof Array ? userConfig.output[0]! : userConfig.output;
+    const outputPath = typeof output === 'string' ? output : (output?.path ?? '');
+    return {
+      plugins: ['@faker-js/faker'],
+      ...userConfig,
+      input:
+        typeof userConfig.input === 'string'
+          ? inputPath
+          : {
+              ...userConfig.input,
+              path: inputPath,
+            },
+      logs: { level: 'silent', path: './logs' },
+      output: path.join(outputDir, outputPath),
+    } as UserConfig;
+  };
+}

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

@@ -0,0 +1,5 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["test/**/*", "__snapshots__/**/*"],
+  "references": [{ "path": "../../../openapi-ts" }]
+}

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

@@ -0,0 +1,10 @@
+{
+  "$schema": "../../../../node_modules/turbo/schema.json",
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "dependsOn": [],
+      "outputs": ["dist/**"]
+    }
+  }
+}

packages/openapi-ts-tests/faker/v1/vitest.setup.ts

@@ -0,0 +1,7 @@
+import { fileURLToPath } from 'node:url';
+
+import { beforeAll } from 'vitest';
+
+beforeAll(() => {
+  process.chdir(fileURLToPath(new URL('.', import.meta.url)));
+});

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

@@ -18,7 +18,7 @@ export const defaultConfig: FakerJsFakerPlugin['Config'] = {
       defaultValue: {
         case: plugin.config.case ?? 'camelCase',
         enabled: true,
-        name: 'v{{name}}',
+        name: 'fake{{name}}',
       },
       mappers,
       value: plugin.config.definitions,

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

@@ -44,17 +44,6 @@ export type UserConfig = Plugin.Name<'@faker-js/faker'> &
            */
           name?: NameTransformer;
         };
-    /**
-     * Faker locale for generated data.
-     *
-     * @default 'en'
-     */
-    locale?: string;
-    /**
-     * Seed for deterministic output. When set, Faker will produce
-     * the same values across runs.
-     */
-    seed?: number;
   };
 
 export type Config = Plugin.Name<'@faker-js/faker'> &
@@ -65,10 +54,6 @@ export type Config = Plugin.Name<'@faker-js/faker'> &
     case: Casing;
     /** Configuration for reusable schema definitions. */
     definitions: NamingOptions & FeatureToggle;
-    /** Faker locale for generated data. */
-    locale: string;
-    /** Seed for deterministic output. */
-    seed?: number;
   };
 
 export type FakerJsFakerPlugin = DefinePlugin<UserConfig, Config, IApi>;