@mittwald/api-client-commons 4.3.0 → 4.4.0-alpha.1

package/dist/types/RequestType.test-types.js

@@ -0,0 +1,146 @@
+import { expectAssignable } from "tsd";
+function ignoredTestEmptyRequestTypes() {
+    expectAssignable({});
+    // @ts-expect-error Not assignable
+    expectAssignable({ extra: true });
+    // @ts-expect-error Not assignable
+    expectAssignable({ data: {} });
+    // @ts-expect-error Not assignable
+    expectAssignable({ data: null });
+    // @ts-expect-error Not assignable
+    expectAssignable({ pathParameters: {} });
+}
+function ignoredTestRequestTypesWithDataType() {
+    expectAssignable({ data: { foo: "" } });
+    // @ts-expect-error Not assignable
+    expectAssignable({});
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        data: { foo: "", extra: "" },
+    });
+    // @ts-expect-error Not assignable
+    expectAssignable({ data: { noFoo: "" } });
+}
+function ignoredTestRequestTypesWithPathParameters() {
+    expectAssignable({
+        data: { foo: "" },
+        pathParameters: { bar: "" },
+    });
+    expectAssignable({
+        pathParameters: { bar: "" },
+    });
+    // @ts-expect-error Not assignable
+    expectAssignable({});
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        pathParameters: {},
+    });
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        pathParameters: { foo: "", extra: "" },
+    });
+}
+function ignoredTestRequestTypesWithHeader() {
+    expectAssignable({
+        data: {
+            foo: "",
+        },
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+    });
+    expectAssignable({
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+    });
+    expectAssignable({
+        headers: { baz: "" },
+    });
+    // @ts-expect-error Not assignable
+    expectAssignable({});
+    expectAssignable({
+        headers: {
+            // @ts-expect-error Not assignable
+            baz: 42,
+        },
+    });
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        headers: {},
+    });
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        data: {},
+        headers: {
+            baz: "",
+        },
+    });
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        pathParameters: {},
+        headers: {
+            baz: "",
+        },
+    });
+}
+function ignoredTestRequestTypesWithQuery() {
+    expectAssignable({
+        data: {
+            foo: "",
+        },
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+        queryParameters: {
+            whut: "",
+        },
+    });
+    expectAssignable({
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+        queryParameters: {
+            whut: "",
+        },
+    });
+    expectAssignable({
+        queryParameters: {
+            whut: "",
+        },
+    });
+    // @ts-expect-error Not assignable
+    expectAssignable({});
+    expectAssignable({
+        queryParameters: {
+            // @ts-expect-error Not assignable
+            whut: 42,
+        },
+    });
+    expectAssignable({
+        // @ts-expect-error Not assignable
+        queryParameters: {},
+    });
+}
+function ignoredTestAdditionalHeadersCanAlwaysBeSet() {
+    expectAssignable({
+        headers: { extra: true },
+    });
+    expectAssignable({
+        headers: { extra: true },
+    });
+    expectAssignable({
+        headers: { extra: true },
+    });
+    expectAssignable({
+        data: {
+            foo: "",
+        },
+        headers: { extra: true },
+    });
+    expectAssignable({
+        pathParameters: {
+            bar: "",
+        },
+        headers: { extra: true },
+    });
+    expectAssignable({
+        headers: { extra: true, baz: "" },
+    });
+}

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/Response.test-types.d.ts

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

package/dist/types/Response.test-types.js

@@ -0,0 +1,70 @@
+import { expectAssignable, expectNotAssignable, expectType } from "tsd";
+const additionalAxiosResponseData = {
+    statusText: "",
+    headers: {},
+    config: {},
+    mediaType: "application/json",
+};
+expectAssignable({
+    data: { a: "" },
+    status: 200,
+    ...additionalAxiosResponseData,
+});
+expectNotAssignable({
+    data: { a: "", extra: "!" },
+    status: 200,
+    ...additionalAxiosResponseData,
+});
+expectAssignable({
+    data: {
+        b: "",
+    },
+    status: 201,
+    ...additionalAxiosResponseData,
+});
+expectAssignable({
+    data: null,
+    status: 400,
+    ...additionalAxiosResponseData,
+});
+expectNotAssignable({
+    data: null,
+    status: 42,
+    ...additionalAxiosResponseData,
+});
+expectNotAssignable({
+    data: null,
+    status: 42,
+    extra: "!",
+    ...additionalAxiosResponseData,
+});
+expectNotAssignable({
+    data: { extraContent: "" },
+    status: 400,
+    ...additionalAxiosResponseData,
+});
+function ignoredTestRequestTypesWithDataPathParameters() {
+    const someResponse = {};
+    expectType(someResponse.status);
+    if (someResponse.status === 200) {
+        // @ts-expect-error > a is not in data
+        someResponse.data.a;
+        // @ts-expect-error > b is not in data
+        someResponse.data.b;
+        if (someResponse.mediaType === "text/plain") {
+            // @ts-expect-error > a is not in data
+            someResponse.data.a;
+            expectType(someResponse.data.text);
+        }
+        else {
+            // @ts-expect-error > text is not in data
+            someResponse.data.text;
+            expectType(someResponse.data.a);
+        }
+    }
+    else if (someResponse.status === 201) {
+        expectType(someResponse.data.b);
+        // @ts-expect-error > a is not in data
+        someResponse.data.a;
+    }
+}

