@mittwald/api-client-commons 1.0.3 → 2.0.0

package/dist/core/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ApiClientBase.js";
+export * from "./ApiClientError.js";
+export * from "./OpenAPIPath.js";
+export * from "./Request.js";

package/dist/core/index.js

@@ -0,0 +1,4 @@
+export * from "./ApiClientBase.js";
+export * from "./ApiClientError.js";
+export * from "./OpenAPIPath.js";
+export * from "./Request.js";

package/dist/types/index.d.ts

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

package/dist/types/index.js

@@ -0,0 +1,5 @@
+export * from "./Request.js";
+export * from "./RequestFunction.js";
+export * from "./Response.js";
+export * from "./OpenAPIOperation.js";
+export * from "./http.js";

package/dist-cjs/axios.d.ts

@@ -0,0 +1 @@
+export * from "axios";

package/dist-cjs/axios.js

@@ -0,0 +1,17 @@
+"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("axios"), exports);

package/dist-cjs/core/ApiClientBase.d.ts

@@ -0,0 +1,9 @@
+import { AxiosInstance, CreateAxiosDefaults } from "axios";
+import { RequestFunction } from "../types/RequestFunction.js";
+import { OpenAPIOperation } from "../types/OpenAPIOperation.js";
+export declare abstract class ApiClientBase {
+    axios: AxiosInstance;
+    constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
+    protected requestFunctionFactory<TOp extends OpenAPIOperation>(operation: TOp): RequestFunction<TOp>;
+}
+export default ApiClientBase;

package/dist-cjs/core/ApiClientBase.js

@@ -0,0 +1,42 @@
+"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;

package/dist-cjs/core/ApiClientError.d.ts

@@ -0,0 +1,7 @@
+import { AxiosError, AxiosResponse, InternalAxiosRequestConfig } from "axios";
+import { AnyResponse } from "../types/Response.js";
+export declare class ApiClientError<T = unknown, D = unknown> extends AxiosError<T, D> {
+    constructor(message?: string, code?: string, config?: InternalAxiosRequestConfig<D>, request?: unknown, response?: AxiosResponse<T, D>);
+    static fromResponse(message: string, response: AnyResponse): ApiClientError;
+}
+export default ApiClientError;

package/dist-cjs/core/ApiClientError.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClientError = void 0;
+const axios_1 = require("axios");
+class ApiClientError extends axios_1.AxiosError {
+    constructor(message, code, config, request, response) {
+        super(message, code, config, request, response);
+        Object.setPrototypeOf(this, ApiClientError.prototype);
+        this.name = "ApiClientError";
+    }
+    static fromResponse(message, response) {
+        return new ApiClientError(message, undefined, response.config, response.request, response);
+    }
+}
+exports.ApiClientError = ApiClientError;
+exports.default = ApiClientError;

package/dist-cjs/core/OpenAPIPath.d.ts

@@ -0,0 +1,9 @@
+import { PathParameters } from "../types/http.js";
+export declare class OpenAPIPath {
+    private readonly rawPath;
+    private readonly params?;
+    constructor(rawPath: string, params?: PathParameters);
+    buildUrl(): string;
+    private static setPathParams;
+}
+export default OpenAPIPath;

package/dist-cjs/core/OpenAPIPath.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAPIPath = void 0;
+class OpenAPIPath {
+    constructor(rawPath, params) {
+        this.rawPath = rawPath;
+        this.params = params;
+    }
+    buildUrl() {
+        return OpenAPIPath.setPathParams(this.rawPath, this.params);
+    }
+    static setPathParams(path, params) {
+        const asEntries = Object.entries(params !== null && params !== void 0 ? params : {});
+        const finalPath = asEntries.reduce((path, entry) => {
+            const [key, value] = entry;
+            return path.replace(`{${key}}`, encodeURIComponent(value));
+        }, path);
+        return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
+    }
+}
+exports.OpenAPIPath = OpenAPIPath;
+exports.default = OpenAPIPath;

package/dist-cjs/core/Request.d.ts

