@hey-api/openapi-ts 0.97.2 → 0.98.0

package/README.md

@@ -39,7 +39,7 @@ Part of the Hey API ecosystem.
 - HTTP clients for Fetch API, Angular, Axios, Next.js, Nuxt, and more
 - 20+ plugins to reduce third-party boilerplate
 - highly customizable via plugins
-- [sync with Hey API Registry](https://heyapi.dev/openapi-ts/integrations) for spec management
+- [sync with Hey API Registry](https://heyapi.dev/docs/openapi/typescript/integrations) for spec management
 
 <!-- template-contributing-start -->
 
@@ -177,7 +177,7 @@ The fastest way to use `@hey-api/openapi-ts` is via npx
 npx @hey-api/openapi-ts -i hey-api/backend -o src/client
 ```
 
-Congratulations on creating your first client! 🎉 You can learn more about the generated files on the [Output](https://heyapi.dev/openapi-ts/output) page.
+Congratulations on creating your first client! 🎉 You can learn more about the generated files on the [Output](https://heyapi.dev/docs/openapi/typescript/output) page.
 
 ## Installation
 
@@ -211,7 +211,7 @@ bun add @hey-api/openapi-ts -D
 
 This package is in [initial development](https://semver.org/#spec-item-4). Please pin an exact version so you can safely upgrade when you're ready.
 
-We publish [migration notes](https://heyapi.dev/openapi-ts/migrating) for every breaking release. You might not be impacted by a breaking change if you don't use the affected features.
+We publish [migration notes](https://heyapi.dev/docs/openapi/typescript/migrating) for every breaking release. You might not be impacted by a breaking change if you don't use the affected features.
 
 ## Usage
 
@@ -225,7 +225,7 @@ Most people run `@hey-api/openapi-ts` via CLI. To do that, add a script to your
 }
 ```
 
-The above script can be executed by running `npm run openapi-ts` or equivalent command in other package managers. Next, we will create a [configuration](https://heyapi.dev/openapi-ts/configuration) file and move our options from Quick Start to it.
+The above script can be executed by running `npm run openapi-ts` or equivalent command in other package managers. Next, we will create a [configuration](https://heyapi.dev/docs/openapi/typescript/configuration) file and move our options from Quick Start to it.
 
 ### Node.js
 
@@ -290,7 +290,7 @@ export default defineConfig({
 });
 ```
 
-See the [Vite](https://heyapi.dev/openapi-ts/configuration/vite) page for full configuration options.
+See the [Vite](https://heyapi.dev/docs/openapi/typescript/configuration/vite) page for full configuration options.
 
 ## Configuration
 
@@ -355,73 +355,74 @@ Clients are responsible for sending the actual HTTP requests. We default to Fetc
 
 ### Available Clients
 
-- [`@hey-api/client-fetch`](https://heyapi.dev/openapi-ts/clients/fetch)
-- [`@hey-api/client-angular`](https://heyapi.dev/openapi-ts/clients/angular)
-- [`@hey-api/client-axios`](https://heyapi.dev/openapi-ts/clients/axios)
-- [`@hey-api/client-ky`](https://heyapi.dev/openapi-ts/clients/ky)
-- [`@hey-api/client-next`](https://heyapi.dev/openapi-ts/clients/next-js)
-- [`@hey-api/client-nuxt`](https://heyapi.dev/openapi-ts/clients/nuxt)
-- [`@hey-api/client-ofetch`](https://heyapi.dev/openapi-ts/clients/ofetch)
+- [`@hey-api/client-fetch`](https://heyapi.dev/docs/openapi/typescript/clients/fetch)
+- [`@hey-api/client-angular`](https://heyapi.dev/docs/openapi/typescript/clients/angular)
+- [`@hey-api/client-axios`](https://heyapi.dev/docs/openapi/typescript/clients/axios)
+- [`@hey-api/client-ky`](https://heyapi.dev/docs/openapi/typescript/clients/ky)
+- [`@hey-api/client-next`](https://heyapi.dev/docs/openapi/typescript/clients/next-js)
+- [`@hey-api/client-nuxt`](https://heyapi.dev/docs/openapi/typescript/clients/nuxt)
+- [`@hey-api/client-ofetch`](https://heyapi.dev/docs/openapi/typescript/clients/ofetch)
 
 ### Proposed Clients (Vote to Prioritize)
 
 The following clients are roadmap proposals and are not started yet. You can help us prioritize them by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues?q=state%3Aopen%20label%3A%22vote%20%F0%9F%93%A9%22).
 
-- [`@hey-api/client-effect`](https://heyapi.dev/openapi-ts/clients/effect)
+- [`@hey-api/client-effect`](https://heyapi.dev/docs/openapi/typescript/clients/effect)
 
-Don't see your client? [Build your own](https://heyapi.dev/openapi-ts/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
+Don't see your client? [Build your own](https://heyapi.dev/docs/openapi/typescript/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
 
 ### Available Plugins
 
 These plugins help reduce boilerplate associated with third-party dependencies. Hey API natively supports the most popular packages. Please open an issue on [GitHub](https://github.com/hey-api/openapi-ts/issues) if you'd like us to support your favorite package.
 
-- [`@angular/common`](https://heyapi.dev/openapi-ts/plugins/angular)
-- [`@hey-api/schemas`](https://heyapi.dev/openapi-ts/output/json-schema)
-- [`@hey-api/sdk`](https://heyapi.dev/openapi-ts/output/sdk)
-- [`@hey-api/transformers`](https://heyapi.dev/openapi-ts/transformers)
-- [`@hey-api/typescript`](https://heyapi.dev/openapi-ts/output/typescript)
-- [`@pinia/colada`](https://heyapi.dev/openapi-ts/plugins/pinia-colada)
-- [`@tanstack/angular-query-experimental`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
-- [`@tanstack/preact-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
-- [`@tanstack/react-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
-- [`@tanstack/solid-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
-- [`@tanstack/svelte-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
-- [`@tanstack/vue-query`](https://heyapi.dev/openapi-ts/plugins/tanstack-query)
-- [`fastify`](https://heyapi.dev/openapi-ts/plugins/fastify)
-- [`orpc`](https://heyapi.dev/openapi-ts/plugins/orpc)
-- [`nestjs`](https://heyapi.dev/openapi-ts/plugins/nest)
-- [`valibot`](https://heyapi.dev/openapi-ts/plugins/valibot)
-- [`zod`](https://heyapi.dev/openapi-ts/plugins/zod)
+- [`@angular/common`](https://heyapi.dev/docs/openapi/typescript/plugins/angular)
+- [`@hey-api/schemas`](https://heyapi.dev/docs/openapi/typescript/plugins/schemas)
+- [`@hey-api/sdk`](https://heyapi.dev/docs/openapi/typescript/plugins/sdk)
+- [`@hey-api/transformers`](https://heyapi.dev/docs/openapi/typescript/plugins/transformers)
+- [`@hey-api/typescript`](https://heyapi.dev/docs/openapi/typescript/plugins/typescript)
+- [`@pinia/colada`](https://heyapi.dev/docs/openapi/typescript/plugins/pinia-colada)
+- [`@tanstack/angular-query-experimental`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
+- [`@tanstack/preact-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
+- [`@tanstack/react-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
+- [`@tanstack/solid-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
+- [`@tanstack/svelte-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
+- [`@tanstack/vue-query`](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query)
+- [`fastify`](https://heyapi.dev/docs/openapi/typescript/plugins/fastify)
+- [`orpc`](https://heyapi.dev/docs/openapi/typescript/plugins/orpc)
+- [`nestjs`](https://heyapi.dev/docs/openapi/typescript/plugins/nest)
+- [`valibot`](https://heyapi.dev/docs/openapi/typescript/plugins/valibot)
+- [`zod`](https://heyapi.dev/docs/openapi/typescript/plugins/zod)
 
 ### Proposed Plugins (Vote to Prioritize)
 
 The following plugins are roadmap proposals and are not started yet. You can help us prioritize them by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues?q=state%3Aopen%20label%3A%22vote%20%F0%9F%93%A9%22).
 
-- [Adonis](https://heyapi.dev/openapi-ts/plugins/adonis)
-- [Ajv](https://heyapi.dev/openapi-ts/plugins/ajv)
-- [Arktype](https://heyapi.dev/openapi-ts/plugins/arktype)
-- [Chance](https://heyapi.dev/openapi-ts/plugins/chance)
-- [Elysia](https://heyapi.dev/openapi-ts/plugins/elysia)
-- [Express](https://heyapi.dev/openapi-ts/plugins/express)
-- [Faker](https://heyapi.dev/openapi-ts/plugins/faker)
-- [Falso](https://heyapi.dev/openapi-ts/plugins/falso)
-- [Hono](https://heyapi.dev/openapi-ts/plugins/hono)
-- [Joi](https://heyapi.dev/openapi-ts/plugins/joi)
-- [Koa](https://heyapi.dev/openapi-ts/plugins/koa)
-- [MSW](https://heyapi.dev/openapi-ts/plugins/msw)
-- [Nock](https://heyapi.dev/openapi-ts/plugins/nock)
-- [Superstruct](https://heyapi.dev/openapi-ts/plugins/superstruct)
-- [Supertest](https://heyapi.dev/openapi-ts/plugins/supertest)
-- [SWR](https://heyapi.dev/openapi-ts/plugins/swr)
-- [TypeBox](https://heyapi.dev/openapi-ts/plugins/typebox)
-- [Yup](https://heyapi.dev/openapi-ts/plugins/yup)
-- [Zustand](https://heyapi.dev/openapi-ts/plugins/zustand)
-
-Don't see your plugin? [Build your own](https://heyapi.dev/openapi-ts/plugins/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
+- [Adonis](https://heyapi.dev/docs/openapi/typescript/plugins/adonis)
+- [Ajv](https://heyapi.dev/docs/openapi/typescript/plugins/ajv)
+- [Arktype](https://heyapi.dev/docs/openapi/typescript/plugins/arktype)
+- [Chance](https://heyapi.dev/docs/openapi/typescript/plugins/chance)
+- [Elysia](https://heyapi.dev/docs/openapi/typescript/plugins/elysia)
+- [Express](https://heyapi.dev/docs/openapi/typescript/plugins/express)
+- [Faker](https://heyapi.dev/docs/openapi/typescript/plugins/faker)
+- [Falso](https://heyapi.dev/docs/openapi/typescript/plugins/falso)
+- [Hono](https://heyapi.dev/docs/openapi/typescript/plugins/hono)
+- [Joi](https://heyapi.dev/docs/openapi/typescript/plugins/joi)
+- [Koa](https://heyapi.dev/docs/openapi/typescript/plugins/koa)
+- [MSW](https://heyapi.dev/docs/openapi/typescript/plugins/msw)
+- [Nock](https://heyapi.dev/docs/openapi/typescript/plugins/nock)
+- [Superstruct](https://heyapi.dev/docs/openapi/typescript/plugins/superstruct)
+- [Supertest](https://heyapi.dev/docs/openapi/typescript/plugins/supertest)
+- [SWR](https://heyapi.dev/docs/openapi/typescript/plugins/swr)
+- [TanStack Start](https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-start)
+- [TypeBox](https://heyapi.dev/docs/openapi/typescript/plugins/typebox)
+- [Yup](https://heyapi.dev/docs/openapi/typescript/plugins/yup)
+- [Zustand](https://heyapi.dev/docs/openapi/typescript/plugins/zustand)
+
+Don't see your plugin? [Build your own](https://heyapi.dev/docs/openapi/typescript/plugins/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
 
 ## Migrating
 
-You can learn more on the [Migrating](https://heyapi.dev/openapi-ts/migrating) page.
+You can learn more on the [Migrating](https://heyapi.dev/docs/openapi/typescript/migrating) page.
 
 <!-- template-license-start -->
 

package/dist/clients/angular/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/angular/types.ts

@@ -156,12 +156,13 @@ type MethodFn = <
 
 type SseFn = <
   TData = unknown,
-  TError = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _TError = unknown,
   ThrowOnError extends boolean = false,
   TResponseStyle extends ResponseStyle = 'fields',
 >(
   options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>,
-) => Promise<ServerSentEventsResult<TData, TError>>;
+) => Promise<ServerSentEventsResult<TData>>;
 
 type RequestFn = <
   TData = unknown,

package/dist/clients/angular/utils.ts

@@ -93,8 +93,8 @@ const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     if (queryParams && typeof queryParams === 'object') {
       for (const name in queryParams) {
@@ -240,7 +240,7 @@ export const getUrl = ({
   query?: Record<string, unknown>;
   querySerializer: QuerySerializer;
   url: string;
-}) => {
+}): string => {
   const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
   let url = (baseUrl ?? '') + pathUrl;
   if (path) {

package/dist/clients/axios/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/axios/types.ts

@@ -105,9 +105,14 @@ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean
   options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>,
 ) => RequestResult<TData, TError, ThrowOnError>;
 
-type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(
+type SseFn = <
+  TData = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _TError = unknown,
+  ThrowOnError extends boolean = false,
+>(
   options: Omit<RequestOptions<never, ThrowOnError>, 'method'>,
-) => Promise<ServerSentEventsResult<TData, TError>>;
+) => Promise<ServerSentEventsResult<TData>>;
 
 type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(
   options: Omit<RequestOptions<TData, ThrowOnError>, 'method'> &

package/dist/clients/axios/utils.ts

@@ -11,8 +11,8 @@ import type { Client, ClientOptions, Config, RequestOptions } from './types';
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     if (queryParams && typeof queryParams === 'object') {
       for (const name in queryParams) {

package/dist/clients/core/auth.ts

@@ -7,6 +7,13 @@ export interface Auth {
    * @default 'header'
    */
   in?: 'header' | 'query' | 'cookie';
+  /**
+   * A unique identifier for the security scheme.
+   *
+   * Defined only when there are multiple security schemes whose `Auth`
+   * shape would otherwise be identical.
+   */
+  key?: string;
   /**
    * Header or query parameter name.
    *

package/dist/clients/core/params.ts

@@ -60,7 +60,7 @@ type KeyMap = Map<
     }
 >;
 
-const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
+function buildKeyMap(fields: FieldsConfig, map?: KeyMap): KeyMap {
   if (!map) {
     map = new Map();
   }
@@ -83,7 +83,7 @@ const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
   }
 
   return map;
-};
+}
 
 interface Params {
   body: unknown;
@@ -92,20 +92,22 @@ interface Params {
   query: Record<string, unknown>;
 }
 
-const stripEmptySlots = (params: Params) => {
+type ParamsSlotMap = Record<Slot, unknown>;
+
+function stripEmptySlots(params: ParamsSlotMap): void {
   for (const [slot, value] of Object.entries(params)) {
     if (value && typeof value === 'object' && !Array.isArray(value) && !Object.keys(value).length) {
       delete params[slot as Slot];
     }
   }
-};
+}
 
-export const buildClientParams = (args: ReadonlyArray<unknown>, fields: FieldsConfig) => {
-  const params: Params = {
-    body: {},
-    headers: {},
-    path: {},
-    query: {},
+export function buildClientParams(args: ReadonlyArray<unknown>, fields: FieldsConfig): Params {
+  const params: ParamsSlotMap = {
+    body: Object.create(null),
+    headers: Object.create(null),
+    path: Object.create(null),
+    query: Object.create(null),
   };
 
   const map = buildKeyMap(fields);
@@ -163,5 +165,5 @@ export const buildClientParams = (args: ReadonlyArray<unknown>, fields: FieldsCo
 
   stripEmptySlots(params);
 
-  return params;
-};
+  return params as Params;
+}

package/dist/clients/core/pathSerializer.ts

@@ -23,7 +23,7 @@ interface SerializePrimitiveParam extends SerializePrimitiveOptions {
   value: string;
 }
 
-export const separatorArrayExplode = (style: ArraySeparatorStyle) => {
+export const separatorArrayExplode = (style: ArraySeparatorStyle): '.' | ';' | ',' | '&' => {
   switch (style) {
     case 'label':
       return '.';
@@ -36,7 +36,7 @@ export const separatorArrayExplode = (style: ArraySeparatorStyle) => {
   }
 };
 
-export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => {
+export const separatorArrayNoExplode = (style: ArraySeparatorStyle): ',' | '|' | '%20' => {
   switch (style) {
     case 'form':
       return ',';
@@ -49,7 +49,7 @@ export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => {
   }
 };
 
-export const separatorObjectExplode = (style: ObjectSeparatorStyle) => {
+export const separatorObjectExplode = (style: ObjectSeparatorStyle): '.' | ';' | ',' | '&' => {
   switch (style) {
     case 'label':
       return '.';
@@ -70,7 +70,7 @@ export const serializeArrayParam = ({
   value,
 }: SerializeOptions<ArraySeparatorStyle> & {
   value: unknown[];
-}) => {
+}): string => {
   if (!explode) {
     const joinedValues = (
       allowReserved ? value : value.map((v) => encodeURIComponent(v as string))
@@ -108,7 +108,7 @@ export const serializePrimitiveParam = ({
   allowReserved,
   name,
   value,
-}: SerializePrimitiveParam) => {
+}: SerializePrimitiveParam): string => {
   if (value === undefined || value === null) {
     return '';
   }
@@ -132,7 +132,7 @@ export const serializeObjectParam = ({
 }: SerializeOptions<ObjectSeparatorStyle> & {
   value: Record<string, unknown> | Date;
   valueOnly?: boolean;
-}) => {
+}): string => {
   if (value instanceof Date) {
     return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`;
   }

package/dist/clients/core/queryKeySerializer.ts

@@ -12,7 +12,7 @@ export type JsonValue =
 /**
  * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes.
  */
-export const queryKeyJsonReplacer = (_key: string, value: unknown) => {
+export const queryKeyJsonReplacer = (_key: string, value: unknown): unknown | undefined => {
   if (value === undefined || typeof value === 'function' || typeof value === 'symbol') {
     return undefined;
   }

package/dist/clients/core/utils.ts

@@ -11,9 +11,9 @@ export interface PathSerializer {
   url: string;
 }
 
-export const PATH_PARAM_RE = /\{[^{}]+\}/g;
+export const PATH_PARAM_RE: RegExp = /\{[^{}]+\}/g;
 
-export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
+export const defaultPathSerializer = ({ path, url: _url }: PathSerializer): string => {
   let url = _url;
   const matches = _url.match(PATH_PARAM_RE);
   if (matches) {
@@ -92,7 +92,7 @@ export const getUrl = ({
   query?: Record<string, unknown>;
   querySerializer: QuerySerializer;
   url: string;
-}) => {
+}): string => {
   const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
   let url = (baseUrl ?? '') + pathUrl;
   if (path) {
@@ -112,7 +112,7 @@ export function getValidRequestBody(options: {
   body?: unknown;
   bodySerializer?: BodySerializer | null;
   serializedBody?: unknown;
-}) {
+}): unknown {
   const hasBody = options.body !== undefined;
   const isSerializedBody = hasBody && options.bodySerializer;
 

package/dist/clients/fetch/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/fetch/types.ts

@@ -149,12 +149,13 @@ type MethodFn = <
 
 type SseFn = <
   TData = unknown,
-  TError = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _TError = unknown,
   ThrowOnError extends boolean = false,
   TResponseStyle extends ResponseStyle = 'fields',
 >(
   options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>,
-) => Promise<ServerSentEventsResult<TData, TError>>;
+) => Promise<ServerSentEventsResult<TData>>;
 
 type RequestFn = <
   TData = unknown,

package/dist/clients/fetch/utils.ts

@@ -12,8 +12,8 @@ import type { Client, ClientOptions, Config, RequestOptions } from './types';
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     if (queryParams && typeof queryParams === 'object') {
       for (const name in queryParams) {

package/dist/clients/ky/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/ky/types.ts

@@ -167,12 +167,13 @@ type MethodFn = <
 
 type SseFn = <
   TData = unknown,
-  TError = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _TError = unknown,
   ThrowOnError extends boolean = false,
   TResponseStyle extends ResponseStyle = 'fields',
 >(
   options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>,
-) => Promise<ServerSentEventsResult<TData, TError>>;
+) => Promise<ServerSentEventsResult<TData>>;
 
 type RequestFn = <
   TData = unknown,

package/dist/clients/ky/utils.ts

@@ -12,8 +12,8 @@ import type { Client, ClientOptions, Config, RequestOptions } from './types';
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     if (queryParams && typeof queryParams === 'object') {
       for (const name in queryParams) {

package/dist/clients/next/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/next/types.ts

@@ -111,9 +111,14 @@ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean
   options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>,
 ) => RequestResult<TData, TError, ThrowOnError>;
 
-type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(
+type SseFn = <
+  TData = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _TError = unknown,
+  ThrowOnError extends boolean = false,
+>(
   options: Omit<RequestOptions<never, ThrowOnError>, 'method'>,
-) => Promise<ServerSentEventsResult<TData, TError>>;
+) => Promise<ServerSentEventsResult<TData>>;
 
 type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false>(
   options: Omit<RequestOptions<TData, ThrowOnError>, 'method'> &

package/dist/clients/next/utils.ts

@@ -92,8 +92,8 @@ const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     if (queryParams && typeof queryParams === 'object') {
       for (const name in queryParams) {
@@ -257,7 +257,7 @@ export const getUrl = ({
   query?: Record<string, unknown>;
   querySerializer: QuerySerializer;
   url: string;
-}) => {
+}): string => {
   const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
   let url = (baseUrl ?? '') + pathUrl;
   if (path) {

package/dist/clients/nuxt/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/nuxt/utils.ts

@@ -95,8 +95,8 @@ const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     const qParams = toValue(queryParams);
     if (qParams && typeof qParams === 'object') {
@@ -225,7 +225,7 @@ export const getUrl = ({
 }: Pick<BuildUrlOptions, 'path' | 'query' | 'url'> & {
   baseUrl?: string;
   querySerializer: QuerySerializer;
-}) => {
+}): string => {
   const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
   let url = (baseUrl ?? '') + pathUrl;
   if (path) {

package/dist/clients/ofetch/index.ts

@@ -7,6 +7,7 @@ export {
 } from '../core/bodySerializer';
 export { buildClientParams } from '../core/params';
 export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export type { ServerSentEventsResult } from '../core/serverSentEvents';
 export { createClient } from './client';
 export type {
   Client,

package/dist/clients/ofetch/types.ts

@@ -212,12 +212,13 @@ type MethodFn = <
 
 type SseFn = <
   TData = unknown,
-  TError = unknown,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _TError = unknown,
   ThrowOnError extends boolean = false,
   TResponseStyle extends ResponseStyle = 'fields',
 >(
   options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>,
-) => Promise<ServerSentEventsResult<TData, TError>>;
+) => Promise<ServerSentEventsResult<TData>>;
 
 type RequestFn = <
   TData = unknown,

package/dist/clients/ofetch/utils.ts

@@ -21,8 +21,8 @@ import type {
 export const createQuerySerializer = <T = unknown>({
   parameters = {},
   ...args
-}: QuerySerializerOptions = {}) => {
-  const querySerializer = (queryParams: T) => {
+}: QuerySerializerOptions = {}): ((queryParams: T) => string) => {
+  const querySerializer = (queryParams: T): string => {
     const search: string[] = [];
     if (queryParams && typeof queryParams === 'object') {
       for (const name in queryParams) {