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

package/dist/clients/nuxt/client.ts

@@ -0,0 +1,213 @@
+import { useAsyncData, useFetch, useLazyAsyncData, useLazyFetch } from 'nuxt/app';
+import { reactive, ref, watch } from 'vue';
+
+import { createSseClient } from '../core/serverSentEvents';
+import type { HttpMethod } from '../core/types';
+import { getValidRequestBody } from '../core/utils';
+import type { Client, Config, RequestOptions } from './types';
+import {
+  buildUrl,
+  createConfig,
+  executeFetchFn,
+  mergeConfigs,
+  mergeHeaders,
+  mergeInterceptors,
+  serializeBody,
+  setAuthParams,
+  unwrapRefs,
+} from './utils';
+
+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 beforeRequest = async (options: RequestOptions) => {
+    const opts = {
+      ..._config,
+      ...options,
+      $fetch: options.$fetch ?? _config.$fetch ?? $fetch,
+      headers: mergeHeaders(_config.headers, options.headers),
+      onRequest: mergeInterceptors(_config.onRequest, options.onRequest),
+      onResponse: mergeInterceptors(_config.onResponse, options.onResponse),
+    };
+
+    if (opts.security) {
+      await setAuthParams({
+        ...opts,
+        security: opts.security,
+      });
+    }
+
+    if (opts.requestValidator) {
+      await opts.requestValidator(opts);
+    }
+
+    const url = buildUrl(opts);
+
+    return { opts, url };
+  };
+
+  const request: Client['request'] = ({ asyncDataOptions, composable = '$fetch', ...options }) => {
+    const key = options.key;
+    const opts = {
+      ..._config,
+      ...options,
+      $fetch: options.$fetch ?? _config.$fetch ?? $fetch,
+      headers: mergeHeaders(_config.headers, options.headers),
+      onRequest: mergeInterceptors(_config.onRequest, options.onRequest),
+      onResponse: mergeInterceptors(_config.onResponse, options.onResponse),
+    };
+
+    const { requestValidator, responseTransformer, responseValidator, security } = opts;
+    if (requestValidator || security) {
+      // auth must happen in interceptors otherwise we'd need to require
+      // asyncContext enabled
+      // https://nuxt.com/docs/guide/going-further/experimental-features#asynccontext
+      opts.onRequest = [
+        async ({ options }) => {
+          if (security) {
+            await setAuthParams({
+              auth: opts.auth,
+              headers: options.headers,
+              query: options.query,
+              security,
+            });
+          }
+
+          if (requestValidator) {
+            await requestValidator({
+              ...options,
+              // @ts-expect-error
+              body: options.rawBody,
+            });
+          }
+        },
+        ...opts.onRequest,
+      ];
+    }
+
+    if (responseTransformer || responseValidator) {
+      opts.onResponse = [
+        ...opts.onResponse,
+        async ({ options, response }) => {
+          if (options.responseType && options.responseType !== 'json') {
+            return;
+          }
+
+          if (!response.ok) {
+            return;
+          }
+
+          if (responseValidator) {
+            await responseValidator(response._data);
+          }
+
+          if (responseTransformer) {
+            response._data = await responseTransformer(response._data);
+          }
+        },
+      ];
+    }
+
+    // remove Content-Type header if body is empty to avoid sending invalid requests
+    if (opts.body === undefined || opts.body === '') {
+      opts.headers.delete('Content-Type');
+    }
+
+    const fetchFn = opts.$fetch;
+
+    if (composable === '$fetch') {
+      return executeFetchFn(
+        // @ts-expect-error
+        opts,
+        fetchFn,
+      );
+    }
+
+    if (composable === 'useFetch' || composable === 'useLazyFetch') {
+      opts.rawBody = opts.body;
+      const bodyParams = reactive({
+        body: opts.body,
+        bodySerializer: opts.bodySerializer,
+      });
+      const body = ref(serializeBody(opts));
+      opts.body = body;
+      watch(bodyParams, (changed) => {
+        body.value = serializeBody(changed);
+      });
+      return composable === 'useLazyFetch'
+        ? useLazyFetch(() => buildUrl(opts), opts)
+        : useFetch(() => buildUrl(opts), opts);
+    }
+
+    const handler: any = () =>
+      executeFetchFn(
+        // @ts-expect-error
+        opts,
+        fetchFn,
+      );
+
+    if (composable === 'useAsyncData') {
+      return key
+        ? useAsyncData(key, handler, asyncDataOptions)
+        : useAsyncData(handler, asyncDataOptions);
+    }
+
+    if (composable === 'useLazyAsyncData') {
+      return key
+        ? useLazyAsyncData(key, handler, asyncDataOptions)
+        : useLazyAsyncData(handler, asyncDataOptions);
+    }
+
+    return undefined as any;
+  };
+
+  const makeMethodFn = (method: Uppercase<HttpMethod>) => (options: RequestOptions) =>
+    request({ ...options, method });
+
+  const makeSseFn = (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
+    const { opts, url } = await beforeRequest(options);
+    return createSseClient({
+      ...unwrapRefs(opts),
+      body: opts.body as BodyInit | null | undefined,
+      method,
+      onRequest: undefined,
+      serializedBody: getValidRequestBody(opts) as BodyInit | null | undefined,
+      signal: unwrapRefs(opts.signal) as AbortSignal,
+      url,
+    });
+  };
+
+  return {
+    buildUrl,
+    connect: makeMethodFn('CONNECT'),
+    delete: makeMethodFn('DELETE'),
+    get: makeMethodFn('GET'),
+    getConfig,
+    head: makeMethodFn('HEAD'),
+    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/nuxt/index.ts

@@ -0,0 +1,22 @@
+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,
+  Composable,
+  Config,
+  CreateClientConfig,
+  Options,
+  RequestOptions,
+  RequestResult,
+  TDataShape,
+} from './types';
+export { createConfig } from './utils';