@@ -0,0 +1,12 @@
+import { OpenAPIOperation } from "../types/OpenAPIOperation.js";
+import { RequestConfig, ResponsePromise } from "../types/RequestFunction.js";
+import { AxiosInstance } from "axios";
+export declare class Request<TOp extends OpenAPIOperation> {
+    private readonly axios;
+    private readonly operationDescriptor;
+    private readonly config?;
+    constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, config?: RequestConfig<TOp>);
+    execute(): ResponsePromise<TOp>;
+    private buildAxiosConfig;
+}
+export default Request;

package/dist-cjs/core/Request.js

@@ -0,0 +1,37 @@
+"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"));
+class Request {
+    constructor(axiosInstance, operationDescriptor, config) {
+        this.axios = axiosInstance;
+        this.operationDescriptor = operationDescriptor;
+        this.config = config;
+    }
+    execute() {
+        return this.axios.request(this.buildAxiosConfig());
+    }
+    buildAxiosConfig() {
+        const { method, path } = this.operationDescriptor;
+        const pathParameters = this.config &&
+            "pathParameters" in this.config &&
+            this.config.pathParameters !== null
+            ? this.config.pathParameters
+            : undefined;
+        const openApiPath = new OpenAPIPath_js_1.default(path, pathParameters);
+        const data = this.config && "data" in this.config ? this.config.data : undefined;
+        const headers = this.config && "headers" in this.config ? this.config.headers : undefined;
+        return {
+            url: openApiPath.buildUrl(),
+            method,
+            headers,
+            data,
+            validateStatus: () => true,
+        };
+    }
+}
+exports.Request = Request;
+exports.default = Request;

package/dist-cjs/core/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ApiClientBase.js";
+export * from "./ApiClientError.js";
+export * from "./OpenAPIPath.js";
+export * from "./Request.js";

package/dist-cjs/core/index.js

@@ -0,0 +1,20 @@
+"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("./ApiClientBase.js"), exports);
+__exportStar(require("./ApiClientError.js"), exports);
+__exportStar(require("./OpenAPIPath.js"), exports);
+__exportStar(require("./Request.js"), exports);

package/dist-cjs/index.d.ts

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

package/dist-cjs/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/types/NullableOnNoRequiredKeysDeep.d.ts

@@ -0,0 +1,6 @@
+import { HasRequiredKeys, PartialOnUndefinedDeep } from "type-fest";
+type PartialOnNoRequiredKeysDeep<T> = PartialOnUndefinedDeep<{
+    [TKey in keyof T]: HasRequiredKeys<PartialOnNoRequiredKeysDeep<T[TKey]>> extends true ? T[TKey] : T[TKey] | undefined;
+}>;
+export type NullableOnNoRequiredKeysDeep<T> = HasRequiredKeys<PartialOnNoRequiredKeysDeep<T>> extends true ? PartialOnNoRequiredKeysDeep<T> : PartialOnNoRequiredKeysDeep<T> | null;
+export {};

package/dist-cjs/types/NullableOnNoRequiredKeysDeep.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/types/OpenAPIOperation.d.ts

@@ -0,0 +1,10 @@
+import { AnyResponse, Response } from "./Response.js";
+import { AnyRequest, Request } from "./Request.js";
+import { HttpMethod } from "./http.js";
+export interface OpenAPIOperation<TIgnoredRequest extends AnyRequest = Request, 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;

package/dist-cjs/types/OpenAPIOperation.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/types/Request.d.ts

@@ -0,0 +1,14 @@
+import { HttpHeaders, HttpPayload, PathParameters } from "./http.js";
+type RequestWithData<TData> = TData extends null ? object : {
+    data: TData;
+};
+type RequestWithPathParameters<TPathParameters> = TPathParameters extends null ? object : {
+    pathParameters: TPathParameters;
+};
+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 {};

package/dist-cjs/types/Request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/types/RequestFunction.d.ts

