@unshared/client 0.3.0 → 0.3.2

package/dist/createClient.js

@@ -1,16 +1,19 @@
 import { attempt } from "@unshared/functions/attempt";
-import { f as fetch } from "./chunks/D51s1VII.js";
-import { r as request } from "./chunks/lMH6B5BV.js";
+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 "@unshared/functions/awaitable";
+import "@unshared/functions";
 class Client {
   /**
    * Create a new client for the application.
    *
-   * @param initialOptions The options to pass to the client.
+   * @param options The options to pass to the client.
    * @example new Client({ baseUrl: 'https://api.example.com' })
    */
-  constructor(initialOptions = {}) {
-    this.initialOptions = initialOptions;
+  constructor(options = {}) {
+    this.options = options;
   }
   /**
    * Fetch a route from the API and return the `Response` object. If the client was instantiated with an
@@ -21,8 +24,8 @@ class Client {
    * @param options The options to pass to the request.
    * @returns The response from the server.
    */
-  async fetch(route, options) {
-    return await fetch(route, { ...this.initialOptions, ...options });
+  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
@@ -42,15 +45,15 @@ class Client {
    * // Fetch the data from the API.
    * const data = request('GET /api/product/:id', { data: { id: '1' } })
    */
-  async request(route, options) {
-    return await request(route, { ...this.initialOptions, ...options });
+  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 name The name of the route to fetch.
+   * @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
@@ -65,20 +68,20 @@ class Client {
    * if (error) console.error(error)
    * else console.log(data)
    */
-  async requestAttempt(name, options) {
-    return await attempt(() => this.request(name, options));
+  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 name The path to connect to.
+   * @param channel The path to connect to.
    * @param options The options to pass to the connection.
    * @returns The WebSocket connection.
    */
-  // public connect<P extends RouteName<T>>(name: P, options: Partial<ConnectOptions<T, P>> = {}): WebSocketConnection<T, P> {
-  //   return connect<T, P>(name, { baseUrl: this.baseUrl, ...options })
-  // }
+  connect(channel, options) {
+    return connect(channel, { baseUrl: this.options.baseUrl, ...options });
+  }
 }
 function createClient(options) {
   return new Client(options);

package/dist/createClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"createClient.js","sources":["../createClient.ts"],"sourcesContent":["import type { Result } from '@unshared/functions/attempt'\nimport type { ObjectLike } from '@unshared/types'\nimport type { ServiceOptions } from './createService'\nimport type { OpenAPIRoutes } from './openapi'\nimport type { RequestOptions } from './utils/request'\nimport { attempt } from '@unshared/functions/attempt'\nimport { fetch } from './utils/fetch'\nimport { request } from './utils/request'\n\n/** Define the routes that can be fetched from the API and their related options. */\nexport type ClientRoutes = Record<string, RequestOptions>\n\n/** The route name that can be fetched from the API. */\ntype Route<T extends ClientRoutes> =\n  T extends Record<infer P extends string, RequestOptions> ? P : string\n\n/** The options to pass to the request based on the route name. */\ntype Options<T extends ClientRoutes, P extends keyof T> =\n  T extends Record<P, infer R> ? R : RequestOptions\n\n/** The data returned from the API based on the route name. */\ntype Data<T extends ClientRoutes, P extends keyof T> =\n  Options<T, P> extends RequestOptions<any, any, any, any, any, any, infer R extends ObjectLike, any>\n    ? R\n    : unknown\n\nexport class Client<T extends ClientRoutes = ClientRoutes> {\n\n  /**\n   * Create a new client for the application.\n   *\n   * @param initialOptions The options to pass to the client.\n   * @example new Client({ baseUrl: 'https://api.example.com' })\n   */\n  constructor(private initialOptions: 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 async fetch<P extends Route<T>>(route: P, options?: Options<T, P>): Promise<Response> {\n    return await fetch(route, { ...this.initialOptions, ...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 async request<P extends Route<T>>(route: P, options?: Options<T, P>): Promise<Data<T, P>> {\n    return await request(route, { ...this.initialOptions, ...options }) as Data<T, P>\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 name 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 async requestAttempt<P extends Route<T>>(name: P, options?: Options<T, P>): Promise<Result<Data<T, P>>> {\n    return await attempt(() => this.request<P>(name, 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 name 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 RouteName<T>>(name: P, options: Partial<ConnectOptions<T, P>> = {}): WebSocketConnection<T, P> {\n  //   return connect<T, P>(name, { baseUrl: this.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 ClientRoutes>(options?: RequestOptions): Client<T>\nexport function createClient<T extends { swagger: string }>(options?: ServiceOptions<T>): Client<OpenAPIRoutes<T>>\nexport function createClient<T extends { openapi: string }>(options?: ServiceOptions<T>): Client<OpenAPIRoutes<T>>\nexport function createClient(options?: RequestOptions): Client {\n  return new Client(options)\n}\n"],"names":[],"mappings":";;;;AA0BO,MAAM,OAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQzD,YAAoB,iBAAiC,IAAI;AAArC,SAAA,iBAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWpB,MAAa,MAA0B,OAAU,SAA4C;AACpF,WAAA,MAAM,MAAM,OAAO,EAAE,GAAG,KAAK,gBAAgB,GAAG,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBlE,MAAa,QAA4B,OAAU,SAA8C;AACxF,WAAA,MAAM,QAAQ,OAAO,EAAE,GAAG,KAAK,gBAAgB,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,EAuBpE,MAAa,eAAmC,MAAS,SAAsD;AAC7G,WAAO,MAAM,QAAQ,MAAM,KAAK,QAAW,MAAM,OAAO,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAc7D;AAqBO,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 { 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;"}

package/dist/createService.cjs

@@ -1,5 +1,6 @@
 "use strict";
-var resolveOperation = require("./chunks/CtW2aMuA.cjs"), handleResponse = require("./chunks/CfKxYeRr.cjs");
+var resolveOperation = require("./chunks/CtW2aMuA.cjs"), handleResponse = require("./chunks/Cayg8606.cjs");
+require("./chunks/CYmaYL5B.cjs");
 require("@unshared/functions/awaitable");
 function createService(document, initialOptions) {
   return new Proxy({}, {

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 { 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;;"}

package/dist/createService.d.ts

@@ -1,6 +1,6 @@
 import { MaybeLiteral } from '@unshared/types';
-import { b as OperationId, d as OperationById, e as OperationOptions, f as OperationResult, S as ServerUrl, a as OpenAPIV3 } from './chunks/CjU0376e.js';
-import { c as RequestOptions } from './chunks/B92aAMq0.js';
+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 'openapi-types';
 import './HttpHeaders.js';
 import './HttpMethods.js';

package/dist/createService.js

@@ -1,5 +1,6 @@
 import { g as getServerUrl, r as resolveOperation } from "./chunks/Biic1J5b.js";
-import { f as fetch, h as handleResponse } from "./chunks/D51s1VII.js";
+import { f as fetch, h as handleResponse } from "./chunks/BUeqbyph.js";
+import "./chunks/0ZzUT3m_.js";
 import "@unshared/functions/awaitable";
 function createService(document, initialOptions) {
   return new Proxy({}, {

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 { 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;"}

package/dist/index.cjs

@@ -1,32 +1,17 @@
 "use strict";
-var createClient = require("./createClient.cjs"), createService = require("./createService.cjs"), HttpHeaders = require("./HttpHeaders.cjs"), HttpMethods = require("./HttpMethods.cjs"), HttpStatusCodes = require("./HttpStatusCodes.cjs"), openapi = require("./openapi.cjs");
-require("./utils.cjs");
-var resolveOperation = require("./chunks/CtW2aMuA.cjs"), handleResponse = require("./chunks/CfKxYeRr.cjs"), request = require("./chunks/iA98-4f5.cjs");
+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("@unshared/functions/awaitable");
+require("./chunks/Du_W5H6e.cjs");
+require("./chunks/BMbsYNBd.cjs");
+require("@unshared/functions");
+require("./chunks/CtW2aMuA.cjs");
 exports.Client = createClient.Client;
 exports.createClient = createClient.createClient;
 exports.createService = createService.createService;
 exports.HttpHeader = HttpHeaders.HttpHeader;
 exports.HttpMethod = HttpMethods.HttpMethod;
 exports.HttpStatusCode = HttpStatusCodes.HttpStatusCode;
-exports.isReferenceObject = openapi.isReferenceObject;
-exports.resolveDocument = openapi.resolveDocument;
-exports.resolveReference = openapi.resolveReference;
-exports.getServerUrl = resolveOperation.getServerUrl;
-exports.resolveOperation = resolveOperation.resolveOperation;
-exports.fetch = handleResponse.fetch;
-exports.handleResponse = handleResponse.handleResponse;
-exports.handleResponseStreamJson = handleResponse.handleResponseStreamJson;
-exports.isFormDataLike = handleResponse.isFormDataLike;
-exports.isObjectLike = handleResponse.isObjectLike;
-exports.parseRequest = handleResponse.parseRequest;
-exports.parseRequestBody = handleResponse.parseRequestBody;
-exports.parseRequestHeaders = handleResponse.parseRequestHeaders;
-exports.parseRequestParameters = handleResponse.parseRequestParameters;
-exports.parseRequestQuery = handleResponse.parseRequestQuery;
-exports.parseRequestUrl = handleResponse.parseRequestUrl;
-exports.toFormData = handleResponse.toFormData;
-exports.toSearchParams = handleResponse.toSearchParams;
-exports.request = request.request;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,13 +1,12 @@
-export { Client, ClientRoutes, createClient } from './createClient.js';
+export { Client, createClient } from './createClient.js';
 export { Service, ServiceOptions, createService } from './createService.js';
 export { HttpHeader } from './HttpHeaders.js';
 export { HttpMethod } from './HttpMethods.js';
 export { HttpStatusCode } from './HttpStatusCodes.js';
-export { k as OpenAPIRoutes, O as OpenAPIV2, a as OpenAPIV3, c as Operation, d as OperationById, j as OperationByRoute, b as OperationId, e as OperationOptions, h as OperationResponse, f as OperationResult, i as OperationRoute, S as ServerUrl, g as getServerUrl, r as resolveOperation } from './chunks/CjU0376e.js';
-export { OpenAPIReference, OpenAPIReferenceDecoded, OpenAPIReferencePath, OpenAPIReferenceResolved, OpenAPIResolved, isReferenceObject, resolveDocument, resolveReference } from './openapi.js';
-export { FormDataLike, fetch, handleResponse, handleResponseStreamJson, isFormDataLike, isObjectLike, parseRequestBody, parseRequestHeaders, parseRequestParameters, parseRequestQuery, parseRequestUrl, toFormData } from './utils.js';
-export { a as FetchHeaders, F as FetchMethod, b as FetchOptions, R as RequestContext, c as RequestOptions, d as SearchArrayFormat, S as SearchParamsObject, T as ToSearchParamsOptions, p as parseRequest, r as request, t as toSearchParams } from './chunks/B92aAMq0.js';
+import '@unshared/functions';
 import '@unshared/functions/attempt';
+import './chunks/mHfUAX_g.js';
 import '@unshared/types';
+import './chunks/CO11DuYE.js';
 import 'openapi-types';
-import '@unshared/functions/awaitable';
+import './websocket.js';

package/dist/index.js

@@ -3,38 +3,20 @@ import { createService } from "./createService.js";
 import { HttpHeader } from "./HttpHeaders.js";
 import { HttpMethod } from "./HttpMethods.js";
 import { HttpStatusCode } from "./HttpStatusCodes.js";
-import { isReferenceObject, resolveDocument, resolveReference } from "./openapi.js";
-import "./utils.js";
-import { g, r } from "./chunks/Biic1J5b.js";
-import { f, h, a, i, b, p, c, d, e, g as g2, j, t, k } from "./chunks/D51s1VII.js";
-import { r as r2 } from "./chunks/lMH6B5BV.js";
 import "@unshared/functions/attempt";
+import "./chunks/BUeqbyph.js";
+import "./chunks/0ZzUT3m_.js";
 import "@unshared/functions/awaitable";
+import "./chunks/DJJsADWD.js";
+import "./chunks/6IxvRpmY.js";
+import "@unshared/functions";
+import "./chunks/Biic1J5b.js";
 export {
   Client,
   HttpHeader,
   HttpMethod,
   HttpStatusCode,
   createClient,
-  createService,
-  f as fetch,
-  g as getServerUrl,
-  h as handleResponse,
-  a as handleResponseStreamJson,
-  i as isFormDataLike,
-  b as isObjectLike,
-  isReferenceObject,
-  p as parseRequest,
-  c as parseRequestBody,
-  d as parseRequestHeaders,
-  e as parseRequestParameters,
-  g2 as parseRequestQuery,
-  j as parseRequestUrl,
-  r2 as request,
-  resolveDocument,
-  r as resolveOperation,
-  resolveReference,
-  t as toFormData,
-  k as toSearchParams
+  createService
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}

package/dist/openapi.d.ts

@@ -1,7 +1,7 @@
-export { k as OpenAPIRoutes, O as OpenAPIV2, a as OpenAPIV3, c as Operation, d as OperationById, j as OperationByRoute, b as OperationId, e as OperationOptions, h as OperationResponse, f as OperationResult, i as OperationRoute, S as ServerUrl, g as getServerUrl, r as resolveOperation } from './chunks/CjU0376e.js';
+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';
 import { StringReplace, WriteableDeep, StringJoin, Substract } from '@unshared/types';
-import './chunks/B92aAMq0.js';
+import './chunks/CO11DuYE.js';
 import './HttpHeaders.js';
 import './HttpMethods.js';
 

package/dist/utils.cjs

@@ -1,5 +1,5 @@
 "use strict";
-var handleResponse = require("./chunks/CfKxYeRr.cjs"), request = require("./chunks/iA98-4f5.cjs");
+var handleResponse = require("./chunks/Cayg8606.cjs"), parseRequestQuery = require("./chunks/CYmaYL5B.cjs"), request = require("./chunks/Du_W5H6e.cjs");
 require("@unshared/functions/awaitable");
 exports.fetch = handleResponse.fetch;
 exports.handleResponse = handleResponse.handleResponse;
@@ -9,10 +9,10 @@ exports.isObjectLike = handleResponse.isObjectLike;
 exports.parseRequest = handleResponse.parseRequest;
 exports.parseRequestBody = handleResponse.parseRequestBody;
 exports.parseRequestHeaders = handleResponse.parseRequestHeaders;
-exports.parseRequestParameters = handleResponse.parseRequestParameters;
-exports.parseRequestQuery = handleResponse.parseRequestQuery;
 exports.parseRequestUrl = handleResponse.parseRequestUrl;
 exports.toFormData = handleResponse.toFormData;
-exports.toSearchParams = handleResponse.toSearchParams;
+exports.parseRequestParameters = parseRequestQuery.parseRequestParameters;
+exports.parseRequestQuery = parseRequestQuery.parseRequestQuery;
+exports.toSearchParams = parseRequestQuery.toSearchParams;
 exports.request = request.request;
 //# sourceMappingURL=utils.cjs.map

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { b as FetchOptions, c as RequestOptions, R as RequestContext } from './chunks/B92aAMq0.js';
-export { a as FetchHeaders, F as FetchMethod, d as SearchArrayFormat, S as SearchParamsObject, T as ToSearchParamsOptions, p as parseRequest, r as request, t as toSearchParams } from './chunks/B92aAMq0.js';
+import { a as FetchOptions, R as RequestOptions, b as RequestContext } from './chunks/CO11DuYE.js';
+export { c as FetchHeaders, F as FetchMethod, d as SearchArrayFormat, S as SearchParamsObject, T as ToSearchParamsOptions, p as parseRequest, r as request, t as toSearchParams } from './chunks/CO11DuYE.js';
 import { Awaitable } from '@unshared/functions/awaitable';
 import { ObjectLike } from '@unshared/types';
 import './HttpHeaders.js';

package/dist/utils.js

@@ -1,5 +1,6 @@
-import { f, h, a, i, b, p, c, d, e, g, j, t, k } from "./chunks/D51s1VII.js";
-import { r } from "./chunks/lMH6B5BV.js";
+import { f, h, a, i, b, p, c, d, e, t } from "./chunks/BUeqbyph.js";
+import { p as p2, a as a2, t as t2 } from "./chunks/0ZzUT3m_.js";
+import { r } from "./chunks/DJJsADWD.js";
 import "@unshared/functions/awaitable";
 export {
   f as fetch,
@@ -10,11 +11,11 @@ export {
   p as parseRequest,
   c as parseRequestBody,
   d as parseRequestHeaders,
-  e as parseRequestParameters,
-  g as parseRequestQuery,
-  j as parseRequestUrl,
+  p2 as parseRequestParameters,
+  a2 as parseRequestQuery,
+  e as parseRequestUrl,
   r as request,
   t as toFormData,
-  k as toSearchParams
+  t2 as toSearchParams
 };
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}
+{"version":3,"file":"utils.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/websocket.cjs

@@ -0,0 +1,8 @@
+"use strict";
+var connect = require("./chunks/BMbsYNBd.cjs");
+require("@unshared/functions");
+require("./chunks/CYmaYL5B.cjs");
+exports.WebSocketChannel = connect.WebSocketChannel;
+exports.connect = connect.connect;
+exports.parseConnectOptions = connect.parseConnectOptions;
+//# sourceMappingURL=websocket.cjs.map

package/dist/websocket.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}

package/dist/websocket.d.ts

@@ -0,0 +1,143 @@
+import { Awaitable } from '@unshared/functions';
+import { ObjectLike, Loose, UnionMerge } from '@unshared/types';
+
+/** The protocols to use for the connection. */
+type ConnectProtocol = 'WS' | 'WSS';
+/** Options to pass to the `createChannel` function. */
+interface ConnectOptions<BaseUrl extends string = string, Query extends ObjectLike = ObjectLike, Parameters extends ObjectLike = ObjectLike, ClientData extends ObjectLike = any, ServerData extends ObjectLike = any> {
+    /** The protocol to use when connecting to the server. */
+    protocol?: Lowercase<ConnectProtocol> | Uppercase<ConnectProtocol>;
+    /** The base URL to connect to. */
+    baseUrl?: BaseUrl;
+    /**
+     * The path parameters to use when connecting to the server. These parameters will be used to
+     * fill in the path parameters of the connection URL.
+     *
+     * @example { id: 1 }
+     */
+    parameters?: Parameters;
+    /**
+     * The query parameters to use when connecting to the server. These parameters will be used to
+     * fill in the query parameters of the connection URL.
+     *
+     * @example { limit: 10, offset: 0 }
+     */
+    query?: Loose<Query>;
+    /**
+     * The data to send when creating the connection. Namely, the path parameters
+     * to use when connecting to the server.
+     *
+     * @example
+     *
+     * // Create a new connection to `http://localhost:8080/users/1`.
+     * connect('GET /users/:id', {
+     *   data: { id: 1 },
+     *   baseUrl: 'http://localhost:8080'
+     * })
+     */
+    data?: UnionMerge<Loose<Query> | Parameters>;
+    /**
+     * The payload to send when creating the connection. Namely, the initial message
+     * to send to the server when the connection is established.
+     */
+    initialPayload?: Loose<ClientData>;
+    /**
+     * Weather to reconnect the connection when it is closed unexpectedly. If `true`,
+     * the connection will automatically reconnect when it is closed. If `false`, the
+     * connection will not reconnect when it is closed.
+     *
+     * @default false
+     */
+    autoReconnect?: boolean;
+    /**
+     * The delay in milliseconds to wait before reconnecting the connection. This delay
+     * will be used to wait before reconnecting the connection after it is closed.
+     *
+     * @default 0
+     */
+    reconnectDelay?: number;
+    /**
+     * The maximum number of times to reconnect the connection before giving up. This
+     * number will be used to determine when to stop trying to reconnect the connection.
+     *
+     * @default 3
+     */
+    reconnectLimit?: number;
+    /**
+     * The function to call when the connection is opened. This function will be called
+     * when the connection is successfully opened or reconnected.
+     */
+    onOpen?: (event: Event) => void;
+    /**
+     * The function to call when the connection is closed with an error. This function will
+     * be called when the connection is closed unexpectedly with an error.
+     */
+    onError?: (event: Event) => void;
+    /**
+     * The function to call when the connection is closed. This function will be called
+     * when the connection is closed unexpectedly or when the connection is closed manually.
+     */
+    onClose?: (event: CloseEvent) => void;
+    /**
+     * The function to call when a message is received from the server. This function will
+     * be called when a message is received from the server.
+     */
+    onMessage?: (data: ServerData) => void;
+}
+interface WebSocketParameters {
+    url: URL;
+    protocol?: 'ws' | 'wss';
+}
+declare function parseConnectOptions(channel: string, options: ConnectOptions): WebSocketParameters;
+
+type RemoveListener = () => void;
+type ClientData<T extends ConnectOptions> = T extends ConnectOptions<any, any, any, infer R, any> ? R : any;
+type ServerData<T extends ConnectOptions> = T extends ConnectOptions<any, any, any, any, infer R> ? R : any;
+declare class WebSocketChannel<T extends ConnectOptions = ConnectOptions> {
+    channel: string;
+    options: T;
+    constructor(channel: string, options: T);
+    /** The WebSocket connection to the server. */
+    webSocket: undefined | WebSocket;
+    /**
+     * Open a new WebSocket connection to the server. The connection will be opened with the given
+     * URL and protocols. If the connection is already open, the connection will be closed before
+     * opening a new connection. Also add the event listeners that were passed in the options.
+     *
+     * @returns The WebSocket connection.
+     */
+    open(): Promise<this>;
+    /**
+     * Send a payload to the server. The payload will be serialized to JSON before sending.
+     *
+     * @param payload The data to send to the server.
+     */
+    send(payload: ClientData<T>): void;
+    /**
+     * Listen for events from the server. The event will be deserialized from JSON before calling the callback.
+     *
+     * @param event The event to listen for.
+     * @param callback The callback to call when the event is received.
+     * @returns A function to remove the event listener.
+     */
+    on(event: 'message', callback: (data: ServerData<T>) => void, options?: AddEventListenerOptions): RemoveListener;
+    on(event: 'close', callback: (event: CloseEvent) => void, options?: AddEventListenerOptions): RemoveListener;
+    on(event: 'error', callback: (event: Event) => void, options?: AddEventListenerOptions): RemoveListener;
+    on(event: 'open', callback: (event: Event) => void, options?: AddEventListenerOptions): RemoveListener;
+    /**
+     * Close the WebSocket connection to the server. The connection will not be able to send or receive
+     * messages after it is closed.
+     */
+    close(): Promise<void>;
+}
+/**
+ * Create a new WebSocket connection to the server with the given path. The connection will
+ * automatically reconnect if the connection is closed unexpectedly.
+ *
+ * @param route The name of the route to connect to.
+ * @param options The options to pass to the connection.
+ * @returns The WebSocket connection.
+ */
+declare function connect(route: string, options: ConnectOptions): Awaitable<WebSocketChannel, WebSocketChannel>;
+
+export { type ConnectOptions, type ConnectProtocol, WebSocketChannel, type WebSocketParameters, connect, parseConnectOptions };

package/dist/websocket.js

@@ -0,0 +1,9 @@
+import { W, c, p } from "./chunks/6IxvRpmY.js";
+import "@unshared/functions";
+import "./chunks/0ZzUT3m_.js";
+export {
+  W as WebSocketChannel,
+  c as connect,
+  p as parseConnectOptions
+};
+//# sourceMappingURL=websocket.js.map

package/dist/websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unshared/client",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "license": "MIT",
   "sideEffects": false,
   "author": "Stanley Horwood <stanley@hsjm.io>",
@@ -51,6 +51,11 @@
       "types": "./dist/utils.d.ts",
       "import": "./dist/utils.js"
     },
+    "./websocket": {
+      "require": "./dist/websocket.cjs",
+      "types": "./dist/websocket.d.ts",
+      "import": "./dist/websocket.js"
+    },
     ".": {
       "require": "./dist/index.cjs",
       "types": "./dist/index.d.ts",
@@ -63,12 +68,12 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@unshared/functions": "0.3.0",
-    "@unshared/types": "0.3.0",
+    "@unshared/functions": "0.3.2",
+    "@unshared/types": "0.3.2",
     "openapi-types": "12.1.3"
   },
   "devDependencies": {
-    "@unshared/scripts": "0.3.0"
+    "@unshared/scripts": "0.3.2"
   },
   "scripts": {
     "build:httpMethods": "tsx ./scripts/buildHttpMethods.ts",