@mittwald/cli 1.0.0-alpha.8 → 1.0.0-beta.1

package/dist/commands/user/api-token/get.d.ts

@@ -0,0 +1,14 @@
+import { MittwaldAPIV2Client } from "@mittwald/api-client";
+import { GetBaseCommand } from "../../../lib/basecommands/GetBaseCommand.js";
+type APIResponse = Awaited<ReturnType<MittwaldAPIV2Client["user"]["getApiToken"]>>;
+export default class Get extends GetBaseCommand<typeof Get, APIResponse> {
+    static description: string;
+    static flags: {
+        [x: string]: import("@oclif/core/interfaces").Flag<any>;
+    };
+    static args: {
+        "token-id": import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    protected getData(): Promise<APIResponse>;
+}
+export {};

package/dist/commands/user/api-token/get.js

@@ -0,0 +1,19 @@
+import { Args } from "@oclif/core";
+import { GetBaseCommand } from "../../../lib/basecommands/GetBaseCommand.js";
+export default class Get extends GetBaseCommand {
+    static description = "Get a specific API token";
+    static flags = {
+        ...GetBaseCommand.baseFlags,
+    };
+    static args = {
+        "token-id": Args.string({
+            description: "The ID of an API token",
+            required: true,
+        }),
+    };
+    async getData() {
+        return await this.apiClient.user.getApiToken({
+            apiTokenId: this.args["token-id"],
+        });
+    }
+}

package/dist/commands/user/api-token/list.d.ts

@@ -0,0 +1,21 @@
+import { Simplify } from "@mittwald/api-client-commons";
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { ListColumns } from "../../../rendering/formatter/ListFormatter.js";
+import { ListBaseCommand } from "../../../lib/basecommands/ListBaseCommand.js";
+type ResponseItem = Simplify<MittwaldAPIV2.Paths.V2UsersSelfApiTokens.Get.Responses.$200.Content.ApplicationJson[number]>;
+type Response = Awaited<ReturnType<MittwaldAPIV2Client["user"]["listApiTokens"]>>;
+export default class List extends ListBaseCommand<typeof List, ResponseItem, Response> {
+    static description: string;
+    static args: {};
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<"json" | "txt" | "yaml" | "csv" | "tsv">;
+        extended: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-header": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-truncate": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-relative-dates": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "csv-separator": import("@oclif/core/interfaces").OptionFlag<"," | ";">;
+    };
+    getData(): Promise<Response>;
+    protected getColumns(): ListColumns<ResponseItem>;
+}
+export {};

package/dist/commands/user/api-token/list.js

@@ -0,0 +1,27 @@
+import { ListBaseCommand } from "../../../lib/basecommands/ListBaseCommand.js";
+import ListDateColumnFormatter from "../../../rendering/formatter/ListDateColumnFormatter.js";
+export default class List extends ListBaseCommand {
+    static description = "List all API tokens of the user";
+    static args = {};
+    static flags = {
+        ...ListBaseCommand.baseFlags,
+    };
+    async getData() {
+        return await this.apiClient.user.listApiTokens();
+    }
+    getColumns() {
+        const dateColumnBuilder = new ListDateColumnFormatter(this.flags);
+        const createdAt = dateColumnBuilder.buildColumn();
+        const expiresAt = dateColumnBuilder.buildColumn({
+            header: "Expires at",
+            column: "expiresAt",
+            fallback: "never",
+        });
+        return {
+            apiTokenId: { header: "ID", minWidth: 36 },
+            description: {},
+            createdAt,
+            expiresAt,
+        };
+    }
+}

package/dist/commands/user/api-token/revoke.d.ts

@@ -0,0 +1,13 @@
+import { DeleteBaseCommand } from "../../../lib/basecommands/DeleteBaseCommand.js";
+export default class Revoke extends DeleteBaseCommand<typeof Revoke> {
+    static description: string;
+    static resource: string;
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected deleteResource(): Promise<void>;
+}

package/dist/commands/user/api-token/revoke.js

