@mittwald/api-client-commons 2.0.2 → 3.0.0-alpha.1

package/README.md

@@ -1 +1,33 @@
 Common code base used by `@mittwald/api-client-*` package.
+
+## API
+
+### assertStatus
+
+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.
+
+#### 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;
+```

package/dist/cjs/core/ApiClientBase.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClientBase = void 0;
+const axios_1 = require("axios");
+const Request_js_1 = require("./Request.js");
+class ApiClientBase {
+    constructor(axiosConfig = axios_1.default) {
+        this.axios =
+            axiosConfig instanceof axios_1.Axios ? axiosConfig : axios_1.default.create(axiosConfig);
+    }
+    requestFunctionFactory(operation) {
+        return (conf) => new Request_js_1.default(this.axios, operation, conf).execute();
+    }
+}
+exports.ApiClientBase = ApiClientBase;
+exports.default = ApiClientBase;

package/{dist-cjs → dist/cjs}/core/Request.js

@@ -1,10 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Request = void 0;
-const OpenAPIPath_js_1 = __importDefault(require("./OpenAPIPath.js"));
+const OpenAPIPath_js_1 = require("./OpenAPIPath.js");
 class Request {
     constructor(axiosInstance, operationDescriptor, config) {
         this.axios = axiosInstance;

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./core/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);
+__exportStar(require("./axios.js"), exports);

package/{dist-cjs → dist/cjs}/types/OpenAPIOperation.d.ts

@@ -1,10 +1,10 @@
 import { AnyResponse, Response } from "./Response.js";
-import { AnyRequest, Request } from "./Request.js";
+import { AnyRequest, RequestType } from "./RequestType.js";
 import { HttpMethod } from "./http.js";
-export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = Request, IgnoredResponse extends AnyResponse = Response> {
+export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
     operationId: string;
     path: string;
     method: HttpMethod;
 }
 export type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
-export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<Request, infer TRes> ? TRes : never;
+export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;

package/{dist-cjs/types/Request.d.ts → dist/cjs/types/RequestType.d.ts}

@@ -9,6 +9,6 @@ type RequestWithHeaders<THeaders> = THeaders extends null ? object : {
     headers: THeaders;
 };
 type EmptyRequest = Record<string, never>;
-export type Request<TData extends HttpPayload = null, TPathParameters extends PathParameters | null = null, THeader extends HttpHeaders | null = null> = TData | TPathParameters | THeader extends null ? EmptyRequest : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithHeaders<THeader>;
-export type AnyRequest = Request<any, any, any>;
+export type RequestType<TData extends HttpPayload = null, TPathParameters extends PathParameters | null = null, THeader extends HttpHeaders | null = null> = TData | TPathParameters | THeader extends null ? EmptyRequest : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithHeaders<THeader>;
+export type AnyRequest = RequestType<any, any, any>;
 export {};

package/dist/cjs/types/assertStatus.d.ts

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

package/dist/cjs/types/assertStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertStatus = void 0;
+const ApiClientError_js_1 = require("../core/ApiClientError.js");
+function assertStatus(response, expectedStatus) {
+    if (response.status !== expectedStatus) {
+        throw ApiClientError_js_1.default.fromResponse(`Unexpected response status (expected ${expectedStatus}, got: ${response.status})`, response);
+    }
+}
+exports.assertStatus = assertStatus;
+exports.default = assertStatus;

package/dist/{types → cjs/types}/index.d.ts

@@ -1,6 +1,8 @@
-export * from "./Request.js";
+export * from "./RequestType.js";
 export * from "./RequestFunction.js";
 export * from "./Response.js";
 export * from "./OpenAPIOperation.js";
 export * from "./http.js";
-export { Simplify } from "type-fest";
+export * from "./assertStatus.js";
+export * from "./simplify.js";
+export * from "./assertStatus.js";

package/{dist-cjs → dist/cjs}/types/index.js

@@ -14,8 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Request.js"), exports);
+__exportStar(require("./RequestType.js"), exports);
 __exportStar(require("./RequestFunction.js"), exports);
 __exportStar(require("./Response.js"), exports);
 __exportStar(require("./OpenAPIOperation.js"), exports);
 __exportStar(require("./http.js"), exports);
+__exportStar(require("./assertStatus.js"), exports);
+__exportStar(require("./simplify.js"), exports);
+__exportStar(require("./assertStatus.js"), exports);

package/dist/cjs/types/simplify.d.ts

@@ -0,0 +1,3 @@
+export type Simplify<T> = {
+    [KeyType in keyof T]: T[KeyType];
+} & {};

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

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

package/dist/{types → esm/types}/OpenAPIOperation.d.ts

@@ -1,10 +1,10 @@
 import { AnyResponse, Response } from "./Response.js";
-import { AnyRequest, Request } from "./Request.js";
+import { AnyRequest, RequestType } from "./RequestType.js";
 import { HttpMethod } from "./http.js";
-export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = Request, IgnoredResponse extends AnyResponse = Response> {
+export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = RequestType, IgnoredResponse extends AnyResponse = Response> {
     operationId: string;
     path: string;
     method: HttpMethod;
 }
 export type InferredRequestType<TOp> = TOp extends OpenAPIOperation<infer TReq> ? TReq : never;
-export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<Request, infer TRes> ? TRes : never;
+export type InferredResponseType<TOp> = TOp extends OpenAPIOperation<RequestType, infer TRes> ? TRes : never;

package/dist/{types/Request.d.ts → esm/types/RequestType.d.ts}

@@ -9,6 +9,6 @@ type RequestWithHeaders<THeaders> = THeaders extends null ? object : {
     headers: THeaders;
 };
 type EmptyRequest = Record<string, never>;
-export type Request<TData extends HttpPayload = null, TPathParameters extends PathParameters | null = null, THeader extends HttpHeaders | null = null> = TData | TPathParameters | THeader extends null ? EmptyRequest : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithHeaders<THeader>;
-export type AnyRequest = Request<any, any, any>;
+export type RequestType<TData extends HttpPayload = null, TPathParameters extends PathParameters | null = null, THeader extends HttpHeaders | null = null> = TData | TPathParameters | THeader extends null ? EmptyRequest : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithHeaders<THeader>;
+export type AnyRequest = RequestType<any, any, any>;
 export {};

package/dist/esm/types/assertStatus.d.ts

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

package/dist/esm/types/assertStatus.js

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

package/{dist-cjs → dist/esm}/types/index.d.ts

@@ -1,6 +1,8 @@
-export * from "./Request.js";
+export * from "./RequestType.js";
 export * from "./RequestFunction.js";
 export * from "./Response.js";
 export * from "./OpenAPIOperation.js";
 export * from "./http.js";
-export { Simplify } from "type-fest";
+export * from "./assertStatus.js";
+export * from "./simplify.js";
+export * from "./assertStatus.js";

package/dist/{types → esm/types}/index.js

@@ -1,5 +1,8 @@
-export * from "./Request.js";
+export * from "./RequestType.js";
 export * from "./RequestFunction.js";
 export * from "./Response.js";
 export * from "./OpenAPIOperation.js";
 export * from "./http.js";
+export * from "./assertStatus.js";
+export * from "./simplify.js";
+export * from "./assertStatus.js";

package/dist/esm/types/simplify.d.ts

@@ -0,0 +1,3 @@
+export type Simplify<T> = {
+    [KeyType in keyof T]: T[KeyType];
+} & {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "2.0.2",
+  "version": "3.0.0-alpha.1",
   "description": "Common types and utilities for mittwald API clients",
   "license": "MIT",
   "repository": "https://github.com/mittwald/api-client-js.git",
@@ -10,19 +10,18 @@
   },
   "homepage": "https://developer.mittwald.de",
   "bugs": "https://github.com/mittwald/api-client-js/issues",
+  "main": "dist/cjs/index.js",
   "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/core/index.js",
-      "default": "./dist-cjs/core/index.js"
-    },
-    "./axios": {
-      "import": "./dist/axios.js",
-      "default": "./dist-cjs/axios.js"
-    },
-    "./types": {
-      "import": "./dist/types/index.js",
-      "default": "./dist-cjs/types/index.js"
+      "types": {
+        "require": "./dist/cjs/index.d.ts",
+        "default": "./dist/esm/index.d.ts"
+      },
+      "default": {
+        "require": "./dist/cjs/index.js",
+        "default": "./dist/esm/index.js"
+      }
     }
   },
   "scripts": {
@@ -30,7 +29,7 @@
     "test:tsd": "pnpify run tsd"
   },
   "files": [
-    "{dist,dist-cjs}/**/*.{js,d.ts}"
+    "dist/**/*.{js,d.ts}"
   ],
   "keywords": [
     "mittwald",
@@ -44,11 +43,11 @@
     "axios": "^1.4.0",
     "parse-path": "^7.0.0",
     "path-to-regexp": "^6.2.1",
-    "type-fest": "^3.10.0"
+    "type-fest": "^3.12.0"
   },
   "devDependencies": {
-    "@yarnpkg/pnpify": "^4.0.0-rc.43",
+    "@yarnpkg/pnpify": "^4.0.0-rc.48",
     "tsd": "^0.28.1"
   },
-  "types": "./dist/index.d.ts"
+  "types": "dist/cjs/index.d.ts"
 }

package/dist/index.js

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

package/dist/types/Request.js

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

package/dist-cjs/core/ApiClientBase.js

@@ -1,42 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiClientBase = void 0;
-const axios_1 = __importStar(require("axios"));
-const Request_js_1 = __importDefault(require("./Request.js"));
-class ApiClientBase {
-    constructor(axiosConfig = axios_1.default) {
-        this.axios =
-            axiosConfig instanceof axios_1.Axios ? axiosConfig : axios_1.default.create(axiosConfig);
-    }
-    requestFunctionFactory(operation) {
-        return (conf) => new Request_js_1.default(this.axios, operation, conf).execute();
-    }
-}
-exports.ApiClientBase = ApiClientBase;
-exports.default = ApiClientBase;