@unshared/client 0.2.3 → 0.3.1

package/dist/openapi.cjs

@@ -1,16 +1,5 @@
 "use strict";
-var getOperationById = require("./chunks/xRZPkxch.cjs");
-function getOperationByRoute(specification, name) {
-  if (!specification || typeof specification != "object" || specification === null || !("paths" in specification) || typeof specification.paths != "object" || specification.paths === null)
-    throw new Error("Missing paths object in the OpenAPI specification.");
-  const match = /^(get|post|put|patch|delete|head|options) (\/.+)$/i.exec(name);
-  if (!match) throw new Error("Could not resolve the path and method from the route name.");
-  const [, routeMethod, routePath] = match, method = routeMethod.toLowerCase(), path = specification.paths[routePath];
-  if (!path) throw new Error(`Route "${name}" not found in specification.`);
-  if (typeof path != "object" || path === null) throw new Error("Invalid path object in the OpenAPI specification.");
-  if (!(method in path)) throw new Error(`Method "${method}" not found in path "${routePath}".`);
-  return { ...path[method], method, path: routePath };
-}
+var resolveOperation = require("./chunks/CtW2aMuA.cjs");
 function isReferenceObject(value) {
   return typeof value == "object" && value !== null && "$ref" in value && typeof value.$ref == "string";
 }
@@ -38,9 +27,8 @@ function resolveDocument(value, document = value) {
     }
   });
 }
-exports.getBaseUrl = getOperationById.getBaseUrl;
-exports.getOperationById = getOperationById.getOperationById;
-exports.getOperationByRoute = getOperationByRoute;
+exports.getServerUrl = resolveOperation.getServerUrl;
+exports.resolveOperation = resolveOperation.resolveOperation;
 exports.isReferenceObject = isReferenceObject;
 exports.resolveDocument = resolveDocument;
 exports.resolveReference = resolveReference;

