@mittwald/api-client-commons 3.0.8 → 3.1.0

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

@@ -1,6 +1,6 @@
 import { AxiosInstance, CreateAxiosDefaults } from "axios";
-import { RequestFunction } from "../types/RequestFunction.js";
-import { OpenAPIOperation } from "../types/OpenAPIOperation.js";
+import { RequestFunction } from "../types/index.js";
+import { OpenAPIOperation } from "../types/index.js";
 export declare abstract class ApiClientBase {
     axios: AxiosInstance;
     constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);

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

@@ -1,5 +1,4 @@
-import { OpenAPIOperation } from "../types/OpenAPIOperation.js";
-import { RequestConfig, ResponsePromise } from "../types/RequestFunction.js";
+import { OpenAPIOperation, RequestConfig, ResponsePromise } from "../types/index.js";
 import { AxiosInstance } from "axios";
 export declare class Request<TOp extends OpenAPIOperation> {
     private readonly axios;
@@ -9,5 +8,6 @@ export declare class Request<TOp extends OpenAPIOperation> {
     execute(): ResponsePromise<TOp>;
     private buildAxiosConfig;
     private makeAxiosHeaders;
+    private convertQueryToUrlSearchParams;
 }
 export default Request;

package/dist/cjs/core/Request.js

@@ -19,12 +19,22 @@ class Request {
             ? this.config.pathParameters
             : undefined;
         const openApiPath = new OpenAPIPath_js_1.default(path, pathParameters);
+        const url = openApiPath.buildUrl();
         const data = this.config && "data" in this.config ? this.config.data : undefined;
-        const headers = this.config && "headers" in this.config ? this.config.headers : undefined;
+        const headersConfig = this.config && "headers" in this.config ? this.config.headers : undefined;
+        const headers = headersConfig
+            ? this.makeAxiosHeaders(headersConfig)
+            : undefined;
+        const queryParametersConfig = this.config && "queryParameters" in this.config
+            ? this.config.queryParameters
+            : undefined;
+        const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
         return {
-            url: openApiPath.buildUrl(),
+            url,
             method,
-            headers: headers ? this.makeAxiosHeaders(headers) : undefined,
+            headers,
+            // Must be a plain object or an URLSearchParams object
+            params,
             data,
             validateStatus: () => true,
         };
@@ -32,6 +42,36 @@ class Request {
     makeAxiosHeaders(headers) {
         return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, value === null || value === void 0 ? void 0 : value.toString()]));
     }
