@unshared/client 0.3.2 → 0.4.0

package/dist/createClient.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createClient.cjs","sources":["../createClient.ts"],"sourcesContent":["import type { Awaitable } from '@unshared/functions'\nimport type { Result } from '@unshared/functions/attempt'\nimport type { ServiceOptions } from './createService'\nimport type { OpenAPILike, OpenAPIOptionsMap } from './openapi'\nimport type { RequestOptions } from './utils'\nimport type { ConnectOptions, WebSocketChannel } from './websocket'\nimport { attempt } from '@unshared/functions/attempt'\nimport { fetch } from './utils/fetch'\nimport { request } from './utils/request'\nimport { connect } from './websocket/connect'\n\ntype Data<T extends RequestOptions> = T extends RequestOptions<any, any, any, any, any, any, infer R, any> ? R : unknown\ntype Routes = Record<string, RequestOptions>\ntype Channels = Record<string, ConnectOptions>\n\nexport class Client<T extends Routes = Routes, U extends Channels = Channels> {\n\n  /**\n   * Create a new client for the application.\n   *\n   * @param options The options to pass to the client.\n   * @example new Client({ baseUrl: 'https://api.example.com' })\n   */\n  constructor(public options: RequestOptions = {}) {}\n\n  /**\n   * Fetch a route from the API and return the `Response` object. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The response from the server.\n   */\n  public fetch<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Response> {\n    return fetch(route, { ...this.options, ...options })\n  }\n\n  /**\n   * Fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The data from the API.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const data = request('GET /api/product/:id', { data: { id: '1' } })\n   */\n  public request<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Data<V>> {\n    return request(route, { ...this.options, ...options }) as Promise<Data<V>>\n  }\n\n  /**\n   * Attempt to fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns A result object with either the data or an error.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const { data, error } = requestAttempt('GET /api/product/:id', { data: { id: '1' } })\n   * if (error) console.error(error)\n   * else console.log(data)\n   */\n  public requestAttempt<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Result<Data<V>>> {\n    return attempt(() => this.request(route, options))\n  }\n\n  /**\n   * Create a new WebSocket connection to the server with the given path. The connection will\n   * automatically reconnect if the connection is closed unexpectedly.\n   *\n   * @param channel The path to connect to.\n   * @param options The options to pass to the connection.\n   * @returns The WebSocket connection.\n   */\n  public connect<P extends keyof U & string, V extends U[P]>(channel: P, options?: V): Awaitable<WebSocketChannel<V>, WebSocketChannel<V>> {\n    return connect(channel, { baseUrl: this.options.baseUrl, ...options }) as Awaitable<WebSocketChannel<V>, WebSocketChannel<V>>\n  }\n}\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends OpenAPILike>(options?: ServiceOptions<T>): Client<OpenAPIOptionsMap<T>>\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends Routes = Routes, V extends Channels = Channels>(options?: RequestOptions): Client<T, V>\nexport function createClient(options?: RequestOptions): Client {\n  return new Client(options)\n}\n"],"names":["fetch","request","attempt","connect"],"mappings":";;;;;AAeO,MAAM,OAAiE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5E,YAAmB,UAA0B,IAAI;AAA9B,SAAA,UAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWZ,MAAkD,OAAU,SAAgC;AAC1F,WAAAA,eAAAA,MAAM,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqB9C,QAAoD,OAAU,SAA+B;AAC3F,WAAAC,QAAAA,QAAQ,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBhD,eAA2D,OAAU,SAAuC;AACjH,WAAOC,QAAAA,QAAQ,MAAM,KAAK,QAAQ,OAAO,OAAO,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAW5C,QAAoD,SAAY,SAAkE;AAChI,WAAAC,QAAA,QAAQ,SAAS,EAAE,SAAS,KAAK,QAAQ,SAAS,GAAG,SAAS;AAAA,EAAA;AAEzE;AAqCO,SAAS,aAAa,SAAkC;AACtD,SAAA,IAAI,OAAO,OAAO;AAC3B;;;"}
+{"version":3,"file":"createClient.cjs","sources":["../createClient.ts"],"sourcesContent":["import type { Awaitable } from '@unshared/functions'\nimport type { Result } from '@unshared/functions/attempt'\nimport type { ServiceOptions } from './createService'\nimport type { OpenAPILike, OpenAPIOptionsMap } from './openapi'\nimport type { FetchOptions, RequestOptions } from './utils'\nimport type { ConnectOptions, WebSocketChannel } from './websocket'\nimport { attempt } from '@unshared/functions/attempt'\nimport { fetch } from './utils/fetch'\nimport { request } from './utils/request'\nimport { connect } from './websocket/connect'\n\ntype Data<T extends RequestOptions> = T extends RequestOptions<any, any, any, any, any, any, infer R, any> ? R : unknown\ntype Routes = Record<string, RequestOptions>\ntype Channels = Record<string, ConnectOptions>\n\nexport class Client<T extends Routes = Routes, U extends Channels = Channels> {\n\n  /**\n   * Create a new client for the application.\n   *\n   * @param options The options to pass to the client.\n   * @example new Client({ baseUrl: 'https://api.example.com' })\n   */\n  constructor(public options: RequestOptions = {}) {}\n\n  /**\n   * Fetch a route from the API and return the `Response` object. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The response from the server.\n   */\n  public fetch<K extends keyof T & string>(route: K, options?: T[K]): Promise<Response & { json: () => Promise<Data<T[K]>> }>\n  public fetch(route: string, options?: FetchOptions): Promise<Response>\n  public fetch(route: string, options?: FetchOptions): Promise<Response> {\n    return fetch(route, { ...this.options, ...options })\n  }\n\n  /**\n   * Fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The data from the API.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const data = request('GET /api/product/:id', { data: { id: '1' } })\n   */\n  public request<K extends keyof T & string>(route: K, options?: T[K]): Promise<Data<T[K]>>\n  public request(route: string, options?: RequestOptions): Promise<unknown>\n  public request(route: string, options?: RequestOptions): Promise<unknown> {\n    return request(route, { ...this.options, ...options })\n  }\n\n  /**\n   * Attempt to fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns A result object with either the data or an error.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const { data, error } = requestAttempt('GET /api/product/:id', { data: { id: '1' } })\n   * if (error) console.error(error)\n   * else console.log(data)\n   */\n  public requestAttempt<K extends keyof T & string>(route: K, options?: T[K]): Promise<Result<Data<T[K]>>>\n  public requestAttempt(route: string, options?: RequestOptions): Promise<Result<unknown>>\n  public requestAttempt(route: string, options?: RequestOptions): Promise<Result<unknown>> {\n    return attempt(() => this.request(route, options))\n  }\n\n  /**\n   * Create a new WebSocket connection to the server with the given path. The connection will\n   * automatically reconnect if the connection is closed unexpectedly.\n   *\n   * @param channel The path to connect to.\n   * @param options The options to pass to the connection.\n   * @returns The WebSocket connection.\n   */\n  public connect<P extends keyof U & string>(channel: P, options?: U[P]): Awaitable<WebSocketChannel<U[P]>, WebSocketChannel<U[P]>>\n  public connect(channel: string, options?: ConnectOptions): Awaitable<WebSocketChannel, WebSocketChannel>\n  public connect(channel: string, options?: ConnectOptions): Awaitable<WebSocketChannel, WebSocketChannel> {\n    return connect(channel, { baseUrl: this.options.baseUrl, ...options })\n  }\n}\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends OpenAPILike>(options?: ServiceOptions<T>): Client<OpenAPIOptionsMap<T>>\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends Routes = Routes, V extends Channels = Channels>(options?: RequestOptions): Client<T, V>\nexport function createClient(options?: RequestOptions): Client {\n  return new Client(options)\n}\n"],"names":["fetch","request","attempt","connect"],"mappings":";;;;;;AAeO,MAAM,OAAiE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5E,YAAmB,UAA0B,IAAI;AAA9B,SAAA,UAAA;AAAA,EAAA;AAAA,EAaZ,MAAM,OAAe,SAA2C;AAC9D,WAAAA,QAAAA,MAAM,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA,EAuB9C,QAAQ,OAAe,SAA4C;AACjE,WAAAC,QAAAA,QAAQ,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA,EAyBhD,eAAe,OAAe,SAAoD;AACvF,WAAOC,QAAAA,QAAQ,MAAM,KAAK,QAAQ,OAAO,OAAO,CAAC;AAAA,EAAA;AAAA,EAa5C,QAAQ,SAAiB,SAAyE;AAChG,WAAAC,QAAA,QAAQ,SAAS,EAAE,SAAS,KAAK,QAAQ,SAAS,GAAG,SAAS;AAAA,EAAA;AAEzE;AAqCO,SAAS,aAAa,SAAkC;AACtD,SAAA,IAAI,OAAO,OAAO;AAC3B;;;"}

