Merge pull request #3255 from jsjames/fix-body-param

handle case where paramsStructure = 'flat' and body is an param.

Author: mrlubos

.changeset/stale-parts-warn.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+**plugin(@hey-api/sdk)**: correctly map body keys in flat mode

dev/openapi-ts.config.ts

@@ -48,8 +48,8 @@ export default defineConfig(() => {
           path: path.resolve(
             getSpecsPath(),
             // '2.0.x',
-            '3.0.x',
-            // '3.1.x',
+            // '3.0.x',
+            '3.1.x',
             // 'circular.yaml',
             // 'dutchie.json',
             // 'enum-names-values.yaml',
@@ -58,9 +58,9 @@ export default defineConfig(() => {
             // 'invalid',
             // 'object-property-names.yaml',
             // 'openai.yaml',
-            // 'opencode.yaml',
+            'opencode.yaml',
             // 'pagination-ref.yaml',
-            'ref-deep.yaml',
+            // 'ref-deep.yaml',
             // 'schema-const.yaml',
             // 'sdk-instance.yaml',
             // 'sdk-method-class-conflict.yaml',
@@ -121,7 +121,7 @@ export default defineConfig(() => {
             '/* eslint-disable */',
             '// This file is auto-generated by @hey-api/openapi-ts',
           ],
-          // importFileExtension: '.js',
+          importFileExtension: '.ts',
           // indexFile: false,
           // nameConflictResolver({ attempt, baseName }) {
           //   // console.log('resolving conflict for:', { attempt, baseName });
@@ -332,7 +332,7 @@ export default defineConfig(() => {
           //   fields.unwrap('path')
           // },
           // include...
-          // name: '@hey-api/sdk',
+          name: '@hey-api/sdk',
           operations: {
             // container: 'object',
             // containerName: {

dev/playground.ts

@@ -1,5 +1,7 @@
 import type { DefinePlugin, IR } from '@hey-api/openapi-ts';
-import { createOpencode } from '@opencode-ai/sdk';
+
+// import { createOpencode } from '@opencode-ai/sdk';
+import { PetStore } from './.gen/sdk.gen.ts';
 
 type MyPluginConfig = { readonly name: 'myplugin' };
 type MyPlugin = DefinePlugin<MyPluginConfig>;
@@ -15,8 +17,19 @@ export const handler: MyPlugin['Handler'] = ({ plugin }) => {
 };
 
 async function run() {
-  const { client, server } = await createOpencode();
-  console.log(client, server);
+  // const { client, server } = await createOpencode();
+  // console.log(client, server);
+  const client = new PetStore();
+  client.tui.publish({
+    body: {
+      properties: {
+        message: 'Hello from Hey API OpenAPI TS Playground!',
+        variant: 'success',
+      },
+      type: 'tui.toast.show',
+    },
+    directory: 'main',
+  });
 }
 
 run();

packages/openapi-ts-tests/sdks/__snapshots__/opencode/export-all/sdk.gen.ts

@@ -1703,7 +1703,7 @@ export const tuiPublish = <ThrowOnError extends boolean = false>(parameters?: {
     directory?: string;
     body?: EventTuiPromptAppend | EventTuiCommandExecute | EventTuiToastShow;
 }, options?: Options<never, ThrowOnError>) => {
-    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { in: 'body' }] }]);
+    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { key: 'body', map: 'body' }] }]);
     return (options?.client ?? client).post<TuiPublishResponses, TuiPublishErrors, ThrowOnError>({
         url: '/tui/publish',
         ...options,
@@ -1741,7 +1741,7 @@ export const tuiControlResponse = <ThrowOnError extends boolean = false>(paramet
     directory?: string;
     body?: unknown;
 }, options?: Options<never, ThrowOnError>) => {
-    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { in: 'body' }] }]);
+    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { key: 'body', map: 'body' }] }]);
     return (options?.client ?? client).post<TuiControlResponseResponses, unknown, ThrowOnError>({
         url: '/tui/control/response',
         ...options,

packages/openapi-ts-tests/sdks/__snapshots__/opencode/flat/sdk.gen.ts

@@ -1703,7 +1703,7 @@ export const tuiPublish = <ThrowOnError extends boolean = false>(parameters?: {
     directory?: string;
     body?: EventTuiPromptAppend | EventTuiCommandExecute | EventTuiToastShow;
 }, options?: Options<never, ThrowOnError>) => {
-    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { in: 'body' }] }]);
+    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { key: 'body', map: 'body' }] }]);
     return (options?.client ?? client).post<TuiPublishResponses, TuiPublishErrors, ThrowOnError>({
         url: '/tui/publish',
         ...options,
@@ -1741,7 +1741,7 @@ export const tuiControlResponse = <ThrowOnError extends boolean = false>(paramet
     directory?: string;
     body?: unknown;
 }, options?: Options<never, ThrowOnError>) => {
-    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { in: 'body' }] }]);
+    const params = buildClientParams([parameters], [{ args: [{ in: 'query', key: 'directory' }, { key: 'body', map: 'body' }] }]);
     return (options?.client ?? client).post<TuiControlResponseResponses, unknown, ThrowOnError>({
         url: '/tui/control/response',
         ...options,

packages/openapi-ts/src/plugins/@hey-api/sdk/shared/operation.ts

@@ -76,15 +76,15 @@ type OperationParameters = {
   parameters: Array<ReturnType<typeof $.param>>;
 };
 
-export const operationParameters = ({
+export function operationParameters({
   isRequiredOptions,
   operation,
   plugin,
 }: {
   isRequiredOptions: boolean;
   operation: IR.OperationObject;
   plugin: HeyApiSdkPlugin['Instance'];
-}): OperationParameters => {
+}): OperationParameters {
   const result: OperationParameters = {
     argNames: [],
     fields: [],
@@ -147,7 +147,7 @@ export const operationParameters = ({
   );
 
   return result;
-};
+}
 
 /**
  * Infers `responseType` value from provided response content type. This is
@@ -205,7 +205,7 @@ const getResponseType = (
   return;
 };
 
-export const operationStatements = ({
+export function operationStatements({
   isRequiredOptions,
   opParameters,
   operation,
@@ -215,7 +215,7 @@ export const operationStatements = ({
   opParameters: OperationParameters;
   operation: IR.OperationObject;
   plugin: HeyApiSdkPlugin['Instance'];
-}): Array<ReturnType<typeof $.return | typeof $.const>> => {
+}): Array<ReturnType<typeof $.return | typeof $.const>> {
   const client = getClientPlugin(plugin.context.config);
   const isNuxtClient = client.name === '@hey-api/client-nuxt';
 
@@ -514,4 +514,4 @@ export const operationStatements = ({
   );
 
   return statements;
-};
+}

packages/openapi-ts/src/plugins/@hey-api/sdk/shared/signature.ts

@@ -38,12 +38,12 @@ type Signature = {
  * - Prefixes all conflicting names with their location (e.g. path_foo, query_foo)
  * - Returns a flat map of resolved parameter names to their metadata
  */
-export const getSignatureParameters = ({
+export function getSignatureParameters({
   operation,
 }: {
   operation: IR.OperationObject;
   plugin: PluginInstance;
-}): Signature | undefined => {
+}): Signature | undefined {
   // TODO: add cookies
   const locations = [
     'header',
@@ -181,7 +181,10 @@ export const getSignatureParameters = ({
         name: 'body',
         schema: operation.body.schema,
       };
-      fields.push({ in: 'body' });
+      fields.push({
+        key: 'body',
+        map: 'body',
+      });
     }
   }
 
@@ -190,4 +193,4 @@ export const getSignatureParameters = ({
   }
 
   return { fields, parameters: signatureParameters };
-};
+}