@mittwald/api-client-commons 4.2.0-alpha.6 → 4.2.1

package/dist/{index.d.cts → index.d.mts}

@@ -1,7 +1,7 @@
 import { AxiosInstance, CreateAxiosDefaults, AxiosError, InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig } from 'axios';
 export * from 'axios';
-import { R as Response, O as OpenAPIOperation, a as RequestFunction, A as AnyResponse, P as PathParameters, b as RequestObject, c as ResponsePromise } from './RequestFunction-b1412636.js';
-export { e as AnyRequest, l as HttpHeaders, j as HttpMediaType, k as HttpMethod, H as HttpPayload, i as HttpStatus, I as InferredRequestType, f as InferredResponseType, Q as QueryParameters, h as RequestData, d as RequestType, g as ResponseData } from './RequestFunction-b1412636.js';
+import { R as Response, O as OpenAPIOperation, a as RequestFunction, A as AnyResponse, P as PathParameters, b as RequestObject, c as ResponsePromise } from './shared/api-client-commons.8b686095.mjs';
+export { e as AnyRequest, n as HttpHeaders, l as HttpMediaType, m as HttpMethod, H as HttpPayload, k as HttpStatus, h as InferredRequestData, I as InferredRequestType, g as InferredResponseData, f as InferredResponseType, Q as QueryParameters, j as RequestData, d as RequestType, i as ResponseData } from './shared/api-client-commons.8b686095.mjs';
 import 'type-fest';
 
 type Simplify<T> = {
@@ -12,10 +12,6 @@ declare function assertStatus<T extends Response, S extends T["status"]>(respons
     status: S;
 };
 
-declare function assertOneOfStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S[]): asserts response is T & {
-    status: S;
-};
-
 declare abstract class ApiClientBase {
     axios: AxiosInstance;
     constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
@@ -46,4 +42,4 @@ declare class Request<TOp extends OpenAPIOperation> {
     private convertQueryToUrlSearchParams;
 }
 
-export { AnyResponse, ApiClientBase, ApiClientError, OpenAPIOperation, OpenAPIPath, PathParameters, Request, RequestFunction, RequestObject, Response, ResponsePromise, Simplify, assertOneOfStatus, assertStatus };
+export { AnyResponse, ApiClientBase, ApiClientError, OpenAPIOperation, OpenAPIPath, PathParameters, Request, RequestFunction, RequestObject, Response, ResponsePromise, type Simplify, assertStatus };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance, CreateAxiosDefaults, AxiosError, InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig } from 'axios';
 export * from 'axios';
-import { R as Response, O as OpenAPIOperation, a as RequestFunction, A as AnyResponse, P as PathParameters, b as RequestObject, c as ResponsePromise } from './RequestFunction-b1412636.js';
-export { e as AnyRequest, l as HttpHeaders, j as HttpMediaType, k as HttpMethod, H as HttpPayload, i as HttpStatus, I as InferredRequestType, f as InferredResponseType, Q as QueryParameters, h as RequestData, d as RequestType, g as ResponseData } from './RequestFunction-b1412636.js';
+import { R as Response, O as OpenAPIOperation, a as RequestFunction, A as AnyResponse, P as PathParameters, b as RequestObject, c as ResponsePromise } from './shared/api-client-commons.8b686095.js';
+export { e as AnyRequest, n as HttpHeaders, l as HttpMediaType, m as HttpMethod, H as HttpPayload, k as HttpStatus, h as InferredRequestData, I as InferredRequestType, g as InferredResponseData, f as InferredResponseType, Q as QueryParameters, j as RequestData, d as RequestType, i as ResponseData } from './shared/api-client-commons.8b686095.js';
 import 'type-fest';
 
 type Simplify<T> = {
@@ -12,10 +12,6 @@ declare function assertStatus<T extends Response, S extends T["status"]>(respons
     status: S;
 };
 
-declare function assertOneOfStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S[]): asserts response is T & {
-    status: S;
-};
-
 declare abstract class ApiClientBase {
     axios: AxiosInstance;
     constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
@@ -46,4 +42,4 @@ declare class Request<TOp extends OpenAPIOperation> {
     private convertQueryToUrlSearchParams;
 }
 
-export { AnyResponse, ApiClientBase, ApiClientError, OpenAPIOperation, OpenAPIPath, PathParameters, Request, RequestFunction, RequestObject, Response, ResponsePromise, Simplify, assertOneOfStatus, assertStatus };
+export { AnyResponse, ApiClientBase, ApiClientError, OpenAPIOperation, OpenAPIPath, PathParameters, Request, RequestFunction, RequestObject, Response, ResponsePromise, type Simplify, assertStatus };

package/dist/index.mjs

@@ -0,0 +1,22 @@
+import axios__default, { Axios } from 'axios';
+export * from 'axios';
+import { R as Request } from './shared/api-client-commons.2a6e3962.mjs';
+export { A as ApiClientError, O as OpenAPIPath, a as assertStatus } from './shared/api-client-commons.2a6e3962.mjs';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ApiClientBase {
+  constructor(axiosConfig = axios__default) {
+    __publicField(this, "axios");
+    this.axios = axiosConfig instanceof Axios ? axiosConfig : axios__default.create(axiosConfig);
+  }
+  requestFunctionFactory(operation) {
+    return (conf) => new Request(operation, conf).execute(this.axios);
+  }
+}
+
+export { ApiClientBase, Request };

package/dist/{react.d.ts → react/index.d.mts}

@@ -1,9 +1,9 @@
-import { O as OpenAPIOperation, b as RequestObject, g as ResponseData, a as RequestFunction } from './RequestFunction-b1412636.js';
+import { O as OpenAPIOperation, b as RequestObject, g as InferredResponseData, a as RequestFunction } from '../shared/api-client-commons.8b686095.mjs';
 import { AsyncResource } from '@mittwald/react-use-promise';
 import 'axios';
 import 'type-fest';
 
-type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;
+type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>>;
 
 declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
     private static namespace;
@@ -16,4 +16,4 @@ declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
     getApiResource: GetApiResourceFn<TOp>;
 }
 
