@mittwald/cli 1.3.0 → 1.4.0

package/README.md

@@ -113,6 +113,7 @@ USAGE
 * [`mw database`](docs/database.md) - Manage databases (like MySQL and Redis) in your projects
 * [`mw ddev`](docs/ddev.md) - Integrate your mittwald projects with DDEV
 * [`mw domain`](docs/domain.md) - Manage domains, virtual hosts and DNS settings in your projects
+* [`mw extension`](docs/extension.md) - Install and manage extensions in your organisations and projects
 * [`mw help`](docs/help.md) - Display help for mw.
 * [`mw login`](docs/login.md) - Manage your client authentication
 * [`mw mail`](docs/mail.md) - Manage mailboxes and mail addresses in your projects

package/dist/commands/extension/install.d.ts

@@ -0,0 +1,20 @@
+import React from "react";
+import { ExecRenderBaseCommand } from "../../lib/basecommands/ExecRenderBaseCommand.js";
+type InstallResult = {
+    extensionInstanceId: string;
+};
+export default class Install extends ExecRenderBaseCommand<typeof Install, InstallResult> {
+    static description: string;
+    static flags: {
+        "org-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "project-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        consent: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        "extension-id": import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    protected exec(): Promise<InstallResult>;
+    protected render(executionResult: InstallResult): React.ReactNode;
+}
+export {};

package/dist/commands/extension/install.js

@@ -0,0 +1,79 @@
+import { jsxs as _jsxs } from "react/jsx-runtime";
+import { ExecRenderBaseCommand } from "../../lib/basecommands/ExecRenderBaseCommand.js";
+import { makeProcessRenderer, processFlags, } from "../../rendering/process/process_flags.js";
+import { Args, Flags } from "@oclif/core";
+import { assertStatus } from "@mittwald/api-client";
+import { Text } from "ink";
+import { contextIDNormalizers } from "../../lib/context/Context.js";
+export default class Install extends ExecRenderBaseCommand {
+    static description = "Install an extension in a project or organization";
+    static flags = {
+        ...processFlags,
+        "org-id": Flags.string({
+            description: "the ID of the organization to install the extension in",
+            exactlyOne: ["org-id", "project-id"],
+        }),
+        "project-id": Flags.string({
+            description: "the ID of the project to install the extension in",
+            exactlyOne: ["org-id", "project-id"],
+        }),
+        consent: Flags.boolean({
+            description: "consent to the extension having access to the requested scopes",
+        }),
+    };
+    static args = {
+        "extension-id": Args.string({
+            description: "the ID of the extension to install",
+            required: true,
+        }),
+    };
+    async exec() {
+        const { "extension-id": extensionId } = this.args;
+        const { consent } = this.flags;
+        let { "org-id": orgId, "project-id": projectId } = this.flags;
+        const p = makeProcessRenderer(this.flags, "Installing extension");
+        const ext = await p.runStep("Loading extension", async () => {
+            const response = await this.apiClient.marketplace.extensionGetExtension({
+                extensionId,
+            });
+            assertStatus(response, 200);
+            return response.data;
+        });
+        if (orgId !== undefined) {
+            const normalizer = contextIDNormalizers["org-id"];
+            orgId = await normalizer(this.apiClient, orgId);
+        }
+        if (projectId !== undefined) {
+            const normalizer = contextIDNormalizers["project-id"];
+            projectId = await normalizer(this.apiClient, projectId);
+        }
+        if (!consent) {
+            p.addInfo(_jsxs(Text, { children: ["This extension requires access to the following scopes:", " ", ext.scopes.join(", "), ". Please confirm your consent, or run the command with the --consent flag."] }));
+            const consentedInteractively = await p.addConfirmation("Consent to requested scopes?");
+            if (!consentedInteractively) {
+                throw new Error("Consent was not given; skipping extension installation");
+            }
+        }
+        const result = await p.runStep("installing extension", async () => {
+            const resp = await this.apiClient.marketplace.extensionCreateExtensionInstance({
+                data: {
+                    extensionId,
+                    context: orgId ? "customer" : "project",
+                    contextId: (orgId ?? projectId),
+                    consentedScopes: ext.scopes,
+                },
+            });
+            assertStatus(resp, 201);
+            return resp;
+        });
+        return {
+            extensionInstanceId: result.data.id,
+        };
+    }
+    render(executionResult) {
+        if (this.flags.quiet) {
+            return executionResult.extensionInstanceId;
+        }
+        return undefined;
+    }
+}

package/dist/commands/extension/list-installed.d.ts

@@ -0,0 +1,30 @@
+import { Simplify } from "@mittwald/api-client-commons";
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { ListBaseCommand } from "../../lib/basecommands/ListBaseCommand.js";
+import { ListColumns } from "../../rendering/formatter/Table.js";
+import { SuccessfulResponse } from "../../lib/apiutil/SuccessfulResponse.js";
+type Extension = MittwaldAPIV2.Components.Schemas.MarketplaceExtension;
+type ResponseItem = Simplify<MittwaldAPIV2.Paths.V2ExtensionInstances.Get.Responses.$200.Content.ApplicationJson[number]>;
+type Response = Awaited<ReturnType<MittwaldAPIV2Client["marketplace"]["extensionListExtensionInstances"]>>;
+type ExtendedResponseItem = ResponseItem & {
+    extension: Extension;
+};
+export declare class ListInstalled extends ListBaseCommand<typeof ListInstalled, ResponseItem, Response> {
+    static description: string;
+    static args: {};
+    static flags: {
+        "org-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "project-id": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        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"]): Promise<ExtendedResponseItem[]>;
+    protected getColumns(data: ExtendedResponseItem[]): ListColumns<ResponseItem>;
+    protected getColumnsExtended(data: ExtendedResponseItem[]): ListColumns<ExtendedResponseItem>;
+}
+export {};