package/dist/createClient.d.ts

@@ -1,13 +1,13 @@
 import { Awaitable } from '@unshared/functions';
 import { Result } from '@unshared/functions/attempt';
 import { ServiceOptions } from './createService.js';
-import { O as OpenAPILike, a as OpenAPIOptionsMap } from './chunks/mHfUAX_g.js';
-import { R as RequestOptions } from './chunks/CO11DuYE.js';
+import { R as RequestOptions, F as FetchOptions } from './chunks/Nc32BOzg.js';
+import { O as OpenAPILike, a as OpenAPIOptionsMap } from './chunks/5p4H9ZaI.js';
 import { WebSocketChannel, ConnectOptions } from './websocket.js';
 import '@unshared/types';
-import 'openapi-types';
 import './HttpHeaders.js';
 import './HttpMethods.js';
+import 'openapi-types';
 
 type Data<T extends RequestOptions> = T extends RequestOptions<any, any, any, any, any, any, infer R, any> ? R : unknown;
 type Routes = Record<string, RequestOptions>;
@@ -30,7 +30,10 @@ declare class Client<T extends Routes = Routes, U extends Channels = Channels> {
      * @param options The options to pass to the request.
      * @returns The response from the server.
      */
-    fetch<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Response>;
+    fetch<K extends keyof T & string>(route: K, options?: T[K]): Promise<Response & {
+        json: () => Promise<Data<T[K]>>;
+    }>;
+    fetch(route: string, options?: FetchOptions): Promise<Response>;
     /**
      * Fetch a route from the API and return the data. If the client was instantiated with an
      * application, the route name will be inferred from the application routes. Otherwise, you
@@ -49,7 +52,8 @@ declare class Client<T extends Routes = Routes, U extends Channels = Channels> {
      * // Fetch the data from the API.
      * const data = request('GET /api/product/:id', { data: { id: '1' } })
      */
-    request<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Data<V>>;
+    request<K extends keyof T & string>(route: K, options?: T[K]): Promise<Data<T[K]>>;
+    request(route: string, options?: RequestOptions): Promise<unknown>;
     /**
      * Attempt to fetch a route from the API and return the data. If the client was instantiated with an
      * application, the route name will be inferred from the application routes. Otherwise, you
@@ -70,7 +74,8 @@ declare class Client<T extends Routes = Routes, U extends Channels = Channels> {
      * if (error) console.error(error)
      * else console.log(data)
      */
-    requestAttempt<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Result<Data<V>>>;
+    requestAttempt<K extends keyof T & string>(route: K, options?: T[K]): Promise<Result<Data<T[K]>>>;
+    requestAttempt(route: string, options?: RequestOptions): Promise<Result<unknown>>;
     /**
      * Create a new WebSocket connection to the server with the given path. The connection will
      * automatically reconnect if the connection is closed unexpectedly.
@@ -79,7 +84,8 @@ declare class Client<T extends Routes = Routes, U extends Channels = Channels> {
      * @param options The options to pass to the connection.
      * @returns The WebSocket connection.
      */
-    connect<P extends keyof U & string, V extends U[P]>(channel: P, options?: V): Awaitable<WebSocketChannel<V>, WebSocketChannel<V>>;
+    connect<P extends keyof U & string>(channel: P, options?: U[P]): Awaitable<WebSocketChannel<U[P]>, WebSocketChannel<U[P]>>;
+    connect(channel: string, options?: ConnectOptions): Awaitable<WebSocketChannel, WebSocketChannel>;
 }
 /**
  * Create a new type-safe client for the application. The client can be used to fetch data from

package/dist/createClient.js

@@ -1,8 +1,8 @@
 import { attempt } from "@unshared/functions/attempt";
-import { f as fetch } from "./chunks/BUeqbyph.js";
-import { r as request } from "./chunks/DJJsADWD.js";
-import { c as connect } from "./chunks/6IxvRpmY.js";
-import "./chunks/0ZzUT3m_.js";
+import { f as fetch, r as request } from "./chunks/D1QsGr3A.js";
+import { c as connect } from "./chunks/Bys4-xE2.js";
+import "./chunks/CS5r-m4U.js";
+import "./chunks/B6pUErTM.js";
 import "@unshared/functions/awaitable";
 import "@unshared/functions";
 class Client {
@@ -15,70 +15,15 @@ class Client {
   constructor(options = {}) {
     this.options = options;
   }
-  /**
-   * Fetch a route from the API and return the `Response` object. If the client was instantiated with an
-   * application, the route name will be inferred from the application routes. Otherwise, you
-   * can pass the route name as a string.
-   *
-   * @param route The name of the route to fetch.
-   * @param options The options to pass to the request.
-   * @returns The response from the server.
-   */
   fetch(route, options) {
     return fetch(route, { ...this.options, ...options });
   }
-  /**
-   * Fetch a route from the API and return the data. If the client was instantiated with an
-   * application, the route name will be inferred from the application routes. Otherwise, you
-   * can pass the route name as a string.
-   *
-   * @param route The name of the route to fetch.
-   * @param options The options to pass to the request.
-   * @returns The data from the API.
-   * @example
-   * // Declare the application type.
-   * type App = Application<[ModuleProduct]>
-   *
-   * // Create a type-safe client for the application.
-   * const request = createClient<App>()
-   *
-   * // Fetch the data from the API.
-   * const data = request('GET /api/product/:id', { data: { id: '1' } })
-   */
   request(route, options) {
     return request(route, { ...this.options, ...options });
   }
-  /**
-   * Attempt to fetch a route from the API and return the data. If the client was instantiated with an
-   * application, the route name will be inferred from the application routes. Otherwise, you
-   * can pass the route name as a string.
-   *
-   * @param route The name of the route to fetch.
-   * @param options The options to pass to the request.
-   * @returns A result object with either the data or an error.
-   * @example
-   * // Declare the application type.
-   * type App = Application<[ModuleProduct]>
-   *
-   * // Create a type-safe client for the application.
-   * const request = createClient<App>()
-   *
-   * // Fetch the data from the API.
-   * const { data, error } = requestAttempt('GET /api/product/:id', { data: { id: '1' } })
-   * if (error) console.error(error)
-   * else console.log(data)
-   */
   requestAttempt(route, options) {
     return attempt(() => this.request(route, options));
   }
-  /**
-   * Create a new WebSocket connection to the server with the given path. The connection will
-   * automatically reconnect if the connection is closed unexpectedly.
-   *
-   * @param channel The path to connect to.
-   * @param options The options to pass to the connection.
-   * @returns The WebSocket connection.
-   */
   connect(channel, options) {
     return connect(channel, { baseUrl: this.options.baseUrl, ...options });
   }