-export { ApiCallAsyncResourceFactory, GetApiResourceFn };
+export { ApiCallAsyncResourceFactory };

package/dist/{react.d.cts → react/index.d.ts}

@@ -1,9 +1,9 @@
-import { O as OpenAPIOperation, b as RequestObject, g as ResponseData, a as RequestFunction } from './RequestFunction-b1412636.js';
+import { O as OpenAPIOperation, b as RequestObject, g as InferredResponseData, a as RequestFunction } from '../shared/api-client-commons.8b686095.js';
 import { AsyncResource } from '@mittwald/react-use-promise';
 import 'axios';
 import 'type-fest';
 
-type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<ResponseData<TOp>>;
+type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>>;
 
 declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
     private static namespace;
@@ -16,4 +16,4 @@ declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
     getApiResource: GetApiResourceFn<TOp>;
 }
 
-export { ApiCallAsyncResourceFactory, GetApiResourceFn };
+export { ApiCallAsyncResourceFactory };

package/dist/react/index.mjs

@@ -0,0 +1,49 @@
+import { getAsyncResource } from '@mittwald/react-use-promise';
+import { R as Request, a as assertStatus } from '../shared/api-client-commons.2a6e3962.mjs';
+import 'axios';
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+const _ApiCallAsyncResourceFactory = class _ApiCallAsyncResourceFactory {
+  constructor(operation, requestFn) {
+    __publicField(this, "operation");
+    __publicField(this, "requestFn");
+    __publicField(this, "getApiResource", (requestObj) => {
+      const request = new Request(this.operation, requestObj);
+      return getAsyncResource(
+        (requestObj2) => this.executeRequest(requestObj2),
+        [requestObj],
+        {
+          tags: this.getAsyncResourceTags(request),
+          loaderId: this.getAsyncResourceId()
+        }
+      );
+    });
+    this.operation = operation;
+    this.requestFn = requestFn;
+  }
+  getAsyncResourceId() {
+    return `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
+  }
+  getAsyncResourceTags(request) {
+    const url = request.requestConfig.url ?? "";
+    return [
+      this.getAsyncResourceId(),
+      `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
+      `${_ApiCallAsyncResourceFactory.namespace}/${url}`
+    ];
+  }
+  async executeRequest(requestObj) {
+    const response = await this.requestFn(requestObj);
+    assertStatus(response, 200);
+    return response.data;
+  }
+};
+__publicField(_ApiCallAsyncResourceFactory, "namespace", "@mittwald/api-client");
+let ApiCallAsyncResourceFactory = _ApiCallAsyncResourceFactory;
+
+export { ApiCallAsyncResourceFactory };

