feat(sdk): add paramsStructure option

Author: mrlubos

.changeset/nine-cats-cross.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(sdk): add paramsStructure field

.changeset/tidy-poets-peel.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/codegen-core': patch
+---
+
+fix: update types

dev/openapi-ts.config.ts

@@ -41,8 +41,8 @@ export default defineConfig(() => {
             // 'invalid',
             // 'openai.yaml',
             // 'full.yaml',
-            // 'opencode.yaml',
-            'sdk-instance.yaml',
+            'opencode.yaml',
+            // 'sdk-instance.yaml',
             // 'string-with-format.yaml',
             // 'transformers.json',
             // 'type-format.yaml',
@@ -248,21 +248,21 @@ export default defineConfig(() => {
           // },
         },
         {
-          asClass: true,
+          // asClass: true,
           // auth: false,
           // classNameBuilder: '{{name}}',
-          classNameBuilder: '{{name}}Service',
+          // classNameBuilder: '{{name}}Service',
           // classStructure: 'off',
           // client: false,
           // getSignature: ({ fields, signature, operation }) => {
           //   // ...
           //   fields.unwrap('path')
           // },
           // include...
-          // instance: true,
+          instance: true,
           name: '@hey-api/sdk',
           // operationId: false,
-          // params_EXPERIMENTAL: 'experiment',
+          paramsStructure: 'flat',
           // responseStyle: 'data',
           // signature: 'auto',
           // signature: 'client',

dev/playground.ts

@@ -0,0 +1,56 @@
+import { Sdk } from './.gen/sdk.gen';
+
+const opencode = new Sdk();
+opencode.session.create(
+  {
+    parentID: '',
+    title: '',
+  },
+  {
+    headers: {
+      'X-Custom-Header': 'value',
+    },
+  },
+);
+opencode.session.init({
+  id: '',
+  messageID: '',
+  modelID: '',
+  providerID: '',
+});
+opencode.session.chat({
+  agent: '',
+  id: '',
+  messageID: '',
+  modelID: '',
+  parts: [
+    {
+      name: '',
+      type: 'agent',
+    },
+  ],
+  providerID: '',
+  system: '',
+  tools: {},
+});
+opencode.auth.set({
+  auth: {
+    // access: '',
+    // expires: 1,
+    key: '',
+    // refresh: '',
+    // token: '',
+    type: 'api',
+  },
+  id: '123',
+});
+opencode.postSessionByIdPermissionsByPermissionId({
+  id: 'session-id',
+  permissionID: 'permission-id',
+  response: 'always',
+});
+opencode.tui.showToast({
+  message: '',
+  title: '',
+  variant: 'error',
+});

packages/codegen-core/src/symbols/types.d.ts

@@ -39,7 +39,7 @@ export interface ISymbolIn {
   /**
    * Kind of symbol.
    */
-  readonly kind?: 'type';
+  readonly kind?: 'class' | 'function' | 'type';
   /**
    * Arbitrary metadata about the symbol.
    *

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/body-response-text-plain/client/types.gen.ts

@@ -238,7 +238,7 @@ export type Options<
   RequestOptions<TResponse, TResponseStyle, ThrowOnError>,
   'body' | 'path' | 'query' | 'url'
 > &
-  Omit<TData, 'url'>;
+  ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 
 export type OptionsLegacyParser<
   TData = unknown,

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/body-response-text-plain/core/params.gen.ts

@@ -2,6 +2,24 @@
 
 type Slot = 'body' | 'headers' | 'path' | 'query';
 
+type Params = {
+  body: unknown;
+  headers: Record<string, unknown>;
+  path: Record<string, unknown>;
+  query: Record<string, unknown>;
+}
+
+type KeyMap = Map<
+  string,
+  {
+    in: Slot;
+    map?: string;
+  } | {
+    in?: never;
+    map: Slot;
+  }
+>;
+
 export type Field =
   | {
       in: Exclude<Slot, 'body'>;
@@ -22,6 +40,17 @@ export type Field =
        */
       key?: string;
       map?: string;
+    }
+  | {
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
+      key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If `in` is omitted, `map` aliases `key` to the transport layer.
+       */
+      map: Slot;
     };
 
 export interface Fields {
@@ -39,14 +68,6 @@ const extraPrefixesMap: Record<string, Slot> = {
 };
 const extraPrefixes = Object.entries(extraPrefixesMap);
 
-type KeyMap = Map<
-  string,
-  {
-    in: Slot;
-    map?: string;
-  }
->;
-
 const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
   if (!map) {
     map = new Map();
@@ -60,6 +81,10 @@ const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
           map: config.map,
         });
       }
+    } else if ('key' in config) {
+      map.set(config.key, {
+        map: config.map,
+      });
     } else if (config.args) {
       buildKeyMap(config.args, map);
     }
@@ -68,13 +93,6 @@ const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
   return map;
 };
 
-interface Params {
-  body: unknown;
-  headers: Record<string, unknown>;
-  path: Record<string, unknown>;
-  query: Record<string, unknown>;
-}
-
 const stripEmptySlots = (params: Params) => {
   for (const [slot, value] of Object.entries(params)) {
     if (value && typeof value === 'object' && !Object.keys(value).length) {
@@ -111,7 +129,9 @@ export const buildClientParams = (
       if (config.key) {
         const field = map.get(config.key)!;
         const name = field.map || config.key;
-        (params[field.in] as Record<string, unknown>)[name] = arg;
+        if (field.in) {
+          (params[field.in] as Record<string, unknown>)[name] = arg;
+        }
       } else {
         params.body = arg;
       }
@@ -120,8 +140,12 @@ export const buildClientParams = (
         const field = map.get(key);
 
         if (field) {
-          const name = field.map || key;
-          (params[field.in] as Record<string, unknown>)[name] = value;
+          if (field.in) {
+            const name = field.map || key;
+            (params[field.in] as Record<string, unknown>)[name] = value;
+          } else {
+            params[field.map] = value;
+          }
         } else {
           const extra = extraPrefixes.find(([prefix]) =>
             key.startsWith(prefix),
@@ -132,10 +156,8 @@ export const buildClientParams = (
             (params[slot] as Record<string, unknown>)[
               key.slice(prefix.length)
             ] = value;
-          } else {
-            for (const [slot, allowed] of Object.entries(
-              config.allowExtra ?? {},
-            )) {
+          } else if ('allowExtra' in config && config.allowExtra) {
+            for (const [slot, allowed] of Object.entries(config.allowExtra)) {
               if (allowed) {
                 (params[slot as Slot] as Record<string, unknown>)[key] = value;
                 break;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/form-data/client/types.gen.ts

@@ -238,7 +238,7 @@ export type Options<
   RequestOptions<TResponse, TResponseStyle, ThrowOnError>,
   'body' | 'path' | 'query' | 'url'
 > &
-  Omit<TData, 'url'>;
+  ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 
 export type OptionsLegacyParser<
   TData = unknown,

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/form-data/core/params.gen.ts

@@ -2,6 +2,24 @@
 
 type Slot = 'body' | 'headers' | 'path' | 'query';
 
+type Params = {
+  body: unknown;
+  headers: Record<string, unknown>;
+  path: Record<string, unknown>;
+  query: Record<string, unknown>;
+}
+
+type KeyMap = Map<
+  string,
+  {
+    in: Slot;
+    map?: string;
+  } | {
+    in?: never;
+    map: Slot;
+  }
+>;
+
 export type Field =
   | {
       in: Exclude<Slot, 'body'>;
@@ -22,6 +40,17 @@ export type Field =
        */
       key?: string;
       map?: string;
+    }
+  | {
+      /**
+       * Field name. This is the name we want the user to see and use.
+       */
+      key: string;
+      /**
+       * Field mapped name. This is the name we want to use in the request.
+       * If `in` is omitted, `map` aliases `key` to the transport layer.
+       */
+      map: Slot;
     };
 
 export interface Fields {
@@ -39,14 +68,6 @@ const extraPrefixesMap: Record<string, Slot> = {
 };
 const extraPrefixes = Object.entries(extraPrefixesMap);
 
-type KeyMap = Map<
-  string,
-  {
-    in: Slot;
-    map?: string;
-  }
->;
-
 const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
   if (!map) {
     map = new Map();
@@ -60,6 +81,10 @@ const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
           map: config.map,
         });
       }
+    } else if ('key' in config) {
+      map.set(config.key, {
+        map: config.map,
+      });
     } else if (config.args) {
       buildKeyMap(config.args, map);
     }
@@ -68,13 +93,6 @@ const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
   return map;
 };
 
-interface Params {
-  body: unknown;
-  headers: Record<string, unknown>;
-  path: Record<string, unknown>;
-  query: Record<string, unknown>;
-}
-
 const stripEmptySlots = (params: Params) => {
   for (const [slot, value] of Object.entries(params)) {
     if (value && typeof value === 'object' && !Object.keys(value).length) {
@@ -111,7 +129,9 @@ export const buildClientParams = (
       if (config.key) {
         const field = map.get(config.key)!;
         const name = field.map || config.key;
-        (params[field.in] as Record<string, unknown>)[name] = arg;
+        if (field.in) {
+          (params[field.in] as Record<string, unknown>)[name] = arg;
+        }
       } else {
         params.body = arg;
       }
@@ -120,8 +140,12 @@ export const buildClientParams = (
         const field = map.get(key);
 
         if (field) {
-          const name = field.map || key;
-          (params[field.in] as Record<string, unknown>)[name] = value;
+          if (field.in) {
+            const name = field.map || key;
+            (params[field.in] as Record<string, unknown>)[name] = value;
+          } else {
+            params[field.map] = value;
+          }
         } else {
           const extra = extraPrefixes.find(([prefix]) =>
             key.startsWith(prefix),
@@ -132,10 +156,8 @@ export const buildClientParams = (
             (params[slot] as Record<string, unknown>)[
               key.slice(prefix.length)
             ] = value;
-          } else {
-            for (const [slot, allowed] of Object.entries(
-              config.allowExtra ?? {},
-            )) {
+          } else if ('allowExtra' in config && config.allowExtra) {
+            for (const [slot, allowed] of Object.entries(config.allowExtra)) {
               if (allowed) {
                 (params[slot as Slot] as Record<string, unknown>)[key] = value;
                 break;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@angular/common/default-class/client/types.gen.ts

@@ -253,7 +253,7 @@ export type Options<
   RequestOptions<TResponse, TResponseStyle, ThrowOnError>,
   'body' | 'path' | 'query' | 'url'
 > &
-  Omit<TData, 'url'>;
+  ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 
 export type OptionsLegacyParser<
   TData = unknown,