fix(typescript): handle nested inline objects with write/read only fields

mrlubos · mrlubos · commit aef80c397b25 · 2025-06-10T15:58:08.000+09:00
diff --git a/.changeset/warm-lemons-count.md b/.changeset/warm-lemons-count.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(typescript): handle nested inline objects with write/read only fields
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/typescript/read-write-only-custom-name/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/typescript/read-write-only-custom-name/types.gen.ts
@@ -29,6 +29,17 @@ export type WritableQuux = {
     baz?: Array<Baz>;
 };
 
+export type ReadableCorge = {
+    foo?: string;
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
+export type WritableCorge = {
+    foo?: string;
+};
+
 export type PostFooReadData = {
     body: WritableFooRead;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/typescript/read-write-only-ignore/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/typescript/read-write-only-ignore/types.gen.ts
@@ -21,6 +21,13 @@ export type Quux = {
     qux?: QuxAllRead;
 };
 
+export type Corge = {
+    foo?: string;
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
 export type PostFooReadData = {
     body: FooRead;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/2.0.x/read-write-only/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/2.0.x/read-write-only/types.gen.ts
@@ -29,6 +29,17 @@ export type QuuxWritable = {
     baz?: Array<Baz>;
 };
 
+export type CorgeReadable = {
+    foo?: string;
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
+export type CorgeWritable = {
+    foo?: string;
+};
+
 export type PostFooReadData = {
     body: FooReadWritable;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/typescript/read-write-only-custom-name/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/typescript/read-write-only-custom-name/types.gen.ts
@@ -47,6 +47,18 @@ export type WritableQuux = {
     baz?: Array<Baz>;
 };
 
+export type ReadableCorge = {
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
+export type WritableCorge = {
+    foo?: {
+        baz?: boolean;
+    };
+};
+
 export type PostFooReadWriteData = {
     body: WritableFooReadWrite;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/typescript/read-write-only-ignore/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/plugins/@hey-api/typescript/read-write-only-ignore/types.gen.ts
@@ -33,6 +33,15 @@ export type Quux = {
     qux?: QuxAllRead;
 };
 
+export type Corge = {
+    foo?: {
+        baz?: boolean;
+    };
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
 export type PostFooReadWriteData = {
     body: FooReadWrite;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.0.x/read-write-only/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.0.x/read-write-only/types.gen.ts
@@ -47,6 +47,18 @@ export type QuuxWritable = {
     baz?: Array<Baz>;
 };
 
+export type CorgeReadable = {
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
+export type CorgeWritable = {
+    foo?: {
+        baz?: boolean;
+    };
+};
+
 export type PostFooReadWriteData = {
     body: FooReadWriteWritable;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/typescript/read-write-only-custom-name/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/typescript/read-write-only-custom-name/types.gen.ts
@@ -51,6 +51,18 @@ export type WritableQuux = {
     baz?: Array<Baz>;
 };
 
+export type ReadableCorge = {
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
+export type WritableCorge = {
+    foo?: {
+        baz?: boolean;
+    };
+};
+
 export type PostFooReadWriteData = {
     body: WritableFooReadWrite;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/typescript/read-write-only-ignore/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/plugins/@hey-api/typescript/read-write-only-ignore/types.gen.ts
@@ -37,6 +37,15 @@ export type Quux = {
     qux?: QuxAllRead;
 };
 
+export type Corge = {
+    foo?: {
+        baz?: boolean;
+    };
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
 export type PostFooReadWriteData = {
     body: FooReadWrite;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/__snapshots__/3.1.x/read-write-only/types.gen.ts b/packages/openapi-ts-tests/test/__snapshots__/3.1.x/read-write-only/types.gen.ts
@@ -51,6 +51,18 @@ export type QuuxWritable = {
     baz?: Array<Baz>;
 };
 
+export type CorgeReadable = {
+    bar?: {
+        readonly baz?: boolean;
+    };
+};
+
+export type CorgeWritable = {
+    foo?: {
+        baz?: boolean;
+    };
+};
+
 export type PostFooReadWriteData = {
     body: FooReadWriteWritable;
     path?: never;
diff --git a/packages/openapi-ts-tests/test/bin.test.ts b/packages/openapi-ts-tests/test/bin.test.ts
@@ -130,7 +130,7 @@ describe('bin', () => {
       'true',
     ]);
     expect(result.stdout.toString()).toBe('');
-    expect(result.stderr.toString()).toContain('Unexpected error occurred');
+    expect(result.stderr.toString()).toContain('encountered an error');
     expect(result.stderr.toString()).toContain('missing input');
   });
 
@@ -143,7 +143,7 @@ describe('bin', () => {
       'true',
     ]);
     expect(result.stdout.toString()).toBe('');
-    expect(result.stderr.toString()).toContain('Unexpected error occurred');
+    expect(result.stderr.toString()).toContain('encountered an error');
     expect(result.stderr.toString()).toContain('missing output');
   });
 
@@ -177,7 +177,7 @@ describe('bin', () => {
       'true',
     ]);
     expect(result.stdout.toString()).toBe('');
-    expect(result.stderr.toString()).toContain('Unexpected error occurred');
+    expect(result.stderr.toString()).toContain('encountered an error');
     expect(result.stderr.toString()).toContain('client needs to be set');
   });
 
diff --git a/packages/openapi-ts-tests/test/openapi-ts.config.ts b/packages/openapi-ts-tests/test/openapi-ts.config.ts
@@ -51,7 +51,8 @@ export default defineConfig(() => {
       //   'invalid',
       //   'servers-entry.yaml',
       // ),
-      path: path.resolve(__dirname, 'spec', '3.0.x', 'bug.yaml'),
+      // path: path.resolve(__dirname, 'spec', '3.1.x', 'read-write-only.yaml'),
+      path: '',
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
       // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
diff --git a/packages/openapi-ts-tests/test/spec/2.0.x/read-write-only.yaml b/packages/openapi-ts-tests/test/spec/2.0.x/read-write-only.yaml
@@ -57,3 +57,14 @@ definitions:
           $ref: '#/definitions/Baz'
       qux:
         $ref: '#/definitions/QuxAllRead'
+  Corge:
+    type: object
+    properties:
+      foo:
+        type: string
+      bar:
+        type: object
+        properties:
+          baz:
+            type: boolean
+            readOnly: true
diff --git a/packages/openapi-ts-tests/test/spec/3.0.x/bug.yaml b/packages/openapi-ts-tests/test/spec/3.0.x/bug.yaml
diff --git a/packages/openapi-ts-tests/test/spec/3.0.x/read-write-only.yaml b/packages/openapi-ts-tests/test/spec/3.0.x/read-write-only.yaml
@@ -110,3 +110,18 @@ components:
             $ref: '#/components/schemas/Baz'
         qux:
           $ref: '#/components/schemas/QuxAllRead'
+    Corge:
+      type: object
+      properties:
+        foo:
+          type: object
+          properties:
+            baz:
+              type: boolean
+              writeOnly: true
+        bar:
+          type: object
+          properties:
+            baz:
+              type: boolean
+              readOnly: true
diff --git a/packages/openapi-ts-tests/test/spec/3.1.x/read-write-only.yaml b/packages/openapi-ts-tests/test/spec/3.1.x/read-write-only.yaml
@@ -120,3 +120,18 @@ components:
             $ref: '#/components/schemas/Baz'
         qux:
           $ref: '#/components/schemas/QuxAllRead'
+    Corge:
+      type: object
+      properties:
+        foo:
+          type: object
+          properties:
+            baz:
+              type: boolean
+              writeOnly: true
+        bar:
+          type: object
+          properties:
+            baz:
+              type: boolean
+              readOnly: true
diff --git a/packages/openapi-ts/src/createClient.ts b/packages/openapi-ts/src/createClient.ts
@@ -101,13 +101,13 @@ export const compileInputPath = (
 
   if (!result.organization) {
     throw new Error(
-      '🚫 missing organization - from which Hey API platform organization do you want to generate your output?',
+      'missing organization - from which Hey API platform organization do you want to generate your output?',
     );
   }
 
   if (!result.project) {
     throw new Error(
-      '🚫 missing project - from which Hey API platform project do you want to generate your output?',
+      'missing project - from which Hey API platform project do you want to generate your output?',
     );
   }
 
diff --git a/packages/openapi-ts/src/error.ts b/packages/openapi-ts/src/error.ts
@@ -3,6 +3,7 @@ import path from 'node:path';
 
 import colors from 'ansi-colors';
 
+import { findPackageJson } from './generate/tsConfig';
 import { ensureDirSync } from './generate/utils';
 
 export const isInteractive = process.stdin.isTTY && process.stdout.isTTY;
@@ -91,10 +92,28 @@ export const openGitHubIssueWithCrashReport = async (error: unknown) => {
     title: 'Crash Report',
   });
 
-  const url = `https://github.com/hey-api/openapi-ts/issues/new?${search.toString()}`;
+  const packageJson = findPackageJson();
+  let bugsUrl: string | undefined;
+  if (
+    packageJson &&
+    typeof packageJson === 'object' &&
+    'bugs' in packageJson &&
+    packageJson.bugs &&
+    typeof packageJson.bugs === 'object' &&
+    'url' in packageJson.bugs &&
+    typeof packageJson.bugs.url === 'string'
+  ) {
+    bugsUrl = packageJson.bugs.url;
+    if (bugsUrl && !bugsUrl.endsWith('/')) {
+      bugsUrl += '/';
+    }
+  }
 
-  const open = (await import('open')).default;
-  await open(url);
+  if (bugsUrl) {
+    const url = `${bugsUrl}new?${search.toString()}`;
+    const open = (await import('open')).default;
+    await open(url);
+  }
 };
 
 export const printCrashReport = ({
@@ -104,8 +123,18 @@ export const printCrashReport = ({
   error: unknown;
   logPath: string | undefined;
 }) => {
-  process.stdout.write(
-    `\n🛑 ${colors.cyan('@hey-api/openapi-ts')} ${colors.red('encountered an error.')}` +
+  const packageJson = findPackageJson();
+  let name: string | undefined;
+  if (
+    packageJson &&
+    typeof packageJson === 'object' &&
+    'name' in packageJson &&
+    typeof packageJson.name === 'string'
+  ) {
+    name = packageJson.name;
+  }
+  process.stderr.write(
+    `\n🛑 ${colors.cyan(name || '')} ${colors.red('encountered an error.')}` +
       `\n\n${colors.red('❗️ Error:')} ${colors.white(typeof error === 'string' ? error : error instanceof Error ? error.message : 'Unknown error')}` +
       (logPath
         ? `\n\n${colors.cyan('📄 Crash log saved to:')} ${colors.gray(logPath)}`
diff --git a/packages/openapi-ts/src/generate/tsConfig.ts b/packages/openapi-ts/src/generate/tsConfig.ts
@@ -7,6 +7,25 @@ import ts from 'typescript';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
+export const findPackageJson = (): unknown | undefined => {
+  let dir = __dirname;
+  while (dir !== path.dirname(dir)) {
+    const files = fs.readdirSync(dir);
+    const candidates = files.filter((file) => file === 'package.json');
+
+    if (candidates[0]) {
+      const packageJsonPath = path.join(dir, candidates[0]);
+      return JSON.parse(
+        fs.readFileSync(packageJsonPath, {
+          encoding: 'utf8',
+        }),
+      );
+    }
+
+    dir = path.dirname(dir);
+  }
+};
+
 export const findTsConfigPath = (
   tsConfigPath?: 'off' | (string & {}),
 ): string | null => {
diff --git a/packages/openapi-ts/src/index.ts b/packages/openapi-ts/src/index.ts
@@ -76,10 +76,14 @@ export const createClient = async (
     const config = configs[0] as Config | undefined;
     const dryRun = config ? config.dryRun : resolvedConfig?.dryRun;
     const logs = config?.logs ?? getLogs(resolvedConfig);
-    const shouldLog = !dryRun && logs.level !== 'silent' && logs.file;
 
-    if (shouldLog) {
-      const logPath = logCrashReport(error, logs.path ?? '');
+    let logPath: string | undefined;
+
+    if (logs.level !== 'silent' && logs.file && !dryRun) {
+      logPath = logCrashReport(error, logs.path ?? '');
+    }
+
+    if (logs.level !== 'silent') {
       printCrashReport({ error, logPath });
       if (await shouldReportCrash()) {
         await openGitHubIssueWithCrashReport(error);
diff --git a/packages/openapi-ts/src/initConfigs.ts b/packages/openapi-ts/src/initConfigs.ts
diff --git a/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts b/packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts
diff --git a/packages/openapi-ts/src/plugins/@tanstack/query-core/plugin-legacy.ts b/packages/openapi-ts/src/plugins/@tanstack/query-core/plugin-legacy.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@hey-api/openapi-ts': patch
 +---
++
 +fix(typescript): handle nested inline objects with write/read only fields