package/dist/clients/nuxt/types.ts

@@ -0,0 +1,189 @@
+import type {
+  AsyncDataOptions,
+  useAsyncData,
+  useFetch,
+  UseFetchOptions,
+  useLazyAsyncData,
+  useLazyFetch,
+} from 'nuxt/app';
+import type { Ref } from 'vue';
+
+import type { Auth } from '../core/auth';
+import type { QuerySerializerOptions } from '../core/bodySerializer';
+import type {
+  ServerSentEventsOptions,
+  ServerSentEventsResult,
+} from '../core/serverSentEvents';
+import type { Client as CoreClient, Config as CoreConfig } from '../core/types';
+
+export type ArraySeparatorStyle = ArrayStyle | MatrixStyle;
+type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+type MatrixStyle = 'label' | 'matrix' | 'simple';
+export type ObjectSeparatorStyle = ObjectStyle | MatrixStyle;
+type ObjectStyle = 'form' | 'deepObject';
+
+export type QuerySerializer = (query: Parameters<Client['buildUrl']>[0]['query']) => string;
+
+type WithRefs<TData> = {
+  [K in keyof TData]: NonNullable<TData[K]> extends object
+    ? WithRefs<NonNullable<TData[K]>> | Ref<NonNullable<TData[K]>> | Extract<TData[K], null>
+    : NonNullable<TData[K]> | Ref<NonNullable<TData[K]>> | Extract<TData[K], null>;
+};
+
+// copied from Nuxt
+export type KeysOf<T> = Array<T extends T ? (keyof T extends string ? keyof T : never) : never>;
+
+export interface Config<T extends ClientOptions = ClientOptions>
+  extends
+    Omit<FetchOptions<unknown>, 'baseURL' | 'body' | 'headers' | 'method' | 'query'>,
+    WithRefs<Pick<FetchOptions<unknown>, 'query'>>,
+    Omit<CoreConfig, 'querySerializer'> {
+  /**
+   * Base URL for all requests made by this client.
+   */
+  baseURL?: T['baseURL'];
+  /**
+   * A function for serializing request query parameters. By default, arrays
+   * will be exploded in form style, objects will be exploded in deepObject
+   * style, and reserved characters are percent-encoded.
+   *
+   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+   */
+  querySerializer?: QuerySerializer | QuerySerializerOptions;
+}
+
+export interface RequestOptions<
+  TComposable extends Composable = '$fetch',
+  ResT = unknown,
+  DefaultT = undefined,
+  Url extends string = string,
+>
+  extends
+    Config,
+    WithRefs<{
+      path?: FetchOptions<unknown>['query'];
+      query?: FetchOptions<unknown>['query'];
+    }>,
+    Pick<
+      ServerSentEventsOptions<ResT>,
+      | 'onSseError'
+      | 'onSseEvent'
+      | 'sseDefaultRetryDelay'
+      | 'sseMaxRetryAttempts'
+      | 'sseMaxRetryDelay'
+    > {
+  asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>;
+  /**
+   * Any body that you want to add to your request.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+   */
+  body?: NonNullable<unknown> | Ref<NonNullable<unknown>> | null;
+  composable?: TComposable;
+  key?: string;
+  rawBody?: NonNullable<unknown> | Ref<NonNullable<unknown>> | null;
+  /**
+   * Security mechanism(s) to use for the request.
+   */
+  security?: ReadonlyArray<Auth>;
+  url: Url;
+}
+
+export type RequestResult<
+  TComposable extends Composable,
+  ResT,
+  TError,
+> = TComposable extends '$fetch'
+  ? ReturnType<typeof $fetch<ResT>>
+  : TComposable extends 'useAsyncData'
+    ? ReturnType<typeof useAsyncData<ResT | null, TError>>
+    : TComposable extends 'useFetch'
+      ? ReturnType<typeof useFetch<ResT | null, TError>>
+      : TComposable extends 'useLazyAsyncData'
+        ? ReturnType<typeof useLazyAsyncData<ResT | null, TError>>
+        : TComposable extends 'useLazyFetch'
+          ? ReturnType<typeof useLazyFetch<ResT | null, TError>>
+          : never;
+
+export interface ClientOptions {
+  baseURL?: string;
+}
+
+type MethodFn = <
+  TComposable extends Composable = '$fetch',
+  ResT = unknown,
+  TError = unknown,
+  DefaultT = undefined,
+>(
+  options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'>,
+) => RequestResult<TComposable, ResT, TError>;
+
+type SseFn = <
+  TComposable extends Composable = '$fetch',
+  ResT = unknown,
+  TError = unknown,
+  DefaultT = undefined,
+>(
+  options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'>,
+) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>;
+
+type RequestFn = <
+  TComposable extends Composable = '$fetch',
+  ResT = unknown,
+  TError = unknown,
+  DefaultT = undefined,
+>(
+  options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'> &
+    Pick<Required<RequestOptions<TComposable, ResT, DefaultT>>, 'method'>,
+) => RequestResult<TComposable, ResT, TError>;
+
+/**
+ * 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 ClientOptions = ClientOptions> = (
+  override?: Config<ClientOptions & T>,
+) => Config<Required<ClientOptions> & T>;
+
+export interface TDataShape {
+  body?: unknown;
+  headers?: unknown;
+  path?: FetchOptions<unknown>['query'];
+  query?: FetchOptions<unknown>['query'];
+  url: string;
+}
+
+export type BuildUrlOptions<
+  TData extends Omit<TDataShape, 'headers'> = Omit<TDataShape, 'headers'>,
+> = Pick<WithRefs<TData>, 'path' | 'query'> &
+  Pick<TData, 'url'> &
+  Pick<Options<'$fetch', TData>, 'baseURL' | 'querySerializer'>;
+
+type BuildUrlFn = <TData extends Omit<TDataShape, 'headers'>>(
+  options: BuildUrlOptions<TData>,
+) => string;
+
+export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>;
+
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+
+export type Options<
+  TComposable extends Composable = '$fetch',
+  TData extends TDataShape = TDataShape,
+  ResT = unknown,
+  DefaultT = undefined,
+> = OmitKeys<RequestOptions<TComposable, ResT, DefaultT>, 'body' | 'path' | 'query' | 'url'> &
+  ([TData] extends [never] ? unknown : WithRefs<Omit<TData, 'url'>>);
+
+type FetchOptions<TData> = Omit<UseFetchOptions<TData, TData>, keyof AsyncDataOptions<TData>>;
+
+export type Composable =
+  | '$fetch'
+  | 'useAsyncData'
+  | 'useFetch'
+  | 'useLazyAsyncData'
+  | 'useLazyFetch';