@@ -0,0 +1,8 @@
+import { OpenAPIOperation, InferredRequestType, InferredResponseType } from "./OpenAPIOperation.js";
+import { NullableOnNoRequiredKeysDeep } from "./NullableOnNoRequiredKeysDeep.js";
+export type RequestConfig<TOp extends OpenAPIOperation> = NullableOnNoRequiredKeysDeep<InferredRequestType<TOp>>;
+export type ResponsePromise<TOp extends OpenAPIOperation> = Promise<InferredResponseType<TOp>>;
+type RequestFunctionWithOptionalRequest<TOp extends OpenAPIOperation> = (request?: RequestConfig<TOp>) => ResponsePromise<TOp>;
+type RequestFunctionWithRequiredRequest<TOp extends OpenAPIOperation> = (request: RequestConfig<TOp>) => ResponsePromise<TOp>;
+export type RequestFunction<TOp extends OpenAPIOperation> = null extends RequestConfig<TOp> ? RequestFunctionWithOptionalRequest<TOp> : RequestFunctionWithRequiredRequest<TOp>;
+export {};

package/dist-cjs/types/RequestFunction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/types/Response.d.ts

@@ -0,0 +1,7 @@
+import { HttpMediaType, HttpPayload, HttpStatus } from "./http.js";
+import { AxiosResponse } from "axios";
+export type Response<TContent extends HttpPayload = HttpPayload, TStatus extends HttpStatus = HttpStatus, TMediaType extends HttpMediaType | null = HttpMediaType> = AxiosResponse<TContent> & {
+    status: TStatus;
+    mediaType: TMediaType;
+};
+export type AnyResponse = Response<any, any, any>;

package/dist-cjs/types/Response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/types/http.d.ts

@@ -0,0 +1,12 @@
+export type HttpPayload = unknown;
+export type HttpStatus = number | "default";
+export type HttpMediaType = string;
+type SafeHttpMethod = "GET" | "HEAD" | "OPTIONS";
+type UnsafeHttpMethod = "PUT" | "DELETE" | "POST" | "PATCH";
+export type HttpMethod = SafeHttpMethod | UnsafeHttpMethod;
+type HeaderValue = string | number | boolean;
+export type HttpHeaders = Partial<{
+    [TKey: string]: HeaderValue | HeaderValue[];
+}>;
+export type PathParameters = Record<string, string | number>;
+export {};

package/dist-cjs/types/http.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist-cjs/types/index.js

@@ -0,0 +1,21 @@
+"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("./Request.js"), exports);
+__exportStar(require("./RequestFunction.js"), exports);
+__exportStar(require("./Response.js"), exports);
+__exportStar(require("./OpenAPIOperation.js"), exports);
+__exportStar(require("./http.js"), exports);

package/package.json

@@ -1,16 +1,37 @@
 {
   "name": "@mittwald/api-client-commons",
+  "version": "2.0.0",
   "description": "Common types and utilities for mittwald API clients",
-  "version": "1.0.3",
   "license": "MIT",
   "repository": "https://github.com/mittwald/api-client-js.git",
-  "homepage": "https://developer.mittwald.de",
-  "bugs": "https://github.com/mittwald/api-client-js/issues",
-  "type": "module",
   "author": {
     "name": "Mittwald CM Service GmbH & Co. KG",
     "email": "opensource@mittwald.de"
   },
+  "homepage": "https://developer.mittwald.de",
+  "bugs": "https://github.com/mittwald/api-client-js/issues",
+  "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"
+    }
+  },
+  "scripts": {
+    "test": "yarn test:tsd",
+    "test:tsd": "pnpify run tsd"
+  },
+  "files": [
+    "{dist,dist-cjs}/**/*.{js,d.ts}"
+  ],
   "keywords": [
     "mittwald",
     "api",
@@ -18,13 +39,6 @@
     "sdk",
     "rest"
   ],
-  "scripts": {
-    "test": "yarn test:tsd",
-    "test:tsd": "pnpify run tsd"
-  },
-  "files": [
-    "dist/**/*.{js,d.ts}"
-  ],
   "dependencies": {
     "@types/parse-path": "^7.0.0",
     "axios": "^1.4.0",

package/dist/type-fest.d.ts

@@ -1 +0,0 @@
-export * from "type-fest";

package/dist/type-fest.js

@@ -1 +0,0 @@
-export * from "type-fest";