@unshared/client 0.2.0

package/dist/openapi.cjs

@@ -0,0 +1,9 @@
+"use strict";
+var index = require("./chunks/BzqHK4CV.cjs");
+exports.getBaseUrl = index.getBaseUrl;
+exports.getOperationById = index.getOperationById;
+exports.getOperationByRoute = index.getOperationByRoute;
+exports.isReferenceObject = index.isReferenceObject;
+exports.resolveDocument = index.resolveDocument;
+exports.resolveReference = index.resolveReference;
+//# sourceMappingURL=openapi.cjs.map

package/dist/openapi.cjs.map

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

package/dist/openapi.d.ts

@@ -0,0 +1,123 @@
+import { OpenAPI, OpenAPIV2 as OpenAPIV2$1, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
+import { O as OpenAPIV2 } from './chunks/BIx2AaJH.js';
+export { a as OpenAPIV3 } from './chunks/BIx2AaJH.js';
+import { StringReplace, WriteableDeep, StringJoin } from '@unshared/types';
+import './chunks/8BFCFxqa.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;
+/**
+ * Check if a value is an {@linkcode OpenAPIReference}.
+ *
+ * @param value The value to check.
+ * @returns `true` if the value is a reference object.
+ * @example isReferenceObject({ $ref: '#/components/schemas/MySchema' }) // true
+ */
+declare function isReferenceObject<T extends OpenAPIReference>(value: unknown): value is T;
+
+/**
+ * Decode an OpenAPI reference path by replacing the encoded characters with
+ * their original values. This function will replace `~0` with `~` and `~1`
+ * with `/`.
+ *
+ * @example DecodeReference<'#/foo~1bar~0baz'> // '#/foo/bar~baz'
+ */
+type OpenAPIReferenceDecoded<T extends string> = StringReplace<StringReplace<T, '~0', '~'>, '~1', '/'>;
+/**
+ * Extract the parts of a reference path as a tuple.
+ *
+ * @example OpenAPIV3ReferencePath<'#/paths/~1users~1{username}'> // ['paths', '/users/{username}']
+ */
+type OpenAPIReferencePath<T extends string> = T extends `#/${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>] : T extends `#/${infer P}` ? [P] : T extends `${infer P}/${infer Rest}` ? [P, ...OpenAPIReferencePath<Rest>] : T extends `${infer P}` ? [P] : [];
+/**
+ * Resolve a type to the type it references. If the source is not a reference,
+ * the source will be returned.
+ *
+ * @template T The type to resolve.
+ * @returns The result type.
+ * @example Resolved<{ $ref: '#/info' }, { info: { title: string } }> // { title: string }
+ */
+type OpenAPIReferenceResolved<T extends OpenAPIReference, D extends object> = D extends object ? T extends {
+    $ref: infer R extends string;
+} ? OpenAPIReferencePath<R> extends [infer P extends string] ? OpenAPIReferenceDecoded<P> extends keyof D ? D[OpenAPIReferenceDecoded<P>] extends object ? WriteableDeep<Omit<D[OpenAPIReferenceDecoded<P>], keyof T>> : never : never : OpenAPIReferencePath<R> extends [infer P extends string, ...infer Rest extends string[]] ? OpenAPIReferenceDecoded<P> extends keyof D ? D[OpenAPIReferenceDecoded<P>] extends object ? OpenAPIReferenceResolved<{
+    $ref: StringJoin<Rest, '/'>;
+}, D[OpenAPIReferenceDecoded<P>]> : never : never : never : never : never;
+/**
+ * Resolve an OpenAPI `ReferenceObject` to the component it references. If the
+ * source is not a reference, the source will be returned.
+ *
+ * @private
+ * @param reference The reference object to resolve.
+ * @param document The OpenAPI document to resolve the reference from.
+ * @returns The result component.
+ * @example resolveReference({ $ref: '#/components/schemas/User' }, document)
+ */
+declare function resolveReference<T extends OpenAPIReference, D extends object>(reference: Readonly<T>, document: Readonly<D>): OpenAPIReferenceResolved<T, D>;
+
+/**
+ * Resolve a type to the type it references. If the source is not a reference,
+ * the source will be returned.
+ *
+ * @template T The type to resolve.
+ * @returns The resolved type.
+ * @example
+ * type Resolved = OpenAPIResolved<{
+ *   ...
+ *   paths: {
+ *     '/users': {
+ *       get: { $ref: '#/components/routes/getUsers' }
+ *     }
+ *   }
+ * }>
+ */
+type OpenAPIResolved<T, D = T> = T extends OpenAPIReference ? D extends object ? OpenAPIResolved<OpenAPIReferenceResolved<T, D>, D> : never : T extends object ? {
+    -readonly [K in keyof T]: OpenAPIResolved<T[K], D>;
+} : T;
+/**
+ * Recursively resolve all references in an OpenAPI specification. This function
+ * will return a `Proxy` object that will resolve references on the fly.
+ *
+ * @param value The OpenAPI specification.
+ * @returns The resolved OpenAPI specification.
+ * @example
+ * const resolved = resolveReferences({
+ *   ...
+ *   paths: {
+ *     '/users': {
+ *       get: { $ref: '#/components/routes/getUsers' },
+ *     },
+ *   },
+ * })
+ */
+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 };

package/dist/openapi.js

