@mittwald/api-client-commons 0.0.0-development-04b7288-20240610

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mittwald CM Service GmbH & Co. KG and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+Common code base used by `@mittwald/api-client-*` package.
+
+## API
+
+### assertStatus, assertOneOfStatus
+
+The API client does not validate any response status by design, to give you the
+most flexibility while handling also erroneous responses. If you want to assert
+some desired response status, you can use the `assertStatus` resp.
+`assertOneOfStatus` function.
+
+#### assertStatus(response, expectedStatus)
+
+Returns: void
+
+This method throws an `ApiClientError` if the given `response` does not match
+the `expectedStatus`.
+
+When you are using TypeScript this function also asserts the correct response
+type.
+
+```ts
+const response = await client.project.getProject({
+  pathParameters: {
+    projectId: "...",
+  },
+});
+
+assertStatus(response, 200);
+
+const project = response.data;
+// Project properties can now be accessed safely
+const name = project.name;
+```
+
+#### assertOnOfStatus(response, expectedStatus)
+
+Returns: void
+
+This method throws an `ApiClientError` if the given `response` does not match
+the `expectedStatus`.
+
+When you are using TypeScript this function also asserts the correct response
+type.
+
+```ts
+const response = await client.project.getProject({
+  pathParameters: {
+    projectId: "...",
+  },
+});
+
+assertOneOfStatus(response, [200, 404]);
+
+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/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@mittwald/api-client-commons",
+  "version": "0.0.0-development-04b7288-20240610",
+  "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
+  "type": "module",
+  "description": "Common types and utilities for mittwald API clients",
+  "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",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/esm/index.js"
+    },
+    "./testing": {
+      "types": "./dist/types/testing/index.d.ts",
+      "default": "./dist/esm/testing/index.js"
+    },
+    "./react": {
+      "types": "./dist/types/react/index.d.ts",
+      "default": "./dist/esm/react/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "run build:clean && run tsc",
+    "build:clean": "run rimraf dist",
+    "format": "run prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
+    "lint": "run eslint .",
+    "test": "node --experimental-vm-modules $(yarn bin jest)"
+  },
+  "dependencies": {
+    "@types/parse-path": "^7.0.3",
+    "axios": "^1.6.7",
+    "parse-path": "^7.0.0",
+    "path-to-regexp": "^6.2.1",
+    "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.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",
+    "jest": "^29.7.0",
+    "prettier": "^3.2.5",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "prettier-plugin-pkgsort": "^0.2.1",
+    "prettier-plugin-sort-json": "^3.1.0",
+    "react": "^18.2.0",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "tsd": "^0.30.7",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "@mittwald/react-use-promise": "^2.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@jest/globals": {
+      "optional": true
+    },
+    "@mittwald/react-use-promise": {
+      "optional": true
+    }
+  },
+  "gitHead": "97660b1fee614cc23b778573ba3e8ae75a961517"
+}