@hey-api/openapi-ts 0.0.0-next-20260205083026

package/dist/clients/nuxt/utils.ts

@@ -0,0 +1,384 @@
+import type { ComputedRef, Ref } from 'vue';
+import { isRef, toValue, unref } from 'vue';
+
+import { getAuthToken } from '../core/auth';
+import type { QuerySerializerOptions } from '../core/bodySerializer';
+import { jsonBodySerializer } from '../core/bodySerializer';
+import {
+  serializeArrayParam,
+  serializeObjectParam,
+  serializePrimitiveParam,
+} from '../core/pathSerializer';
+import type {
+  ArraySeparatorStyle,
+  BuildUrlOptions,
+  Client,
+  ClientOptions,
+  Config,
+  QuerySerializer,
+  RequestOptions,
+} from './types';
+
+type PathSerializer = Pick<Required<BuildUrlOptions>, 'path' | 'url'>;
+
+const PATH_PARAM_RE = /\{[^{}]+\}/g;
+
+type MaybeArray<T> = T | T[];
+
+const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
+  let url = _url;
+  const matches = _url.match(PATH_PARAM_RE);
+  if (matches) {
+    for (const match of matches) {
+      let explode = false;
+      let name = match.substring(1, match.length - 1);
+      let style: ArraySeparatorStyle = 'simple';
+
+      if (name.endsWith('*')) {
+        explode = true;
+        name = name.substring(0, name.length - 1);
+      }
+
+      if (name.startsWith('.')) {
+        name = name.substring(1);
+        style = 'label';
+      } else if (name.startsWith(';')) {
+        name = name.substring(1);
+        style = 'matrix';
+      }
+
+      const value = toValue((toValue(path) as Record<string, unknown> | undefined)?.[name]);
+
+      if (value === undefined || value === null) {
+        continue;
+      }
+
+      if (Array.isArray(value)) {
+        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
+        continue;
+      }
+
+      if (typeof value === 'object') {
+        url = url.replace(
+          match,
+          serializeObjectParam({
+            explode,
+            name,
+            style,
+            value: value as Record<string, unknown>,
+            valueOnly: true,
+          }),
+        );
+        continue;
+      }
+
+      if (style === 'matrix') {
+        url = url.replace(
+          match,
+          `;${serializePrimitiveParam({
+            name,
+            value: value as string,
+          })}`,
+        );
+        continue;
+      }
+
+      const replaceValue = encodeURIComponent(
+        style === 'label' ? `.${value as string}` : (value as string),
+      );
+      url = url.replace(match, replaceValue);
+    }
+  }
+  return url;
+};
+
+export const createQuerySerializer = <T = unknown>({
+  parameters = {},
+  ...args
+}: QuerySerializerOptions = {}) => {
+  const querySerializer = (queryParams: T) => {
+    const search: string[] = [];
+    const qParams = toValue(queryParams);
+    if (qParams && typeof qParams === 'object') {
+      for (const name in qParams) {
+        const value = toValue(qParams[name]);
+
+        if (value === undefined || value === null) {
+          continue;
+        }
+
+        const options = parameters[name] || args;
+
+        if (Array.isArray(value)) {
+          const serializedArray = serializeArrayParam({
+            allowReserved: options.allowReserved,
+            explode: true,
+            name,
+            style: 'form',
+            value,
+            ...options.array,
+          });
+          if (serializedArray) search.push(serializedArray);
+        } else if (typeof value === 'object') {
+          const serializedObject = serializeObjectParam({
+            allowReserved: options.allowReserved,
+            explode: true,
+            name,
+            style: 'deepObject',
+            value: value as Record<string, unknown>,
+            ...options.object,
+          });
+          if (serializedObject) search.push(serializedObject);
+        } else {
+          const serializedPrimitive = serializePrimitiveParam({
+            allowReserved: options.allowReserved,
+            name,
+            value: value as string,
+          });
+          if (serializedPrimitive) search.push(serializedPrimitive);
+        }
+      }
+    }
+    return search.join('&');
+  };
+  return querySerializer;
+};
+
+const checkForExistence = (
+  options: Pick<RequestOptions, 'auth' | 'query'> & {
+    headers: Headers;
+  },
+  name?: string,
+): boolean => {
+  if (!name) {
+    return false;
+  }
+  if (
+    options.headers.has(name) ||
+    (toValue(options.query) as Record<string, unknown> | undefined)?.[name] ||
+    options.headers.get('Cookie')?.includes(`${name}=`)
+  ) {
+    return true;
+  }
+  return false;
+};
+
+export const setAuthParams = async ({
+  security,
+  ...options
+}: Pick<Required<RequestOptions>, 'security'> &
+  Pick<RequestOptions, 'auth' | 'query'> & {
+    headers: Headers;
+  }) => {
+  for (const auth of security) {
+    if (checkForExistence(options, auth.name)) {
+      continue;
+    }
+    const token = await getAuthToken(auth, options.auth);
+
+    if (!token) {
+      continue;
+    }
+
+    const name = auth.name ?? 'Authorization';
+
+    switch (auth.in) {
+      case 'query': {
+        if (!options.query) {
+          options.query = {};
+        }
+        const queryValue = toValue(options.query) as Record<string, unknown> | undefined;
+        if (queryValue) {
+          queryValue[name] = token;
+        }
+        break;
+      }
+      case 'cookie':
+        options.headers.append('Cookie', `${name}=${token}`);
+        break;
+      case 'header':
+      default:
+        options.headers.set(name, token);
+        break;
+    }
+  }
+};
+
+export const buildUrl: Client['buildUrl'] = (options) => {
+  const url = getUrl({
+    baseUrl: options.baseURL as string,
+    path: options.path,
+    query: options.query,
+    querySerializer:
+      typeof options.querySerializer === 'function'
+        ? options.querySerializer
+        : createQuerySerializer(options.querySerializer),
+    url: options.url,
+  });
+  return url;
+};
+
+export const getUrl = ({
+  baseUrl,
+  path,
+  query,
+  querySerializer,
+  url: _url,
+}: Pick<BuildUrlOptions, 'path' | 'query' | 'url'> & {
+  baseUrl?: string;
+  querySerializer: QuerySerializer;
+}) => {
+  const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
+  let url = (baseUrl ?? '') + pathUrl;
+  if (path) {
+    url = defaultPathSerializer({ path, url });
+  }
+  let search = query ? querySerializer(query) : '';
+  if (search.startsWith('?')) {
+    search = search.substring(1);
+  }
+  if (search) {
+    url += `?${search}`;
+  }
+  return url;
+};
+
+export const mergeConfigs = (a: Config, b: Config): Config => {
+  const config = { ...a, ...b };
+  if (config.baseURL?.endsWith('/')) {
+    config.baseURL = config.baseURL.substring(0, config.baseURL.length - 1);
+  }
+  config.headers = mergeHeaders(a.headers, b.headers);
+  return config;
+};
+
+const headersEntries = (headers: Headers): Array<[string, string]> => {
+  const entries: Array<[string, string]> = [];
+  headers.forEach((value, key) => {
+    entries.push([key, value]);
+  });
+  return entries;
+};
+
+export const mergeHeaders = (
+  ...headers: Array<Required<Config>['headers'] | undefined>
+): Headers => {
+  const mergedHeaders = new Headers();
+  for (const header of headers) {
+    if (!header || typeof header !== 'object') {
+      continue;
+    }
+
+    let h: unknown = header;
+    if (isRef(h)) {
+      h = unref(h);
+    }
+
+    const iterator =
+      h instanceof Headers ? headersEntries(h) : Object.entries(h as Record<string, unknown>);
+
+    for (const [key, value] of iterator) {
+      if (value === null) {
+        mergedHeaders.delete(key);
+      } else if (Array.isArray(value)) {
+        for (const v of value) {
+          mergedHeaders.append(key, unwrapRefs(v) as string);
+        }
+      } else if (value !== undefined) {
+        const v = unwrapRefs(value);
+        // assume object headers are meant to be JSON stringified, i.e. their
+        // content value in OpenAPI specification is 'application/json'
+        mergedHeaders.set(key, typeof v === 'object' ? JSON.stringify(v) : (v as string));
+      }
+    }
+  }
+  return mergedHeaders;
+};
+
+export const mergeInterceptors = <T>(...args: Array<MaybeArray<T>>): Array<T> =>
+  args.reduce<Array<T>>((acc, item) => {
+    if (typeof item === 'function') {
+      acc.push(item);
+    } else if (Array.isArray(item)) {
+      return acc.concat(item);
+    }
+    return acc;
+  }, []);
+
+const defaultQuerySerializer = createQuerySerializer({
+  allowReserved: false,
+  array: {
+    explode: true,
+    style: 'form',
+  },
+  object: {
+    explode: true,
+    style: 'deepObject',
+  },
+});
+
+const defaultHeaders = {
+  'Content-Type': 'application/json',
+};
+
+export const createConfig = <T extends ClientOptions = ClientOptions>(
+  override: Config<Omit<ClientOptions, keyof T> & T> = {},
+): Config<Omit<ClientOptions, keyof T> & T> => ({
+  ...jsonBodySerializer,
+  headers: defaultHeaders,
+  querySerializer: defaultQuerySerializer,
+  ...override,
+});
+
+type UnwrapRefs<T> =
+  T extends Ref<infer V>
+    ? V
+    : T extends ComputedRef<infer V>
+      ? V
+      : T extends Record<string, unknown> // this doesn't handle functions well
+        ? { [K in keyof T]: UnwrapRefs<T[K]> }
+        : T;
+
+export const unwrapRefs = <T>(value: T): UnwrapRefs<T> => {
+  if (value === null || typeof value !== 'object' || value instanceof Headers) {
+    return (isRef(value) ? unref(value) : value) as UnwrapRefs<T>;
+  }
+
+  if (Array.isArray(value)) {
+    return value.map((item) => unwrapRefs(item)) as UnwrapRefs<T>;
+  }
+
+  if (isRef(value)) {
+    return unwrapRefs(unref(value) as T);
+  }
+
+  // unwrap into new object to avoid modifying the source
+  const result: Record<string, unknown> = {};
+  for (const key in value) {
+    result[key] = unwrapRefs(value[key] as T);
+  }
+  return result as UnwrapRefs<T>;
+};
+
+export const serializeBody = (
+  opts: Pick<Parameters<Client['request']>[0], 'body' | 'bodySerializer'>,
+) => {
+  if (opts.body && opts.bodySerializer) {
+    return opts.bodySerializer(opts.body);
+  }
+  return opts.body;
+};
+
+export const executeFetchFn = (
+  opts: Omit<Parameters<Client['request']>[0], 'composable'>,
+  fetchFn: Required<Config>['$fetch'],
+) => {
+  const unwrappedOpts = unwrapRefs(opts);
+  unwrappedOpts.rawBody = unwrappedOpts.body;
+  unwrappedOpts.body = serializeBody(unwrappedOpts);
+  return fetchFn(
+    buildUrl(opts),
+    // @ts-expect-error
+    unwrappedOpts,
+  );
+};