@@ -0,0 +1,10 @@
+import { g, a, b, i, r, c } from "./chunks/CRISqhP7.js";
+export {
+  g as getBaseUrl,
+  a as getOperationById,
+  b as getOperationByRoute,
+  i as isReferenceObject,
+  r as resolveDocument,
+  c as resolveReference
+};
+//# sourceMappingURL=openapi.js.map

package/dist/openapi.js.map

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

package/dist/utils.cjs

@@ -0,0 +1,13 @@
+"use strict";
+var parseRequest = require("./chunks/C3RyfPUw.cjs");
+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;
+//# sourceMappingURL=utils.cjs.map

package/dist/utils.cjs.map

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

package/dist/utils.d.ts

@@ -0,0 +1,93 @@
+import { a as RequestOptions, b as RequestContext } from './chunks/B0duX_ls.js';
+export { R as RequestHeaders, c as SearchArrayFormat, S as SearchParamsObject, T as ToSearchParamsOptions, p as parseRequest, t as toSearchParams } from './chunks/B0duX_ls.js';
+import '@unshared/types';
+import './chunks/8BFCFxqa.js';
+
+/**
+ * A type that represents a FormData-like object, which is a plain object with
+ * nested Blob, File, or FileList values. Or a FormData instance.
+ */
+type FormDataLike = FormData | Record<string, Blob | File | FileList>;
+/**
+ * Predicate to check if a value is FormData-like, meaning it is a plain object
+ * with nested Blob, File, or FileList values.
+ *
+ * @param value The value to check.
+ * @returns `true` if the value is FormData-like, `false` otherwise.
+ * @example isFormDataLike({ file: new File(['test'], 'test.txt') }) // true
+ */
+declare function isFormDataLike(value: unknown): value is FormDataLike;
+
+/**
+ * Predicate to check if a value is an object-like value.
+ *
+ * @param value The value to check.
+ * @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>;
+
+/**
+ * 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.
+ */
+declare function parseRequestBody(route: string, options: Pick<RequestOptions, 'body' | 'data'>, context: RequestContext): 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.
+ */
+declare function parseRequestHeaders(route: string, options: Pick<RequestOptions, 'headers'>, context: RequestContext): 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.
+ *
+ * @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.
+ * @example
+ * // Using `express` style path parameters.
+ * parseRequestParameters('GET /users/:id', { data: { id: 1 } }, context)
+ *
+ * // Using `OpenAPI` style path parameters.
+ * parseRequestParameters('GET /users/{id}', { data: { id: 1 } }, context)
+ */
+declare function parseRequestParameters(route: string, options: Pick<RequestOptions, 'data' | 'parameters'>, context: RequestContext): 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.
+ */
+declare function parseRequestQuery(route: string, options: Pick<RequestOptions, 'data' | 'query' | 'searchArrayFormat'>, context: RequestContext): 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 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;
+
+/**
+ * Casts an object that may contain `Blob`, `File`, or `FileList` values to a `FormData` object.
+ *
+ * @param object The object to cast to a `FormData` object.
+ * @returns The `FormData` object.
+ */
+declare function toFormData(object: FormDataLike): FormData;
+
+export { type FormDataLike, RequestContext, RequestOptions, isFormDataLike, isObjectLike, parseRequestBody, parseRequestHeaders, parseRequestParameters, parseRequestQuery, parseRequestUrl, toFormData };

package/dist/utils.js

@@ -0,0 +1,14 @@
+import { i, a, p, b, c, d, e, f, t, g } from "./chunks/wF9C7mO0.js";
+export {
+  i as isFormDataLike,
+  a as isObjectLike,
+  p as parseRequest,
+  b as parseRequestBody,
+  c as parseRequestHeaders,
+  d as parseRequestParameters,
+  e as parseRequestQuery,
+  f as parseRequestUrl,
+  t as toFormData,
+  g as toSearchParams
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

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

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@unshared/client",
+  "type": "module",
+  "version": "0.2.0",
+  "license": "MIT",
+  "sideEffects": false,
+  "author": "Stanley Horwood <stanley@hsjm.io>",
+  "bugs": "https://github.com/shorwood/unshared/issues",
+  "homepage": "https://github.com/shorwood/unshared#readme",
+  "repository": {
+    "directory": "packages/client",
+    "type": "git",
+    "url": "https://github.com/shorwood/unshared"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./createClient": {
+      "require": "./dist/createClient.cjs",
+      "types": "./dist/createClient.d.ts",
+      "import": "./dist/createClient.js"
+    },
+    "./fetch": {
+      "require": "./dist/fetch.cjs",
+      "types": "./dist/fetch.d.ts",
+      "import": "./dist/fetch.js"
+    },
+    "./openapi": {
+      "require": "./dist/openapi.cjs",
+      "types": "./dist/openapi.d.ts",
+      "import": "./dist/openapi.js"
+    },
+    "./utils": {
+      "require": "./dist/utils.cjs",
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.js"
+    },
+    ".": {
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "dependencies": {
+    "@unshared/types": "0.2.0",
+    "openapi-types": "12.1.3"
+  },
+  "devDependencies": {
+    "@unshared/scripts": "0.2.0"
+  },
+  "scripts": {
+    "build:httpMethods": "tsx ./scripts/buildHttpMethods.ts",
+    "build:httpHeaders": "tsx ./scripts/buildHttpHeaders.ts",
+    "build:httpStatusCodes": "tsx ./scripts/buildHttpStatusCodes.ts"
+  }
+}