@@ -0,0 +1,21 @@
+import { Args } from "@oclif/core";
+import { assertStatus } from "@mittwald/api-client-commons";
+import { DeleteBaseCommand } from "../../../lib/basecommands/DeleteBaseCommand.js";
+export default class Revoke extends DeleteBaseCommand {
+    static description = "Revoke an API token";
+    static resource = "API token";
+    static args = {
+        id: Args.string({
+            description: "ID of the API token to revoke",
+            required: true,
+        }),
+    };
+    static flags = { ...DeleteBaseCommand.baseFlags };
+    async deleteResource() {
+        const { args } = await this.parse(Revoke);
+        const response = await this.apiClient.user.deleteApiToken({
+            apiTokenId: args.id,
+        });
+        assertStatus(response, 204);
+    }
+}

package/dist/commands/user/get.d.ts

@@ -0,0 +1,15 @@
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { GetBaseCommand } from "../../lib/basecommands/GetBaseCommand.js";
+export type PathParams = MittwaldAPIV2.Paths.V2UsersUserId.Get.Parameters.Path;
+type APIResponse = Awaited<ReturnType<MittwaldAPIV2Client["user"]["getUser"]>>;
+export default class Get extends GetBaseCommand<typeof Get, APIResponse> {
+    static description: string;
+    static flags: {
+        [x: string]: import("@oclif/core/interfaces").Flag<any>;
+    };
+    static args: {
+        "user-id": import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    protected getData(): Promise<APIResponse>;
+}
+export {};

package/dist/commands/user/get.js

@@ -0,0 +1,20 @@
+import { GetBaseCommand } from "../../lib/basecommands/GetBaseCommand.js";
+import { Args } from "@oclif/core";
+export default class Get extends GetBaseCommand {
+    static description = "Get profile information for a user.";
+    static flags = {
+        ...GetBaseCommand.baseFlags,
+    };
+    static args = {
+        "user-id": Args.string({
+            description: "The user ID to get information for; defaults to the special value 'self', which references to the currently authenticated user.",
+            default: "self",
+            required: true,
+        }),
+    };
+    async getData() {
+        return await this.apiClient.user.getUser({
+            userId: this.args["user-id"],
+        });
+    }
+}

package/dist/commands/user/session/get.d.ts

@@ -0,0 +1,14 @@
+import { MittwaldAPIV2Client } from "@mittwald/api-client";
+import { GetBaseCommand } from "../../../lib/basecommands/GetBaseCommand.js";
+type APIResponse = Awaited<ReturnType<MittwaldAPIV2Client["user"]["getSession"]>>;
+export default class Get extends GetBaseCommand<typeof Get, APIResponse> {
+    static description: string;
+    static flags: {
+        [x: string]: import("@oclif/core/interfaces").Flag<any>;
+    };
+    static args: {
+        "token-id": import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    protected getData(): Promise<APIResponse>;
+}
+export {};

package/dist/commands/user/session/get.js

@@ -0,0 +1,19 @@
+import { Args } from "@oclif/core";
+import { GetBaseCommand } from "../../../lib/basecommands/GetBaseCommand.js";
+export default class Get extends GetBaseCommand {
+    static description = "Get a specific session";
+    static flags = {
+        ...GetBaseCommand.baseFlags,
+    };
+    static args = {
+        "token-id": Args.string({
+            description: "Token ID to identify the specific session",
+            required: true,
+        }),
+    };
+    async getData() {
+        return await this.apiClient.user.getSession({
+            tokenId: this.args["token-id"],
+        });
+    }
+}

package/dist/commands/user/session/list.d.ts

@@ -0,0 +1,21 @@
+import { Simplify } from "@mittwald/api-client-commons";
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { ListColumns } from "../../../rendering/formatter/ListFormatter.js";
+import { ListBaseCommand } from "../../../lib/basecommands/ListBaseCommand.js";
+type ResponseItem = Simplify<MittwaldAPIV2.Paths.V2UsersSelfSessions.Get.Responses.$200.Content.ApplicationJson[number]>;
+type Response = Awaited<ReturnType<MittwaldAPIV2Client["user"]["listSessions"]>>;
+export default class List extends ListBaseCommand<typeof List, ResponseItem, Response> {
+    static description: string;
+    static args: {};
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<"json" | "txt" | "yaml" | "csv" | "tsv">;
+        extended: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-header": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-truncate": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-relative-dates": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "csv-separator": import("@oclif/core/interfaces").OptionFlag<"," | ";">;
+    };
+    getData(): Promise<Response>;
+    protected getColumns(): ListColumns<ResponseItem>;
+}
+export {};

package/dist/commands/user/session/list.js

@@ -0,0 +1,32 @@
+import { ListBaseCommand } from "../../../lib/basecommands/ListBaseCommand.js";
+import ListDateColumnFormatter from "../../../rendering/formatter/ListDateColumnFormatter.js";
+export default class List extends ListBaseCommand {
+    static description = "List all active sessions";
+    static args = {};
+    static flags = {
+        ...ListBaseCommand.baseFlags,
+    };
+    async getData() {
+        return await this.apiClient.user.listSessions();
+    }
+    getColumns() {
+        const dateColumnBuilder = new ListDateColumnFormatter(this.flags);
+        const lastAccess = dateColumnBuilder.buildColumn({
+            header: "Last access",
+            column: "lastAccess",
+            fallback: "(never)",
+        });
+        return {
+            tokenId: { header: "ID", minWidth: 36 },
+            device: {
+                header: "Device",
+                get: (row) => `${row.device.browser ?? "unknown browser"} on ${row.device.os ?? "unknown OS"}`,
+            },
+            location: {
+                header: "Location",
+                get: (row) => row.location?.country,
+            },
+            lastAccess,
+        };
+    }
+}

package/dist/commands/user/ssh-key/create.d.ts

@@ -0,0 +1,14 @@
+import { ExecRenderBaseCommand } from "../../../lib/basecommands/ExecRenderBaseCommand.js";
+export default class Create extends ExecRenderBaseCommand<typeof Create, undefined> {
+    static description: string;
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        "no-passphrase": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        comment: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        expires: import("@oclif/core/interfaces").OptionFlag<Date | undefined>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected exec(): Promise<undefined>;
+    protected render(): null;
+    private getPassphrase;
+}

package/dist/commands/user/ssh-key/create.js

@@ -0,0 +1,69 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Flags } from "@oclif/core";
+import { assertStatus } from "@mittwald/api-client-commons";
+import * as path from "path";
+import * as os from "os";
+import * as fs from "fs/promises";
+import { ExecRenderBaseCommand } from "../../../lib/basecommands/ExecRenderBaseCommand.js";
+import { makeProcessRenderer, processFlags, } from "../../../rendering/process/process_flags.js";
+import { Success } from "../../../rendering/react/components/Success.js";
+import { Filename } from "../../../rendering/react/components/Filename.js";
+import { Text } from "ink";
+import { spawnInProcess } from "../../../rendering/process/process_exec.js";
+import { expireFlags } from "../../../lib/flags/expireFlags.js";
+export default class Create extends ExecRenderBaseCommand {
+    static description = "Create and import a new SSH key";
+    static flags = {
+        ...processFlags,
+        ...expireFlags("SSH key", false),
+        output: Flags.string({
+            description: "A filename in your ~/.ssh directory to write the SSH key to.",
+            default: "mstudio-cli",
+        }),
+        "no-passphrase": Flags.boolean({
+            description: "Use this flag to not set a passphrase for the SSH key.",
+        }),
+        comment: Flags.string({
+            description: "A comment for the SSH key.",
+        }),
+    };
+    async exec() {
+        const cmd = "ssh-keygen";
+        const outputFile = path.join(os.homedir(), ".ssh", this.flags.output);
+        const r = makeProcessRenderer(this.flags, "Creating a new SSH key");
+        const { expires } = this.flags;
+        const passphrase = await this.getPassphrase(r);
+        const args = ["-t", "rsa", "-f", outputFile, "-N", passphrase];
+        if (this.flags.comment) {
+            args.push("-C", this.flags.comment);
+        }
+        await spawnInProcess(r, "generating SSH key using ssh-keygen", cmd, args);
+        const publicKey = await fs.readFile(outputFile + ".pub", "utf-8");
+        r.addInfo(_jsx(InfoSSHKeySaved, { filename: outputFile }));
+        await r.runStep("importing SSH key", async () => {
+            const response = await this.apiClient.user.createSshKey({
+                data: {
+                    publicKey,
+                    expiresAt: expires?.toJSON(),
+                },
+            });
+            assertStatus(response, 201);
+        });
+        await r.complete(_jsx(SSHKeySuccess, {}));
+    }
+    render() {
+        return null;
+    }
+    async getPassphrase(r) {
+        if (this.flags["no-passphrase"]) {
+            return "";
+        }
+        return await r.addInput(_jsx(Text, { children: "enter passphrase for SSH key" }), true);
+    }
+}
+function SSHKeySuccess() {
+    return (_jsx(Success, { children: "Your SSH key was successfully created and imported to your user profile." }));
+}
+function InfoSSHKeySaved({ filename }) {
+    return (_jsxs(Text, { children: ["ssh key saved to ", _jsx(Filename, { filename: filename }), "."] }));
+}