package/dist/createClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"createClient.js","sources":["../createClient.ts"],"sourcesContent":["import type { Awaitable } from '@unshared/functions'\nimport type { Result } from '@unshared/functions/attempt'\nimport type { ServiceOptions } from './createService'\nimport type { OpenAPILike, OpenAPIOptionsMap } from './openapi'\nimport type { RequestOptions } from './utils'\nimport type { ConnectOptions, WebSocketChannel } from './websocket'\nimport { attempt } from '@unshared/functions/attempt'\nimport { fetch } from './utils/fetch'\nimport { request } from './utils/request'\nimport { connect } from './websocket/connect'\n\ntype Data<T extends RequestOptions> = T extends RequestOptions<any, any, any, any, any, any, infer R, any> ? R : unknown\ntype Routes = Record<string, RequestOptions>\ntype Channels = Record<string, ConnectOptions>\n\nexport class Client<T extends Routes = Routes, U extends Channels = Channels> {\n\n  /**\n   * Create a new client for the application.\n   *\n   * @param options The options to pass to the client.\n   * @example new Client({ baseUrl: 'https://api.example.com' })\n   */\n  constructor(public options: RequestOptions = {}) {}\n\n  /**\n   * Fetch a route from the API and return the `Response` object. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The response from the server.\n   */\n  public fetch<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Response> {\n    return fetch(route, { ...this.options, ...options })\n  }\n\n  /**\n   * Fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The data from the API.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const data = request('GET /api/product/:id', { data: { id: '1' } })\n   */\n  public request<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Data<V>> {\n    return request(route, { ...this.options, ...options }) as Promise<Data<V>>\n  }\n\n  /**\n   * Attempt to fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns A result object with either the data or an error.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const { data, error } = requestAttempt('GET /api/product/:id', { data: { id: '1' } })\n   * if (error) console.error(error)\n   * else console.log(data)\n   */\n  public requestAttempt<K extends keyof T & string, V extends T[K]>(route: K, options?: V): Promise<Result<Data<V>>> {\n    return attempt(() => this.request(route, options))\n  }\n\n  /**\n   * Create a new WebSocket connection to the server with the given path. The connection will\n   * automatically reconnect if the connection is closed unexpectedly.\n   *\n   * @param channel The path to connect to.\n   * @param options The options to pass to the connection.\n   * @returns The WebSocket connection.\n   */\n  public connect<P extends keyof U & string, V extends U[P]>(channel: P, options?: V): Awaitable<WebSocketChannel<V>, WebSocketChannel<V>> {\n    return connect(channel, { baseUrl: this.options.baseUrl, ...options }) as Awaitable<WebSocketChannel<V>, WebSocketChannel<V>>\n  }\n}\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends OpenAPILike>(options?: ServiceOptions<T>): Client<OpenAPIOptionsMap<T>>\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends Routes = Routes, V extends Channels = Channels>(options?: RequestOptions): Client<T, V>\nexport function createClient(options?: RequestOptions): Client {\n  return new Client(options)\n}\n"],"names":[],"mappings":";;;;;;;AAeO,MAAM,OAAiE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5E,YAAmB,UAA0B,IAAI;AAA9B,SAAA,UAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWZ,MAAkD,OAAU,SAAgC;AAC1F,WAAA,MAAM,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqB9C,QAAoD,OAAU,SAA+B;AAC3F,WAAA,QAAQ,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBhD,eAA2D,OAAU,SAAuC;AACjH,WAAO,QAAQ,MAAM,KAAK,QAAQ,OAAO,OAAO,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAW5C,QAAoD,SAAY,SAAkE;AAChI,WAAA,QAAQ,SAAS,EAAE,SAAS,KAAK,QAAQ,SAAS,GAAG,SAAS;AAAA,EAAA;AAEzE;AAqCO,SAAS,aAAa,SAAkC;AACtD,SAAA,IAAI,OAAO,OAAO;AAC3B;"}
+{"version":3,"file":"createClient.js","sources":["../createClient.ts"],"sourcesContent":["import type { Awaitable } from '@unshared/functions'\nimport type { Result } from '@unshared/functions/attempt'\nimport type { ServiceOptions } from './createService'\nimport type { OpenAPILike, OpenAPIOptionsMap } from './openapi'\nimport type { FetchOptions, RequestOptions } from './utils'\nimport type { ConnectOptions, WebSocketChannel } from './websocket'\nimport { attempt } from '@unshared/functions/attempt'\nimport { fetch } from './utils/fetch'\nimport { request } from './utils/request'\nimport { connect } from './websocket/connect'\n\ntype Data<T extends RequestOptions> = T extends RequestOptions<any, any, any, any, any, any, infer R, any> ? R : unknown\ntype Routes = Record<string, RequestOptions>\ntype Channels = Record<string, ConnectOptions>\n\nexport class Client<T extends Routes = Routes, U extends Channels = Channels> {\n\n  /**\n   * Create a new client for the application.\n   *\n   * @param options The options to pass to the client.\n   * @example new Client({ baseUrl: 'https://api.example.com' })\n   */\n  constructor(public options: RequestOptions = {}) {}\n\n  /**\n   * Fetch a route from the API and return the `Response` object. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The response from the server.\n   */\n  public fetch<K extends keyof T & string>(route: K, options?: T[K]): Promise<Response & { json: () => Promise<Data<T[K]>> }>\n  public fetch(route: string, options?: FetchOptions): Promise<Response>\n  public fetch(route: string, options?: FetchOptions): Promise<Response> {\n    return fetch(route, { ...this.options, ...options })\n  }\n\n  /**\n   * Fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns The data from the API.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const data = request('GET /api/product/:id', { data: { id: '1' } })\n   */\n  public request<K extends keyof T & string>(route: K, options?: T[K]): Promise<Data<T[K]>>\n  public request(route: string, options?: RequestOptions): Promise<unknown>\n  public request(route: string, options?: RequestOptions): Promise<unknown> {\n    return request(route, { ...this.options, ...options })\n  }\n\n  /**\n   * Attempt to fetch a route from the API and return the data. If the client was instantiated with an\n   * application, the route name will be inferred from the application routes. Otherwise, you\n   * can pass the route name as a string.\n   *\n   * @param route The name of the route to fetch.\n   * @param options The options to pass to the request.\n   * @returns A result object with either the data or an error.\n   * @example\n   * // Declare the application type.\n   * type App = Application<[ModuleProduct]>\n   *\n   * // Create a type-safe client for the application.\n   * const request = createClient<App>()\n   *\n   * // Fetch the data from the API.\n   * const { data, error } = requestAttempt('GET /api/product/:id', { data: { id: '1' } })\n   * if (error) console.error(error)\n   * else console.log(data)\n   */\n  public requestAttempt<K extends keyof T & string>(route: K, options?: T[K]): Promise<Result<Data<T[K]>>>\n  public requestAttempt(route: string, options?: RequestOptions): Promise<Result<unknown>>\n  public requestAttempt(route: string, options?: RequestOptions): Promise<Result<unknown>> {\n    return attempt(() => this.request(route, options))\n  }\n\n  /**\n   * Create a new WebSocket connection to the server with the given path. The connection will\n   * automatically reconnect if the connection is closed unexpectedly.\n   *\n   * @param channel The path to connect to.\n   * @param options The options to pass to the connection.\n   * @returns The WebSocket connection.\n   */\n  public connect<P extends keyof U & string>(channel: P, options?: U[P]): Awaitable<WebSocketChannel<U[P]>, WebSocketChannel<U[P]>>\n  public connect(channel: string, options?: ConnectOptions): Awaitable<WebSocketChannel, WebSocketChannel>\n  public connect(channel: string, options?: ConnectOptions): Awaitable<WebSocketChannel, WebSocketChannel> {\n    return connect(channel, { baseUrl: this.options.baseUrl, ...options })\n  }\n}\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends OpenAPILike>(options?: ServiceOptions<T>): Client<OpenAPIOptionsMap<T>>\n\n/**\n * Create a new type-safe client for the application. The client can be used to fetch data from\n * the API and connect to the server using WebSockets with the given path.\n *\n * @param options The options to pass to the client.\n * @returns The client object with the request method.\n * @example\n * // Create a type-safe client for the application.\n * const client = createClient<[ModuleUser]>()\n *\n * // Fetch the data from the API.\n * const data = await client.request('GET /api/user/:id', { id: '1' })\n *\n * // Use the data from the API.\n * console.log(data) // { id: '1', name: 'John Doe' }\n */\nexport function createClient<T extends Routes = Routes, V extends Channels = Channels>(options?: RequestOptions): Client<T, V>\nexport function createClient(options?: RequestOptions): Client {\n  return new Client(options)\n}\n"],"names":[],"mappings":";;;;;;;AAeO,MAAM,OAAiE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5E,YAAmB,UAA0B,IAAI;AAA9B,SAAA,UAAA;AAAA,EAAA;AAAA,EAaZ,MAAM,OAAe,SAA2C;AAC9D,WAAA,MAAM,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA,EAuB9C,QAAQ,OAAe,SAA4C;AACjE,WAAA,QAAQ,OAAO,EAAE,GAAG,KAAK,SAAS,GAAG,SAAS;AAAA,EAAA;AAAA,EAyBhD,eAAe,OAAe,SAAoD;AACvF,WAAO,QAAQ,MAAM,KAAK,QAAQ,OAAO,OAAO,CAAC;AAAA,EAAA;AAAA,EAa5C,QAAQ,SAAiB,SAAyE;AAChG,WAAA,QAAQ,SAAS,EAAE,SAAS,KAAK,QAAQ,SAAS,GAAG,SAAS;AAAA,EAAA;AAEzE;AAqCO,SAAS,aAAa,SAAkC;AACtD,SAAA,IAAI,OAAO,OAAO;AAC3B;"}