+    convertQueryToUrlSearchParams(query) {
+        if (query === undefined || query === null) {
+            return undefined;
+        }
+        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})`);
+    }
 }
 exports.Request = Request;
 exports.default = Request;

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

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

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

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Request_js_1 = require("./Request.js");
+const globals_1 = require("@jest/globals");
+const requestFn = globals_1.jest.fn();
+const mockedAxios = {
+    request: requestFn,
+};
+beforeEach(() => {
+    globals_1.jest.resetAllMocks();
+});
+describe("query parameters", () => {
+    const op = {
+        path: "/",
+        operationId: "test",
+        method: "GET",
+    };
+    const executeRequest = (query) => {
+        const request = new Request_js_1.default(mockedAxios, op, { queryParameters: query });
+        request.execute();
+        const requestConfig = requestFn.mock.calls[0][0];
+        return requestConfig.params.toString();
+    };
+    test("Empty query", () => {
+        const query = executeRequest({});
+        expect(query).toBe("");
+    });
+    test("Simple parameter", () => {
+        const query = executeRequest({
+            foo: "bar",
+        });
+        expect(query).toBe("foo=bar");
+    });
+    test("Two parameters", () => {
+        const query = executeRequest({
+            foo: "bar",
+            bam: "baz",
+        });
+        expect(query).toBe("foo=bar&bam=baz");
+    });
+    test("Array parameters", () => {
+        const query = executeRequest({
+            foo: ["bar", "bam"],
+        });
+        expect(query).toBe("foo=bar&foo=bam");
+    });
+    test("Number, boolean, JSON", () => {
+        const query = executeRequest({
+            foo: 1,
+            bar: true,
+            baz: { some: "value" },
+        });
+        expect(query).toBe("foo=1&bar=true&baz=%7B%22some%22%3A%22value%22%7D");
+    });
+});

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

@@ -1,4 +1,4 @@
-import { OpenAPIOperation, InferredRequestType, InferredResponseType } from "./OpenAPIOperation.js";
+import { InferredRequestType, InferredResponseType, OpenAPIOperation } 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>>;

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

@@ -1,4 +1,4 @@
-import { HttpHeaders, HttpPayload, PathParameters } from "./http.js";
+import { HttpHeaders, HttpPayload, PathParameters, QueryParameters } from "./http.js";
 type EmptyObject = Record<string, never>;
 type EmptyRequestComponent = EmptyObject | null;
 type RequestWithOptionalHeaders = {
@@ -13,6 +13,9 @@ type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyR
 type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
     headers: THeaders & HttpHeaders;
 };
-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>;
+type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    queryParameters: TQuery & HttpHeaders;
+};
+export type RequestType<TData extends HttpPayload = EmptyRequestComponent, TPathParameters extends PathParameters | EmptyRequestComponent = EmptyRequestComponent, TQueryParameters extends QueryParameters | EmptyRequestComponent = EmptyRequestComponent, THeader extends HttpHeaders | EmptyRequestComponent = EmptyRequestComponent> = TData | TPathParameters | THeader | TQueryParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithQueryParameters<TQueryParameters> & RequestWithHeaders<THeader>;
+export type AnyRequest = RequestType<any, any, any, any>;
 export {};

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

@@ -84,6 +84,42 @@ function ignoredTestRequestTypesWithHeader() {
         },
     });
 }
+function ignoredTestRequestTypesWithQuery() {
+    (0, tsd_1.expectAssignable)({
+        data: {
+            foo: "",
+        },
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+        queryParameters: {
+            whut: "",
+        },
+    });
+    (0, tsd_1.expectAssignable)({
+        pathParameters: { bar: "" },
+        headers: { baz: "" },
+        queryParameters: {
+            whut: "",
+        },
+    });
+    (0, tsd_1.expectAssignable)({
+        queryParameters: {
+            whut: "",
+        },
+    });
+    // @ts-expect-error Not assignable
+    (0, tsd_1.expectAssignable)({});
+    (0, tsd_1.expectAssignable)({
+        queryParameters: {
+            // @ts-expect-error Not assignable
+            whut: 42,
+        },
+    });
+    (0, tsd_1.expectAssignable)({
+        // @ts-expect-error Not assignable
+        queryParameters: {},
+    });
+}
 function ignoredTestAdditionalHeadersCanAlwaysBeSet() {
     (0, tsd_1.expectAssignable)({
         headers: { extra: true },

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

@@ -9,4 +9,5 @@ export type HttpHeaders = Partial<{
     [TKey: string]: HeaderValue | HeaderValue[];
 }>;
 export type PathParameters = Record<string, string | number>;
+export type QueryParameters = Record<string, unknown>;
 export {};

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

@@ -1,6 +1,6 @@
 import { AxiosInstance, CreateAxiosDefaults } from "axios";
-import { RequestFunction } from "../types/RequestFunction.js";
-import { OpenAPIOperation } from "../types/OpenAPIOperation.js";
+import { RequestFunction } from "../types/index.js";
+import { OpenAPIOperation } from "../types/index.js";
 export declare abstract class ApiClientBase {
     axios: AxiosInstance;
     constructor(axiosConfig?: AxiosInstance | CreateAxiosDefaults);

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

@@ -1,5 +1,4 @@
-import { OpenAPIOperation } from "../types/OpenAPIOperation.js";
-import { RequestConfig, ResponsePromise } from "../types/RequestFunction.js";
+import { OpenAPIOperation, RequestConfig, ResponsePromise } from "../types/index.js";
 import { AxiosInstance } from "axios";
 export declare class Request<TOp extends OpenAPIOperation> {
     private readonly axios;
@@ -9,5 +8,6 @@ export declare class Request<TOp extends OpenAPIOperation> {
     execute(): ResponsePromise<TOp>;
     private buildAxiosConfig;
     private makeAxiosHeaders;
+    private convertQueryToUrlSearchParams;
 }
 export default Request;

package/dist/esm/core/Request.js

@@ -19,12 +19,22 @@ export class Request {
             ? this.config.pathParameters
             : undefined;
         const openApiPath = new OpenAPIPath(path, pathParameters);
+        const url = openApiPath.buildUrl();
         const data = this.config && "data" in this.config ? this.config.data : undefined;
-        const headers = this.config && "headers" in this.config ? this.config.headers : undefined;
+        const headersConfig = this.config && "headers" in this.config ? this.config.headers : undefined;
+        const headers = headersConfig
+            ? this.makeAxiosHeaders(headersConfig)
+            : undefined;
+        const queryParametersConfig = this.config && "queryParameters" in this.config
+            ? this.config.queryParameters
+            : undefined;
+        const params = this.convertQueryToUrlSearchParams(queryParametersConfig);
         return {
-            url: openApiPath.buildUrl(),
+            url,
             method,
-            headers: headers ? this.makeAxiosHeaders(headers) : undefined,
+            headers,
+            // Must be a plain object or an URLSearchParams object
+            params,
             data,
             validateStatus: () => true,
         };
@@ -32,5 +42,35 @@ export class Request {
     makeAxiosHeaders(headers) {
         return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, value?.toString()]));
     }
+    convertQueryToUrlSearchParams(query) {
+        if (query === undefined || query === null) {
+            return undefined;
+        }
+        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})`);
+    }
 }
 export default Request;

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

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

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