package/dist/commands/user/ssh-key/delete.d.ts

@@ -0,0 +1,13 @@
+import { DeleteBaseCommand } from "../../../lib/basecommands/DeleteBaseCommand.js";
+export default class Delete extends DeleteBaseCommand<typeof Delete> {
+    static description: string;
+    static resourceName: string;
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected deleteResource(): Promise<void>;
+}

package/dist/commands/user/ssh-key/delete.js

@@ -0,0 +1,22 @@
+import { Args } from "@oclif/core";
+import { assertStatus } from "@mittwald/api-client-commons";
+import { DeleteBaseCommand } from "../../../lib/basecommands/DeleteBaseCommand.js";
+export default class Delete extends DeleteBaseCommand {
+    static description = "Delete an SSH key";
+    static resourceName = "SSH key";
+    static args = {
+        id: Args.string({
+            required: true,
+            description: "ID of the SSH key to be deleted.",
+        }),
+    };
+    static flags = { ...DeleteBaseCommand.baseFlags };
+    async deleteResource() {
+        const { args } = await this.parse(Delete);
+        const { id } = args;
+        const response = await this.apiClient.user.deleteSshKey({
+            sshKeyId: id,
+        });
+        assertStatus(response, 204);
+    }
+}

package/dist/commands/user/ssh-key/get.d.ts