package/dist/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/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/types/assertStatus.test-types.d.ts

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

package/dist/types/assertStatus.test-types.js

@@ -0,0 +1,8 @@
+import { expectAssignable } from "tsd";
+import assertStatus from "./assertStatus.js";
+function ignoredTestAssertStatusAssertsAlsoTheCorrectResponseType() {
+    assertStatus(someResponse, 200);
+    expectAssignable(someResponse);
+    // @ts-expect-error Not assignable
+    expectAssignable(someResponse);
+}

package/dist/types/http.d.ts

@@ -0,0 +1,13 @@
+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 type QueryParameters = Record<string, unknown>;
+export {};

package/dist/types/http.js

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

package/dist/types/index.d.ts

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

package/dist/types/index.js

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

package/dist/types/simplify.d.ts

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

package/dist/types/simplify.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "4.3.0",
+  "version": "4.4.0-alpha.1",
   "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
   "type": "module",
   "description": "Common types and utilities for mittwald API clients",
@@ -17,50 +17,51 @@
   "license": "MIT",
   "exports": {
     ".": {
-      "types": "./dist/index.d.mts",
-      "default": "./dist/index.mjs"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./react": {
-      "types": "./dist/react/index.d.mts",
-      "default": "./dist/react/index.mjs"
+      "types": "./dist/react/index.d.ts",
+      "default": "./dist/react/index.js"
     }
   },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "yarn unbuild",
-    "format": "prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
-    "lint": "eslint .",
+    "build": "run build:clean && run tsc",
+    "build:clean": "rimraf dist",
+    "format": "run prettier --write '**/*.{ts,tsx,yaml,yml,json,md,mdx,js}'",
+    "lint": "run eslint .",
     "test": "node --experimental-vm-modules $(yarn bin jest)"
   },
   "dependencies": {
     "@types/parse-path": "^7.0.3",
-    "axios": "^1.6.2",
+    "axios": "^1.6.7",
     "parse-path": "^7.0.0",
     "path-to-regexp": "^6.2.1",
-    "type-fest": "^4.8.2"
+    "type-fest": "^4.10.3"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@mittwald/react-use-promise": "^2.1.0",
-    "@types/jest": "^29.5.10",
-    "@typescript-eslint/eslint-plugin": "^6.12.0",
-    "@typescript-eslint/parser": "^6.12.0",
-    "eslint": "^8.54.0",
-    "eslint-config-prettier": "^9.0.0",
+    "@mittwald/react-use-promise": "^2.3.12",
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
-    "prettier": "^3.1.0",
-    "prettier-plugin-jsdoc": "^1.1.1",
+    "prettier": "^3.2.5",
+    "prettier-plugin-jsdoc": "^1.3.0",
     "prettier-plugin-pkgsort": "^0.2.1",
     "prettier-plugin-sort-json": "^3.1.0",
     "react": "^18.2.0",
-    "ts-jest": "^29.1.1",
-    "tsd": "^0.29.0",
-    "typescript": "^5.3.3",
-    "unbuild": "^2.0.0"
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "tsd": "^0.30.5",
+    "typescript": "^5.3.3"
   },
   "peerDependencies": {
     "@mittwald/react-use-promise": "^2.1.0"
@@ -69,8 +70,5 @@
     "@mittwald/react-use-promise": {
       "optional": true
     }
-  },
-  "unbuild": {
-    "declaration": true
   }
 }

package/dist/index.d.mts

