@mittwald/api-client-commons 4.13.1 → 4.15.0

package/README.md

@@ -56,3 +56,34 @@ if (!response.data) {
   console.log("Project not found");
 }
 ```
+
+### Common interceptors
+
+To make it easy to opt in to some API mechanisms, a few
+[interceptors](https://axios-http.com/docs/interceptors) can be easily
+configured.
+
+#### withAccessToken
+
+In most cases you want to add the users access token to every API-Request as a
+request header. This can be tedious if you need to do this on your own. To
+automatically set the request header use `withAccessToken` for your `APIClient`
+instance.
+
+```ts
+const client = new APIClient({ baseURL });
+const authenticatedClient = withToken(client, token);
+```
+
+#### withEventConsistencyHandling
+
+To opt in into the
+[event consistency handling](https://developer.mittwald.de/docs/v2/api/intro/#eventual-consistency)
+you might use `withEventConsistencyHandling`. This will set automatically handle
+the `etag` response header and set its value as `if-event-reached` request
+header for GET requests:
+
+```ts
+const client = new APIClient({ baseURL });
+const authenticatedClient = withEventConsistencyHandling(client);
+```

package/dist/esm/index.js

@@ -1,3 +1,4 @@
 export * from "./core/index.js";
 export * from "./types/index.js";
 export * from "./axios.js";
+export * from "./interceptors/index.js";

package/dist/esm/interceptors/accessToken.js

@@ -0,0 +1,19 @@
+import ApiClientBase from "../core/ApiClientBase.js";
+function configureAccessTokenInterceptor(axios, token, headerName = "x-access-token") {
+    axios.interceptors.request.use((conf) => {
+        if (!conf.headers.has(headerName)) {
+            conf.headers.set(headerName, token);
+        }
+        return conf;
+    });
+}
+export function withAccessToken(clientOrAxiosInstance, token, headerName = "x-access-token") {
+    if (token) {
+        const axiosInstance = clientOrAxiosInstance instanceof ApiClientBase
+            ? clientOrAxiosInstance.axios
+            : clientOrAxiosInstance;
+        configureAccessTokenInterceptor(axiosInstance, token, headerName);
+    }
+    return clientOrAxiosInstance;
+}
+export default withAccessToken;

package/dist/esm/interceptors/consistencyHandling.js

@@ -0,0 +1,27 @@
+import ApiClientBase from "../core/ApiClientBase.js";
+function isMutatingRequest(request) {
+    return ["post", "put", "delete", "patch"].includes(request.method?.toLowerCase() ?? "");
+}
+function configureConsistencyHandlingInterceptor(axios) {
+    let lastEventId = undefined;
+    axios.interceptors.request.use((config) => {
+        if (lastEventId !== undefined && !isMutatingRequest(config)) {
+            config.headers["if-event-reached"] = lastEventId;
+        }
+        return config;
+    });
+    axios.interceptors.response.use((response) => {
+        const headers = response.headers;
+        if (headers.has("etag") && isMutatingRequest(response.config)) {
+            lastEventId = headers.get("etag");
+        }
+        return response;
+    });
+}
+export function withEventConsistencyHandling(clientOrAxiosInstance) {
+    const axiosInstance = clientOrAxiosInstance instanceof ApiClientBase
+        ? clientOrAxiosInstance.axios
+        : clientOrAxiosInstance;
+    configureConsistencyHandlingInterceptor(axiosInstance);
+    return clientOrAxiosInstance;
+}

package/dist/esm/interceptors/index.js

@@ -0,0 +1,2 @@
+export * from "./accessToken.js";
+export * from "./consistencyHandling.js";

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./core/index.js";
 export * from "./types/index.js";
 export * from "./axios.js";
+export * from "./interceptors/index.js";

package/dist/types/interceptors/accessToken.d.ts

@@ -0,0 +1,4 @@
+import { AxiosInstance } from "axios";
+import ApiClientBase from "../core/ApiClientBase.js";
+export declare function withAccessToken<T extends ApiClientBase | AxiosInstance>(clientOrAxiosInstance: T, token: string | undefined, headerName?: string): T;
+export default withAccessToken;

package/dist/types/interceptors/consistencyHandling.d.ts

@@ -0,0 +1,3 @@
+import { AxiosInstance } from "axios";
+import ApiClientBase from "../core/ApiClientBase.js";
+export declare function withEventConsistencyHandling<T extends ApiClientBase | AxiosInstance>(clientOrAxiosInstance: T): T;

package/dist/types/interceptors/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./accessToken.js";
+export * from "./consistencyHandling.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "4.13.1",
+  "version": "4.15.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Common types and utilities for mittwald API clients",
@@ -44,15 +44,15 @@
     "axios": "^1.6.7",
     "parse-path": "^7.0.0",
     "path-to-regexp": "^6.2.1",
-    "type-fest": "^4.10.3"
+    "type-fest": "^4.12.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@mittwald/react-use-promise": "^2.3.12",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
-    "@typescript-eslint/parser": "^7.0.2",
-    "eslint": "^8.56.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-prettier": "^5.1.3",
@@ -64,8 +64,8 @@
     "react": "^18.2.0",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.2",
-    "tsd": "^0.30.6",
-    "typescript": "^5.3.3"
+    "tsd": "^0.30.7",
+    "typescript": "^5.4.2"
   },
   "peerDependencies": {
     "@mittwald/react-use-promise": "^2.1.0"
@@ -78,5 +78,5 @@
       "optional": true
     }
   },
-  "gitHead": "27ede7b99b15b423749de87ecf08d74701721734"
+  "gitHead": "b04612b188ae649a5d1fb7788da3a6149d6a7ebd"
 }