package/dist/{chunk-PEYA5TMK.js → shared/api-client-commons.2a6e3962.mjs}

@@ -1,29 +1,20 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+import { AxiosError } from 'axios';
 
-// src/core/OpenAPIPath.ts
-var OpenAPIPath = class _OpenAPIPath {
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class OpenAPIPath {
   constructor(rawPath, params) {
+    __publicField$1(this, "rawPath");
+    __publicField$1(this, "params");
     this.rawPath = rawPath;
     this.params = params;
   }
   buildUrl() {
-    return _OpenAPIPath.setPathParams(this.rawPath, this.params);
+    return OpenAPIPath.setPathParams(this.rawPath, this.params);
   }
   static setPathParams(path, params) {
     const asEntries = Object.entries(params ?? {});
@@ -33,12 +24,19 @@ var OpenAPIPath = class _OpenAPIPath {
     }, path);
     return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
   }
-};
-var OpenAPIPath_default = OpenAPIPath;
+}
 
-// src/core/Request.ts
-var Request = class {
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class Request {
   constructor(operationDescriptor, requestObject) {
+    __publicField(this, "operationDescriptor");
+    __publicField(this, "requestObject");
+    __publicField(this, "requestConfig");
     this.operationDescriptor = operationDescriptor;
     this.requestObject = requestObject;
     this.requestConfig = Object.freeze(this.buildAxiosConfig());
@@ -49,7 +47,7 @@ var Request = class {
   buildAxiosConfig() {
     const { method, path } = this.operationDescriptor;
     const pathParameters = this.requestObject;
-    const openApiPath = new OpenAPIPath_default(path, pathParameters);
+    const openApiPath = new OpenAPIPath(path, pathParameters);
     const url = openApiPath.buildUrl();
     const data = this.requestObject && "data" in this.requestObject ? this.requestObject.data : void 0;
     const headersConfig = this.requestObject && "headers" in this.requestObject ? this.requestObject.headers : void 0;
@@ -99,19 +97,16 @@ var Request = class {
     }
     throw new Error(`Unexpected query parameter type (${typeof query})`);
   }
-};
-var Request_default = Request;
+}
 
-// src/core/ApiClientError.ts
-import { AxiosError } from "axios";
-var ApiClientError = class _ApiClientError extends AxiosError {
+class ApiClientError extends AxiosError {
   constructor(message, code, config, request, response) {
     super(message, code, config, request, response);
-    Object.setPrototypeOf(this, _ApiClientError.prototype);
+    Object.setPrototypeOf(this, ApiClientError.prototype);
     this.name = "ApiClientError";
   }
   static fromResponse(message, response) {
-    return new _ApiClientError(
+    return new ApiClientError(
       message,
       void 0,
       response.config,
@@ -119,36 +114,15 @@ var ApiClientError = class _ApiClientError extends AxiosError {
       response
     );
   }
-};
-var ApiClientError_default = ApiClientError;
+}
 
-// src/types/assertStatus.ts
 function assertStatus(response, expectedStatus) {
   if (response.status !== expectedStatus) {
-    throw ApiClientError_default.fromResponse(
-      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
-      response
-    );
-  }
-}
-
-// src/types/assertOneOfStatus.ts
-function assertOneOfStatus(response, expectedStatus) {
-  if (!expectedStatus.includes(response.status)) {
-    throw ApiClientError_default.fromResponse(
+    throw ApiClientError.fromResponse(
       `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
       response
     );
   }
 }
 
-export {
-  __export,
-  __reExport,
-  OpenAPIPath,
-  Request,
-  Request_default,
-  ApiClientError,
-  assertStatus,
-  assertOneOfStatus
-};
+export { ApiClientError as A, OpenAPIPath as O, Request as R, assertStatus as a };

package/dist/{RequestFunction-b1412636.d.ts → shared/api-client-commons.8b686095.d.mts}

@@ -47,12 +47,16 @@ interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, Ign
 }
 type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
 type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
-type ResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
+type InferredResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
     status: TStatus;
 }>["data"];
-type RequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
+type InferredRequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
     data: infer TData;
 } ? TData : never : never;
+/** @deprecated Use InferredResponseData */
+type ResponseData<TOp> = InferredResponseData<TOp>;
+/** @deprecated Use InferredRequestData */
+type RequestData<TOp> = InferredRequestData<TOp>;
 
 type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<OmitIndexSignature<{
     [TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
@@ -68,4 +72,4 @@ type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request
 type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
 type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
 
-export { AnyResponse as A, HttpPayload as H, InferredRequestType as I, OpenAPIOperation as O, PathParameters as P, QueryParameters as Q, Response as R, RequestFunction as a, RequestObject as b, ResponsePromise as c, RequestType as d, AnyRequest as e, InferredResponseType as f, ResponseData as g, RequestData as h, HttpStatus as i, HttpMediaType as j, HttpMethod as k, HttpHeaders as l };
+export type { AnyResponse as A, HttpPayload as H, InferredRequestType as I, OpenAPIOperation as O, PathParameters as P, QueryParameters as Q, Response as R, RequestFunction as a, RequestObject as b, ResponsePromise as c, RequestType as d, AnyRequest as e, InferredResponseType as f, InferredResponseData as g, InferredRequestData as h, ResponseData as i, RequestData as j, HttpStatus as k, HttpMediaType as l, HttpMethod as m, HttpHeaders as n };

package/dist/shared/api-client-commons.8b686095.d.ts

@@ -0,0 +1,75 @@
+import { AxiosResponse } from 'axios';
+import { HasRequiredKeys, PartialOnUndefinedDeep, OmitIndexSignature } from 'type-fest';
+
+type HttpPayload = unknown;
+type HttpStatus = number | "default";
+type HttpMediaType = string;
+type SafeHttpMethod = "GET" | "HEAD" | "OPTIONS";
+type UnsafeHttpMethod = "PUT" | "DELETE" | "POST" | "PATCH";
+type HttpMethod = SafeHttpMethod | UnsafeHttpMethod;
+type HeaderValue = string | number | boolean;
+type HttpHeaders = Partial<{
+    [TKey: string]: HeaderValue | HeaderValue[];
+}>;
+type PathParameters = Record<string, string | number>;
+type QueryParameters = Record<string, unknown>;
+
+type EmptyObject = Record<string, never>;
+type EmptyRequestComponent = EmptyObject | null;
+type RequestWithOptionalHeaders = {
+    headers?: HttpHeaders;
+};
+type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    data: TData;
+};
+type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    pathParameters: TPathParameters;
+};
+type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    headers: THeaders & HttpHeaders;
+};
+type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    queryParameters: TQuery & HttpHeaders;
+};
+type RequestType<TData extends HttpPayload = EmptyRequestComponent, TPathParameters extends PathParameters | EmptyRequestComponent = EmptyRequestComponent, TQueryParameters extends QueryParameters | EmptyRequestComponent = EmptyRequestComponent, THeader extends HttpHeaders | EmptyRequestComponent = EmptyRequestComponent> = TData | TPathParameters | THeader | TQueryParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithQueryParameters<TQueryParameters> & RequestWithHeaders<THeader>;
+type AnyRequest = RequestType<any, any, any, any>;
+
+type Response<TContent extends HttpPayload = HttpPayload, TStatus extends HttpStatus = HttpStatus, TMediaType extends HttpMediaType | null = HttpMediaType> = AxiosResponse<TContent> & {
+    status: TStatus;
+    mediaType: TMediaType;
+};
+type AnyResponse = Response<any, any, any>;
+
+interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
+    operationId: string;
+    path: string;
+    method: HttpMethod;
+}
+type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
+type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;
+type InferredResponseData<TOp, TStatus extends HttpStatus = 200> = Extract<InferredResponseType<TOp>, {
+    status: TStatus;
+}>["data"];
+type InferredRequestData<TOp> = TOp extends OpenAPIOperation ? InferredRequestType<TOp> extends {
+    data: infer TData;
+} ? TData : never : never;
+/** @deprecated Use InferredResponseData */
+type ResponseData<TOp> = InferredResponseData<TOp>;
+/** @deprecated Use InferredRequestData */
+type RequestData<TOp> = InferredRequestData<TOp>;
+
+type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<OmitIndexSignature<{
+    [TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
+}>>;
+type NullableOnNoRequiredKeysDeep<T> = HasRequiredKeys<PartialOnNoRequiredKeysDeep<T>> extends true ? PartialOnNoRequiredKeysDeep<T> : PartialOnNoRequiredKeysDeep<T> | null;
+
+type UnboxPathParameters<T> = T extends {
+    pathParameters: infer TPath;
+} ? Omit<T, "pathParameters"> & TPath : T;
+type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
+type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
+type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
+type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
+type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
+
+export type { AnyResponse as A, HttpPayload as H, InferredRequestType as I, OpenAPIOperation as O, PathParameters as P, QueryParameters as Q, Response as R, RequestFunction as a, RequestObject as b, ResponsePromise as c, RequestType as d, AnyRequest as e, InferredResponseType as f, InferredResponseData as g, InferredRequestData as h, ResponseData as i, RequestData as j, HttpStatus as k, HttpMediaType as l, HttpMethod as m, HttpHeaders as n };

package/package.json

@@ -1,68 +1,76 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "4.2.0-alpha.6",
+  "version": "4.2.1",
+  "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
+  "type": "module",
   "description": "Common types and utilities for mittwald API clients",
-  "license": "MIT",
-  "repository": "https://github.com/mittwald/api-client-js.git",
-  "author": {
-    "name": "Mittwald CM Service GmbH & Co. KG",
-    "email": "opensource@mittwald.de"
-  },
+  "keywords": [
+    "api",
+    "client",
+    "mittwald",
+    "rest",
+    "sdk"
+  ],
   "homepage": "https://developer.mittwald.de",
+  "repository": "https://github.com/mittwald/api-client-js.git",
   "bugs": "https://github.com/mittwald/api-client-js/issues",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "type": "module",
+  "license": "MIT",
   "exports": {
     ".": {
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     },
     "./react": {
-      "require": "./dist/react.cjs",
-      "import": "./dist/react.js",
-      "types": "./dist/react.d.ts"
+      "types": "./dist/react/index.d.mts",
+      "default": "./dist/react/index.mjs"
     }
   },
-  "scripts": {
-    "compile": "tsup src/index.ts src/react.ts --format esm,cjs --dts --clean",
-    "test": "node --experimental-vm-modules $(yarn bin jest)"
-  },
   "files": [
-    "dist/**/*.*"
+    "dist"
   ],
-  "keywords": [
-    "mittwald",
-    "api",
-    "client",
-    "sdk",
-    "rest"
-  ],
-  "peerDependencies": {
-    "@mittwald/react-use-promise": "^1.3.6"
-  },
-  "peerDependenciesMeta": {
-    "@mittwald/react-use-promise": {
-      "optional": true
-    }
+  "scripts": {
+    "build": "yarn unbuild",
+    "format": "prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
+    "lint": "eslint .",
+    "test": "node --experimental-vm-modules $(yarn bin jest)"
   },
   "dependencies": {
-    "@types/parse-path": "^7.0.2",
-    "axios": "^1.6.0",
+    "@types/parse-path": "^7.0.3",
+    "axios": "^1.6.2",
     "parse-path": "^7.0.0",
     "path-to-regexp": "^6.2.1",
-    "type-fest": "^4.6.0"
+    "type-fest": "^4.8.2"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@mittwald/react-use-promise": "^1.3.6",
-    "@types/jest": "^29.5.7",
+    "@mittwald/react-use-promise": "^2.1.0",
+    "@types/jest": "^29.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.12.0",
+    "@typescript-eslint/parser": "^6.12.0",
+    "eslint": "^8.54.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-json": "^3.1.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",
+    "prettier": "^3.1.0",
+    "prettier-plugin-jsdoc": "^1.1.1",
+    "prettier-plugin-pkgsort": "^0.2.1",
+    "prettier-plugin-sort-json": "^3.1.0",
     "react": "^18.2.0",
     "ts-jest": "^29.1.1",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2"
+    "tsd": "^0.29.0",
+    "typescript": "^5.3.3",
+    "unbuild": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@mittwald/react-use-promise": "^2.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@mittwald/react-use-promise": {
+      "optional": true
+    }
   },
-  "types": "./dist/index.d.ts"
+  "unbuild": {
+    "declaration": true
+  }
 }

package/dist/index.cjs

@@ -1,196 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  ApiClientBase: () => ApiClientBase,
-  ApiClientError: () => ApiClientError,
-  OpenAPIPath: () => OpenAPIPath,
-  Request: () => Request,
-  assertOneOfStatus: () => assertOneOfStatus,
-  assertStatus: () => assertStatus
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/core/ApiClientBase.ts
-var import_axios = __toESM(require("axios"), 1);
-
-// src/core/OpenAPIPath.ts
-var OpenAPIPath = class _OpenAPIPath {
-  constructor(rawPath, params) {
-    this.rawPath = rawPath;
-    this.params = params;
-  }
-  buildUrl() {
-    return _OpenAPIPath.setPathParams(this.rawPath, this.params);
-  }
-  static setPathParams(path, params) {
-    const asEntries = Object.entries(params ?? {});
-    const finalPath = asEntries.reduce((path2, entry) => {
-      const [key, value] = entry;
-      return path2.replace(`{${key}}`, encodeURIComponent(value));
-    }, path);
-    return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
-  }
-};
-var OpenAPIPath_default = OpenAPIPath;
-
-// src/core/Request.ts
-var Request = class {
-  constructor(operationDescriptor, requestObject) {
-    this.operationDescriptor = operationDescriptor;
-    this.requestObject = requestObject;
-    this.requestConfig = Object.freeze(this.buildAxiosConfig());
-  }
-  execute(axios2) {
-    return axios2.request(this.requestConfig);
-  }
-  buildAxiosConfig() {
-    const { method, path } = this.operationDescriptor;
-    const pathParameters = this.requestObject;
-    const openApiPath = new OpenAPIPath_default(path, pathParameters);
-    const url = openApiPath.buildUrl();
-    const data = this.requestObject && "data" in this.requestObject ? this.requestObject.data : void 0;
-    const headersConfig = this.requestObject && "headers" in this.requestObject ? this.requestObject.headers : void 0;
-    const headers = headersConfig ? this.makeAxiosHeaders(headersConfig) : void 0;
-    const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject ? this.requestObject.queryParameters : void 0;
-    const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
-    return {
-      url,
-      method,
-      headers,
-      // Must be a plain object or an URLSearchParams object
-      params,
-      data,
-      validateStatus: () => true
-    };
-  }
-  makeAxiosHeaders(headers) {
-    return Object.fromEntries(
-      Object.entries(headers).map(([key, value]) => [key, value?.toString()])
-    );
-  }
-  convertQueryToUrlSearchParams(query) {
-    if (query === void 0 || query === null) {
-      return void 0;
-    }
-    if (query instanceof URLSearchParams) {
-      return query;
-    }
-    if (typeof query === "string") {
-      return new URLSearchParams(query);
-    }
-    if (typeof query === "object") {
-      const searchParams = new URLSearchParams();
-      for (const [key, value] of Object.entries(query)) {
-        if (Array.isArray(value)) {
-          for (const arrayItem of value) {
-            searchParams.append(key, arrayItem);
-          }
-        } else {
-          searchParams.append(
-            key,
-            typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? value.toString() : JSON.stringify(value)
-          );
-        }
-      }
-      return searchParams;
-    }
-    throw new Error(`Unexpected query parameter type (${typeof query})`);
-  }
-};
-var Request_default = Request;
-
-// src/core/ApiClientBase.ts
-var ApiClientBase = class {
-  constructor(axiosConfig = import_axios.default) {
-    this.axios = axiosConfig instanceof import_axios.Axios ? axiosConfig : import_axios.default.create(axiosConfig);
-  }
-  requestFunctionFactory(operation) {
-    return (conf) => new Request_default(operation, conf).execute(this.axios);
-  }
-};
-
-// src/core/ApiClientError.ts
-var import_axios2 = require("axios");
-var ApiClientError = class _ApiClientError extends import_axios2.AxiosError {
-  constructor(message, code, config, request, response) {
-    super(message, code, config, request, response);
-    Object.setPrototypeOf(this, _ApiClientError.prototype);
-    this.name = "ApiClientError";
-  }
-  static fromResponse(message, response) {
-    return new _ApiClientError(
-      message,
-      void 0,
-      response.config,
-      response.request,
-      response
-    );
-  }
-};
-var ApiClientError_default = ApiClientError;
-
-// src/types/assertStatus.ts
-function assertStatus(response, expectedStatus) {
-  if (response.status !== expectedStatus) {
-    throw ApiClientError_default.fromResponse(
-      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
-      response
-    );
-  }
-}
-
-// src/types/assertOneOfStatus.ts
-function assertOneOfStatus(response, expectedStatus) {
-  if (!expectedStatus.includes(response.status)) {
-    throw ApiClientError_default.fromResponse(
-      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
-      response
-    );
-  }
-}
-
-// src/axios.ts
-var axios_exports = {};
-__reExport(axios_exports, require("axios"));
-
-// src/index.ts
-__reExport(src_exports, axios_exports, module.exports);
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ApiClientBase,
-  ApiClientError,
-  OpenAPIPath,
-  Request,
-  assertOneOfStatus,
-  assertStatus
-});

package/dist/index.js

@@ -1,48 +0,0 @@
-import {
-  ApiClientError,
-  OpenAPIPath,
-  Request,
-  Request_default,
-  __export,
-  __reExport,
-  assertOneOfStatus,
-  assertStatus
-} from "./chunk-PEYA5TMK.js";
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  ApiClientBase: () => ApiClientBase,
-  ApiClientError: () => ApiClientError,
-  OpenAPIPath: () => OpenAPIPath,
-  Request: () => Request,
-  assertOneOfStatus: () => assertOneOfStatus,
-  assertStatus: () => assertStatus
-});
-
-// src/core/ApiClientBase.ts
-import axios, { Axios } from "axios";
-var ApiClientBase = class {
-  constructor(axiosConfig = axios) {
-    this.axios = axiosConfig instanceof Axios ? axiosConfig : axios.create(axiosConfig);
-  }
-  requestFunctionFactory(operation) {
-    return (conf) => new Request_default(operation, conf).execute(this.axios);
-  }
-};
-
-// src/axios.ts
-var axios_exports = {};
-__reExport(axios_exports, axios_star);
-import * as axios_star from "axios";
-
-// src/index.ts
-__reExport(src_exports, axios_exports);
-export {
-  ApiClientBase,
-  ApiClientError,
-  OpenAPIPath,
-  Request,
-  assertOneOfStatus,
-  assertStatus
-};

package/dist/react.cjs

@@ -1,185 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/react.ts
-var react_exports = {};
-__export(react_exports, {
-  ApiCallAsyncResourceFactory: () => ApiCallAsyncResourceFactory
-});
-module.exports = __toCommonJS(react_exports);
-
-// src/react/ApiCallAsyncResourceFactory.ts
-var import_react_use_promise = require("@mittwald/react-use-promise");
-
-// src/core/ApiClientError.ts
-var import_axios = require("axios");
-var ApiClientError = class _ApiClientError extends import_axios.AxiosError {
-  constructor(message, code, config, request, response) {
-    super(message, code, config, request, response);
-    Object.setPrototypeOf(this, _ApiClientError.prototype);
-    this.name = "ApiClientError";
-  }
-  static fromResponse(message, response) {
-    return new _ApiClientError(
-      message,
-      void 0,
-      response.config,
-      response.request,
-      response
-    );
-  }
-};
-var ApiClientError_default = ApiClientError;
-
-// src/types/assertStatus.ts
-function assertStatus(response, expectedStatus) {
-  if (response.status !== expectedStatus) {
-    throw ApiClientError_default.fromResponse(
-      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
-      response
-    );
-  }
-}
-
-// src/core/OpenAPIPath.ts
-var OpenAPIPath = class _OpenAPIPath {
-  constructor(rawPath, params) {
-    this.rawPath = rawPath;
-    this.params = params;
-  }
-  buildUrl() {
-    return _OpenAPIPath.setPathParams(this.rawPath, this.params);
-  }
-  static setPathParams(path, params) {
-    const asEntries = Object.entries(params ?? {});
-    const finalPath = asEntries.reduce((path2, entry) => {
-      const [key, value] = entry;
-      return path2.replace(`{${key}}`, encodeURIComponent(value));
-    }, path);
-    return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
-  }
-};
-var OpenAPIPath_default = OpenAPIPath;
-
-// src/core/Request.ts
-var Request = class {
-  constructor(operationDescriptor, requestObject) {
-    this.operationDescriptor = operationDescriptor;
-    this.requestObject = requestObject;
-    this.requestConfig = Object.freeze(this.buildAxiosConfig());
-  }
-  execute(axios) {
-    return axios.request(this.requestConfig);
-  }
-  buildAxiosConfig() {
-    const { method, path } = this.operationDescriptor;
-    const pathParameters = this.requestObject;
-    const openApiPath = new OpenAPIPath_default(path, pathParameters);
-    const url = openApiPath.buildUrl();
-    const data = this.requestObject && "data" in this.requestObject ? this.requestObject.data : void 0;
-    const headersConfig = this.requestObject && "headers" in this.requestObject ? this.requestObject.headers : void 0;
-    const headers = headersConfig ? this.makeAxiosHeaders(headersConfig) : void 0;
-    const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject ? this.requestObject.queryParameters : void 0;
-    const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
-    return {
-      url,
-      method,
-      headers,
-      // Must be a plain object or an URLSearchParams object
-      params,
-      data,
-      validateStatus: () => true
-    };
-  }
-  makeAxiosHeaders(headers) {
-    return Object.fromEntries(
-      Object.entries(headers).map(([key, value]) => [key, value?.toString()])
-    );
-  }
-  convertQueryToUrlSearchParams(query) {
-    if (query === void 0 || query === null) {
-      return void 0;
-    }
-    if (query instanceof URLSearchParams) {
-      return query;
-    }
-    if (typeof query === "string") {
-      return new URLSearchParams(query);
-    }
-    if (typeof query === "object") {
-      const searchParams = new URLSearchParams();
-      for (const [key, value] of Object.entries(query)) {
-        if (Array.isArray(value)) {
-          for (const arrayItem of value) {
-            searchParams.append(key, arrayItem);
-          }
-        } else {
-          searchParams.append(
-            key,
-            typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? value.toString() : JSON.stringify(value)
-          );
-        }
-      }
-      return searchParams;
-    }
-    throw new Error(`Unexpected query parameter type (${typeof query})`);
-  }
-};
-var Request_default = Request;
-
-// src/react/ApiCallAsyncResourceFactory.ts
-var _ApiCallAsyncResourceFactory = class _ApiCallAsyncResourceFactory {
-  constructor(operation, requestFn) {
-    this.getApiResource = (requestObj) => {
-      const request = new Request_default(this.operation, requestObj);
-      return (0, import_react_use_promise.getAsyncResource)(
-        (requestObj2) => this.executeRequest(requestObj2),
-        [requestObj],
-        {
-          tags: this.getAsyncResourceTags(request),
-          loaderId: this.getAsyncResourceId()
-        }
-      );
-    };
-    this.operation = operation;
-    this.requestFn = requestFn;
-  }
-  getAsyncResourceId() {
-    return `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
-  }
-  getAsyncResourceTags(request) {
-    const url = request.requestConfig.url ?? "";
-    return [
-      this.getAsyncResourceId(),
-      `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
-      `${_ApiCallAsyncResourceFactory.namespace}/${url}`
-    ];
-  }
-  async executeRequest(requestObj) {
-    const response = await this.requestFn(requestObj);
-    assertStatus(response, 200);
-    return response.data;
-  }
-};
-_ApiCallAsyncResourceFactory.namespace = "@mittwald/api-client";
-var ApiCallAsyncResourceFactory = _ApiCallAsyncResourceFactory;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ApiCallAsyncResourceFactory
-});

package/dist/react.js

@@ -1,45 +0,0 @@
-import {
-  Request_default,
-  assertStatus
-} from "./chunk-PEYA5TMK.js";
-
-// src/react/ApiCallAsyncResourceFactory.ts
-import { getAsyncResource } from "@mittwald/react-use-promise";
-var _ApiCallAsyncResourceFactory = class _ApiCallAsyncResourceFactory {
-  constructor(operation, requestFn) {
-    this.getApiResource = (requestObj) => {
-      const request = new Request_default(this.operation, requestObj);
-      return getAsyncResource(
-        (requestObj2) => this.executeRequest(requestObj2),
-        [requestObj],
-        {
-          tags: this.getAsyncResourceTags(request),
-          loaderId: this.getAsyncResourceId()
-        }
-      );
-    };
-    this.operation = operation;
-    this.requestFn = requestFn;
-  }
-  getAsyncResourceId() {
-    return `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
-  }
-  getAsyncResourceTags(request) {
-    const url = request.requestConfig.url ?? "";
-    return [
-      this.getAsyncResourceId(),
-      `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
-      `${_ApiCallAsyncResourceFactory.namespace}/${url}`
-    ];
-  }
-  async executeRequest(requestObj) {
-    const response = await this.requestFn(requestObj);
-    assertStatus(response, 200);
-    return response.data;
-  }
-};
-_ApiCallAsyncResourceFactory.namespace = "@mittwald/api-client";
-var ApiCallAsyncResourceFactory = _ApiCallAsyncResourceFactory;
-export {
-  ApiCallAsyncResourceFactory
-};