New Models package

packages/commons/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");
+}
+```

packages/commons/src/types/assertOneOfStatus.ts

@@ -0,0 +1,16 @@
+import ApiClientError from "../core/ApiClientError.js";
+import { Response } from "./Response.js";
+
+export function assertOneOfStatus<T extends Response, S extends T["status"]>(
+  response: T,
+  expectedStatus: S[],
+): asserts response is T & { status: S } {
+  if (!expectedStatus.includes(response.status as S)) {
+    throw ApiClientError.fromResponse(
+      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
+      response,
+    );
+  }
+}
+
+export default assertOneOfStatus;

packages/commons/src/types/assertStatus.ts

@@ -1,16 +1,11 @@
 import { Response } from "./Response.js";
-import ApiClientError from "../core/ApiClientError.js";
+import assertOneOfStatus from "./assertOneOfStatus.js";
 
 export function assertStatus<T extends Response, S extends T["status"]>(
   response: T,
   expectedStatus: S,
 ): asserts response is T & { status: S } {
-  if (response.status !== expectedStatus) {
-    throw ApiClientError.fromResponse(
-      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
-      response,
-    );
-  }
+  assertOneOfStatus(response, [expectedStatus]);
 }
 
 export default assertStatus;

packages/commons/src/types/index.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";

packages/mittwald/src/index.ts

@@ -1,3 +1,3 @@
-export { assertStatus } from "@mittwald/api-client-commons";
+export { assertStatus, assertOneOfStatus } from "@mittwald/api-client-commons";
 export { MittwaldAPIClient as MittwaldAPIV2Client } from "./v2/default.js";
 export type { MittwaldAPIV2 } from "./generated/v2/types.js";

packages/models/.eslintignore

@@ -0,0 +1,2 @@
+dist/
+

packages/models/.eslintrc.yml

@@ -0,0 +1,2 @@
+extends:
+  - "../../config/.eslintrc.yml"

packages/models/.prettierignore

@@ -0,0 +1 @@
+dist/

packages/models/.prettierrc.js

@@ -0,0 +1,3 @@
+import config from "../../config/.prettierrc.js";
+
+export default config;