@@ -1,45 +0,0 @@
-import { AxiosInstance, CreateAxiosDefaults, AxiosError, InternalAxiosRequestConfig, AxiosResponse, AxiosRequestConfig } from 'axios';
-export * from 'axios';
-import { R as Response, O as OpenAPIOperation, a as RequestFunction, A as AnyResponse, P as PathParameters, b as RequestObject, c as ResponsePromise } from './shared/api-client-commons.8b686095.mjs';
-export { e as AnyRequest, n as HttpHeaders, l as HttpMediaType, m as HttpMethod, H as HttpPayload, k as HttpStatus, h as InferredRequestData, I as InferredRequestType, g as InferredResponseData, f as InferredResponseType, Q as QueryParameters, j as RequestData, d as RequestType, i as ResponseData } from './shared/api-client-commons.8b686095.mjs';
-import 'type-fest';
-
-type Simplify<T> = {
-    [KeyType in keyof T]: T[KeyType];
-} & {};
-
-declare function assertStatus<T extends Response, S extends T["status"]>(response: T, expectedStatus: S): asserts response is T & {
-    status: S;
-};
-
-declare abstract class ApiClientBase {
-    axios: AxiosInstance;
-    constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);
-    protected requestFunctionFactory<TOp extends OpenAPIOperation>(operation: TOp): RequestFunction<TOp>;
-}
-
-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;
-}
-
-declare class OpenAPIPath {
-    private readonly rawPath;
-    private readonly params?;
-    constructor(rawPath: string, params?: PathParameters);
-    buildUrl(): string;
-    private static setPathParams;
-}
-
-declare class Request<TOp extends OpenAPIOperation> {
-    private readonly operationDescriptor;
-    private readonly requestObject?;
-    readonly requestConfig: AxiosRequestConfig;
-    constructor(operationDescriptor: TOp, requestObject?: RequestObject<TOp>);
-    execute(axios: AxiosInstance): ResponsePromise<TOp>;
-    private buildAxiosConfig;
-    private makeAxiosHeaders;
-    private convertQueryToUrlSearchParams;
-}
-
-export { AnyResponse, ApiClientBase, ApiClientError, OpenAPIOperation, OpenAPIPath, PathParameters, Request, RequestFunction, RequestObject, Response, ResponsePromise, type Simplify, assertStatus };

package/dist/index.mjs

@@ -1,22 +0,0 @@
-import axios__default, { Axios } from 'axios';
-export * from 'axios';
-import { R as Request } from './shared/api-client-commons.2a6e3962.mjs';
-export { A as ApiClientError, O as OpenAPIPath, a as assertStatus } from './shared/api-client-commons.2a6e3962.mjs';
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class ApiClientBase {
-  constructor(axiosConfig = axios__default) {
-    __publicField(this, "axios");
-    this.axios = axiosConfig instanceof Axios ? axiosConfig : axios__default.create(axiosConfig);
-  }
-  requestFunctionFactory(operation) {
-    return (conf) => new Request(operation, conf).execute(this.axios);
-  }
-}
-
-export { ApiClientBase, Request };

package/dist/react/index.d.mts

