@mittwald/api-client-commons 4.58.1 → 4.60.0

package/dist/esm/core/ApiClientBase.js

@@ -2,12 +2,26 @@ import axios, { Axios } from "axios";
 import Request from "./Request.js";
 export class ApiClientBase {
     axios;
+    defaultRequestOptions = {};
     constructor(axiosConfig = axios) {
         this.axios =
             axiosConfig instanceof Axios ? axiosConfig : axios.create(axiosConfig);
     }
+    buildRequestOptions(fromRequest) {
+        return {
+            ...this.defaultRequestOptions,
+            ...fromRequest,
+        };
+    }
     requestFunctionFactory(operation) {
-        return (conf) => new Request(operation, conf).execute(this.axios);
+        return (conf, opts = {}) => {
+            const { onBeforeRequest } = this.buildRequestOptions(opts);
+            const request = new Request(operation, conf);
+            if (onBeforeRequest) {
+                onBeforeRequest(request);
+            }
+            return request.execute(this.axios);
+        };
     }
 }
 export default ApiClientBase;

package/dist/esm/core/ApiClientBase.test.js

@@ -0,0 +1,37 @@
+import { Axios } from "axios";
+import { beforeEach, jest } from "@jest/globals";
+import ApiClientBase from "./ApiClientBase.js";
+const requestFn = jest.fn();
+const mockedAxios = Object.assign(Object.create(Axios.prototype), {
+    request: requestFn,
+});
+class TestClient extends ApiClientBase {
+    testRequest = this.requestFunctionFactory({
+        path: "/test",
+        method: "GET",
+        operationId: "test",
+    });
+}
+const testClient = new TestClient(mockedAxios);
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+test("onBeforeRequest is called before actual request", async () => {
+    const onBeforeRequest = jest.fn(() => {
+        expect(requestFn).not.toHaveBeenCalled();
+    });
+    await testClient.testRequest(undefined, {
+        onBeforeRequest,
+    });
+    expect(onBeforeRequest).toHaveBeenCalledTimes(1);
+    expect(requestFn).toHaveBeenCalledTimes(1);
+});
+test("onBeforeRequest configured in default options is called before actual request", async () => {
+    const onBeforeRequest = jest.fn(() => {
+        expect(requestFn).not.toHaveBeenCalled();
+    });
+    testClient.defaultRequestOptions.onBeforeRequest = onBeforeRequest;
+    await testClient.testRequest(undefined);
+    expect(onBeforeRequest).toHaveBeenCalledTimes(1);
+    expect(requestFn).toHaveBeenCalledTimes(1);
+});

package/dist/types/core/ApiClientBase.d.ts

@@ -1,9 +1,11 @@
 import { AxiosInstance, CreateAxiosDefaults } from "axios";
-import { RequestFunction } from "../types/index.js";
+import { RequestFunction, RequestOptions } from "../types/index.js";
 import { OpenAPIOperation } from "../types/index.js";
 export declare abstract class ApiClientBase {
-    axios: AxiosInstance;
+    readonly axios: AxiosInstance;
+    readonly defaultRequestOptions: RequestOptions;
     constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
+    private buildRequestOptions;
     protected requestFunctionFactory<TOp extends OpenAPIOperation>(operation: TOp): RequestFunction<TOp>;
 }
 export default ApiClientBase;

package/dist/types/core/ApiClientBase.test.d.ts

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

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

@@ -1,11 +1,15 @@
 import { InferredRequestType, InferredResponseType, OpenAPIOperation } from "./OpenAPIOperation.js";
 import { NullableOnNoRequiredKeysDeep } from "./NullableOnNoRequiredKeysDeep.js";
+import Request from "../core/Request.js";
+export interface RequestOptions<TOp extends OpenAPIOperation = OpenAPIOperation> {
+    onBeforeRequest?: (req: Request<TOp>) => void;
+}
 type UnboxPathParameters<T> = T extends {
     pathParameters: infer TPath;
 } ? Omit<T, "pathParameters"> & TPath : T;
 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?: RequestObject<TOp>) => ResponsePromise<TOp>;
-type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>) => ResponsePromise<TOp>;
+type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestObject<TOp>, opts?: RequestOptions<TOp>) => ResponsePromise<TOp>;
+type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestObject<TOp>, opts?: RequestOptions<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.58.1",
+  "version": "4.60.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Common types and utilities for mittwald API clients",
@@ -41,14 +41,14 @@
   },
   "dependencies": {
     "@types/parse-path": "^7.0.3",
-    "axios": "^1.7.4",
+    "axios": "^1.7.7",
     "parse-path": "^7.0.0",
     "path-to-regexp": "^8.1.0",
     "type-fest": "^4.23.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@mittwald/react-use-promise": "^2.3.13",
+    "@mittwald/react-use-promise": "^2.5.0",
     "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
@@ -78,5 +78,5 @@
       "optional": true
     }
   },
-  "gitHead": "df0b8fa85d0a03da0dbab27569adc4db65fd84f2"
+  "gitHead": "8058044c2d8ab32e0507561baa1172cbfbce4fe0"
 }