@mittwald/api-client-commons 4.8.2 → 4.10.0

package/README.md

@@ -2,11 +2,12 @@ Common code base used by `@mittwald/api-client-*` package.
 
 ## API
 
-### assertStatus
+### 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` function.
+some desired response status, you can use the `assertStatus` resp.
+`assertOneOfStatus` function.
 
 #### assertStatus(response, expectedStatus)
 
@@ -31,3 +32,27 @@ 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");
+}
+```

package/dist/esm/types/assertOneOfStatus.js

@@ -0,0 +1,7 @@
+import ApiClientError from "../core/ApiClientError.js";
+export function assertOneOfStatus(response, expectedStatus) {
+    if (!expectedStatus.includes(response.status)) {
+        throw ApiClientError.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
+    }
+}
+export default assertOneOfStatus;

package/dist/esm/types/assertStatus.js

@@ -1,7 +1,5 @@
-import ApiClientError from "../core/ApiClientError.js";
+import assertOneOfStatus from "./assertOneOfStatus.js";
 export function assertStatus(response, expectedStatus) {
-    if (response.status !== expectedStatus) {
-        throw ApiClientError.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
-    }
+    assertOneOfStatus(response, [expectedStatus]);
 }
 export default assertStatus;

package/dist/esm/types/index.js

@@ -5,3 +5,4 @@ export * from "./OpenAPIOperation.js";
 export * from "./http.js";
 export * from "./simplify.js";
 export * from "./assertStatus.js";
+export * from "./assertOneOfStatus.js";

package/dist/types/types/assertOneOfStatus.d.ts

@@ -0,0 +1,5 @@
+import { Response } from "./Response.js";
+export declare function assertOneOfStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S[]): asserts response is T & {
+    status: S;
+};
+export default assertOneOfStatus;

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

@@ -5,3 +5,4 @@ export * from "./OpenAPIOperation.js";
 export * from "./http.js";
 export * from "./simplify.js";
 export * from "./assertStatus.js";
+export * from "./assertOneOfStatus.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "4.8.2",
+  "version": "4.10.0",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Common types and utilities for mittwald API clients",
@@ -71,5 +71,5 @@
       "optional": true
     }
   },
-  "gitHead": "3f028bedde28da6271bba34dc7438dc4307a7437"
+  "gitHead": "2a22d83ac84633065aeae70821f6f6297c3d91e9"
 }