@mittwald/api-client-commons 4.0.1 → 4.1.0-alpha.1

package/dist/cjs/core/ApiClientBase.js

@@ -1,8 +1,34 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiClientBase = void 0;
-const axios_1 = require("axios");
-const Request_js_1 = require("./Request.js");
+const axios_1 = __importStar(require("axios"));
+const Request_js_1 = __importDefault(require("./Request.js"));
 class ApiClientBase {
     constructor(axiosConfig = axios_1.default) {
         this.axios =

package/dist/cjs/core/Request.d.ts

@@ -1,10 +1,11 @@
-import { OpenAPIOperation, RequestConfig, ResponsePromise } from "../types/index.js";
-import { AxiosInstance } from "axios";
+import { OpenAPIOperation, RequestObject, ResponsePromise } from "../types/index.js";
+import { AxiosInstance, AxiosRequestConfig } from "axios";
 export declare class Request<TOp extends OpenAPIOperation> {
     private readonly axios;
     private readonly operationDescriptor;
-    private readonly config?;
-    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, config?: RequestConfig<TOp>);
+    private readonly requestObject?;
+    readonly requestConfig: AxiosRequestConfig;
+    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, request?: RequestObject<TOp>);
     execute(): ResponsePromise<TOp>;
     private buildAxiosConfig;
     private makeAxiosHeaders;

package/dist/cjs/core/Request.js

@@ -1,28 +1,36 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Request = void 0;
-const OpenAPIPath_js_1 = require("./OpenAPIPath.js");
+const OpenAPIPath_js_1 = __importDefault(require("./OpenAPIPath.js"));
 class Request {
-    constructor(axiosInstance, operationDescriptor, config) {
+    constructor(axiosInstance, operationDescriptor, request) {
         this.axios = axiosInstance;
         this.operationDescriptor = operationDescriptor;
-        this.config = config;
+        this.requestObject = request;
+        this.requestConfig = Object.freeze(this.buildAxiosConfig());
     }
     execute() {
-        return this.axios.request(this.buildAxiosConfig());
+        return this.axios.request(this.requestConfig);
     }
     buildAxiosConfig() {
         const { method, path } = this.operationDescriptor;
-        const pathParameters = this.config;
+        const pathParameters = this.requestObject;
         const openApiPath = new OpenAPIPath_js_1.default(path, pathParameters);
         const url = openApiPath.buildUrl();
-        const data = this.config && "data" in this.config ? this.config.data : undefined;
-        const headersConfig = this.config && "headers" in this.config ? this.config.headers : undefined;
+        const data = this.requestObject && "data" in this.requestObject
+            ? this.requestObject.data
+            : undefined;
+        const headersConfig = this.requestObject && "headers" in this.requestObject
+            ? this.requestObject.headers
+            : undefined;
         const headers = headersConfig
             ? this.makeAxiosHeaders(headersConfig)
             : undefined;
-        const queryParametersConfig = this.config && "queryParameters" in this.config
-            ? this.config.queryParameters
+        const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject
+            ? this.requestObject.queryParameters
             : undefined;
         const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
         return {

package/dist/cjs/core/Request.test.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Request_js_1 = require("./Request.js");
+const Request_js_1 = __importDefault(require("./Request.js"));
 const globals_1 = require("@jest/globals");
 const requestFn = globals_1.jest.fn();
 const mockedAxios = {

package/dist/cjs/react/getAsyncResourceFactory.d.ts

@@ -0,0 +1,10 @@
+import { AsyncResource } from "@mittwald/react-use-promise";
+import { InferredResponseType, OpenAPIOperation, RequestObject } from "../types/index.js";
+import { AxiosInstance } from "axios";
+type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>>;
+export declare const getAsyncResourceFactory: <TOp extends OpenAPIOperation<{
+    headers?: Partial<{
+        [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
+    }> | undefined;
+}, import("../types/Response.js").Response>>(axios: AxiosInstance, op: TOp) => GetApiResourceFn<TOp>;
+export {};

package/dist/cjs/react/getAsyncResourceFactory.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAsyncResourceFactory = void 0;
+const react_use_promise_1 = require("@mittwald/react-use-promise");
+const Request_js_1 = __importDefault(require("../core/Request.js"));
+const prefix = "@mittwald/api-client/";
+const getAsyncResourceFactory = (axios, op) => ((requestObj) => {
+    const request = new Request_js_1.default(axios, op, requestObj);
+    const url = request.requestConfig.url;
+    const loaderId = prefix + op.operationId;
+    const tags = [loaderId, prefix + op.method];
+    if (url) {
+        tags.push(prefix + url);
+    }
+    return (0, react_use_promise_1.getAsyncResource)((ignored) => request.execute(), [requestObj], {
+        tags,
+        loaderId,
+    });
+});
+exports.getAsyncResourceFactory = getAsyncResourceFactory;

package/dist/cjs/react/getAsyncResourceFactory.test-types.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/react/getAsyncResourceFactory.test-types.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getAsyncResourceFactory_js_1 = require("./getAsyncResourceFactory.js");
+const getStuff = (0, getAsyncResourceFactory_js_1.getAsyncResourceFactory)({}, {
+    operationId: "getStuff",
+    path: "/stuff",
+    method: "GET",
+});
+function ignoredCheckRequestType() {
+    getStuff({
+        data: {
+            // @ts-expect-error Not matching request type
+            foo: "",
+        },
+    });
+    getStuff({
+        data: {
+            requestString: "",
+        },
+    });
+}
+function ignoredCheckResponseType() {
+    const stuff = getStuff({
+        data: {
+            requestString: "",
+        },
+    }).watch();
+    // @ts-expect-error error
+    if (stuff.status === 42) {
+        // must be 200
+    }
+    // @ts-expect-error Accessing unknown prop
+    stuff.data.foo;
+    (function (ignored) {
+        // @ts-expect-error is a number
+    })(stuff.data.responseNumber);
+    (function (ignored) {
+        // is number
+    })(stuff.data.responseNumber);
+}

package/dist/cjs/react/getAsyncResourceFactory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/react/getAsyncResourceFactory.test.js

@@ -0,0 +1,61 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const getAsyncResourceFactory_js_1 = require("./getAsyncResourceFactory.js");
+const react_use_promise_1 = require("@mittwald/react-use-promise");
+(0, globals_1.beforeEach)(() => {
+    (0, react_use_promise_1.refresh)();
+    globals_1.jest.resetAllMocks();
+});
+const requestMock = globals_1.jest.fn();
+const axios = { request: requestMock };
+const getStuff = (0, getAsyncResourceFactory_js_1.getAsyncResourceFactory)(axios, {
+    operationId: "getStuff",
+    path: "/stuff",
+    method: "GET",
+});
+const testRequest1 = {
+    data: {
+        foo: "bar",
+    },
+};
+const testRequest2 = {
+    data: {
+        foo: "baz",
+    },
+};
+test("Resource loader executes request", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield getStuff(testRequest1).load();
+    (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
+    const firstRequestParams = requestMock.mock.calls[0][0];
+    (0, globals_1.expect)(firstRequestParams).toMatchObject({
+        method: "GET",
+        url: "stuff",
+    });
+}));
+test("Resource is cached under URL", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield getStuff(testRequest1).load();
+    (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
+    yield getStuff(testRequest1).load();
+    (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
+    (0, react_use_promise_1.refresh)({
+        tag: "@mittwald/api-client/stuff",
+    });
+    yield getStuff(testRequest1).load();
+    (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(2);
+}));
+test("Resources are different when request object changes", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield getStuff(testRequest1).load();
+    (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(1);
+    yield getStuff(testRequest2).load();
+    (0, globals_1.expect)(requestMock).toHaveBeenCalledTimes(2);
+}));

package/dist/cjs/react/index.d.ts

@@ -0,0 +1 @@
+export * from "./getAsyncResourceFactory.js";

package/dist/cjs/react/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./getAsyncResourceFactory.js"), exports);

package/dist/cjs/types/RequestFunction.d.ts

@@ -3,9 +3,9 @@ import { NullableOnNoRequiredKeysDeep } from "./NullableOnNoRequiredKeysDeep.js"
 type UnboxPathParameters<T> = T extends {
     pathParameters: infer TPath;
 } ? Omit<T, "pathParameters"> & TPath : T;
-export type RequestConfig<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
+export type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
 export type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
-type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestConfig<TOp>) => ResponsePromise<TOp>;
-type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestConfig<TOp>) => ResponsePromise<TOp>;
-export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestConfig<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
+type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
+type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
+export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
 export {};

package/dist/cjs/types/assertStatus.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assertStatus = void 0;
-const ApiClientError_js_1 = require("../core/ApiClientError.js");
+const ApiClientError_js_1 = __importDefault(require("../core/ApiClientError.js"));
 function assertStatus(response, expectedStatus) {
     if (response.status !== expectedStatus) {
         throw ApiClientError_js_1.default.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);

package/dist/cjs/types/assertStatus.test-types.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const tsd_1 = require("tsd");
-const assertStatus_js_1 = require("./assertStatus.js");
+const assertStatus_js_1 = __importDefault(require("./assertStatus.js"));
 function ignoredTestAssertStatusAssertsAlsoTheCorrectResponseType() {
     (0, assertStatus_js_1.default)(someResponse, 200);
     (0, tsd_1.expectAssignable)(someResponse);

package/dist/esm/core/Request.d.ts

@@ -1,10 +1,11 @@
-import { OpenAPIOperation, RequestConfig, ResponsePromise } from "../types/index.js";
-import { AxiosInstance } from "axios";
+import { OpenAPIOperation, RequestObject, ResponsePromise } from "../types/index.js";
+import { AxiosInstance, AxiosRequestConfig } from "axios";
 export declare class Request<TOp extends OpenAPIOperation> {
     private readonly axios;
     private readonly operationDescriptor;
-    private readonly config?;
-    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, config?: RequestConfig<TOp>);
+    private readonly requestObject?;
+    readonly requestConfig: AxiosRequestConfig;
+    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, request?: RequestObject<TOp>);
     execute(): ResponsePromise<TOp>;
     private buildAxiosConfig;
     private makeAxiosHeaders;

package/dist/esm/core/Request.js

@@ -2,27 +2,33 @@ import OpenAPIPath from "./OpenAPIPath.js";
 export class Request {
     axios;
     operationDescriptor;
-    config;
-    constructor(axiosInstance, operationDescriptor, config) {
+    requestObject;
+    requestConfig;
+    constructor(axiosInstance, operationDescriptor, request) {
         this.axios = axiosInstance;
         this.operationDescriptor = operationDescriptor;
-        this.config = config;
+        this.requestObject = request;
+        this.requestConfig = Object.freeze(this.buildAxiosConfig());
     }
     execute() {
-        return this.axios.request(this.buildAxiosConfig());
+        return this.axios.request(this.requestConfig);
     }
     buildAxiosConfig() {
         const { method, path } = this.operationDescriptor;
-        const pathParameters = this.config;
+        const pathParameters = this.requestObject;
         const openApiPath = new OpenAPIPath(path, pathParameters);
         const url = openApiPath.buildUrl();
-        const data = this.config && "data" in this.config ? this.config.data : undefined;
-        const headersConfig = this.config && "headers" in this.config ? this.config.headers : undefined;
+        const data = this.requestObject && "data" in this.requestObject
+            ? this.requestObject.data
+            : undefined;
+        const headersConfig = this.requestObject && "headers" in this.requestObject
+            ? this.requestObject.headers
+            : undefined;
         const headers = headersConfig
             ? this.makeAxiosHeaders(headersConfig)
             : undefined;
-        const queryParametersConfig = this.config && "queryParameters" in this.config
-            ? this.config.queryParameters
+        const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject
+            ? this.requestObject.queryParameters
             : undefined;
         const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
         return {

package/dist/esm/react/getAsyncResourceFactory.d.ts

@@ -0,0 +1,10 @@
+import { AsyncResource } from "@mittwald/react-use-promise";
+import { InferredResponseType, OpenAPIOperation, RequestObject } from "../types/index.js";
+import { AxiosInstance } from "axios";
+type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseType<TOp>>;
+export declare const getAsyncResourceFactory: <TOp extends OpenAPIOperation<{
+    headers?: Partial<{
+        [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
+    }> | undefined;
+}, import("../types/Response.js").Response>>(axios: AxiosInstance, op: TOp) => GetApiResourceFn<TOp>;
+export {};

package/dist/esm/react/getAsyncResourceFactory.js

@@ -0,0 +1,16 @@
+import { getAsyncResource } from "@mittwald/react-use-promise";
+import Request from "../core/Request.js";
+const prefix = "@mittwald/api-client/";
+export const getAsyncResourceFactory = (axios, op) => ((requestObj) => {
+    const request = new Request(axios, op, requestObj);
+    const url = request.requestConfig.url;
+    const loaderId = prefix + op.operationId;
+    const tags = [loaderId, prefix + op.method];
+    if (url) {
+        tags.push(prefix + url);
+    }
+    return getAsyncResource((ignored) => request.execute(), [requestObj], {
+        tags,
+        loaderId,
+    });
+});

package/dist/esm/react/getAsyncResourceFactory.test-types.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/react/getAsyncResourceFactory.test-types.js

@@ -0,0 +1,38 @@
+import { getAsyncResourceFactory } from "./getAsyncResourceFactory.js";
+const getStuff = getAsyncResourceFactory({}, {
+    operationId: "getStuff",
+    path: "/stuff",
+    method: "GET",
+});
+function ignoredCheckRequestType() {
+    getStuff({
+        data: {
+            // @ts-expect-error Not matching request type
+            foo: "",
+        },
+    });
+    getStuff({
+        data: {
+            requestString: "",
+        },
+    });
+}
+function ignoredCheckResponseType() {
+    const stuff = getStuff({
+        data: {
+            requestString: "",
+        },
+    }).watch();
+    // @ts-expect-error error
+    if (stuff.status === 42) {
+        // must be 200
+    }
+    // @ts-expect-error Accessing unknown prop
+    stuff.data.foo;
+    (function (ignored) {
+        // @ts-expect-error is a number
+    })(stuff.data.responseNumber);
+    (function (ignored) {
+        // is number
+    })(stuff.data.responseNumber);
+}

package/dist/esm/react/getAsyncResourceFactory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/react/getAsyncResourceFactory.test.js

@@ -0,0 +1,50 @@
+import { beforeEach, expect, jest } from "@jest/globals";
+import { getAsyncResourceFactory } from "./getAsyncResourceFactory.js";
+import { refresh } from "@mittwald/react-use-promise";
+beforeEach(() => {
+    refresh();
+    jest.resetAllMocks();
+});
+const requestMock = jest.fn();
+const axios = { request: requestMock };
+const getStuff = getAsyncResourceFactory(axios, {
+    operationId: "getStuff",
+    path: "/stuff",
+    method: "GET",
+});
+const testRequest1 = {
+    data: {
+        foo: "bar",
+    },
+};
+const testRequest2 = {
+    data: {
+        foo: "baz",
+    },
+};
+test("Resource loader executes request", async () => {
+    await getStuff(testRequest1).load();
+    expect(requestMock).toHaveBeenCalledTimes(1);
+    const firstRequestParams = requestMock.mock.calls[0][0];
+    expect(firstRequestParams).toMatchObject({
+        method: "GET",
+        url: "stuff",
+    });
+});
+test("Resource is cached under URL", async () => {
+    await getStuff(testRequest1).load();
+    expect(requestMock).toHaveBeenCalledTimes(1);
+    await getStuff(testRequest1).load();
+    expect(requestMock).toHaveBeenCalledTimes(1);
+    refresh({
+        tag: "@mittwald/api-client/stuff",
+    });
+    await getStuff(testRequest1).load();
+    expect(requestMock).toHaveBeenCalledTimes(2);
+});
+test("Resources are different when request object changes", async () => {
+    await getStuff(testRequest1).load();
+    expect(requestMock).toHaveBeenCalledTimes(1);
+    await getStuff(testRequest2).load();
+    expect(requestMock).toHaveBeenCalledTimes(2);
+});

package/dist/esm/react/index.d.ts

@@ -0,0 +1 @@
+export * from "./getAsyncResourceFactory.js";

package/dist/esm/react/index.js

@@ -0,0 +1 @@
+export * from "./getAsyncResourceFactory.js";

package/dist/esm/types/RequestFunction.d.ts

@@ -3,9 +3,9 @@ import { NullableOnNoRequiredKeysDeep } from "./NullableOnNoRequiredKeysDeep.js"
 type UnboxPathParameters<T> = T extends {
     pathParameters: infer TPath;
 } ? Omit<T, "pathParameters"> & TPath : T;
-export type RequestConfig<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
+export type RequestObject<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<UnboxPathParameters<InferredRequestType<TOp>>>;
 export type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
-type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestConfig<TOp>) => ResponsePromise<TOp>;
-type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestConfig<TOp>) => ResponsePromise<TOp>;
-export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestConfig<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
+type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>) => ResponsePromise<TOp>;
+type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
+export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "4.0.1",
+  "version": "4.1.0-alpha.1",
   "description": "Common types and utilities for mittwald API clients",
   "license": "MIT",
   "repository": "https://github.com/mittwald/api-client-js.git",
@@ -22,6 +22,16 @@
         "require": "./dist/cjs/index.js",
         "default": "./dist/esm/index.js"
       }
+    },
+    "./react": {
+      "types": {
+        "require": "./dist/cjs/react/index.d.ts",
+        "default": "./dist/esm/react/index.d.ts"
+      },
+      "default": {
+        "require": "./dist/cjs/react/index.js",
+        "default": "./dist/esm/react/index.js"
+      }
     }
   },
   "scripts": {
@@ -37,6 +47,14 @@
     "sdk",
     "rest"
   ],
+  "peerDependencies": {
+    "@mittwald/react-use-promise": "^1.3.2"
+  },
+  "peerDependenciesMeta": {
+    "@mittwald/react-use-promise": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@types/parse-path": "^7.0.0",
     "axios": "^1.4.0",
@@ -46,9 +64,11 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.6.0",
+    "@mittwald/react-use-promise": "^1.3.2",
     "@types/jest": "^29.5.2",
     "@yarnpkg/pnpify": "^4.0.0-rc.48",
     "jest": "^29.6.1",
+    "react": "^18.2.0",
     "ts-jest": "^29.1.1",
     "tsd": "^0.28.1"
   },