@unshared/client 0.2.3 → 0.3.0

package/dist/createClient.cjs

@@ -1,24 +1,87 @@
 "use strict";
-var fetch = require("./fetch.cjs"), getOperationById = require("./chunks/xRZPkxch.cjs"), handleResponse = require("./chunks/Cx8m1YzL.cjs");
-require("./chunks/D8Tsm7xC.cjs");
+var attempt = require("@unshared/functions/attempt"), handleResponse = require("./chunks/CfKxYeRr.cjs"), request = require("./chunks/iA98-4f5.cjs");
 require("@unshared/functions/awaitable");
-function createClient(documentOrUrl, initialOptions = {}) {
-  const specifications = typeof documentOrUrl == "string" ? void 0 : documentOrUrl;
-  typeof documentOrUrl == "string" && (initialOptions.baseUrl = documentOrUrl);
-  async function fetchByOperationId(operationId, options) {
-    if (!specifications) throw new Error("No OpenAPI specification provided.");
-    const operation = getOperationById.getOperationById(specifications, operationId);
-    if (!operation) throw new Error(`Operation ID "${operationId}" not found.`);
-    const { method, path, responses = {} } = operation, fetchOptions = { method, baseUrl: getOperationById.getBaseUrl(specifications), ...initialOptions, ...options }, response = await fetch.fetch(path, fetchOptions);
-    if (response.ok) return handleResponse.handleResponse(response, fetchOptions);
-    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);
+class Client {
+  /**
+   * Create a new client for the application.
+   *
+   * @param initialOptions The options to pass to the client.
+   * @example new Client({ baseUrl: 'https://api.example.com' })
+   */
+  constructor(initialOptions = {}) {
+    this.initialOptions = initialOptions;
   }
-  return new Proxy({}, {
-    get(_, property) {
-      return property === "fetch" ? (route, options) => fetch.fetch(route, { ...initialOptions, ...options }) : (options) => fetchByOperationId(property, 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.
+   */
+  async fetch(route, options) {
+    return await handleResponse.fetch(route, { ...this.initialOptions, ...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' } })
+   */
+  async request(route, options) {
+    return await request.request(route, { ...this.initialOptions, ...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 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)
+   */
+  async requestAttempt(name, options) {
+    return await attempt.attempt(() => this.request(name, 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 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 })
+  // }
+}
+function createClient(options) {
+  return new Client(options);
 }
+exports.Client = Client;
 exports.createClient = createClient;
 //# sourceMappingURL=createClient.cjs.map

package/dist/createClient.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createClient.cjs","sources":["../createClient.ts"],"sourcesContent":["import type { MaybeLiteral, Override, Pretty } from '@unshared/types'\nimport type { OpenAPI, OpenAPIV2 as V2, OpenAPIV3 as V3, OpenAPIV3_1 as V3_1 } from 'openapi-types'\nimport type { OpenAPIV2, OpenAPIV3 } from './openapi/index'\nimport type { RequestHooks } from './utils/handleResponse'\nimport type { RequestMethod, RequestOptions } from './utils/parseRequest'\nimport { fetch } from './fetch'\nimport { getBaseUrl } from './openapi/getBaseUrl'\nimport { getOperationById } from './openapi/getOperationById'\nimport { handleResponse } from './utils/handleResponse'\n\ntype ClientBaseUrl<T> =\n  MaybeLiteral<\n    T extends V2.Document ? OpenAPIV2.ServerUrl<T>\n      : T extends V3.Document ? OpenAPIV3.ServerUrl<T>\n        : T extends V3_1.Document ? OpenAPIV3.ServerUrl<T>\n          : string\n  >\n\ntype ClientFetch<T> =\n  T extends V2.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV2.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV2.Response<OpenAPIV2.OperationByRoute<T, P>>>\n    : T extends V3.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV3.Response<OpenAPIV2.OperationByRoute<T, P>>>\n      : T extends V3_1.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV3.Response<OpenAPIV2.OperationByRoute<T, P>>>\n        : typeof globalThis.fetch\n\ntype ClientFetchOperation<T, U extends OpenAPIV2.OperationId<T>> =\n  T extends V2.Document ? (options: OpenAPIV2.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV2.ResponseBody<OpenAPIV2.OperationById<T, U>>>\n    : T extends V3.Document ? (options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV3.ResponseBody<OpenAPIV2.OperationById<T, U>>>\n      : T extends V3_1.Document ? (options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV3.ResponseBody<OpenAPIV2.OperationById<T, U>>>\n        : (options: RequestOptions) => Promise<Response>\n\nexport type Client<T = OpenAPI.Document> =\n  Pretty<\n    & { [K in OpenAPIV2.OperationId<T>]: ClientFetchOperation<T, K> }\n    & { fetch: ClientFetch<T> }\n  >\n\nexport type ClientOptions<T = any> = Override<RequestHooks & RequestOptions, {\n  baseUrl?: ClientBaseUrl<T>\n\n  /**\n   * The headers to include in every request made by the client.\n   *\n   * @example { 'Authorization': 'Bearer ...' }\n   */\n  headers?: T extends V3.Document\n    ? OpenAPIV3.ServerHeaders<T>\n    : 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 * const client = createClient(document)\n * await client.fetch({ ... })\n */\n// @ts-expect-error: `ClientOptions` is not assignable to `ClientOptions<T>`.\nexport function createClient<T extends OpenAPI.Document>(document: Readonly<T>, initialOptions?: ClientOptions<T>): Client<T>\nexport function createClient<T extends OpenAPI.Document>(url: ClientBaseUrl<T>, initialOptions?: ClientOptions<T>): Client<T>\nexport function createClient(documentOrUrl: Readonly<OpenAPI.Document> | string, initialOptions: ClientOptions = {}): Client {\n  const specifications = typeof documentOrUrl === 'string' ? undefined : documentOrUrl\n  if (typeof documentOrUrl === 'string') initialOptions.baseUrl = documentOrUrl\n\n  async function fetchByOperationId(operationId: string, options: ClientOptions<any>) {\n    if (!specifications) throw new Error('No OpenAPI specification provided.')\n    const operation = getOperationById(specifications, operationId) as { method: RequestMethod; path: string } & OpenAPI.Operation\n    if (!operation) throw new Error(`Operation ID \"${operationId}\" not found.`)\n    const { method, path, responses = {} } = operation\n    const fetchOptions = { method, baseUrl: getBaseUrl(specifications), ...initialOptions, ...options }\n    const response = await fetch(path, fetchOptions)\n\n    // --- Return the JSON response if successful.\n    if (response.ok) return handleResponse(response, fetchOptions)\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  return new Proxy({}, {\n    get(_, property: string) {\n      if (property === 'fetch') return (route: string, options: RequestOptions) => fetch(route, ({ ...initialOptions, ...options }))\n      return (options: Record<string, unknown>) => fetchByOperationId(property, options)\n    },\n  }) as unknown as Client\n}\n"],"names":["getOperationById","getBaseUrl","fetch","handleResponse"],"mappings":";;;;AA8DO,SAAS,aAAa,eAAoD,iBAAgC,IAAY;AAC3H,QAAM,iBAAiB,OAAO,iBAAkB,WAAW,SAAY;AACnE,SAAO,iBAAkB,aAAU,eAAe,UAAU;AAEjD,iBAAA,mBAAmB,aAAqB,SAA6B;AAClF,QAAI,CAAC,eAAsB,OAAA,IAAI,MAAM,oCAAoC;AACnE,UAAA,YAAYA,iBAAAA,iBAAiB,gBAAgB,WAAW;AAC9D,QAAI,CAAC,UAAW,OAAM,IAAI,MAAM,iBAAiB,WAAW,cAAc;AACpE,UAAA,EAAE,QAAQ,MAAM,YAAY,CAAA,EAAO,IAAA,WACnC,eAAe,EAAE,QAAQ,SAASC,4BAAW,cAAc,GAAG,GAAG,gBAAgB,GAAG,QAAA,GACpF,WAAW,MAAMC,MAAAA,MAAM,MAAM,YAAY;AAG/C,QAAI,SAAS,GAAW,QAAAC,eAAAA,eAAe,UAAU,YAAY;AAGvD,UAAA,SAAS,SAAS,OAAO,SAAS;AACxC,UAAI,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,EAAA;AAG9B,SAAA,IAAI,MAAM,IAAI;AAAA,IACnB,IAAI,GAAG,UAAkB;AACvB,aAAI,aAAa,UAAgB,CAAC,OAAe,YAA4BD,MAAA,MAAM,OAAQ,EAAE,GAAG,gBAAgB,GAAG,SAAU,IACtH,CAAC,YAAqC,mBAAmB,UAAU,OAAO;AAAA,IAAA;AAAA,EACnF,CACD;AACH;;"}
+{"version":3,"file":"createClient.cjs","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":["fetch","request","attempt"],"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,MAAMA,qBAAM,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,MAAMC,gBAAQ,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,MAAMC,QAAQ,QAAA,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;;;"}

package/dist/createClient.d.ts

@@ -1,38 +1,102 @@
-import { Pretty, Override, MaybeLiteral } from '@unshared/types';
-import { OpenAPI, OpenAPIV3, OpenAPIV2 as OpenAPIV2$1, OpenAPIV3_1 } from 'openapi-types';
-import { O as OpenAPIV2, a as OpenAPIV3$1 } from './chunks/B2OrSen1.js';
-import { R as RequestHooks } from './chunks/r8pYO6Hx.js';
-import { c as RequestOptions } from './chunks/DZp6zyqV.js';
-import './chunks/8BFCFxqa.js';
+import { Result } from '@unshared/functions/attempt';
+import { ObjectLike } from '@unshared/types';
+import { ServiceOptions } from './createService.js';
+import { k as OpenAPIRoutes } from './chunks/CjU0376e.js';
+import { c as RequestOptions } from './chunks/B92aAMq0.js';
+import 'openapi-types';
+import './HttpHeaders.js';
+import './HttpMethods.js';
 
-type ClientBaseUrl<T> = MaybeLiteral<T extends OpenAPIV2$1.Document ? OpenAPIV2.ServerUrl<T> : T extends OpenAPIV3.Document ? OpenAPIV3$1.ServerUrl<T> : T extends OpenAPIV3_1.Document ? OpenAPIV3$1.ServerUrl<T> : string>;
-type ClientFetch<T> = T extends OpenAPIV2$1.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV2.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV2.Response<OpenAPIV2.OperationByRoute<T, P>>> : T extends OpenAPIV3.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV3$1.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV3$1.Response<OpenAPIV2.OperationByRoute<T, P>>> : T extends OpenAPIV3_1.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV3$1.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV3$1.Response<OpenAPIV2.OperationByRoute<T, P>>> : typeof globalThis.fetch;
-type ClientFetchOperation<T, U extends OpenAPIV2.OperationId<T>> = T extends OpenAPIV2$1.Document ? (options: OpenAPIV2.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV2.ResponseBody<OpenAPIV2.OperationById<T, U>>> : T extends OpenAPIV3.Document ? (options: OpenAPIV3$1.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV3$1.ResponseBody<OpenAPIV2.OperationById<T, U>>> : T extends OpenAPIV3_1.Document ? (options: OpenAPIV3$1.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV3$1.ResponseBody<OpenAPIV2.OperationById<T, U>>> : (options: RequestOptions) => Promise<Response>;
-type Client<T = OpenAPI.Document> = Pretty<{
-    [K in OpenAPIV2.OperationId<T>]: ClientFetchOperation<T, K>;
-} & {
-    fetch: ClientFetch<T>;
-}>;
-type ClientOptions<T = any> = Override<RequestHooks & RequestOptions, {
-    baseUrl?: ClientBaseUrl<T>;
+/** Define the routes that can be fetched from the API and their related options. */
+type ClientRoutes = Record<string, RequestOptions>;
+/** The route name that can be fetched from the API. */
+type Route<T extends ClientRoutes> = T extends Record<infer P extends string, RequestOptions> ? P : string;
+/** The options to pass to the request based on the route name. */
+type Options<T extends ClientRoutes, P extends keyof T> = T extends Record<P, infer R> ? R : RequestOptions;
+/** The data returned from the API based on the route name. */
+type Data<T extends ClientRoutes, P extends keyof T> = Options<T, P> extends RequestOptions<any, any, any, any, any, any, infer R extends ObjectLike, any> ? R : unknown;
+declare class Client<T extends ClientRoutes = ClientRoutes> {
+    private initialOptions;
     /**
-     * The headers to include in every request made by the client.
+     * Create a new client for the application.
      *
-     * @example { 'Authorization': 'Bearer ...' }
+     * @param initialOptions The options to pass to the client.
+     * @example new Client({ baseUrl: 'https://api.example.com' })
      */
-    headers?: T extends OpenAPIV3.Document ? OpenAPIV3$1.ServerHeaders<T> : never;
-}>;
+    constructor(initialOptions?: RequestOptions);
+    /**
+     * 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<P extends Route<T>>(route: P, options?: Options<T, P>): 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
+     * 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<P extends Route<T>>(route: P, options?: Options<T, P>): Promise<Data<T, P>>;
+    /**
+     * 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 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<P extends Route<T>>(name: P, options?: Options<T, P>): Promise<Result<Data<T, P>>>;
+}
 /**
- * Create a new client instance for the given OpenAPI specification.
+ * Create a new type-safe client for the application. The client can be used to fetch data from
+ * the API and connect to the server using WebSockets with the given path.
  *
- * @param document The OpenAPI specification document.
- * @param initialOptions The initial options to use for every request.
- * @returns The client instance.
+ * @param options The options to pass to the client.
+ * @returns The client object with the request method.
  * @example
- * const client = createClient(document)
- * await client.fetch({ ... })
+ * // Create a type-safe client for the application.
+ * const client = createClient<[ModuleUser]>()
+ *
+ * // Fetch the data from the API.
+ * const data = await client.request('GET /api/user/:id', { id: '1' })
+ *
+ * // Use the data from the API.
+ * console.log(data) // { id: '1', name: 'John Doe' }
  */
-declare function createClient<T extends OpenAPI.Document>(document: Readonly<T>, initialOptions?: ClientOptions<T>): Client<T>;
-declare function createClient<T extends OpenAPI.Document>(url: ClientBaseUrl<T>, initialOptions?: ClientOptions<T>): Client<T>;
+declare function createClient<T extends ClientRoutes>(options?: RequestOptions): Client<T>;
+declare function createClient<T extends {
+    swagger: string;
+}>(options?: ServiceOptions<T>): Client<OpenAPIRoutes<T>>;
+declare function createClient<T extends {
+    openapi: string;
+}>(options?: ServiceOptions<T>): Client<OpenAPIRoutes<T>>;
 
-export { type Client, type ClientOptions, createClient };
+export { Client, type ClientRoutes, createClient };

package/dist/createClient.js

@@ -1,27 +1,90 @@
-import { fetch } from "./fetch.js";
-import { a as getOperationById, g as getBaseUrl } from "./chunks/D-WqCFul.js";
-import { h as handleResponse } from "./chunks/CKfJvIQ8.js";
-import "./chunks/B5hc73Po.js";
+import { attempt } from "@unshared/functions/attempt";
+import { f as fetch } from "./chunks/D51s1VII.js";
+import { r as request } from "./chunks/lMH6B5BV.js";
 import "@unshared/functions/awaitable";
-function createClient(documentOrUrl, initialOptions = {}) {
-  const specifications = typeof documentOrUrl == "string" ? void 0 : documentOrUrl;
-  typeof documentOrUrl == "string" && (initialOptions.baseUrl = documentOrUrl);
-  async function fetchByOperationId(operationId, options) {
-    if (!specifications) throw new Error("No OpenAPI specification provided.");
-    const operation = getOperationById(specifications, operationId);
-    if (!operation) throw new Error(`Operation ID "${operationId}" not found.`);
-    const { method, path, responses = {} } = operation, fetchOptions = { method, baseUrl: getBaseUrl(specifications), ...initialOptions, ...options }, response = await fetch(path, fetchOptions);
-    if (response.ok) return handleResponse(response, fetchOptions);
-    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);
+class Client {
+  /**
+   * Create a new client for the application.
+   *
+   * @param initialOptions The options to pass to the client.
+   * @example new Client({ baseUrl: 'https://api.example.com' })
+   */
+  constructor(initialOptions = {}) {
+    this.initialOptions = initialOptions;
   }
-  return new Proxy({}, {
-    get(_, property) {
-      return property === "fetch" ? (route, options) => fetch(route, { ...initialOptions, ...options }) : (options) => fetchByOperationId(property, 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.
+   */
+  async fetch(route, options) {
+    return await fetch(route, { ...this.initialOptions, ...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' } })
+   */
+  async request(route, options) {
+    return await request(route, { ...this.initialOptions, ...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 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)
+   */
+  async requestAttempt(name, options) {
+    return await attempt(() => this.request(name, 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 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 })
+  // }
+}
+function createClient(options) {
+  return new Client(options);
 }
 export {
+  Client,
   createClient
 };
 //# sourceMappingURL=createClient.js.map

package/dist/createClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"createClient.js","sources":["../createClient.ts"],"sourcesContent":["import type { MaybeLiteral, Override, Pretty } from '@unshared/types'\nimport type { OpenAPI, OpenAPIV2 as V2, OpenAPIV3 as V3, OpenAPIV3_1 as V3_1 } from 'openapi-types'\nimport type { OpenAPIV2, OpenAPIV3 } from './openapi/index'\nimport type { RequestHooks } from './utils/handleResponse'\nimport type { RequestMethod, RequestOptions } from './utils/parseRequest'\nimport { fetch } from './fetch'\nimport { getBaseUrl } from './openapi/getBaseUrl'\nimport { getOperationById } from './openapi/getOperationById'\nimport { handleResponse } from './utils/handleResponse'\n\ntype ClientBaseUrl<T> =\n  MaybeLiteral<\n    T extends V2.Document ? OpenAPIV2.ServerUrl<T>\n      : T extends V3.Document ? OpenAPIV3.ServerUrl<T>\n        : T extends V3_1.Document ? OpenAPIV3.ServerUrl<T>\n          : string\n  >\n\ntype ClientFetch<T> =\n  T extends V2.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV2.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV2.Response<OpenAPIV2.OperationByRoute<T, P>>>\n    : T extends V3.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV3.Response<OpenAPIV2.OperationByRoute<T, P>>>\n      : T extends V3_1.Document ? <P extends OpenAPIV2.Route<T>>(name: P, options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationByRoute<T, P>>) => Promise<OpenAPIV3.Response<OpenAPIV2.OperationByRoute<T, P>>>\n        : typeof globalThis.fetch\n\ntype ClientFetchOperation<T, U extends OpenAPIV2.OperationId<T>> =\n  T extends V2.Document ? (options: OpenAPIV2.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV2.ResponseBody<OpenAPIV2.OperationById<T, U>>>\n    : T extends V3.Document ? (options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV3.ResponseBody<OpenAPIV2.OperationById<T, U>>>\n      : T extends V3_1.Document ? (options: OpenAPIV3.RequestInit<T, OpenAPIV2.OperationById<T, U>>) => Promise<OpenAPIV3.ResponseBody<OpenAPIV2.OperationById<T, U>>>\n        : (options: RequestOptions) => Promise<Response>\n\nexport type Client<T = OpenAPI.Document> =\n  Pretty<\n    & { [K in OpenAPIV2.OperationId<T>]: ClientFetchOperation<T, K> }\n    & { fetch: ClientFetch<T> }\n  >\n\nexport type ClientOptions<T = any> = Override<RequestHooks & RequestOptions, {\n  baseUrl?: ClientBaseUrl<T>\n\n  /**\n   * The headers to include in every request made by the client.\n   *\n   * @example { 'Authorization': 'Bearer ...' }\n   */\n  headers?: T extends V3.Document\n    ? OpenAPIV3.ServerHeaders<T>\n    : 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 * const client = createClient(document)\n * await client.fetch({ ... })\n */\n// @ts-expect-error: `ClientOptions` is not assignable to `ClientOptions<T>`.\nexport function createClient<T extends OpenAPI.Document>(document: Readonly<T>, initialOptions?: ClientOptions<T>): Client<T>\nexport function createClient<T extends OpenAPI.Document>(url: ClientBaseUrl<T>, initialOptions?: ClientOptions<T>): Client<T>\nexport function createClient(documentOrUrl: Readonly<OpenAPI.Document> | string, initialOptions: ClientOptions = {}): Client {\n  const specifications = typeof documentOrUrl === 'string' ? undefined : documentOrUrl\n  if (typeof documentOrUrl === 'string') initialOptions.baseUrl = documentOrUrl\n\n  async function fetchByOperationId(operationId: string, options: ClientOptions<any>) {\n    if (!specifications) throw new Error('No OpenAPI specification provided.')\n    const operation = getOperationById(specifications, operationId) as { method: RequestMethod; path: string } & OpenAPI.Operation\n    if (!operation) throw new Error(`Operation ID \"${operationId}\" not found.`)\n    const { method, path, responses = {} } = operation\n    const fetchOptions = { method, baseUrl: getBaseUrl(specifications), ...initialOptions, ...options }\n    const response = await fetch(path, fetchOptions)\n\n    // --- Return the JSON response if successful.\n    if (response.ok) return handleResponse(response, fetchOptions)\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  return new Proxy({}, {\n    get(_, property: string) {\n      if (property === 'fetch') return (route: string, options: RequestOptions) => fetch(route, ({ ...initialOptions, ...options }))\n      return (options: Record<string, unknown>) => fetchByOperationId(property, options)\n    },\n  }) as unknown as Client\n}\n"],"names":[],"mappings":";;;;;AA8DO,SAAS,aAAa,eAAoD,iBAAgC,IAAY;AAC3H,QAAM,iBAAiB,OAAO,iBAAkB,WAAW,SAAY;AACnE,SAAO,iBAAkB,aAAU,eAAe,UAAU;AAEjD,iBAAA,mBAAmB,aAAqB,SAA6B;AAClF,QAAI,CAAC,eAAsB,OAAA,IAAI,MAAM,oCAAoC;AACnE,UAAA,YAAY,iBAAiB,gBAAgB,WAAW;AAC9D,QAAI,CAAC,UAAW,OAAM,IAAI,MAAM,iBAAiB,WAAW,cAAc;AACpE,UAAA,EAAE,QAAQ,MAAM,YAAY,CAAA,EAAO,IAAA,WACnC,eAAe,EAAE,QAAQ,SAAS,WAAW,cAAc,GAAG,GAAG,gBAAgB,GAAG,QAAA,GACpF,WAAW,MAAM,MAAM,MAAM,YAAY;AAG/C,QAAI,SAAS,GAAW,QAAA,eAAe,UAAU,YAAY;AAGvD,UAAA,SAAS,SAAS,OAAO,SAAS;AACxC,UAAI,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,EAAA;AAG9B,SAAA,IAAI,MAAM,IAAI;AAAA,IACnB,IAAI,GAAG,UAAkB;AACvB,aAAI,aAAa,UAAgB,CAAC,OAAe,YAA4B,MAAM,OAAQ,EAAE,GAAG,gBAAgB,GAAG,SAAU,IACtH,CAAC,YAAqC,mBAAmB,UAAU,OAAO;AAAA,IAAA;AAAA,EACnF,CACD;AACH;"}
+{"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;"}

package/dist/createService.cjs

@@ -0,0 +1,17 @@
+"use strict";
+var resolveOperation = require("./chunks/CtW2aMuA.cjs"), handleResponse = require("./chunks/CfKxYeRr.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 });
+        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);
+      };
+    }
+  });
+}
+exports.createService = createService;
+//# sourceMappingURL=createService.cjs.map

package/dist/createService.cjs.map

@@ -0,0 +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;;"}

package/dist/createService.d.ts

@@ -0,0 +1,38 @@
+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 'openapi-types';
+import './HttpHeaders.js';
+import './HttpMethods.js';
+
+/** A service instance for the given OpenAPI specification. */
+type Service<T> = {
+    [K in OperationId<T>]: OperationById<T, K> extends infer U extends OperationById<T, K> ? (data: OperationOptions<T, U>['data'], options?: OperationOptions<T, U>) => Promise<OperationResult<T, U>> : never;
+};
+/** The options to pass to the service client. */
+interface ServiceOptions<T = any> extends RequestOptions {
+    baseUrl?: MaybeLiteral<ServerUrl<T>>;
+    headers?: T extends {
+        openapi: string;
+    } ? OpenAPIV3.ServerHeaders<T> : never;
+}
+/**
+ * Create a new client instance for the given OpenAPI specification.
+ *
+ * @param document The OpenAPI specification document.
+ * @param initialOptions The initial options to use for every request.
+ * @returns The client instance.
+ * @example
+ *
+ * // Import the Giphy OpenAPI specification.
+ * import Giphy from './giphy.openapi.json'
+ *
+ * // Create a new service instance for the Giphy API.
+ * const service = createService(Giphy, { headers: { 'Bearer' } })
+ *
+ * // Request the "searchGifs" operation from the Giphy API.
+ * await service.getGifs({ limit: 10, offset: 0, q: 'cats' }) // => { data: [...] }
+ */
+declare function createService<T extends object>(document: Readonly<T>, initialOptions?: ServiceOptions<T>): Service<T>;
+
+export { type Service, type ServiceOptions, createService };

package/dist/createService.js

@@ -0,0 +1,19 @@
+import { g as getServerUrl, r as resolveOperation } from "./chunks/Biic1J5b.js";
+import { f as fetch, h as handleResponse } from "./chunks/D51s1VII.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 });
+        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);
+      };
+    }
+  });
+}
+export {
+  createService
+};
+//# sourceMappingURL=createService.js.map

package/dist/createService.js.map

@@ -0,0 +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;"}