package/dist/openapi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.cjs","sources":["../openapi/getOperationByRoute.ts","../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["import type { OpenAPI } from 'openapi-types'\nimport type { OpenAPIV2 } from './OpenApiV2'\n\n/**\n * Given an OpenAPI specification, find a route by its name.\n *\n * @param specification The OpenAPI specification.\n * @param name The name of the route to resolve.\n * @returns The resolved route.\n * @example getOperationByRoute(specification, 'GET /users') // { method: 'get', path: '/users', ... }\n */\nexport function getOperationByRoute<\n  T extends object,\n  U extends OpenAPIV2.Route<T>,\n>(\n  specification: Readonly<T>,\n  name: U,\n): OpenAPIV2.OperationByRoute<T, U> {\n\n  // --- Assert the specification has a paths object.\n  if (!specification\n    || typeof specification !== 'object'\n    || specification === null\n    || 'paths' in specification === false\n    || typeof specification.paths !== 'object'\n    || specification.paths === null)\n    throw new Error('Missing paths object in the OpenAPI specification.')\n\n  // --- Extract the path and method from the name.\n  const match = /^(get|post|put|patch|delete|head|options) (\\/.+)$/i.exec(name)\n  if (!match) throw new Error('Could not resolve the path and method from the route name.')\n  const [, routeMethod, routePath] = match\n  const method = routeMethod.toLowerCase()\n\n  // --- Search for the route in the specification's paths.\n  const paths = specification.paths as Record<string, OpenAPI.Operation>\n  const path = paths[routePath]\n  if (!path) throw new Error(`Route \"${name}\" not found in specification.`)\n  if (typeof path !== 'object' || path === null) throw new Error('Invalid path object in the OpenAPI specification.')\n  if (method in path === false) throw new Error(`Method \"${method}\" not found in path \"${routePath}\".`)\n  const operation = path[method as keyof typeof path] as OpenAPI.Operation\n  return { ...operation, method, path: routePath } as OpenAPIV2.OperationByRoute<T, U>\n}\n","import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";;AAWgB,SAAA,oBAId,eACA,MACkC;AAGlC,MAAI,CAAC,iBACA,OAAO,iBAAkB,YACzB,kBAAkB,QAClB,EAAW,WAAA,kBACX,OAAO,cAAc,SAAU,YAC/B,cAAc,UAAU;AACrB,UAAA,IAAI,MAAM,oDAAoD;AAGhE,QAAA,QAAQ,qDAAqD,KAAK,IAAI;AAC5E,MAAI,CAAC,MAAa,OAAA,IAAI,MAAM,4DAA4D;AACxF,QAAM,GAAG,aAAa,SAAS,IAAI,OAC7B,SAAS,YAAY,YAAY,GAIjC,OADQ,cAAc,MACT,SAAS;AAC5B,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,UAAU,IAAI,+BAA+B;AACpE,MAAA,OAAO,QAAS,YAAY,SAAS,KAAY,OAAA,IAAI,MAAM,mDAAmD;AAC9G,MAAA,EAAA,UAAU,MAAsB,OAAA,IAAI,MAAM,WAAW,MAAM,wBAAwB,SAAS,IAAI;AAEpG,SAAO,EAAE,GADS,KAAK,MAA2B,GAC3B,QAAQ,MAAM,UAAU;AACjD;AC5BO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;;;;;;;"}
+{"version":3,"file":"openapi.cjs","sources":["../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";;AAcO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;;;;;;"}

package/dist/openapi.d.ts

@@ -1,39 +1,11 @@
-import { OpenAPI, OpenAPIV2 as OpenAPIV2$1, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
-import { O as OpenAPIV2 } from './chunks/B2OrSen1.js';
-export { a as OpenAPIV3 } from './chunks/B2OrSen1.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/DOZHjge0.js';
+import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
 import { StringReplace, WriteableDeep, StringJoin, Substract } from '@unshared/types';
-import './chunks/8BFCFxqa.js';
+import './chunks/CO11DuYE.js';
+import './HttpHeaders.js';
+import './HttpMethods.js';
 
-/**
- * Given an OpenAPI specification, get the first base URL.
- *
- * @param specification The OpenAPI specification.
- * @returns The first base URL.
- * @example getBaseUrl(specification) // 'https://api.example.com/v1'
- */
-declare function getBaseUrl(specification: OpenAPI.Document): string;
-
-/**
- * Given an OpenAPI specification, find an operation by its operationId.
- *
- * @param specification The OpenAPI specification.
- * @param operationId The operationId of the operation to resolve.
- * @returns The resolved operation.
- * @example openapiGetOperation(specification, 'getUser') // { method: 'get', path: '/users/{username}', ... }
- */
-declare function getOperationById<T, U extends OpenAPIV2.OperationId<T>>(specification: T, operationId: U): OpenAPIV2.OperationById<T, U>;
-
-/**
- * Given an OpenAPI specification, find a route by its name.
- *
- * @param specification The OpenAPI specification.
- * @param name The name of the route to resolve.
- * @returns The resolved route.
- * @example getOperationByRoute(specification, 'GET /users') // { method: 'get', path: '/users', ... }
- */
-declare function getOperationByRoute<T extends object, U extends OpenAPIV2.Route<T>>(specification: Readonly<T>, name: U): OpenAPIV2.OperationByRoute<T, U>;
-
-type OpenAPIReference = OpenAPIV2$1.ReferenceObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
+type OpenAPIReference = OpenAPIV2.ReferenceObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
 /**
  * Check if a value is an {@linkcode OpenAPIReference}.
  *
@@ -120,4 +92,4 @@ type OpenAPIResolved<T, D = T, N extends number = 8> = N extends 0 ? T : T exten
 declare function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>;
 declare function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>;
 
-export { type OpenAPIReference, type OpenAPIReferenceDecoded, type OpenAPIReferencePath, type OpenAPIReferenceResolved, type OpenAPIResolved, OpenAPIV2, getBaseUrl, getOperationById, getOperationByRoute, isReferenceObject, resolveDocument, resolveReference };
+export { type OpenAPIReference, type OpenAPIReferenceDecoded, type OpenAPIReferencePath, type OpenAPIReferenceResolved, type OpenAPIResolved, isReferenceObject, resolveDocument, resolveReference };

package/dist/openapi.js

@@ -1,15 +1,4 @@
-import { g, a } from "./chunks/D-WqCFul.js";
-function getOperationByRoute(specification, name) {
-  if (!specification || typeof specification != "object" || specification === null || !("paths" in specification) || typeof specification.paths != "object" || specification.paths === null)
-    throw new Error("Missing paths object in the OpenAPI specification.");
-  const match = /^(get|post|put|patch|delete|head|options) (\/.+)$/i.exec(name);
-  if (!match) throw new Error("Could not resolve the path and method from the route name.");
-  const [, routeMethod, routePath] = match, method = routeMethod.toLowerCase(), path = specification.paths[routePath];
-  if (!path) throw new Error(`Route "${name}" not found in specification.`);
-  if (typeof path != "object" || path === null) throw new Error("Invalid path object in the OpenAPI specification.");
-  if (!(method in path)) throw new Error(`Method "${method}" not found in path "${routePath}".`);
-  return { ...path[method], method, path: routePath };
-}
+import { g, r } from "./chunks/Biic1J5b.js";
 function isReferenceObject(value) {
   return typeof value == "object" && value !== null && "$ref" in value && typeof value.$ref == "string";
 }
@@ -38,11 +27,10 @@ function resolveDocument(value, document = value) {
   });
 }
 export {
-  g as getBaseUrl,
-  a as getOperationById,
-  getOperationByRoute,
+  g as getServerUrl,
   isReferenceObject,
   resolveDocument,
+  r as resolveOperation,
   resolveReference
 };
 //# sourceMappingURL=openapi.js.map

package/dist/openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi.js","sources":["../openapi/getOperationByRoute.ts","../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["import type { OpenAPI } from 'openapi-types'\nimport type { OpenAPIV2 } from './OpenApiV2'\n\n/**\n * Given an OpenAPI specification, find a route by its name.\n *\n * @param specification The OpenAPI specification.\n * @param name The name of the route to resolve.\n * @returns The resolved route.\n * @example getOperationByRoute(specification, 'GET /users') // { method: 'get', path: '/users', ... }\n */\nexport function getOperationByRoute<\n  T extends object,\n  U extends OpenAPIV2.Route<T>,\n>(\n  specification: Readonly<T>,\n  name: U,\n): OpenAPIV2.OperationByRoute<T, U> {\n\n  // --- Assert the specification has a paths object.\n  if (!specification\n    || typeof specification !== 'object'\n    || specification === null\n    || 'paths' in specification === false\n    || typeof specification.paths !== 'object'\n    || specification.paths === null)\n    throw new Error('Missing paths object in the OpenAPI specification.')\n\n  // --- Extract the path and method from the name.\n  const match = /^(get|post|put|patch|delete|head|options) (\\/.+)$/i.exec(name)\n  if (!match) throw new Error('Could not resolve the path and method from the route name.')\n  const [, routeMethod, routePath] = match\n  const method = routeMethod.toLowerCase()\n\n  // --- Search for the route in the specification's paths.\n  const paths = specification.paths as Record<string, OpenAPI.Operation>\n  const path = paths[routePath]\n  if (!path) throw new Error(`Route \"${name}\" not found in specification.`)\n  if (typeof path !== 'object' || path === null) throw new Error('Invalid path object in the OpenAPI specification.')\n  if (method in path === false) throw new Error(`Method \"${method}\" not found in path \"${routePath}\".`)\n  const operation = path[method as keyof typeof path] as OpenAPI.Operation\n  return { ...operation, method, path: routePath } as OpenAPIV2.OperationByRoute<T, U>\n}\n","import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";AAWgB,SAAA,oBAId,eACA,MACkC;AAGlC,MAAI,CAAC,iBACA,OAAO,iBAAkB,YACzB,kBAAkB,QAClB,EAAW,WAAA,kBACX,OAAO,cAAc,SAAU,YAC/B,cAAc,UAAU;AACrB,UAAA,IAAI,MAAM,oDAAoD;AAGhE,QAAA,QAAQ,qDAAqD,KAAK,IAAI;AAC5E,MAAI,CAAC,MAAa,OAAA,IAAI,MAAM,4DAA4D;AACxF,QAAM,GAAG,aAAa,SAAS,IAAI,OAC7B,SAAS,YAAY,YAAY,GAIjC,OADQ,cAAc,MACT,SAAS;AAC5B,MAAI,CAAC,KAAM,OAAM,IAAI,MAAM,UAAU,IAAI,+BAA+B;AACpE,MAAA,OAAO,QAAS,YAAY,SAAS,KAAY,OAAA,IAAI,MAAM,mDAAmD;AAC9G,MAAA,EAAA,UAAU,MAAsB,OAAA,IAAI,MAAM,WAAW,MAAM,wBAAwB,SAAS,IAAI;AAEpG,SAAO,EAAE,GADS,KAAK,MAA2B,GAC3B,QAAQ,MAAM,UAAU;AACjD;AC5BO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;"}
+{"version":3,"file":"openapi.js","sources":["../openapi/isReferenceObject.ts","../openapi/resolveReference.ts","../openapi/resolveDocument.ts"],"sourcesContent":["import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'\n\nexport type OpenAPIReference =\n  | OpenAPIV2.ReferenceObject\n  | OpenAPIV3.ReferenceObject\n  | OpenAPIV3_1.ReferenceObject\n\n/**\n * Check if a value is an {@linkcode OpenAPIReference}.\n *\n * @param value The value to check.\n * @returns `true` if the value is a reference object.\n * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true\n */\nexport function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T {\n  return typeof value === 'object'\n    && value !== null\n    && '$ref' in value\n    && typeof value.$ref === 'string'\n}\n","import type { StringJoin, StringReplace, WriteableDeep } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport { isReferenceObject } from './isReferenceObject'\n\n/**\n * Decode an OpenAPI reference path by replacing the encoded characters with\n * their original values. This function will replace `~0` with `~` and `~1`\n * with `/`.\n *\n * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'\n */\nexport type OpenAPIReferenceDecoded<T extends string> =\n  StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>\n\n/**\n * Extract the parts of a reference path as a tuple.\n *\n * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']\n */\nexport type OpenAPIReferencePath<T extends string> =\n  T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n    : T extends `#/${infer P}` ? [P]\n      : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>]\n        : T extends `${infer P}` ? [P]\n          : []\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The result type.\n * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }\n */\nexport type OpenAPIReferenceResolved<\n  T extends OpenAPIReference,\n  D extends object,\n> =\n  D extends object\n    ? T extends { $ref: infer R extends string }\n\n      // --- Match last part of the reference.\n      ? OpenAPIReferencePath<R> extends [infer P extends string]\n        ? OpenAPIReferenceDecoded<P> extends keyof D\n          ? D[OpenAPIReferenceDecoded<P>] extends object\n            ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>>\n            : never\n          : never\n\n        // --- Match middle part of the reference.\n        : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]]\n          ? OpenAPIReferenceDecoded<P> extends keyof D\n            ? D[OpenAPIReferenceDecoded<P>] extends object\n              ? OpenAPIReferenceResolved<{ $ref: StringJoin<Rest, '/'> }, D[OpenAPIReferenceDecoded<P>]>\n              : never\n            : never\n          : never\n      : never\n    : never\n\n/**\n * Resolve an OpenAPI `ReferenceObject` to the component it references. If the\n * source is not a reference, the source will be returned.\n *\n * @private\n * @param reference The reference object to resolve.\n * @param document The OpenAPI document to resolve the reference from.\n * @returns The result component.\n * @example resolveReference({ $ref: '#/components/schemas/User' }, document)\n */\nexport function resolveReference<\n  T extends OpenAPIReference,\n  D extends object,\n>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D> {\n\n  // --- Return the source if it is not a reference.\n  if (!isReferenceObject(reference))\n    throw new TypeError('Expected value to be an OpenAPI reference object.')\n\n  // --- Assert that the parameters are valid.\n  if (typeof document !== 'object' || document === null)\n    throw new TypeError('Expected OpenAPI specification to be an object.')\n\n  // --- Resolve the component with it's reference path.\n  const referenceParts = reference.$ref.replace(/^#\\//, '').split('/')\n  let result = document\n  for (const part of referenceParts) {\n    if (result === undefined) break\n    if (typeof result !== 'object' || result === null) break\n    const key = part.replaceAll('~1', '/').replaceAll('~0', '~')\n    // @ts-expect-error: assume the part is a key of the object.\n    result = result[key] as unknown\n  }\n\n  // --- Throw an error if the component could not be result.\n  if (result === undefined)\n    throw new Error(`Could not resolve OpenAPI component: ${reference.$ref}`)\n\n  // --- Return the result component.\n  return result as OpenAPIReferenceResolved<T, D>\n}\n","import type { ObjectLike, Substract } from '@unshared/types'\nimport type { OpenAPIReference } from './isReferenceObject'\nimport type { OpenAPIReferenceResolved } from './resolveReference'\nimport { isReferenceObject } from './isReferenceObject'\nimport { resolveReference as resolveReference } from './resolveReference'\n\n/**\n * Resolve a type to the type it references. If the source is not a reference,\n * the source will be returned.\n *\n * @template T The type to resolve.\n * @returns The resolved type.\n * @example\n * type Resolved = OpenAPIResolved<{\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' }\n *     }\n *   }\n * }>\n */\nexport type OpenAPIResolved<T, D = T, N extends number = 8> =\n  N extends 0 ? T\n    : T extends OpenAPIReference\n      ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D, Substract<N, 1>> : never\n      : T extends object ? { -readonly [K in keyof T]: OpenAPIResolved<T[K], D, N> } : T\n\n/**\n * Recursively resolve all references in an OpenAPI specification. This function\n * will return a `Proxy` object that will resolve references on the fly.\n *\n * @param value The OpenAPI specification.\n * @returns The resolved OpenAPI specification.\n * @example\n * const resolved = resolveReferences({\n *   ...\n *   paths: {\n *     '/users': {\n *       get: { $ref: '#/components/routes/getUsers' },\n *     },\n *   },\n * })\n */\nexport function resolveDocument<T extends object>(value: Readonly<T>): OpenAPIResolved<T>\nexport function resolveDocument<T extends object, D>(value: Readonly<T>, document: Readonly<D>): OpenAPIResolved<T, D>\nexport function resolveDocument(value: Readonly<ObjectLike>, document = value): unknown {\n  return new Proxy(value, {\n    get(target, property: string) {\n      let value = target[property]\n\n      // --- Abort if no document is provided.\n      if (!document) return value\n\n      // --- Resolve the reference if it is a reference object.\n      if (isReferenceObject(value))\n        value = resolveReference(value, document)\n\n      // --- Recursively resolve references in objects.\n      if (typeof value === 'object' && value !== null)\n        return resolveDocument(value as ObjectLike, document)\n\n      // --- Return the value as is.\n      return value\n    },\n  })\n}\n"],"names":["value"],"mappings":";AAcO,SAAS,kBAA8C,OAA4B;AACjF,SAAA,OAAO,SAAU,YACnB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,QAAS;AAC7B;ACmDgB,SAAA,iBAGd,WAAwB,UAAuD;AAG3E,MAAA,CAAC,kBAAkB,SAAS;AACxB,UAAA,IAAI,UAAU,mDAAmD;AAGrE,MAAA,OAAO,YAAa,YAAY,aAAa;AACzC,UAAA,IAAI,UAAU,iDAAiD;AAGjE,QAAA,iBAAiB,UAAU,KAAK,QAAQ,QAAQ,EAAE,EAAE,MAAM,GAAG;AACnE,MAAI,SAAS;AACb,aAAW,QAAQ,gBAAgB;AAEjC,QADI,WAAW,UACX,OAAO,UAAW,YAAY,WAAW,KAAM;AAC7C,UAAA,MAAM,KAAK,WAAW,MAAM,GAAG,EAAE,WAAW,MAAM,GAAG;AAE3D,aAAS,OAAO,GAAG;AAAA,EAAA;AAIrB,MAAI,WAAW;AACb,UAAM,IAAI,MAAM,wCAAwC,UAAU,IAAI,EAAE;AAGnE,SAAA;AACT;ACtDgB,SAAA,gBAAgB,OAA6B,WAAW,OAAgB;AAC/E,SAAA,IAAI,MAAM,OAAO;AAAA,IACtB,IAAI,QAAQ,UAAkB;AACxBA,UAAAA,SAAQ,OAAO,QAAQ;AAG3B,aAAK,YAGD,kBAAkBA,MAAK,MACzBA,SAAQ,iBAAiBA,QAAO,QAAQ,IAGtC,OAAOA,UAAU,YAAYA,WAAU,OAClC,gBAAgBA,QAAqB,QAAQ,IAG/CA,UAXeA;AAAAA,IAAA;AAAA,EAYxB,CACD;AACH;"}

package/dist/utils.cjs

@@ -1,16 +1,18 @@
 "use strict";
-var handleResponse = require("./chunks/Cx8m1YzL.cjs"), parseRequest = require("./chunks/D8Tsm7xC.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;
 exports.handleResponseStreamJson = handleResponse.handleResponseStreamJson;
-exports.isFormDataLike = parseRequest.isFormDataLike;
-exports.isObjectLike = parseRequest.isObjectLike;
-exports.parseRequest = parseRequest.parseRequest;
-exports.parseRequestBody = parseRequest.parseRequestBody;
-exports.parseRequestHeaders = parseRequest.parseRequestHeaders;
-exports.parseRequestParameters = parseRequest.parseRequestParameters;
-exports.parseRequestQuery = parseRequest.parseRequestQuery;
-exports.parseRequestUrl = parseRequest.parseRequestUrl;
-exports.toFormData = parseRequest.toFormData;
-exports.toSearchParams = parseRequest.toSearchParams;
+exports.isFormDataLike = handleResponse.isFormDataLike;
+exports.isObjectLike = handleResponse.isObjectLike;
+exports.parseRequest = handleResponse.parseRequest;
+exports.parseRequestBody = handleResponse.parseRequestBody;
+exports.parseRequestHeaders = handleResponse.parseRequestHeaders;
+exports.parseRequestUrl = handleResponse.parseRequestUrl;
+exports.toFormData = handleResponse.toFormData;
+exports.parseRequestParameters = parseRequestQuery.parseRequestParameters;
+exports.parseRequestQuery = parseRequestQuery.parseRequestQuery;
+exports.toSearchParams = parseRequestQuery.toSearchParams;
+exports.request = request.request;
 //# sourceMappingURL=utils.cjs.map

package/dist/utils.cjs.map

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

package/dist/utils.d.ts

@@ -1,10 +1,31 @@
-import { R as RequestHooks } from './chunks/r8pYO6Hx.js';
-export { h as handleResponse } from './chunks/r8pYO6Hx.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 { c as RequestOptions, d as RequestContext } from './chunks/DZp6zyqV.js';
-export { b as RequestBody, a as RequestHeaders, R as RequestMethod, e as SearchArrayFormat, S as SearchParamsObject, T as ToSearchParamsOptions, p as parseRequest, t as toSearchParams } from './chunks/DZp6zyqV.js';
-import '@unshared/types';
-import './chunks/8BFCFxqa.js';
+import { ObjectLike } from '@unshared/types';
+import './HttpHeaders.js';
+import './HttpMethods.js';
+
+/**
+ * Fetch a route with the provided options. This function will parse the route and
+ * options to create a `Request` object and return the response from the server.
+ *
+ * @param route The name of the route to fetch.
+ * @param options The options to pass to the request.
+ * @returns The response from the server.
+ * @example fetch('GET /users', { query: { limit: 10 } })
+ */
+declare function fetch(route: string, options?: FetchOptions): Promise<Response>;
+
+/**
+ * Handle a request response. This function will parse the response based on the content type and
+ * return the data. If an error occurs, the `onError` callback will be called and the function will
+ * throw an error.
+ *
+ * @param response The response to handle.
+ * @param options The options to pass to the request.
+ * @returns The parsed data from the response.
+ */
+declare function handleResponse(response: Response, options?: RequestOptions): Promise<unknown>;
 
 /**
  * Handle a request response where the content type is a stream of JSON objects. This function
@@ -15,7 +36,7 @@ import './chunks/8BFCFxqa.js';
  * @param options The options to pass to the request.
  * @returns An awaitable iterator that yields the parsed JSON objects.
  */
-declare function handleResponseStreamJson<T>(response: Response, options: RequestHooks): Awaitable<AsyncIterable<T>, T[]>;
+declare function handleResponseStreamJson(response: Response, options: RequestOptions): Awaitable<AsyncIterable<unknown>, unknown[]>;
 
 /**
  * A type that represents a FormData-like object, which is a plain object with
@@ -39,62 +60,71 @@ declare function isFormDataLike(value: unknown): value is FormDataLike;
  * @returns `true` if the value is an object-like value, `false` otherwise.
  * @example isObjectLike({}) // true
  */
-declare function isObjectLike(value: unknown): value is Record<string, unknown>;
+declare function isObjectLike(value: unknown): value is ObjectLike;
 
 /**
  * Parse the request body based on the provided data and options.
  *
- * @param route The route path.
- * @param options The request options.
  * @param context The request context.
+ * @param options The request options.
  */
-declare function parseRequestBody(route: string, options: Pick<RequestOptions, 'body' | 'data'>, context: RequestContext): void;
+declare function parseRequestBody(context: RequestContext, options: FetchOptions): void;
 
 /**
  * Parse the request headers based on the provided data and options.
  *
- * @param route The route path.
- * @param options The request options.
  * @param context The request context.
+ * @param options The request options.
+ * @example
+ *
+ * // Append the `Content-Type` header to the request.
+ * const context = {}
+ * parseRequestHeaders(context, { headers: { 'Content-Type': 'application/json' } })
+ *
+ * // Will mutate the `init` object to include the headers.
+ * console.log(context) // => { init: { headers: { 'Content-Type': 'application/json' } } }
  */
-declare function parseRequestHeaders(route: string, options: Pick<RequestOptions, 'headers'>, context: RequestContext): void;
+declare function parseRequestHeaders(context: RequestContext, options: FetchOptions): void;
 
 /**
- * Parse the request parameters from the request data. This function will append
- * the path parameters to the URL based on the method and the data provided.
+ * Parse the request parameters from the request data. This function will mutate the
+ * `url` object of the context to include the path parameters based on the provided data.
  *
- * @param route The name of the route to fetch. (ignored)
+ * @param context The request context to mutate.
  * @param options The options to pass to the request.
- * @param context The request context to modify.
  * @example
+ *
  * // Using `express` style path parameters.
- * parseRequestParameters('GET /users/:id', { data: { id: 1 } }, context)
+ * const context = { url: new URL('https://api.example.com/users/:id') }
+ * parseRequestParameters(context, { parameters: { id: 1 } })
+ * console.log(context.url.pathname) // 'https://api.example.com/users/1'
  *
  * // Using `OpenAPI` style path parameters.
- * parseRequestParameters('GET /users/{id}', { data: { id: 1 } }, context)
+ * const context = { url: new URL('https://api.example.com/users/{id}') }
+ * parseRequestParameters(context, { parameters: { id: 1 } })
+ * console.log(context.url.pathname) // 'https://api.example.com/users/1'
  */
-declare function parseRequestParameters(route: string, options: Pick<RequestOptions, 'data' | 'parameters'>, context: RequestContext): void;
+declare function parseRequestParameters(context: RequestContext, options: FetchOptions): void;
 
 /**
  * Parse the query parameters from the request data. This function will append
  * the query parameters to the URL based on the method and the data provided.
  *
- * @param route The name of the route to fetch. (ignored)
- * @param options The options to pass to the request.
  * @param context The request context to modify.
+ * @param options The options to pass to the request.
  */
-declare function parseRequestQuery(route: string, options: Pick<RequestOptions, 'data' | 'query' | 'searchArrayFormat'>, context: RequestContext): void;
+declare function parseRequestQuery(context: RequestContext, options: FetchOptions): void;
 
 /**
  * Parses the route name to extract the URL and method. It allows the url and method to be
  * provided in the route name, or in the options object. The method will default to 'get'.
  *
+ * @param context The request context to mutate.
  * @param route The name of the route to fetch.
  * @param options The options to pass to the request.
- * @param context The request context to modify.
  * @example parseRequestUrl('GET /users', { baseUrl: 'https://api.example.com' }, context)
  */
-declare function parseRequestUrl(route: string, options: Pick<RequestOptions, 'baseUrl' | 'method'>, context: RequestContext): void;
+declare function parseRequestUrl(context: RequestContext, route: string, options: FetchOptions): void;
 
 /**
  * Casts an object that may contain `Blob`, `File`, or `FileList` values to a `FormData` object.
@@ -104,4 +134,4 @@ declare function parseRequestUrl(route: string, options: Pick<RequestOptions, 'b
  */
 declare function toFormData(object: FormDataLike): FormData;
 
-export { type FormDataLike, RequestContext, RequestHooks, RequestOptions, handleResponseStreamJson, isFormDataLike, isObjectLike, parseRequestBody, parseRequestHeaders, parseRequestParameters, parseRequestQuery, parseRequestUrl, toFormData };
+export { FetchOptions, type FormDataLike, RequestContext, RequestOptions, fetch, handleResponse, handleResponseStreamJson, isFormDataLike, isObjectLike, parseRequestBody, parseRequestHeaders, parseRequestParameters, parseRequestQuery, parseRequestUrl, toFormData };

package/dist/utils.js

@@ -1,18 +1,21 @@
-import { h, a } from "./chunks/CKfJvIQ8.js";
-import { i, a as a2, p, b, c, d, e, f, t, g } from "./chunks/B5hc73Po.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,
   h as handleResponse,
   a as handleResponseStreamJson,
   i as isFormDataLike,
-  a2 as isObjectLike,
+  b as isObjectLike,
   p as parseRequest,
-  b as parseRequestBody,
-  c as parseRequestHeaders,
-  d as parseRequestParameters,
-  e as parseRequestQuery,
-  f as parseRequestUrl,
+  c as parseRequestBody,
+  d as parseRequestHeaders,
+  p2 as parseRequestParameters,
+  a2 as parseRequestQuery,
+  e as parseRequestUrl,
+  r as request,
   t as toFormData,
-  g 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,7 @@
+"use strict";
+var connect = require("./chunks/VkINJoq7.cjs");
+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,148 @@
+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 = ObjectLike, ServerData extends ObjectLike = ObjectLike> {
+    /** 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>;
+    /**
+     * Automatically open the connection when it is created. If `true`, the connection
+     * will automatically open when it is created. If `false`, the connection will not
+     * open when it is created.
+     *
+     * @default false
+     */
+    autoOpen?: boolean;
+    /**
+     * 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 extends ObjectLike, any> ? R : ObjectLike;
+type ServerData<T extends ConnectOptions> = T extends ConnectOptions<any, any, any, any, infer R extends ObjectLike> ? R : ObjectLike;
+declare class WebSocketChannel<T extends ConnectOptions = ConnectOptions> {
+    channel: string;
+    options: T;
+    constructor(channel: string, options: T);
+    /** The WebSocket connection to the server. */
+    webSocket: WebSocket | undefined;
+    /**
+     * 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.
+     */
+    open(): Promise<void>;
+    /**
+     * 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): RemoveListener;
+    on(event: 'close', callback: (event: CloseEvent) => void): RemoveListener;
+    on(event: 'error', callback: (event: Event) => void): RemoveListener;
+    on(event: 'open', callback: (event: Event) => void): 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): WebSocketChannel;
+
+export { type ConnectOptions, type ConnectProtocol, WebSocketChannel, type WebSocketParameters, connect, parseConnectOptions };

package/dist/websocket.js

@@ -0,0 +1,8 @@
+import { W, c, p } from "./chunks/Du56lBvc.js";
+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":";;"}