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

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

@@ -8,5 +8,6 @@ export declare class Request<TOp extends OpenAPIOperation> {
     constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, config?: RequestConfig<TOp>);
     execute(): ResponsePromise<TOp>;
     private buildAxiosConfig;
+    private makeAxiosHeaders;
 }
 export default Request;

package/dist/cjs/core/Request.js

@@ -24,11 +24,14 @@ class Request {
         return {
             url: openApiPath.buildUrl(),
             method,
-            headers,
+            headers: headers ? this.makeAxiosHeaders(headers) : undefined,
             data,
             validateStatus: () => true,
         };
     }
+    makeAxiosHeaders(headers) {
+        return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, value.toString()]));
+    }
 }
 exports.Request = Request;
 exports.default = Request;

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

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

package/dist/cjs/core/Request.test-types.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tsd_1 = require("tsd");
+function ignoredTestEmptyRequestTypes() {
+    (0, tsd_1.expectAssignable)({});
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({ extra: true });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({ data: {} });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({ data: null });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({ pathParameters: {} });
+}
+function ignoredTestRequestTypesWithDataType() {
+    (0, tsd_1.expectAssignable)({ data: { foo: "" } });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({});
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        data: { foo: "", extra: "" },
+    });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({ data: { noFoo: "" } });
+}
+function ignoredTestRequestTypesWithPathParameters() {
+    (0, tsd_1.expectAssignable)({
+        data: { foo: "" },
+        pathParameters: { bar: "" },
+    });
+    (0, tsd_1.expectAssignable)({
+        pathParameters: { bar: "" },
+    });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({});
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        pathParameters: {},
+    });
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        pathParameters: { foo: "", extra: "" },
+    });
+}
+function ignoredTestRequestTypesWithHeader() {
+    (0, tsd_1.expectAssignable)({
+        data: {
+            foo: "",
+        },
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+    });
+    (0, tsd_1.expectAssignable)({
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+    });
+    (0, tsd_1.expectAssignable)({
+        headers: { baz: "" },
+    });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({});
+    (0, tsd_1.expectAssignable)({
+        headers: {
+            // @ts-expect-error Not assignable
+            baz: 42,
+        },
+    });
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        headers: {},
+    });
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        data: {},
+        headers: {
+            baz: "",
+        },
+    });
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        pathParameters: {},
+        headers: {
+            baz: "",
+        },
+    });
+}
+function ignoredTestAdditionalHeadersCanAlwaysBeSet() {
+    (0, tsd_1.expectAssignable)({
+        headers: { extra: true },
+    });
+    (0, tsd_1.expectAssignable)({
+        headers: { extra: true },
+    });
+    (0, tsd_1.expectAssignable)({
+        headers: { extra: true },
+    });
+    (0, tsd_1.expectAssignable)({
+        data: {
+            foo: "",
+        },
+        headers: { extra: true },
+    });
+    (0, tsd_1.expectAssignable)({
+        pathParameters: {
+            bar: "",
+        },
+        headers: { extra: true },
+    });
+    (0, tsd_1.expectAssignable)({
+        headers: { extra: true, baz: "" },
+    });
+}

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

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

package/dist/cjs/types/RequestFunction.test-types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function ignoredTestEmptyRequestTypes() {
+    const f = {};
+    void f();
+    void f({
+        headers: {},
+    });
+    void f({
+        headers: { extra: true },
+    });
+}

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

@@ -1,14 +1,18 @@
 import { HttpHeaders, HttpPayload, PathParameters } from "./http.js";
-type RequestWithData<TData> = TData extends null ? object : {
+type EmptyObject = Record<string, never>;
+type EmptyRequestComponent = EmptyObject | null;
+type RequestWithOptionalHeaders = {
+    headers?: HttpHeaders;
+};
+type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
     data: TData;
 };
-type RequestWithPathParameters<TPathParameters> = TPathParameters extends null ? object : {
+type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
     pathParameters: TPathParameters;
 };
-type RequestWithHeaders<THeaders> = THeaders extends null ? object : {
-    headers: THeaders;
+type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    headers: THeaders & HttpHeaders;
 };
