chore: add changeset

Author: mrlubos

.changeset/cold-snails-end.md

@@ -0,0 +1,23 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+feat(sdk): add `classStructure` option supporting dot or slash `operationId` notation when generating class-based SDKs
+
+### Added `sdk.classStructure` option
+
+When generating class-based SDKs, we now try to infer the ideal structure using `operationId` keywords. If you'd like to preserve the previous behavior, set `classStructure` to `off`.
+
+```js
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      classStructure: 'off',
+      name: '@hey-api/sdk',
+    },
+  ],
+};
+```

docs/openapi-ts/migrating.md

@@ -27,20 +27,38 @@ This config option is deprecated and will be removed in favor of [clients](./cli
 
 This config option is deprecated and will be removed.
 
+## v0.72.0
+
+### Added `sdk.classStructure` option
+
+When generating class-based SDKs, we now try to infer the ideal structure using `operationId` keywords. If you'd like to preserve the previous behavior, set `classStructure` to `off`.
+
+```js
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      classStructure: 'off', // [!code ++]
+      name: '@hey-api/sdk',
+    },
+  ],
+};
+```
+
 ## v0.71.0
 
 ### Renamed `sdk.serviceNameBuilder` option
 
 This option has been renamed to `sdk.classNameBuilder` to better represent its functionality. Additionally, it's no longer set by default. To preserve the previous behavior, update your configuration.
 
 ```js
-import { defaultPlugins } from '@hey-api/openapi-ts';
-
 export default {
   input: 'https://get.heyapi.dev/hey-api/backend',
   output: 'src/client',
   plugins: [
-    ...defaultPlugins,
+    // ...other plugins
     {
       classNameBuilder: '{{name}}Service', // [!code ++]
       name: '@hey-api/sdk',
@@ -259,14 +277,12 @@ The Fetch API client will return raw response body as `ReadableStream` when `Con
 When generating SDKs, you now have to specify `transformer` in order to modify response data. By default, adding `@hey-api/transformers` to your plugins will only produce additional output. To preserve the previous functionality, set `sdk.transformer` to `true`.
 
 ```js
-import { defaultPlugins } from '@hey-api/openapi-ts';
-
 export default {
   client: '@hey-api/client-fetch',
   input: 'https://get.heyapi.dev/hey-api/backend',
   output: 'src/client',
   plugins: [
-    ...defaultPlugins,
+    // ...other plugins
     {
       dates: true,
       name: '@hey-api/transformers',
@@ -302,15 +318,13 @@ export default {
 `@hey-api/schemas` has been removed from the default plugins. To continue using it, add it to your plugins array.
 
 ```js
-import { defaultPlugins } from '@hey-api/openapi-ts';
-
 export default {
   client: '@hey-api/client-fetch',
   experimentalParser: true,
   input: 'https://get.heyapi.dev/hey-api/backend',
   output: 'src/client',
   plugins: [
-    ...defaultPlugins,
+    // ...other plugins
     '@hey-api/schemas', // [!code ++]
   ],
 };

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/instance/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { FooPostData, FooPostResponses, FooPutData, FooPutResponses, FooBarPostData, FooBarPostResponses, FooBarPutData, FooBarPutResponses } from './types.gen';
+import type { GetFooData, GetFooResponses, FooPostData, FooPostResponses, FooPutData, FooPutResponses, GetFooBarData, GetFooBarResponses, FooBarPostData, FooBarPostResponses, FooBarPutData, FooBarPutResponses } from './types.gen';
 import { client as _heyApiClient } from './client.gen';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -30,6 +30,22 @@ class _HeyApiClient {
     }
 }
 
+class Bar extends _HeyApiClient {
+    public post<ThrowOnError extends boolean = false>(options?: Options<FooBarPostData, ThrowOnError>) {
+        return (options?.client ?? this._client).post<FooBarPostResponses, unknown, ThrowOnError>({
+            url: '/foo/bar',
+            ...options
+        });
+    }
+    
+    public put<ThrowOnError extends boolean = false>(options?: Options<FooBarPutData, ThrowOnError>) {
+        return (options?.client ?? this._client).put<FooBarPutResponses, unknown, ThrowOnError>({
+            url: '/foo/bar',
+            ...options
+        });
+    }
+}
+
 class Foo extends _HeyApiClient {
     public post<ThrowOnError extends boolean = false>(options?: Options<FooPostData, ThrowOnError>) {
         return (options?.client ?? this._client).post<FooPostResponses, unknown, ThrowOnError>({
@@ -47,22 +63,19 @@ class Foo extends _HeyApiClient {
     bar = new Bar({ client: this._client });
 }
 
-class Bar extends _HeyApiClient {
-    public post<ThrowOnError extends boolean = false>(options?: Options<FooBarPostData, ThrowOnError>) {
-        return (options?.client ?? this._client).post<FooBarPostResponses, unknown, ThrowOnError>({
-            url: '/foo/bar',
+export class Sdk extends _HeyApiClient {
+    public getFoo<ThrowOnError extends boolean = false>(options?: Options<GetFooData, ThrowOnError>) {
+        return (options?.client ?? this._client).get<GetFooResponses, unknown, ThrowOnError>({
+            url: '/foo',
             ...options
         });
     }
 
-    public put<ThrowOnError extends boolean = false>(options?: Options<FooBarPutData, ThrowOnError>) {
-        return (options?.client ?? this._client).put<FooBarPutResponses, unknown, ThrowOnError>({
+    public getFooBar<ThrowOnError extends boolean = false>(options?: Options<GetFooBarData, ThrowOnError>) {
+        return (options?.client ?? this._client).get<GetFooBarResponses, unknown, ThrowOnError>({
             url: '/foo/bar',
             ...options
         });
     }
-}
-
-export class Sdk extends _HeyApiClient {
     foo = new Foo({ client: this._client });
 }

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/instance/types.gen.ts

@@ -1,5 +1,21 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
+export type GetFooData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/foo';
+};
+
+export type GetFooResponses = {
+    /**
+     * OK
+     */
+    200: string;
+};
+
+export type GetFooResponse = GetFooResponses[keyof GetFooResponses];
+
 export type FooPostData = {
     body?: never;
     path?: never;
@@ -32,6 +48,22 @@ export type FooPutResponses = {
 
 export type FooPutResponse = FooPutResponses[keyof FooPutResponses];
 
+export type GetFooBarData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/foo/bar';
+};
+
+export type GetFooBarResponses = {
+    /**
+     * OK
+     */
+    200: string;
+};
+
+export type GetFooBarResponse = GetFooBarResponses[keyof GetFooBarResponses];
+
 export type FooBarPostData = {
     body?: never;
     path?: never;