package/dist/commands/extension/list-installed.js

@@ -0,0 +1,80 @@
+import { assertStatus } from "@mittwald/api-client-commons";
+import { ListBaseCommand } from "../../lib/basecommands/ListBaseCommand.js";
+import { Flags } from "@oclif/core";
+import { contextIDNormalizers } from "../../lib/context/Context.js";
+export class ListInstalled extends ListBaseCommand {
+    static description = "List installed extensions in an organization or project.";
+    static args = {};
+    static flags = {
+        ...ListBaseCommand.baseFlags,
+        "org-id": Flags.string({
+            description: "the ID of the organization to install the extension in",
+            exactlyOne: ["org-id", "project-id"],
+        }),
+        "project-id": Flags.string({
+            description: "the ID of the project to install the extension in",
+            exactlyOne: ["org-id", "project-id"],
+        }),
+    };
+    async getData() {
+        let { "org-id": orgId, "project-id": projectId } = this.flags;
+        if (orgId) {
+            const normalizer = contextIDNormalizers["org-id"];
+            orgId = await normalizer(this.apiClient, orgId);
+        }
+        if (projectId) {
+            const normalizer = contextIDNormalizers["project-id"];
+            projectId = await normalizer(this.apiClient, projectId);
+        }
+        return await this.apiClient.marketplace.extensionListExtensionInstances({
+            queryParameters: {
+                context: orgId ? "customer" : "project",
+                contextId: (orgId ?? projectId),
+            },
+        });
+    }
+    mapData(data) {
+        return Promise.all(data.map(async (item) => {
+            const resp = await this.apiClient.marketplace.extensionGetExtension({
+                extensionId: item.extensionId,
+            });
+            assertStatus(resp, 200);
+            const extension = resp.data;
+            return {
+                ...item,
+                extension,
+            };
+        }));
+    }
+    getColumns(data) {
+        return this.getColumnsExtended(data);
+    }
+    getColumnsExtended(data) {
+        const { id } = super.getColumns(data, {});
+        return {
+            id,
+            extension: {
+                header: "Extension",
+                get: (row) => row.extension.name,
+            },
+            state: {
+                header: "State",
+                get: (row) => {
+                    // Temporary "as any" cast, because the API response is not typed correctly
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    if (row.pendingInstallation) {
+                        return "installing";
+                    }
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    if (row.pendingRemoval) {
+                        return "removing";
+                    }
+                    if (row.disabled) {
+                        return "disabled";
+                    }
+                    return "enabled";
+                },
+            },
+        };
+    }
+}