-type EmptyRequest = Record<string, never>;
-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 RequestType<TData extends HttpPayload = EmptyRequestComponent, TPathParameters extends PathParameters | EmptyRequestComponent = EmptyRequestComponent, THeader extends HttpHeaders | EmptyRequestComponent = EmptyRequestComponent> = TData | TPathParameters | THeader extends EmptyRequestComponent ? RequestWithOptionalHeaders : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithHeaders<THeader>;
 export type AnyRequest = RequestType<any, any, any>;
 export {};

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

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

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tsd_1 = require("tsd");
+const additionalAxiosResponseData = {
+    statusText: "",
+    headers: {},
+    config: {},
+    mediaType: "application/json",
+};
+(0, tsd_1.expectAssignable)(Object.assign({ data: { a: "" }, status: 200 }, additionalAxiosResponseData));
+(0, tsd_1.expectNotAssignable)(Object.assign({ data: { a: "", extra: "!" }, status: 200 }, additionalAxiosResponseData));
+(0, tsd_1.expectAssignable)(Object.assign({ data: {
+        b: "",
+    }, status: 201 }, additionalAxiosResponseData));
+(0, tsd_1.expectAssignable)(Object.assign({ data: null, status: 400 }, additionalAxiosResponseData));
+(0, tsd_1.expectNotAssignable)(Object.assign({ data: null, status: 42 }, additionalAxiosResponseData));
+(0, tsd_1.expectNotAssignable)(Object.assign({ data: null, status: 42, extra: "!" }, additionalAxiosResponseData));
+(0, tsd_1.expectNotAssignable)(Object.assign({ data: { extraContent: "" }, status: 400 }, additionalAxiosResponseData));
+function ignoredTestRequestTypesWithDataPathParameters() {
+    const someResponse = {};
+    (0, tsd_1.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;
+            (0, tsd_1.expectType)(someResponse.data.text);
+        }
+        else {
+            // @ts-expect-error > text is not in data
+            someResponse.data.text;
+            (0, tsd_1.expectType)(someResponse.data.a);
+        }
+    }
+    else if (someResponse.status === 201) {
+        (0, tsd_1.expectType)(someResponse.data.b);
+        // @ts-expect-error > a is not in data
+        someResponse.data.a;
+    }
+}

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

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

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tsd_1 = require("tsd");
+const assertStatus_js_1 = require("./assertStatus.js");
+function ignoredTestAssertStatusAssertsAlsoTheCorrectResponseType() {
+    (0, assertStatus_js_1.default)(someResponse, 200);
+    (0, tsd_1.expectAssignable)(someResponse);
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)(someResponse);
+}

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

@@ -5,8 +5,8 @@ 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<{
+export type HttpHeaders = {
     [TKey: string]: HeaderValue | HeaderValue[];
-}>;
+};
 export type PathParameters = Record<string, string | number>;
 export {};

package/dist/esm/core/Request.d.ts

@@ -8,5 +8,6 @@ export declare class Request<TOp extends OpenAPIOperation> {
     constructor(axiosInstance: AxiosInstance, operationDescriptor: TOp, config?: RequestConfig<TOp>);
     execute(): ResponsePromise<TOp>;
     private buildAxiosConfig;
+    private makeAxiosHeaders;
 }
 export default Request;

package/dist/esm/core/Request.js

@@ -24,10 +24,13 @@ export class Request {
         return {
             url: openApiPath.buildUrl(),
             method,
-            headers,
+            headers: headers ? this.makeAxiosHeaders(headers) : undefined,
             data,
             validateStatus: () => true,
         };
     }
+    makeAxiosHeaders(headers) {
+        return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, value.toString()]));
+    }
 }
 export default Request;

package/dist/esm/core/Request.test-types.d.ts

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

package/dist/esm/core/Request.test-types.js

@@ -0,0 +1,110 @@
+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 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/esm/types/RequestFunction.test-types.d.ts

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

package/dist/esm/types/RequestFunction.test-types.js

@@ -0,0 +1,11 @@
+function ignoredTestEmptyRequestTypes() {
+    const f = {};
+    void f();
+    void f({
+        headers: {},
+    });
+    void f({
+        headers: { extra: true },
+    });
+}
+export {};

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

@@ -1,14 +1,18 @@
 import { HttpHeaders, HttpPayload, PathParameters } from "./http.js";
-type RequestWithData<TData> = TData extends null ? object : {
+type EmptyObject = Record<string, never>;
+type EmptyRequestComponent = EmptyObject | null;
+type RequestWithOptionalHeaders = {
+    headers?: HttpHeaders;
+};
+type RequestWithData<TData> = TData extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
     data: TData;
 };
-type RequestWithPathParameters<TPathParameters> = TPathParameters extends null ? object : {
+type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
     pathParameters: TPathParameters;
 };
-type RequestWithHeaders<THeaders> = THeaders extends null ? object : {
-    headers: THeaders;
+type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    headers: THeaders & HttpHeaders;
 };
-type EmptyRequest = Record<string, never>;
-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 RequestType<TData extends HttpPayload = EmptyRequestComponent, TPathParameters extends PathParameters | EmptyRequestComponent = EmptyRequestComponent, THeader extends HttpHeaders | EmptyRequestComponent = EmptyRequestComponent> = TData | TPathParameters | THeader extends EmptyRequestComponent ? RequestWithOptionalHeaders : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithHeaders<THeader>;
 export type AnyRequest = RequestType<any, any, any>;
 export {};

package/dist/esm/types/Response.test-types.d.ts

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

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

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

package/dist/esm/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/esm/types/http.d.ts

@@ -5,8 +5,8 @@ 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<{
+export type HttpHeaders = {
     [TKey: string]: HeaderValue | HeaderValue[];
-}>;
+};
 export type PathParameters = Record<string, string | number>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.2",
   "description": "Common types and utilities for mittwald API clients",
   "license": "MIT",
   "repository": "https://github.com/mittwald/api-client-js.git",
@@ -25,8 +25,7 @@
     }
   },
   "scripts": {
-    "test": "yarn test:tsd",
-    "test:tsd": "pnpify run tsd"
+    "test": "echo 'No tests available'"
   },
   "files": [
     "dist/**/*.{js,d.ts}"