package/dist/clients/ofetch/client.ts

@@ -0,0 +1,259 @@
+import { ofetch, type ResponseType as OfetchResponseType } from 'ofetch';
+
+import { createSseClient } from '../core/serverSentEvents';
+import type { HttpMethod } from '../core/types';
+import { getValidRequestBody } from '../core/utils';
+import type { Client, Config, RequestOptions, ResolvedRequestOptions } from './types';
+import {
+  buildOfetchOptions,
+  buildUrl,
+  createConfig,
+  createInterceptors,
+  isRepeatableBody,
+  mapParseAsToResponseType,
+  mergeConfigs,
+  mergeHeaders,
+  parseError,
+  parseSuccess,
+  setAuthParams,
+  wrapDataReturn,
+  wrapErrorReturn,
+} from './utils';
+
+type ReqInit = Omit<RequestInit, 'body' | 'headers'> & {
+  body?: BodyInit | null | undefined;
+  headers: ReturnType<typeof mergeHeaders>;
+};
+
+export const createClient = (config: Config = {}): Client => {
+  let _config = mergeConfigs(createConfig(), config);
+
+  const getConfig = (): Config => ({ ..._config });
+
+  const setConfig = (config: Config): Config => {
+    _config = mergeConfigs(_config, config);
+    return getConfig();
+  };
+
+  const interceptors = createInterceptors<Request, Response, unknown, ResolvedRequestOptions>();
+
+  // precompute serialized / network body
+  const resolveOptions = async (options: RequestOptions) => {
+    const opts = {
+      ..._config,
+      ...options,
+      headers: mergeHeaders(_config.headers, options.headers),
+      serializedBody: undefined,
+    };
+
+    if (opts.security) {
+      await setAuthParams({
+        ...opts,
+        security: opts.security,
+      });
+    }
+
+    if (opts.requestValidator) {
+      await opts.requestValidator(opts);
+    }
+
+    if (opts.body !== undefined && opts.bodySerializer) {
+      opts.serializedBody = opts.bodySerializer(opts.body);
+    }
+
+    // remove Content-Type if body is empty to avoid invalid requests
+    if (opts.body === undefined || opts.serializedBody === '') {
+      opts.headers.delete('Content-Type');
+    }
+
+    // if a raw body is provided (no serializer), adjust Content-Type only when it
+    // equals the default JSON value to better match the concrete body type
+    if (
+      opts.body !== undefined &&
+      opts.bodySerializer === null &&
+      (opts.headers.get('Content-Type') || '').toLowerCase() === 'application/json'
+    ) {
+      const b: unknown = opts.body;
+      if (typeof FormData !== 'undefined' && b instanceof FormData) {
+        // let the runtime set the multipart boundary
+        opts.headers.delete('Content-Type');
+      } else if (typeof URLSearchParams !== 'undefined' && b instanceof URLSearchParams) {
+        // standard urlencoded content type (+ charset)
+        opts.headers.set('Content-Type', 'application/x-www-form-urlencoded;charset=UTF-8');
+      } else if (typeof Blob !== 'undefined' && b instanceof Blob) {
+        const t = b.type?.trim();
+        if (t) {
+          opts.headers.set('Content-Type', t);
+        } else {
+          // unknown blob type: avoid sending a misleading JSON header
+          opts.headers.delete('Content-Type');
+        }
+      }
+    }
+
+    // precompute network body (stability for retries and interceptors)
+    const networkBody = getValidRequestBody(opts) as RequestInit['body'] | null | undefined;
+
+    const url = buildUrl(opts);
+
+    return { networkBody, opts, url };
+  };
+
+  // apply request interceptors and mirror header/method/signal back to opts
+  const applyRequestInterceptors = async (
+    request: Request,
+    opts: ResolvedRequestOptions,
+    body: BodyInit | null | undefined,
+  ) => {
+    for (const fn of interceptors.request.fns) {
+      if (fn) {
+        request = await fn(request, opts);
+      }
+    }
+    // reflect interceptor changes into opts used by the network layer
+    opts.headers = request.headers;
+    opts.method = request.method as Uppercase<HttpMethod>;
+    // ignore request.body changes to avoid turning serialized bodies into streams
+    // body comes only from getValidRequestBody(options)
+    // reflect signal if present
+    opts.signal = (request as any).signal as AbortSignal | undefined;
+
+    // When body is FormData, remove Content-Type header to avoid boundary mismatch.
+    // Note: We already delete Content-Type in resolveOptions for FormData, but the
+    // Request constructor (line 175) re-adds it with an auto-generated boundary.
+    // Since we pass the original FormData (not the Request's body) to ofetch, and
+    // ofetch will generate its own boundary, we must remove the Request's Content-Type
+    // to let ofetch set the correct one. Otherwise the boundary in the header won't
+    // match the boundary in the actual multipart body sent by ofetch.
+    if (typeof FormData !== 'undefined' && body instanceof FormData) {
+      opts.headers.delete('Content-Type');
+    }
+
+    return request;
+  };
+
+  // build ofetch options with stable retry logic based on body repeatability
+  const buildNetworkOptions = (
+    opts: ResolvedRequestOptions,
+    body: BodyInit | null | undefined,
+    responseType: OfetchResponseType | undefined,
+  ) => {
+    const effectiveRetry = isRepeatableBody(body) ? (opts.retry as any) : (0 as any);
+    return buildOfetchOptions(opts, body, responseType, effectiveRetry);
+  };
+
+  const request: Client['request'] = async (options) => {
+    const { networkBody: initialNetworkBody, opts, url } = await resolveOptions(options as any);
+    // map parseAs -> ofetch responseType once per request
+    const ofetchResponseType: OfetchResponseType | undefined = mapParseAsToResponseType(
+      opts.parseAs,
+      opts.responseType,
+    );
+
+    const $ofetch = opts.ofetch ?? ofetch;
+
+    // create Request before network to run middleware consistently
+    const networkBody = initialNetworkBody;
+    const requestInit: ReqInit = {
+      body: networkBody,
+      headers: opts.headers as Headers,
+      method: opts.method,
+      redirect: 'follow',
+      signal: opts.signal,
+    };
+    let request = new Request(url, requestInit);
+
+    request = await applyRequestInterceptors(request, opts, networkBody);
+    const finalUrl = request.url;
+
+    // build ofetch options and perform the request (.raw keeps the Response)
+    const responseOptions = buildNetworkOptions(
+      opts as ResolvedRequestOptions,
+      networkBody,
+      ofetchResponseType,
+    );
+
+    let response = await $ofetch.raw(finalUrl, responseOptions);
+
+    for (const fn of interceptors.response.fns) {
+      if (fn) {
+        response = await fn(response, request, opts);
+      }
+    }
+
+    const result = { request, response };
+
+    if (response.ok) {
+      const data = await parseSuccess(response, opts, ofetchResponseType);
+      return wrapDataReturn(data, result, opts.responseStyle);
+    }
+
+    let finalError = await parseError(response);
+
+    for (const fn of interceptors.error.fns) {
+      if (fn) {
+        finalError = await fn(finalError, response, request, opts);
+      }
+    }
+
+    // ensure error is never undefined after interceptors
+    finalError = (finalError as any) || ({} as string);
+
+    if (opts.throwOnError) {
+      throw finalError;
+    }
+
+    return wrapErrorReturn(finalError, result, opts.responseStyle) as any;
+  };
+
+  const makeMethodFn = (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
+    request({ ...options, method } as any);
+
+  const makeSseFn = (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
+    const { networkBody, opts, url } = await resolveOptions(options);
+    const optsForSse: any = { ...opts };
+    delete optsForSse.body; // body is provided via serializedBody below
+    return createSseClient({
+      ...optsForSse,
+      fetch: opts.fetch,
+      headers: opts.headers as Headers,
+      method,
+      onRequest: async (url, init) => {
+        let request = new Request(url, init);
+        request = await applyRequestInterceptors(request, opts, networkBody);
+        return request;
+      },
+      serializedBody: networkBody as BodyInit | null | undefined,
+      signal: opts.signal,
+      url,
+    });
+  };
+
+  return {
+    buildUrl,
+    connect: makeMethodFn('CONNECT'),
+    delete: makeMethodFn('DELETE'),
+    get: makeMethodFn('GET'),
+    getConfig,
+    head: makeMethodFn('HEAD'),
+    interceptors,
+    options: makeMethodFn('OPTIONS'),
+    patch: makeMethodFn('PATCH'),
+    post: makeMethodFn('POST'),
+    put: makeMethodFn('PUT'),
+    request,
+    setConfig,
+    sse: {
+      connect: makeSseFn('CONNECT'),
+      delete: makeSseFn('DELETE'),
+      get: makeSseFn('GET'),
+      head: makeSseFn('HEAD'),
+      options: makeSseFn('OPTIONS'),
+      patch: makeSseFn('PATCH'),
+      post: makeSseFn('POST'),
+      put: makeSseFn('PUT'),
+      trace: makeSseFn('TRACE'),
+    },
+    trace: makeMethodFn('TRACE'),
+  } as Client;
+};

package/dist/clients/ofetch/index.ts

@@ -0,0 +1,23 @@
+export type { Auth } from '../core/auth';
+export type { QuerySerializerOptions } from '../core/bodySerializer';
+export {
+  formDataBodySerializer,
+  jsonBodySerializer,
+  urlSearchParamsBodySerializer,
+} from '../core/bodySerializer';
+export { buildClientParams } from '../core/params';
+export { serializeQueryKeyValue } from '../core/queryKeySerializer';
+export { createClient } from './client';
+export type {
+  Client,
+  ClientOptions,
+  Config,
+  CreateClientConfig,
+  Options,
+  RequestOptions,
+  RequestResult,
+  ResolvedRequestOptions,
+  ResponseStyle,
+  TDataShape,
+} from './types';
+export { createConfig, mergeHeaders } from './utils';