@@ -0,0 +1,53 @@
+import Request from "./Request.js";
+import { jest } from "@jest/globals";
+const requestFn = jest.fn();
+const mockedAxios = {
+    request: requestFn,
+};
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+describe("query parameters", () => {
+    const op = {
+        path: "/",
+        operationId: "test",
+        method: "GET",
+    };
+    const executeRequest = (query) => {
+        const request = new Request(mockedAxios, op, { queryParameters: query });
+        request.execute();
+        const requestConfig = requestFn.mock.calls[0][0];
+        return requestConfig.params.toString();
+    };
+    test("Empty query", () => {
+        const query = executeRequest({});
+        expect(query).toBe("");
+    });
+    test("Simple parameter", () => {
+        const query = executeRequest({
+            foo: "bar",
+        });
+        expect(query).toBe("foo=bar");
+    });
+    test("Two parameters", () => {
+        const query = executeRequest({
+            foo: "bar",
+            bam: "baz",
+        });
+        expect(query).toBe("foo=bar&bam=baz");
+    });
+    test("Array parameters", () => {
+        const query = executeRequest({
+            foo: ["bar", "bam"],
+        });
+        expect(query).toBe("foo=bar&foo=bam");
+    });
+    test("Number, boolean, JSON", () => {
+        const query = executeRequest({
+            foo: 1,
+            bar: true,
+            baz: { some: "value" },
+        });
+        expect(query).toBe("foo=1&bar=true&baz=%7B%22some%22%3A%22value%22%7D");
+    });
+});

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

@@ -1,4 +1,4 @@
-import { OpenAPIOperation, InferredRequestType, InferredResponseType } from "./OpenAPIOperation.js";
+import { InferredRequestType, InferredResponseType, OpenAPIOperation } 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>>;

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

@@ -1,4 +1,4 @@
-import { HttpHeaders, HttpPayload, PathParameters } from "./http.js";
+import { HttpHeaders, HttpPayload, PathParameters, QueryParameters } from "./http.js";
 type EmptyObject = Record<string, never>;
 type EmptyRequestComponent = EmptyObject | null;
 type RequestWithOptionalHeaders = {
@@ -13,6 +13,9 @@ type RequestWithPathParameters<TPathParameters> = TPathParameters extends EmptyR
 type RequestWithHeaders<THeaders> = THeaders extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
     headers: THeaders & HttpHeaders;
 };
-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>;
+type RequestWithQueryParameters<TQuery> = TQuery extends EmptyRequestComponent ? RequestWithOptionalHeaders : {
+    queryParameters: TQuery & HttpHeaders;
+};
+export type RequestType<TData extends HttpPayload = EmptyRequestComponent, TPathParameters extends PathParameters | EmptyRequestComponent = EmptyRequestComponent, TQueryParameters extends QueryParameters | EmptyRequestComponent = EmptyRequestComponent, THeader extends HttpHeaders | EmptyRequestComponent = EmptyRequestComponent> = TData | TPathParameters | THeader | TQueryParameters extends EmptyRequestComponent ? RequestWithOptionalHeaders : RequestWithData<TData> & RequestWithPathParameters<TPathParameters> & RequestWithQueryParameters<TQueryParameters> & RequestWithHeaders<THeader>;
+export type AnyRequest = RequestType<any, any, any, any>;
 export {};

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

@@ -82,6 +82,42 @@ function ignoredTestRequestTypesWithHeader() {
         },
     });
 }
+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 },

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

@@ -9,4 +9,5 @@ export type HttpHeaders = Partial<{
     [TKey: string]: HeaderValue | HeaderValue[];
 }>;
 export type PathParameters = Record<string, string | number>;
+export type QueryParameters = Record<string, unknown>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/api-client-commons",
-  "version": "3.0.8",
+  "version": "3.1.0",
   "description": "Common types and utilities for mittwald API clients",
   "license": "MIT",
   "repository": "https://github.com/mittwald/api-client-js.git",
@@ -25,7 +25,7 @@
     }
   },
   "scripts": {
-    "test": "echo 'No tests available'"
+    "test": "node --experimental-vm-modules $(yarn bin jest)"
   },
   "files": [
     "dist/**/*.{js,d.ts}"
@@ -45,7 +45,11 @@
     "type-fest": "^3.12.0"
   },
   "devDependencies": {
+    "@jest/globals": "^29.6.0",
+    "@types/jest": "^29.5.2",
     "@yarnpkg/pnpify": "^4.0.0-rc.48",
+    "jest": "^29.6.1",
+    "ts-jest": "^29.1.1",
     "tsd": "^0.28.1"
   },
   "types": "dist/cjs/index.d.ts"