@kubb/plugin-client 5.0.0-beta.64 → 5.7.0-canary.20260930T095256

package/README.md

@@ -1,70 +1,17 @@
-<div align="center">
-  <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
-    <img src="https://kubb.dev/og.png" alt="Kubb banner">
-  </a>
-
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Stars][stars-src]][stars-href]
-[![License][license-src]][license-href]
-[![Node][node-src]][node-href]
-
-<h4>
-<a href="https://kubb.dev/plugins/client" target="_blank">Documentation</a>
-<span> · </span>
-<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
-<span> · </span>
-<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Request Feature</a>
-</h4>
-</div>
-
-<br />
-
 # @kubb/plugin-client
 
-### Generate type-safe HTTP clients from OpenAPI
-
-`@kubb/plugin-client` generates HTTP clients from your OpenAPI specification. It supports Axios, Fetch, and custom adapters, with request and response types inferred directly from the spec.
+Generate typed operations from an OpenAPI document and connect them to a client module that you own. The plugin generates operation functions and types; it does not choose a transport or copy runtime helpers.
 
-## Installation
+```ts
+import { pluginClient } from '@kubb/plugin-client'
 
-```bash
-bun add @kubb/plugin-client
-# or
-pnpm add @kubb/plugin-client
-# or
-npm install @kubb/plugin-client
+pluginClient({ importPath: '../api/client' })
 ```
 
-## Documentation
-
-See the [full documentation](https://kubb.dev/plugins/client) for configuration options and examples.
-
-## Supporting Kubb
-
-Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:
-
-- [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
-
-<p align="center">
-  <a href="https://github.com/sponsors/stijnvanhulle">
-    <img src="https://raw.githubusercontent.com/stijnvanhulle/sponsors/main/sponsors.svg" alt="My sponsors" />
-  </a>
-</p>
-
-## License
+`importPath` is written into each generated import as-is, so it must resolve from the generated operation file (for example `../../../client`, or a package or alias specifier). The module must export `client`, plus the `Options` and `RequestResult` types. Generated operations call `client` with a config containing `method`, `url`, and the operation options, and return its promise typed as `RequestResult`. There are no `withUnwrap` or `unwrapResult` helpers to write, and `returnType` is not an option.
 
-[MIT](https://github.com/kubb-labs/plugins/blob/main/LICENSE)
+If your spec has server-sent event operations, also export `toEventStream` and the `EventStreamResult` and `SuccessOf` types. Implement the behavior your application needs in that module.
 
-<!-- Badges -->
+Set the base URL, auth, retries, and any other behavior inside your `client`. `sdk`, `returnType`, and `baseURL` are not options of this plugin. `validator: 'zod'` needs `pluginZod()` in the plugins, and generation stops with an error if it is missing. Your `client` receives the schemas on `config.validator` (`{ request?, response?, error? }`), so add that field to your `RequestConfig` and run them yourself.
 
-[npm-version-src]: https://shieldcn.dev/npm/v/@kubb/plugin-client.svg?variant=secondary&size=xs&theme=zinc&mode=dark
-[npm-version-href]: https://npmx.dev/package/@kubb/plugin-client
-[npm-downloads-src]: https://shieldcn.dev/npm/dm/@kubb/plugin-client.svg?variant=secondary&size=xs&theme=zinc&mode=dark
-[npm-downloads-href]: https://npmx.dev/package/@kubb/plugin-client
-[stars-src]: https://shieldcn.dev/github/stars/kubb-labs/kubb.svg?variant=secondary&size=xs&theme=zinc&mode=dark
-[stars-href]: https://github.com/kubb-labs/kubb
-[license-src]: https://shieldcn.dev/npm/license/@kubb/plugin-client.svg?variant=secondary&size=xs&theme=zinc
-[license-href]: https://github.com/kubb-labs/kubb/blob/main/LICENSE
-[node-src]: https://shieldcn.dev/npm/node/@kubb/plugin-client.svg?variant=secondary&size=xs&theme=zinc&mode=dark
-[node-href]: https://npmx.dev/package/@kubb/plugin-client
+See [`examples/client`](../../examples/client) for a minimal `client.ts` built on `fetch`.