package/dist/commands/extension/list.d.ts

@@ -0,0 +1,21 @@
+import { Simplify } from "@mittwald/api-client-commons";
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { ListBaseCommand } from "../../lib/basecommands/ListBaseCommand.js";
+import { ListColumns } from "../../rendering/formatter/Table.js";
+type ResponseItem = Simplify<MittwaldAPIV2.Paths.V2Extensions.Get.Responses.$200.Content.ApplicationJson[number]>;
+type Response = Awaited<ReturnType<MittwaldAPIV2Client["marketplace"]["extensionListExtensions"]>>;
+export declare 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(data: ResponseItem[]): ListColumns<ResponseItem>;
+}
+export {};

package/dist/commands/extension/list.js

@@ -0,0 +1,22 @@
+import { ListBaseCommand } from "../../lib/basecommands/ListBaseCommand.js";
+export class List extends ListBaseCommand {
+    static description = "Get all available extensions.";
+    static args = {};
+    static flags = {
+        ...ListBaseCommand.baseFlags,
+    };
+    async getData() {
+        return await this.apiClient.marketplace.extensionListExtensions();
+    }
+    getColumns(data) {
+        const { id } = super.getColumns(data, {});
+        return {
+            id,
+            name: {},
+            context: {},
+            subTitle: {
+                get: (ext) => ext.subTitle?.en ?? ext.subTitle?.de,
+            },
+        };
+    }
+}

package/dist/commands/extension/uninstall.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { ExecRenderBaseCommand } from "../../lib/basecommands/ExecRenderBaseCommand.js";
+export default class Uninstall extends ExecRenderBaseCommand<typeof Uninstall, void> {
+    static description: string;
+    static flags: {
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        "extension-instance-id": import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    protected exec(): Promise<void>;
+    protected render(): React.ReactNode;
+}

package/dist/commands/extension/uninstall.js

@@ -0,0 +1,32 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { ExecRenderBaseCommand } from "../../lib/basecommands/ExecRenderBaseCommand.js";
+import { makeProcessRenderer, processFlags, } from "../../rendering/process/process_flags.js";
+import { Args } from "@oclif/core";
+import assertSuccess from "../../lib/apiutil/assert_success.js";
+import { Success } from "../../rendering/react/components/Success.js";
+export default class Uninstall extends ExecRenderBaseCommand {
+    static description = "Remove an extension from an organization";
+    static flags = {
+        ...processFlags,
+    };
+    static args = {
+        "extension-instance-id": Args.string({
+            description: "the ID of the extension instance to uninstall",
+            required: true,
+        }),
+    };
+    async exec() {
+        const { "extension-instance-id": extensionInstanceId } = this.args;
+        const p = makeProcessRenderer(this.flags, "Uninstalling extension");
+        await p.runStep("removing extension instance", async () => {
+            const resp = await this.apiClient.marketplace.extensionDeleteExtensionInstance({
+                extensionInstanceId,
+            });
+            assertSuccess(resp);
+        });
+        await p.complete(_jsx(Success, { children: "Extension successfully uninstalled" }));
+    }
+    render() {
+        return undefined;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "author": {
@@ -159,6 +159,9 @@
       "domain": {
         "description": "Manage domains, virtual hosts and DNS settings in your projects"
       },
+      "extension": {
+        "description": "Install and manage extensions in your organisations and projects"
+      },
       "login": {
         "description": "Manage your client authentication"
       },