Merge pull request #1889 from hey-api/feat/client-custom-2

feat: support custom clients

Author: mrlubos

.changeset/silver-mice-dance.md

@@ -0,0 +1,8 @@
+---
+'@hey-api/client-axios': minor
+'@hey-api/client-fetch': minor
+'@hey-api/client-next': minor
+'@hey-api/client-nuxt': minor
+---
+
+fix: add @hey-api/openapi-ts to peer dependencies

.changeset/spotty-hats-punch.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+feat: support custom clients

package.json

@@ -45,6 +45,11 @@
     "@arethetypeswrong/cli": "0.17.2",
     "@changesets/changelog-github": "0.5.0",
     "@changesets/cli": "2.27.8",
+    "@hey-api/client-axios": "workspace:*",
+    "@hey-api/client-custom": "workspace:*",
+    "@hey-api/client-fetch": "workspace:*",
+    "@hey-api/client-next": "workspace:*",
+    "@hey-api/client-nuxt": "workspace:*",
     "@types/node": "22.10.5",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@vitest/coverage-v8": "1.6.0",

packages/client-axios/package.json

@@ -66,10 +66,12 @@
     "typecheck": "vitest --typecheck --watch=false"
   },
   "peerDependencies": {
+    "@hey-api/openapi-ts": "< 2",
     "axios": ">= 1.0.0 < 2"
   },
   "devDependencies": {
     "@hey-api/client-core": "workspace:*",
+    "@hey-api/openapi-ts": "workspace:*",
     "axios": "1.7.9"
   }
 }

packages/client-custom/src/plugin.ts

@@ -1,25 +1,26 @@
 import {
+  type Client,
   clientDefaultConfig,
   clientPluginHandler,
   type Plugin,
 } from '@hey-api/openapi-ts';
 
-export interface Config {
+export interface Config extends Client.Config {
   /**
    * Plugin name. Must be unique.
    */
-  name: 'my-client';
+  name: '@hey-api/client-custom';
 }
 
 export const defaultConfig: Plugin.Config<Config> = {
   ...clientDefaultConfig,
   _handler: clientPluginHandler,
   _handlerLegacy: () => {},
-  name: 'my-client',
+  name: '@hey-api/client-custom',
 };
 
 /**
- * Type helper for `my-client` plugin, returns {@link Plugin.Config} object
+ * Type helper for `@hey-api/client-custom` plugin, returns {@link Plugin.Config} object
  */
 export const customClientPlugin: Plugin.DefineConfig<Config> = (config) => ({
   ...defaultConfig,

packages/client-fetch/package.json

@@ -65,7 +65,11 @@
     "test": "vitest run",
     "typecheck": "vitest --typecheck --watch=false"
   },
+  "peerDependencies": {
+    "@hey-api/openapi-ts": "< 2"
+  },
   "devDependencies": {
-    "@hey-api/client-core": "workspace:*"
+    "@hey-api/client-core": "workspace:*",
+    "@hey-api/openapi-ts": "workspace:*"
   }
 }

packages/client-next/package.json

@@ -65,7 +65,11 @@
     "test": "vitest run",
     "typecheck": "vitest --typecheck --watch=false"
   },
+  "peerDependencies": {
+    "@hey-api/openapi-ts": "< 2"
+  },
   "devDependencies": {
-    "@hey-api/client-core": "workspace:*"
+    "@hey-api/client-core": "workspace:*",
+    "@hey-api/openapi-ts": "workspace:*"
   }
 }

packages/client-nuxt/package.json

@@ -61,11 +61,13 @@
     "typecheck": "vitest --typecheck --watch=false"
   },
   "peerDependencies": {
+    "@hey-api/openapi-ts": "< 2",
     "nuxt": ">= 3.0.0 < 4",
     "vue": ">= 3.5.13 < 4"
   },
   "devDependencies": {
     "@hey-api/client-core": "workspace:*",
+    "@hey-api/openapi-ts": "workspace:*",
     "@nuxt/test-utils": "3.14.0",
     "vite": "6.0.9"
   }

packages/openapi-ts-tests/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@test/openapi-ts",
   "version": "0.0.0",
+  "private": true,
   "type": "module",
   "scripts": {
     "test:coverage": "vitest run --config vitest.config.unit.ts --coverage",
@@ -29,6 +30,7 @@
     "@angular/platform-browser-dynamic": "19.2.0",
     "@angular/router": "19.2.0",
     "@hey-api/client-axios": "workspace:*",
+    "@hey-api/client-core": "workspace:*",
     "@hey-api/client-custom": "workspace:*",
     "@hey-api/client-fetch": "workspace:*",
     "@hey-api/client-next": "workspace:*",

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/client-custom/base-url-false/client.gen.ts

@@ -0,0 +1,16 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-custom';
+
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+
+export const client = createClient(createConfig<ClientOptions>());

packages/openapi-ts-tests/test/__snapshots__/3.1.x/clients/client-custom/base-url-false/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';