@@ -0,0 +1,14 @@
+import { MittwaldAPIV2Client } from "@mittwald/api-client";
+import { GetBaseCommand } from "../../../lib/basecommands/GetBaseCommand.js";
+type APIResponse = Awaited<ReturnType<MittwaldAPIV2Client["user"]["getSshKey"]>>;
+export default class Get extends GetBaseCommand<typeof Get, APIResponse> {
+    static description: string;
+    static flags: {
+        [x: string]: import("@oclif/core/interfaces").Flag<any>;
+    };
+    static args: {
+        "key-id": import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    protected getData(): Promise<APIResponse>;
+}
+export {};

package/dist/commands/user/ssh-key/get.js

@@ -0,0 +1,19 @@
+import { Args } from "@oclif/core";
+import { GetBaseCommand } from "../../../lib/basecommands/GetBaseCommand.js";
+export default class Get extends GetBaseCommand {
+    static description = "Get a specific SSH key";
+    static flags = {
+        ...GetBaseCommand.baseFlags,
+    };
+    static args = {
+        "key-id": Args.string({
+            description: "The ID of an SSH key",
+            required: true,
+        }),
+    };
+    async getData() {
+        return await this.apiClient.user.getSshKey({
+            sshKeyId: this.args["key-id"],
+        });
+    }
+}

package/dist/commands/user/ssh-key/import.d.ts

@@ -0,0 +1,11 @@
+import { ExecRenderBaseCommand } from "../../../lib/basecommands/ExecRenderBaseCommand.js";
+export default class Import extends ExecRenderBaseCommand<typeof Import, undefined> {
+    static description: string;
+    static flags: {
+        input: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        expires: import("@oclif/core/interfaces").OptionFlag<Date | undefined>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected exec(): Promise<undefined>;
+    protected render(): null;
+}

package/dist/commands/user/ssh-key/import.js

@@ -0,0 +1,56 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import { Flags } from "@oclif/core";
+import { assertStatus } from "@mittwald/api-client-commons";
+import * as path from "path";
+import * as os from "os";
+import * as fs from "fs/promises";
+import { ExecRenderBaseCommand } from "../../../lib/basecommands/ExecRenderBaseCommand.js";
+import { makeProcessRenderer, processFlags, } from "../../../rendering/process/process_flags.js";
+import { Success } from "../../../rendering/react/components/Success.js";
+import { Filename } from "../../../rendering/react/components/Filename.js";
+import { expireFlags } from "../../../lib/flags/expireFlags.js";
+export default class Import extends ExecRenderBaseCommand {
+    static description = "Import an existing (local) SSH key";
+    static flags = {
+        ...processFlags,
+        ...expireFlags("SSH key", false),
+        input: Flags.string({
+            description: "A filename in your ~/.ssh directory containing the key to import.",
+            default: "id_rsa.pub",
+        }),
+    };
+    async exec() {
+        const inputFile = path.join(os.homedir(), ".ssh", this.flags.input);
+        const r = makeProcessRenderer(this.flags, "Importing an SSH key");
+        const { expires } = this.flags;
+        const publicKey = await fs.readFile(inputFile, "utf-8");
+        const publicKeyParts = publicKey.split(" ");
+        const keys = await r.runStep("retrieving existing SSH keys", async () => {
+            const response = await this.apiClient.user.listSshKeys();
+            assertStatus(response, 200);
+            return response.data;
+        });
+        const keyAlreadyExists = (keys.sshKeys ?? []).some(({ key }) => publicKeyParts.includes(key));
+        if (keyAlreadyExists) {
+            r.addInfo(_jsxs(_Fragment, { children: ["the SSH key ", _jsx(Filename, { filename: inputFile }), " is already imported."] }));
+            await r.complete(_jsx(SSHKeySuccess, {}));
+            return;
+        }
+        await r.runStep("importing SSH key", async () => {
+            const response = await this.apiClient.user.createSshKey({
+                data: {
+                    publicKey,
+                    expiresAt: expires?.toJSON(),
+                },
+            });
+            assertStatus(response, 201);
+        });
+        await r.complete(_jsx(SSHKeySuccess, {}));
+    }
+    render() {
+        return null;
+    }
+}
+function SSHKeySuccess() {
+    return (_jsx(Success, { children: "Your SSH key was successfully read and imported to your user profile." }));
+}

package/dist/commands/user/ssh-key/list.d.ts

@@ -0,0 +1,23 @@
+import { Simplify } from "@mittwald/api-client-commons";
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { SuccessfulResponse } from "../../../lib/apiutil/SuccessfulResponse.js";
+import { ListColumns } from "../../../rendering/formatter/ListFormatter.js";
+import { ListBaseCommand } from "../../../lib/basecommands/ListBaseCommand.js";
+type ResponseItem = Simplify<Required<MittwaldAPIV2.Paths.V2UsersSelfSshKeys.Get.Responses.$200.Content.ApplicationJson>["sshKeys"][number]>;
+type Response = Awaited<ReturnType<MittwaldAPIV2Client["user"]["listSshKeys"]>>;
+export default class List extends ListBaseCommand<typeof List, ResponseItem, Response> {
+    static description: string;
+    static args: {};
+    static flags: {
+        output: import("@oclif/core/interfaces").OptionFlag<"json" | "txt" | "yaml" | "csv" | "tsv">;
+        extended: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-header": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-truncate": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "no-relative-dates": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "csv-separator": import("@oclif/core/interfaces").OptionFlag<"," | ";">;
+    };
+    getData(): Promise<Response>;
+    protected mapData(data: SuccessfulResponse<Response, 200>["data"]): MittwaldAPIV2.Components.Schemas.SignupSshKey[];
+    protected getColumns(): ListColumns<ResponseItem>;
+}
+export {};

package/dist/commands/user/ssh-key/list.js

@@ -0,0 +1,26 @@
+import { ListBaseCommand } from "../../../lib/basecommands/ListBaseCommand.js";
+import ListDateColumnFormatter from "../../../rendering/formatter/ListDateColumnFormatter.js";
+export default class List extends ListBaseCommand {
+    static description = "Get your stored ssh keys";
+    static args = {};
+    static flags = {
+        ...ListBaseCommand.baseFlags,
+    };
+    async getData() {
+        return await this.apiClient.user.listSshKeys();
+    }
+    mapData(data) {
+        return data.sshKeys ?? [];
+    }
+    getColumns() {
+        return {
+            sshKeyId: {
+                header: "ID",
+                minWidth: 36,
+            },
+            comment: {},
+            fingerprint: {},
+            createdAt: new ListDateColumnFormatter(this.flags).buildColumn(),
+        };
+    }
+}

package/dist/lib/apiutil/SuccessfulResponse.d.ts

@@ -0,0 +1,19 @@
+import { Response } from "@mittwald/api-client-commons";
+/**
+ * Helper type to assert that a response has a specific status code.
+ *
+ * Usage:
+ *
+ *     // ResponseType is a union of all possible responses
+ *     type AppListResponseType = Awaited<
+ *       ReturnType<MittwaldAPIV2Client["app"]["listAppinstallations"]>
+ *     >;
+ *
+ *     type AppListSuccessfulResponse = SuccessfulResponse<
+ *       AppListResponseType,
+ *       200
+ *     >;
+ */
+export type SuccessfulResponse<T extends Response, S extends T["status"]> = T & {
+    status: S;
+};

package/dist/lib/apiutil/SuccessfulResponse.js

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

package/dist/lib/apiutil/api_consistency.d.ts

@@ -0,0 +1,2 @@
+import { AxiosInstance } from "@mittwald/api-client-commons";
+export declare function configureConsistencyHandling(axios: AxiosInstance): void;

package/dist/lib/apiutil/api_consistency.js

@@ -0,0 +1,27 @@
+import debug from "debug";
+const d = debug("mw:api-consistency");
+export function configureConsistencyHandling(axios) {
+    let lastEventId = undefined;
+    let mutatedPaths = undefined;
+    axios.interceptors.request.use((config) => {
+        if (lastEventId !== undefined &&
+            mutatedPaths?.some((path) => config.url?.startsWith(path))) {
+            d("setting if-event-reached to %o", lastEventId);
+            config.headers["if-event-reached"] = lastEventId;
+        }
+        return config;
+    });
+    axios.interceptors.response.use((response) => {
+        const isMutatingRequest = ["post", "put", "delete", "patch"].indexOf(response.config?.method?.toLowerCase() ?? "") >= 0;
+        const headers = response.headers;
+        if (headers.has("etag") && isMutatingRequest) {
+            lastEventId = headers.get("etag");
+            const mutatedPath = response.config?.url;
+            if (mutatedPath !== undefined) {
+                mutatedPaths = [mutatedPath];
+            }
+            d("setting last event id to %o after mutating request for path %o", headers["etag"], mutatedPath);
+        }
+        return response;
+    });
+}

package/dist/lib/apiutil/api_logging.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from "@mittwald/api-client-commons";
+/**
+ * Configure logging for Axios requests and responses using the `debug` module.
+ *
+ * Run the CLI with `DEBUG=mw:api:client:*` to see the logs. Keep in mind that
+ * this will also log sensitive information in request bodies or headers.
+ */
+export declare function configureAxiosLogging(axios: AxiosInstance): void;

package/dist/lib/apiutil/api_logging.js

@@ -0,0 +1,20 @@
+import debug from "debug";
+/**
+ * Configure logging for Axios requests and responses using the `debug` module.
+ *
+ * Run the CLI with `DEBUG=mw:api:client:*` to see the logs. Keep in mind that
+ * this will also log sensitive information in request bodies or headers.
+ */
+export function configureAxiosLogging(axios) {
+    const baseDebugger = debug("mw:api:client");
+    const reqDebugger = baseDebugger.extend("request");
+    const resDebugger = baseDebugger.extend("response");
+    axios.interceptors.request.use((config) => {
+        reqDebugger("%s %s requested with %O", config.method?.toUpperCase(), config.url, config.data);
+        return config;
+    });
+    axios.interceptors.response.use((response) => {
+        resDebugger("%s %s responded with %o %O", response.config.method?.toUpperCase(), response.config.url, response.status + " " + response.statusText, response.data);
+        return response;
+    });
+}

package/dist/lib/apiutil/api_retry.d.ts

@@ -0,0 +1,2 @@
+import { AxiosInstance } from "@mittwald/api-client-commons";
+export declare function configureAxiosRetry(axios: AxiosInstance): void;