@hey-api/openapi-ts 0.97.3 → 0.98.0

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/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/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,16 +92,18 @@ 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 = {
+export function buildClientParams(args: ReadonlyArray<unknown>, fields: FieldsConfig): Params {
+  const params: ParamsSlotMap = {
     body: Object.create(null),
     headers: Object.create(null),
     path: Object.create(null),
@@ -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/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/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/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/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) {