package/dist/createService.cjs

@@ -1,12 +1,12 @@
 "use strict";
-var resolveOperation = require("./chunks/CtW2aMuA.cjs"), handleResponse = require("./chunks/Cayg8606.cjs");
-require("./chunks/CYmaYL5B.cjs");
+var resolveOperationTokenOptions = require("./chunks/DEyigyGy.cjs"), handleResponse = require("./chunks/CVzmr2NA.cjs");
+require("./chunks/BDxlAULu.cjs");
 require("@unshared/functions/awaitable");
 function createService(document, initialOptions) {
   return new Proxy({}, {
     get(_, id) {
       return async (data, options) => {
-        const baseUrl = resolveOperation.getServerUrl(document), operation = resolveOperation.resolveOperation(document, id), { method, path, responses = {} } = operation, response = await handleResponse.fetch(path, { method, baseUrl, data, ...initialOptions, ...options });
+        const baseUrl = resolveOperationTokenOptions.getServerUrl(document), operation = resolveOperationTokenOptions.resolveOperation(document, id), tokenOptions = resolveOperationTokenOptions.resolveOperationTokenOptions(document, operation), { method, path, responses = {} } = operation, { url, init } = handleResponse.parseRequest(path, { method, baseUrl, data, ...tokenOptions, ...initialOptions, ...options }), response = await globalThis.fetch(url, init);
         if (response.ok) return handleResponse.handleResponse(response, { ...initialOptions, ...options });
         const status = response.status.toString();
         throw status in responses && typeof responses[status] == "object" && responses[status] !== null && "description" in responses[status] && typeof responses[status].description == "string" ? new Error(responses[status].description) : new Error(response.statusText);

package/dist/createService.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createService.cjs","sources":["../createService.ts"],"sourcesContent":["import type { MaybeLiteral } from '@unshared/types'\nimport type { OpenAPIV3, Operation, OperationById, OperationId, OperationOptions, OperationResult, ServerUrl } from './openapi'\nimport type { RequestOptions } from './utils/request'\nimport { getServerUrl } from './openapi/getServerUrl'\nimport { resolveOperation } from './openapi/resolveOperation'\nimport { fetch } from './utils/fetch'\nimport { handleResponse } from './utils/handleResponse'\n\n/** A service instance for the given OpenAPI specification. */\nexport type Service<T> = {\n  [K in OperationId<T>]:\n  OperationById<T, K> extends infer U extends OperationById<T, K>\n    ? (data: OperationOptions<T, U>['data'], options?: OperationOptions<T, U>) => Promise<OperationResult<T, U>>\n    : never\n}\n\n/** The options to pass to the service client. */\nexport interface ServiceOptions<T = any> extends RequestOptions {\n  baseUrl?: MaybeLiteral<ServerUrl<T>>\n  headers?: T extends { openapi: string } ? OpenAPIV3.ServerHeaders<T> : never\n}\n\n/**\n * Create a new client instance for the given OpenAPI specification.\n *\n * @param document The OpenAPI specification document.\n * @param initialOptions The initial options to use for every request.\n * @returns The client instance.\n * @example\n *\n * // Import the Giphy OpenAPI specification.\n * import Giphy from './giphy.openapi.json'\n *\n * // Create a new service instance for the Giphy API.\n * const service = createService(Giphy, { headers: { 'Bearer' } })\n *\n * // Request the \"searchGifs\" operation from the Giphy API.\n * await service.getGifs({ limit: 10, offset: 0, q: 'cats' }) // => { data: [...] }\n */\nexport function createService<T extends object>(document: Readonly<T>, initialOptions?: ServiceOptions<T>): Service<T> {\n  return new Proxy({}, {\n    get(_, id: OperationId<T>) {\n      return async(data: object, options: RequestOptions) => {\n\n        // --- Find the operation in the OpenAPI specification.\n        const baseUrl = getServerUrl(document)\n        const operation = resolveOperation(document, id) as Operation\n\n        // --- Fetch the relevant resource from the server.\n        const { method, path, responses = {} } = operation\n        const response = await fetch(path, { method, baseUrl, data, ...initialOptions, ...options })\n        if (response.ok) return handleResponse(response, { ...initialOptions, ...options })\n\n        // --- Throw an error if the response was not successful.\n        const status = response.status.toString()\n        if (status in responses\n          && typeof responses[status] === 'object'\n          && responses[status] !== null\n          && 'description' in responses[status]\n          && typeof responses[status].description === 'string')\n          throw new Error(responses[status].description)\n\n        // --- Throw a generic error if the response was not successful.\n        throw new Error(response.statusText)\n      }\n    },\n  }) as Service<T>\n}\n"],"names":["getServerUrl","resolveOperation","fetch","handleResponse"],"mappings":";;;;AAuCgB,SAAA,cAAgC,UAAuB,gBAAgD;AAC9G,SAAA,IAAI,MAAM,IAAI;AAAA,IACnB,IAAI,GAAG,IAAoB;AAClB,aAAA,OAAM,MAAc,YAA4B;AAGrD,cAAM,UAAUA,iBAAAA,aAAa,QAAQ,GAC/B,YAAYC,iBAAAA,iBAAiB,UAAU,EAAE,GAGzC,EAAE,QAAQ,MAAM,YAAY,GAAG,IAAI,WACnC,WAAW,MAAMC,eAAAA,MAAM,MAAM,EAAE,QAAQ,SAAS,MAAM,GAAG,gBAAgB,GAAG,SAAS;AACvF,YAAA,SAAS,GAAI,QAAOC,eAAe,eAAA,UAAU,EAAE,GAAG,gBAAgB,GAAG,SAAS;AAG5E,cAAA,SAAS,SAAS,OAAO,SAAS;AACxC,cAAI,UAAU,aACT,OAAO,UAAU,MAAM,KAAM,YAC7B,UAAU,MAAM,MAAM,QACtB,iBAAiB,UAAU,MAAM,KACjC,OAAO,UAAU,MAAM,EAAE,eAAgB,WACtC,IAAI,MAAM,UAAU,MAAM,EAAE,WAAW,IAGzC,IAAI,MAAM,SAAS,UAAU;AAAA,MACrC;AAAA,IAAA;AAAA,EACF,CACD;AACH;;"}
+{"version":3,"file":"createService.cjs","sources":["../createService.ts"],"sourcesContent":["import type { MaybeLiteral } from '@unshared/types'\nimport type { OpenAPIV3, Operation, OperationById, OperationId, OperationOptions, OperationResult, ServerUrl } from './openapi'\nimport type { RequestOptions } from './utils/request'\nimport { getServerUrl } from './openapi/getServerUrl'\nimport { resolveOperation } from './openapi/resolveOperation'\nimport { resolveOperationTokenOptions } from './openapi/resolveOperationTokenOptions'\nimport { handleResponse } from './utils/handleResponse'\nimport { parseRequest } from './utils/parseRequest'\n\n/** A service instance for the given OpenAPI specification. */\nexport type Service<T> = {\n  [K in OperationId<T>]:\n  OperationById<T, K> extends infer U extends OperationById<T, K>\n    ? (data: OperationOptions<T, U>['data'], options?: OperationOptions<T, U>) => Promise<OperationResult<T, U>>\n    : never\n}\n\n/** The options to pass to the service client. */\nexport interface ServiceOptions<T = any> extends RequestOptions {\n  baseUrl?: MaybeLiteral<ServerUrl<T>>\n  headers?: T extends { openapi: string } ? OpenAPIV3.ServerHeaders<T> : never\n}\n\n/**\n * Create a new client instance for the given OpenAPI specification.\n *\n * @param document The OpenAPI specification document.\n * @param initialOptions The initial options to use for every request.\n * @returns The client instance.\n * @example\n *\n * // Import the Giphy OpenAPI specification.\n * import Giphy from './giphy.openapi.json'\n *\n * // Create a new service instance for the Giphy API.\n * const service = createService(Giphy, { headers: { 'Bearer' } })\n *\n * // Request the \"searchGifs\" operation from the Giphy API.\n * await service.getGifs({ limit: 10, offset: 0, q: 'cats' }) // => { data: [...] }\n */\nexport function createService<T extends object>(document: Readonly<T>, initialOptions?: ServiceOptions<T>): Service<T> {\n  return new Proxy({}, {\n    get(_, id: OperationId<T>) {\n      return async(data: object, options: RequestOptions) => {\n\n        // --- Find the operation in the OpenAPI specification.\n        const baseUrl = getServerUrl(document)\n        const operation = resolveOperation(document, id) as Operation\n        const tokenOptions = resolveOperationTokenOptions(document, operation)\n\n        // --- Fetch the relevant resource from the server.\n        const { method, path, responses = {} } = operation\n        const { url, init } = parseRequest(path, { method, baseUrl, data, ...tokenOptions, ...initialOptions, ...options })\n        const response = await globalThis.fetch(url, init)\n        if (response.ok) return handleResponse(response, { ...initialOptions, ...options })\n\n        // --- Throw an error if the response was not successful.\n        const status = response.status.toString()\n        if (status in responses\n          && typeof responses[status] === 'object'\n          && responses[status] !== null\n          && 'description' in responses[status]\n          && typeof responses[status].description === 'string')\n          throw new Error(responses[status].description)\n\n        // --- Throw a generic error if the response was not successful.\n        throw new Error(response.statusText)\n      }\n    },\n  }) as Service<T>\n}\n"],"names":["getServerUrl","resolveOperation","resolveOperationTokenOptions","parseRequest","handleResponse"],"mappings":";;;;AAwCgB,SAAA,cAAgC,UAAuB,gBAAgD;AAC9G,SAAA,IAAI,MAAM,IAAI;AAAA,IACnB,IAAI,GAAG,IAAoB;AAClB,aAAA,OAAM,MAAc,YAA4B;AAG/C,cAAA,UAAUA,0CAAa,QAAQ,GAC/B,YAAYC,8CAAiB,UAAU,EAAE,GACzC,eAAeC,6BAAAA,6BAA6B,UAAU,SAAS,GAG/D,EAAE,QAAQ,MAAM,YAAY,OAAO,WACnC,EAAE,KAAK,KAAA,IAASC,eAAAA,aAAa,MAAM,EAAE,QAAQ,SAAS,MAAM,GAAG,cAAc,GAAG,gBAAgB,GAAG,QAAS,CAAA,GAC5G,WAAW,MAAM,WAAW,MAAM,KAAK,IAAI;AAC7C,YAAA,SAAS,GAAI,QAAOC,eAAe,eAAA,UAAU,EAAE,GAAG,gBAAgB,GAAG,SAAS;AAG5E,cAAA,SAAS,SAAS,OAAO,SAAS;AACxC,cAAI,UAAU,aACT,OAAO,UAAU,MAAM,KAAM,YAC7B,UAAU,MAAM,MAAM,QACtB,iBAAiB,UAAU,MAAM,KACjC,OAAO,UAAU,MAAM,EAAE,eAAgB,WACtC,IAAI,MAAM,UAAU,MAAM,EAAE,WAAW,IAGzC,IAAI,MAAM,SAAS,UAAU;AAAA,MACrC;AAAA,IAAA;AAAA,EACF,CACD;AACH;;"}

package/dist/createService.d.ts

@@ -1,6 +1,6 @@
 import { MaybeLiteral } from '@unshared/types';
-import { b as OperationId, c as OperationById, d as OperationOptions, e as OperationResult, S as ServerUrl, f as OpenAPIV3 } from './chunks/mHfUAX_g.js';
-import { R as RequestOptions } from './chunks/CO11DuYE.js';
+import { b as OperationId, c as OperationById, d as OperationOptions, e as OperationResult, S as ServerUrl, f as OpenAPIV3 } from './chunks/5p4H9ZaI.js';
+import { R as RequestOptions } from './chunks/Nc32BOzg.js';
 import 'openapi-types';
 import './HttpHeaders.js';
 import './HttpMethods.js';

package/dist/createService.js

@@ -1,12 +1,12 @@
-import { g as getServerUrl, r as resolveOperation } from "./chunks/Biic1J5b.js";
-import { f as fetch, h as handleResponse } from "./chunks/BUeqbyph.js";
-import "./chunks/0ZzUT3m_.js";
+import { g as getServerUrl, r as resolveOperation, a as resolveOperationTokenOptions } from "./chunks/B_Gz6Yz8.js";
+import { p as parseRequest, h as handleResponse } from "./chunks/CS5r-m4U.js";
+import "./chunks/B6pUErTM.js";
 import "@unshared/functions/awaitable";
 function createService(document, initialOptions) {
   return new Proxy({}, {
     get(_, id) {
       return async (data, options) => {
-        const baseUrl = getServerUrl(document), operation = resolveOperation(document, id), { method, path, responses = {} } = operation, response = await fetch(path, { method, baseUrl, data, ...initialOptions, ...options });
+        const baseUrl = getServerUrl(document), operation = resolveOperation(document, id), tokenOptions = resolveOperationTokenOptions(document, operation), { method, path, responses = {} } = operation, { url, init } = parseRequest(path, { method, baseUrl, data, ...tokenOptions, ...initialOptions, ...options }), response = await globalThis.fetch(url, init);
         if (response.ok) return handleResponse(response, { ...initialOptions, ...options });
         const status = response.status.toString();
         throw status in responses && typeof responses[status] == "object" && responses[status] !== null && "description" in responses[status] && typeof responses[status].description == "string" ? new Error(responses[status].description) : new Error(response.statusText);

package/dist/createService.js.map

@@ -1 +1 @@
-{"version":3,"file":"createService.js","sources":["../createService.ts"],"sourcesContent":["import type { MaybeLiteral } from '@unshared/types'\nimport type { OpenAPIV3, Operation, OperationById, OperationId, OperationOptions, OperationResult, ServerUrl } from './openapi'\nimport type { RequestOptions } from './utils/request'\nimport { getServerUrl } from './openapi/getServerUrl'\nimport { resolveOperation } from './openapi/resolveOperation'\nimport { fetch } from './utils/fetch'\nimport { handleResponse } from './utils/handleResponse'\n\n/** A service instance for the given OpenAPI specification. */\nexport type Service<T> = {\n  [K in OperationId<T>]:\n  OperationById<T, K> extends infer U extends OperationById<T, K>\n    ? (data: OperationOptions<T, U>['data'], options?: OperationOptions<T, U>) => Promise<OperationResult<T, U>>\n    : never\n}\n\n/** The options to pass to the service client. */\nexport interface ServiceOptions<T = any> extends RequestOptions {\n  baseUrl?: MaybeLiteral<ServerUrl<T>>\n  headers?: T extends { openapi: string } ? OpenAPIV3.ServerHeaders<T> : never\n}\n\n/**\n * Create a new client instance for the given OpenAPI specification.\n *\n * @param document The OpenAPI specification document.\n * @param initialOptions The initial options to use for every request.\n * @returns The client instance.\n * @example\n *\n * // Import the Giphy OpenAPI specification.\n * import Giphy from './giphy.openapi.json'\n *\n * // Create a new service instance for the Giphy API.\n * const service = createService(Giphy, { headers: { 'Bearer' } })\n *\n * // Request the \"searchGifs\" operation from the Giphy API.\n * await service.getGifs({ limit: 10, offset: 0, q: 'cats' }) // => { data: [...] }\n */\nexport function createService<T extends object>(document: Readonly<T>, initialOptions?: ServiceOptions<T>): Service<T> {\n  return new Proxy({}, {\n    get(_, id: OperationId<T>) {\n      return async(data: object, options: RequestOptions) => {\n\n        // --- Find the operation in the OpenAPI specification.\n        const baseUrl = getServerUrl(document)\n        const operation = resolveOperation(document, id) as Operation\n\n        // --- Fetch the relevant resource from the server.\n        const { method, path, responses = {} } = operation\n        const response = await fetch(path, { method, baseUrl, data, ...initialOptions, ...options })\n        if (response.ok) return handleResponse(response, { ...initialOptions, ...options })\n\n        // --- Throw an error if the response was not successful.\n        const status = response.status.toString()\n        if (status in responses\n          && typeof responses[status] === 'object'\n          && responses[status] !== null\n          && 'description' in responses[status]\n          && typeof responses[status].description === 'string')\n          throw new Error(responses[status].description)\n\n        // --- Throw a generic error if the response was not successful.\n        throw new Error(response.statusText)\n      }\n    },\n  }) as Service<T>\n}\n"],"names":[],"mappings":";;;;AAuCgB,SAAA,cAAgC,UAAuB,gBAAgD;AAC9G,SAAA,IAAI,MAAM,IAAI;AAAA,IACnB,IAAI,GAAG,IAAoB;AAClB,aAAA,OAAM,MAAc,YAA4B;AAGrD,cAAM,UAAU,aAAa,QAAQ,GAC/B,YAAY,iBAAiB,UAAU,EAAE,GAGzC,EAAE,QAAQ,MAAM,YAAY,GAAG,IAAI,WACnC,WAAW,MAAM,MAAM,MAAM,EAAE,QAAQ,SAAS,MAAM,GAAG,gBAAgB,GAAG,SAAS;AACvF,YAAA,SAAS,GAAI,QAAO,eAAe,UAAU,EAAE,GAAG,gBAAgB,GAAG,SAAS;AAG5E,cAAA,SAAS,SAAS,OAAO,SAAS;AACxC,cAAI,UAAU,aACT,OAAO,UAAU,MAAM,KAAM,YAC7B,UAAU,MAAM,MAAM,QACtB,iBAAiB,UAAU,MAAM,KACjC,OAAO,UAAU,MAAM,EAAE,eAAgB,WACtC,IAAI,MAAM,UAAU,MAAM,EAAE,WAAW,IAGzC,IAAI,MAAM,SAAS,UAAU;AAAA,MACrC;AAAA,IAAA;AAAA,EACF,CACD;AACH;"}
+{"version":3,"file":"createService.js","sources":["../createService.ts"],"sourcesContent":["import type { MaybeLiteral } from '@unshared/types'\nimport type { OpenAPIV3, Operation, OperationById, OperationId, OperationOptions, OperationResult, ServerUrl } from './openapi'\nimport type { RequestOptions } from './utils/request'\nimport { getServerUrl } from './openapi/getServerUrl'\nimport { resolveOperation } from './openapi/resolveOperation'\nimport { resolveOperationTokenOptions } from './openapi/resolveOperationTokenOptions'\nimport { handleResponse } from './utils/handleResponse'\nimport { parseRequest } from './utils/parseRequest'\n\n/** A service instance for the given OpenAPI specification. */\nexport type Service<T> = {\n  [K in OperationId<T>]:\n  OperationById<T, K> extends infer U extends OperationById<T, K>\n    ? (data: OperationOptions<T, U>['data'], options?: OperationOptions<T, U>) => Promise<OperationResult<T, U>>\n    : never\n}\n\n/** The options to pass to the service client. */\nexport interface ServiceOptions<T = any> extends RequestOptions {\n  baseUrl?: MaybeLiteral<ServerUrl<T>>\n  headers?: T extends { openapi: string } ? OpenAPIV3.ServerHeaders<T> : never\n}\n\n/**\n * Create a new client instance for the given OpenAPI specification.\n *\n * @param document The OpenAPI specification document.\n * @param initialOptions The initial options to use for every request.\n * @returns The client instance.\n * @example\n *\n * // Import the Giphy OpenAPI specification.\n * import Giphy from './giphy.openapi.json'\n *\n * // Create a new service instance for the Giphy API.\n * const service = createService(Giphy, { headers: { 'Bearer' } })\n *\n * // Request the \"searchGifs\" operation from the Giphy API.\n * await service.getGifs({ limit: 10, offset: 0, q: 'cats' }) // => { data: [...] }\n */\nexport function createService<T extends object>(document: Readonly<T>, initialOptions?: ServiceOptions<T>): Service<T> {\n  return new Proxy({}, {\n    get(_, id: OperationId<T>) {\n      return async(data: object, options: RequestOptions) => {\n\n        // --- Find the operation in the OpenAPI specification.\n        const baseUrl = getServerUrl(document)\n        const operation = resolveOperation(document, id) as Operation\n        const tokenOptions = resolveOperationTokenOptions(document, operation)\n\n        // --- Fetch the relevant resource from the server.\n        const { method, path, responses = {} } = operation\n        const { url, init } = parseRequest(path, { method, baseUrl, data, ...tokenOptions, ...initialOptions, ...options })\n        const response = await globalThis.fetch(url, init)\n        if (response.ok) return handleResponse(response, { ...initialOptions, ...options })\n\n        // --- Throw an error if the response was not successful.\n        const status = response.status.toString()\n        if (status in responses\n          && typeof responses[status] === 'object'\n          && responses[status] !== null\n          && 'description' in responses[status]\n          && typeof responses[status].description === 'string')\n          throw new Error(responses[status].description)\n\n        // --- Throw a generic error if the response was not successful.\n        throw new Error(response.statusText)\n      }\n    },\n  }) as Service<T>\n}\n"],"names":[],"mappings":";;;;AAwCgB,SAAA,cAAgC,UAAuB,gBAAgD;AAC9G,SAAA,IAAI,MAAM,IAAI;AAAA,IACnB,IAAI,GAAG,IAAoB;AAClB,aAAA,OAAM,MAAc,YAA4B;AAG/C,cAAA,UAAU,aAAa,QAAQ,GAC/B,YAAY,iBAAiB,UAAU,EAAE,GACzC,eAAe,6BAA6B,UAAU,SAAS,GAG/D,EAAE,QAAQ,MAAM,YAAY,OAAO,WACnC,EAAE,KAAK,KAAA,IAAS,aAAa,MAAM,EAAE,QAAQ,SAAS,MAAM,GAAG,cAAc,GAAG,gBAAgB,GAAG,QAAS,CAAA,GAC5G,WAAW,MAAM,WAAW,MAAM,KAAK,IAAI;AAC7C,YAAA,SAAS,GAAI,QAAO,eAAe,UAAU,EAAE,GAAG,gBAAgB,GAAG,SAAS;AAG5E,cAAA,SAAS,SAAS,OAAO,SAAS;AACxC,cAAI,UAAU,aACT,OAAO,UAAU,MAAM,KAAM,YAC7B,UAAU,MAAM,MAAM,QACtB,iBAAiB,UAAU,MAAM,KACjC,OAAO,UAAU,MAAM,EAAE,eAAgB,WACtC,IAAI,MAAM,UAAU,MAAM,EAAE,WAAW,IAGzC,IAAI,MAAM,SAAS,UAAU;AAAA,MACrC;AAAA,IAAA;AAAA,EACF,CACD;AACH;"}

package/dist/index.cjs

@@ -1,13 +1,13 @@
 "use strict";
 var createClient = require("./createClient.cjs"), createService = require("./createService.cjs"), HttpHeaders = require("./HttpHeaders.cjs"), HttpMethods = require("./HttpMethods.cjs"), HttpStatusCodes = require("./HttpStatusCodes.cjs");
 require("@unshared/functions/attempt");
-require("./chunks/Cayg8606.cjs");
-require("./chunks/CYmaYL5B.cjs");
+require("./chunks/DXrQkl1A.cjs");
+require("./chunks/CVzmr2NA.cjs");
+require("./chunks/BDxlAULu.cjs");
 require("@unshared/functions/awaitable");
-require("./chunks/Du_W5H6e.cjs");
-require("./chunks/BMbsYNBd.cjs");
+require("./chunks/BdFNzMcu.cjs");
 require("@unshared/functions");
-require("./chunks/CtW2aMuA.cjs");
+require("./chunks/DEyigyGy.cjs");
 exports.Client = createClient.Client;
 exports.createClient = createClient.createClient;
 exports.createService = createService.createService;

package/dist/index.d.ts

@@ -5,8 +5,8 @@ export { HttpMethod } from './HttpMethods.js';
 export { HttpStatusCode } from './HttpStatusCodes.js';
 import '@unshared/functions';
 import '@unshared/functions/attempt';
-import './chunks/mHfUAX_g.js';
+import './chunks/Nc32BOzg.js';
 import '@unshared/types';
-import './chunks/CO11DuYE.js';
+import './chunks/5p4H9ZaI.js';
 import 'openapi-types';
 import './websocket.js';

package/dist/index.js

@@ -4,13 +4,13 @@ import { HttpHeader } from "./HttpHeaders.js";
 import { HttpMethod } from "./HttpMethods.js";
 import { HttpStatusCode } from "./HttpStatusCodes.js";
 import "@unshared/functions/attempt";
-import "./chunks/BUeqbyph.js";
-import "./chunks/0ZzUT3m_.js";
+import "./chunks/D1QsGr3A.js";
+import "./chunks/CS5r-m4U.js";
+import "./chunks/B6pUErTM.js";
 import "@unshared/functions/awaitable";
-import "./chunks/DJJsADWD.js";
-import "./chunks/6IxvRpmY.js";
+import "./chunks/Bys4-xE2.js";
 import "@unshared/functions";
-import "./chunks/Biic1J5b.js";
+import "./chunks/B_Gz6Yz8.js";
 export {
   Client,
   HttpHeader,

package/dist/openapi.cjs

@@ -1,5 +1,11 @@
 "use strict";
-var resolveOperation = require("./chunks/CtW2aMuA.cjs");
+var resolveOperationTokenOptions = require("./chunks/DEyigyGy.cjs");
+function isOpenAPIV2(value) {
+  return typeof value == "object" && value !== null && "swagger" in value && value.swagger === "2.0";
+}
+function isOpenAPIV3_1(value) {
+  return typeof value == "object" && value !== null && "openapi" in value && value.openapi === "3.1.0";
+}
 function isReferenceObject(value) {
   return typeof value == "object" && value !== null && "$ref" in value && typeof value.$ref == "string";
 }
@@ -27,8 +33,12 @@ function resolveDocument(value, document = value) {
     }
   });
 }
-exports.getServerUrl = resolveOperation.getServerUrl;
-exports.resolveOperation = resolveOperation.resolveOperation;
+exports.getServerUrl = resolveOperationTokenOptions.getServerUrl;
+exports.isOpenAPIV3 = resolveOperationTokenOptions.isOpenAPIV3;
+exports.resolveOperation = resolveOperationTokenOptions.resolveOperation;
+exports.resolveOperationTokenOptions = resolveOperationTokenOptions.resolveOperationTokenOptions;
+exports.isOpenAPIV2 = isOpenAPIV2;
+exports.isOpenAPIV3_1 = isOpenAPIV3_1;
 exports.isReferenceObject = isReferenceObject;
 exports.resolveDocument = resolveDocument;
 exports.resolveReference = resolveReference;

package/dist/openapi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.cjs","sources":["../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";;AAcO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;;;;;;"}
+{"version":3,"file":"openapi.cjs","sources":["../openapi/isOpenAPIV2.ts","../openapi/isOpenAPIV3_1.ts","../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["/* eslint-disable unicorn/filename-case */\nimport type { OpenAPIV2 } from 'openapi-types'\n\n/**\n * Check if the given document is an OpenAPI v2 specification.\n *\n * @param value The document to check.\n * @returns `true` if the document is an OpenAPI v2 specification, `false` otherwise.\n * @example isOpenAPIV2({ swagger: '2.0', info: { title: 'Test API', version: '1.0.0' } }) // => true\n */\nexport function isOpenAPIV2(value: unknown): value is OpenAPIV2.Document {\n  return typeof value === 'object'\n    && value !== null\n    && 'swagger' in value\n    && value.swagger === '2.0'\n}\n","/* eslint-disable unicorn/filename-case */\nimport type { OpenAPIV3_1 } from 'openapi-types'\n\n/**\n * Check if the given document is an OpenAPI v3.1 specification.\n *\n * @param value The document to check.\n * @returns `true` if the document is an OpenAPI v3.1 specification, `false` otherwise.\n * @example isOpenAPIV3_1({ openapi: '3.1.0', info: { title: 'Test API', version: '1.0.0' } }) // => true\n */\nexport function isOpenAPIV3_1(value: unknown): value is OpenAPIV3_1.Document {\n  return typeof value === 'object'\n    && value !== null\n    && 'openapi' in value\n    && value.openapi === '3.1.0'\n}\n","import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";;AAUO,SAAS,YAAY,OAA6C;AAChE,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,aAAa,SACb,MAAM,YAAY;AACzB;ACLO,SAAS,cAAc,OAA+C;AACpE,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,aAAa,SACb,MAAM,YAAY;AACzB;ACDO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;;;;;;;;;;"}

package/dist/openapi.d.ts

@@ -1,10 +1,37 @@
-export { O as OpenAPILike, a as OpenAPIOptionsMap, h as OpenAPIV2, j as OpenAPIV2Like, f as OpenAPIV3, k as OpenAPIV3Like, i as Operation, c as OperationById, n as OperationByRoute, b as OperationId, d as OperationOptions, l as OperationResponse, e as OperationResult, m as OperationRoute, S as ServerUrl, g as getServerUrl, r as resolveOperation } from './chunks/mHfUAX_g.js';
-import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
+export { O as OpenAPILike, a as OpenAPIOptionsMap, h as OpenAPIV2, j as OpenAPIV2Like, f as OpenAPIV3, k as OpenAPIV3Like, i as Operation, c as OperationById, n as OperationByRoute, b as OperationId, d as OperationOptions, l as OperationResponse, e as OperationResult, m as OperationRoute, S as ServerUrl, g as getServerUrl, r as resolveOperation } from './chunks/5p4H9ZaI.js';
+import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1, OpenAPI } from 'openapi-types';
 import { StringReplace, WriteableDeep, StringJoin, Substract } from '@unshared/types';
-import './chunks/CO11DuYE.js';
+import './chunks/Nc32BOzg.js';
 import './HttpHeaders.js';
 import './HttpMethods.js';
 
+/**
+ * Check if the given document is an OpenAPI v2 specification.
+ *
+ * @param value The document to check.
+ * @returns `true` if the document is an OpenAPI v2 specification, `false` otherwise.
+ * @example isOpenAPIV2({ swagger: '2.0', info: { title: 'Test API', version: '1.0.0' } }) // => true
+ */
+declare function isOpenAPIV2(value: unknown): value is OpenAPIV2.Document;
+
+/**
+ * Check if the given document is an OpenAPI v3.0 specification.
+ *
+ * @param value The document to check.
+ * @returns `true` if the document is an OpenAPI v3.0 specification, `false` otherwise.
+ * @example isOpenAPIV3({ openapi: '3.0.0', info: { title: 'Test API', version: '1.0.0' } }) // => true
+ */
+declare function isOpenAPIV3(value: unknown): value is OpenAPIV3.Document;
+
+/**
+ * Check if the given document is an OpenAPI v3.1 specification.
+ *
+ * @param value The document to check.
+ * @returns `true` if the document is an OpenAPI v3.1 specification, `false` otherwise.
+ * @example isOpenAPIV3_1({ openapi: '3.1.0', info: { title: 'Test API', version: '1.0.0' } }) // => true
+ */
+declare function isOpenAPIV3_1(value: unknown): value is OpenAPIV3_1.Document;
+
 type OpenAPIReference = OpenAPIV2.ReferenceObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
 /**
  * Check if a value is an {@linkcode OpenAPIReference}.
@@ -92,4 +119,18 @@ type OpenAPIResolved<T, D = T, N extends number = 8> = N extends 0 ? T : T exten
 declare function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>;
 declare function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>;
 
-export { type OpenAPIReference, type OpenAPIReferenceDecoded, type OpenAPIReferencePath, type OpenAPIReferenceResolved, type OpenAPIResolved, isReferenceObject, resolveDocument, resolveReference };
+interface TokenOptions {
+    tokenLocation?: 'cookie' | 'header' | 'query';
+    tokenProperty?: string;
+}
+/**
+ * Resolve the location of the apiKey token based on the OpenAPI specification.
+ *
+ * @param document The OpenAPI specification document.
+ * @param operation The OpenAPI operation object.
+ * @returns The location of the apiKey token ('query' | 'cookie' | 'header').
+ * @example resolveOperationTokenOptions(document, operation) // => { tokenLocation: 'header', tokenProperty: 'X-API-Key' }
+ */
+declare function resolveOperationTokenOptions(document: object, operation: OpenAPI.Operation): TokenOptions;
+
+export { type OpenAPIReference, type OpenAPIReferenceDecoded, type OpenAPIReferencePath, type OpenAPIReferenceResolved, type OpenAPIResolved, type TokenOptions, isOpenAPIV2, isOpenAPIV3, isOpenAPIV3_1, isReferenceObject, resolveDocument, resolveOperationTokenOptions, resolveReference };

package/dist/openapi.js

@@ -1,4 +1,10 @@
-import { g, r } from "./chunks/Biic1J5b.js";
+import { g, i, r, a } from "./chunks/B_Gz6Yz8.js";
+function isOpenAPIV2(value) {
+  return typeof value == "object" && value !== null && "swagger" in value && value.swagger === "2.0";
+}
+function isOpenAPIV3_1(value) {
+  return typeof value == "object" && value !== null && "openapi" in value && value.openapi === "3.1.0";
+}
 function isReferenceObject(value) {
   return typeof value == "object" && value !== null && "$ref" in value && typeof value.$ref == "string";
 }
@@ -28,9 +34,13 @@ function resolveDocument(value, document = value) {
 }
 export {
   g as getServerUrl,
+  isOpenAPIV2,
+  i as isOpenAPIV3,
+  isOpenAPIV3_1,
   isReferenceObject,
   resolveDocument,
   r as resolveOperation,
+  a as resolveOperationTokenOptions,
   resolveReference
 };
 //# sourceMappingURL=openapi.js.map

package/dist/openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.js","sources":["../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";AAcO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;"}
+{"version":3,"file":"openapi.js","sources":["../openapi/isOpenAPIV2.ts","../openapi/isOpenAPIV3_1.ts","../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["/* eslint-disable unicorn/filename-case */\nimport type { OpenAPIV2 } from 'openapi-types'\n\n/**\n * Check if the given document is an OpenAPI v2 specification.\n *\n * @param value The document to check.\n * @returns `true` if the document is an OpenAPI v2 specification, `false` otherwise.\n * @example isOpenAPIV2({ swagger: '2.0', info: { title: 'Test API', version: '1.0.0' } }) // => true\n */\nexport function isOpenAPIV2(value: unknown): value is OpenAPIV2.Document {\n  return typeof value === 'object'\n    && value !== null\n    && 'swagger' in value\n    && value.swagger === '2.0'\n}\n","/* eslint-disable unicorn/filename-case */\nimport type { OpenAPIV3_1 } from 'openapi-types'\n\n/**\n * Check if the given document is an OpenAPI v3.1 specification.\n *\n * @param value The document to check.\n * @returns `true` if the document is an OpenAPI v3.1 specification, `false` otherwise.\n * @example isOpenAPIV3_1({ openapi: '3.1.0', info: { title: 'Test API', version: '1.0.0' } }) // => true\n */\nexport function isOpenAPIV3_1(value: unknown): value is OpenAPIV3_1.Document {\n  return typeof value === 'object'\n    && value !== null\n    && 'openapi' in value\n    && value.openapi === '3.1.0'\n}\n","import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";AAUO,SAAS,YAAY,OAA6C;AAChE,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,aAAa,SACb,MAAM,YAAY;AACzB;ACLO,SAAS,cAAc,OAA+C;AACpE,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,aAAa,SACb,MAAM,YAAY;AACzB;ACDO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;"}