@@ -1,19 +0,0 @@
-import { O as OpenAPIOperation, b as RequestObject, g as InferredResponseData, a as RequestFunction } from '../shared/api-client-commons.8b686095.mjs';
-import { AsyncResource } from '@mittwald/react-use-promise';
-import 'axios';
-import 'type-fest';
-
-type GetApiResourceFn<TOp extends OpenAPIOperation> = null extends RequestObject<TOp> ? (conf?: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>> : (conf: RequestObject<TOp>) => AsyncResource<InferredResponseData<TOp>>;
-
-declare class ApiCallAsyncResourceFactory<TOp extends OpenAPIOperation> {
-    private static namespace;
-    private readonly operation;
-    private readonly requestFn;
-    constructor(operation: TOp, requestFn: RequestFunction<TOp>);
-    private getAsyncResourceId;
-    private getAsyncResourceTags;
-    private executeRequest;
-    getApiResource: GetApiResourceFn<TOp>;
-}
-
-export { ApiCallAsyncResourceFactory };

package/dist/react/index.mjs

@@ -1,49 +0,0 @@
-import { getAsyncResource } from '@mittwald/react-use-promise';
-import { R as Request, a as assertStatus } from '../shared/api-client-commons.2a6e3962.mjs';
-import 'axios';
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-const _ApiCallAsyncResourceFactory = class _ApiCallAsyncResourceFactory {
-  constructor(operation, requestFn) {
-    __publicField(this, "operation");
-    __publicField(this, "requestFn");
-    __publicField(this, "getApiResource", (requestObj) => {
-      const request = new Request(this.operation, requestObj);
-      return getAsyncResource(
-        (requestObj2) => this.executeRequest(requestObj2),
-        [requestObj],
-        {
-          tags: this.getAsyncResourceTags(request),
-          loaderId: this.getAsyncResourceId()
-        }
-      );
-    });
-    this.operation = operation;
-    this.requestFn = requestFn;
-  }
-  getAsyncResourceId() {
-    return `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.operationId}`;
-  }
-  getAsyncResourceTags(request) {
-    const url = request.requestConfig.url ?? "";
-    return [
-      this.getAsyncResourceId(),
-      `${_ApiCallAsyncResourceFactory.namespace}/${this.operation.method}`,
-      `${_ApiCallAsyncResourceFactory.namespace}/${url}`
-    ];
-  }
-  async executeRequest(requestObj) {
-    const response = await this.requestFn(requestObj);
-    assertStatus(response, 200);
-    return response.data;
-  }
-};
-__publicField(_ApiCallAsyncResourceFactory, "namespace", "@mittwald/api-client");
-let ApiCallAsyncResourceFactory = _ApiCallAsyncResourceFactory;
-
-export { ApiCallAsyncResourceFactory };

package/dist/shared/api-client-commons.2a6e3962.mjs

@@ -1,128 +0,0 @@
-import { AxiosError } from 'axios';
-
-var __defProp$1 = Object.defineProperty;
-var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$1 = (obj, key, value) => {
-  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class OpenAPIPath {
-  constructor(rawPath, params) {
-    __publicField$1(this, "rawPath");
-    __publicField$1(this, "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((path2, entry) => {
-      const [key, value] = entry;
-      return path2.replace(`{${key}}`, encodeURIComponent(value));
-    }, path);
-    return finalPath.startsWith("/") ? finalPath.substring(1) : finalPath;
-  }
-}
-
-var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
-class Request {
-  constructor(operationDescriptor, requestObject) {
-    __publicField(this, "operationDescriptor");
-    __publicField(this, "requestObject");
-    __publicField(this, "requestConfig");
-    this.operationDescriptor = operationDescriptor;
-    this.requestObject = requestObject;
-    this.requestConfig = Object.freeze(this.buildAxiosConfig());
-  }
-  execute(axios) {
-    return axios.request(this.requestConfig);
-  }
-  buildAxiosConfig() {
-    const { method, path } = this.operationDescriptor;
-    const pathParameters = this.requestObject;
-    const openApiPath = new OpenAPIPath(path, pathParameters);
-    const url = openApiPath.buildUrl();
-    const data = this.requestObject && "data" in this.requestObject ? this.requestObject.data : void 0;
-    const headersConfig = this.requestObject && "headers" in this.requestObject ? this.requestObject.headers : void 0;
-    const headers = headersConfig ? this.makeAxiosHeaders(headersConfig) : void 0;
-    const queryParametersConfig = this.requestObject && "queryParameters" in this.requestObject ? this.requestObject.queryParameters : void 0;
-    const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
-    return {
-      url,
-      method,
-      headers,
-      // Must be a plain object or an URLSearchParams object
-      params,
-      data,
-      validateStatus: () => true
-    };
-  }
-  makeAxiosHeaders(headers) {
-    return Object.fromEntries(
-      Object.entries(headers).map(([key, value]) => [key, value?.toString()])
-    );
-  }
-  convertQueryToUrlSearchParams(query) {
-    if (query === void 0 || query === null) {
-      return void 0;
-    }
-    if (query instanceof URLSearchParams) {
-      return query;
-    }
-    if (typeof query === "string") {
-      return new URLSearchParams(query);
-    }
-    if (typeof query === "object") {
-      const searchParams = new URLSearchParams();
-      for (const [key, value] of Object.entries(query)) {
-        if (Array.isArray(value)) {
-          for (const arrayItem of value) {
-            searchParams.append(key, arrayItem);
-          }
-        } else {
-          searchParams.append(
-            key,
-            typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? value.toString() : JSON.stringify(value)
-          );
-        }
-      }
-      return searchParams;
-    }
-    throw new Error(`Unexpected query parameter type (${typeof query})`);
-  }
-}
-
-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,
-      void 0,
-      response.config,
-      response.request,
-      response
-    );
-  }
-}
-
-function assertStatus(response, expectedStatus) {
-  if (response.status !== expectedStatus) {
-    throw ApiClientError.fromResponse(
-      `Unexpected response status (expected ${expectedStatus}, got: ${response.status})`,
-      response
-    );
-  }
-}
-
-export { ApiClientError as A, OpenAPIPath as O, Request as R, assertStatus as a };