@mittwald/api-client-commons 1.0.3

package/README.md

@@ -0,0 +1 @@
+Common code base used by `@mittwald/api-client-*` package.

package/dist/axios.d.ts

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

package/dist/axios.js

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

package/dist/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/core/ApiClientBase.js

@@ -0,0 +1,13 @@
+import axios, { Axios } from "axios";
+import Request from "./Request.js";
+export class ApiClientBase {
+    axios;
+    constructor(axiosConfig = axios) {
+        this.axios =
+            axiosConfig instanceof Axios ? axiosConfig : axios.create(axiosConfig);
+    }
+    requestFunctionFactory(operation) {
+        return (conf) => new Request(this.axios, operation, conf).execute();
+    }
+}
+export default ApiClientBase;

package/dist/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/core/ApiClientError.js

@@ -0,0 +1,12 @@
+import { AxiosError } from "axios";
+export class ApiClientError extends 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);
+    }
+}
+export default ApiClientError;

package/dist/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/core/OpenAPIPath.js

@@ -0,0 +1,20 @@
+export class OpenAPIPath {
+    rawPath;
+    params;
+    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 ?? {});
+        const finalPath = asEntries.reduce((path, entry) => {
+            const [key, value] = entry;
+            return path.replace(`{${key}}`, encodeURIComponent(value));
+        }, path);
+        return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
+    }
+}
+export default OpenAPIPath;

package/dist/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/core/Request.js

@@ -0,0 +1,33 @@
+import OpenAPIPath from "./OpenAPIPath.js";
+export class Request {
+    axios;
+    operationDescriptor;
+    config;
+    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(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,
+        };
+    }
+}
+export default Request;

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/type-fest.d.ts

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

package/dist/type-fest.js

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

package/dist/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/types/NullableOnNoRequiredKeysDeep.js

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

package/dist/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/types/OpenAPIOperation.js

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

package/dist/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/types/Request.js

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

package/dist/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/types/RequestFunction.js

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

package/dist/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/types/Response.js

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

package/dist/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/types/http.js

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

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@mittwald/api-client-commons",
+  "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"
+  },
+  "keywords": [
+    "mittwald",
+    "api",
+    "client",
+    "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",
+    "parse-path": "^7.0.0",
+    "path-to-regexp": "^6.2.1",
+    "type-fest": "^3.10.0"
+  },
+  "devDependencies": {
+    "@yarnpkg/pnpify": "^4.0.0-rc.43",
+    "tsd": "^0.28.1"
+  },
+  "types": "./dist/index.d.ts"
+}