@mittwald/cli 1.0.0-alpha.38 → 1.0.0-alpha.39

package/README.md

@@ -191,7 +191,7 @@ USAGE
 * [`mw domain virtualhost delete VIRTUAL-HOST-ID`](#mw-domain-virtualhost-delete-virtual-host-id)
 * [`mw domain virtualhost get INGRESS-ID`](#mw-domain-virtualhost-get-ingress-id)
 * [`mw domain virtualhost list`](#mw-domain-virtualhost-list)
-* [`mw help [COMMANDS]`](#mw-help-commands)
+* [`mw help [COMMAND]`](#mw-help-command)
 * [`mw login reset`](#mw-login-reset)
 * [`mw login status`](#mw-login-status)
 * [`mw login token`](#mw-login-token)
@@ -254,6 +254,7 @@ USAGE
 * [`mw user ssh-key create`](#mw-user-ssh-key-create)
 * [`mw user ssh-key delete ID`](#mw-user-ssh-key-delete-id)
 * [`mw user ssh-key get KEY-ID`](#mw-user-ssh-key-get-key-id)
+* [`mw user ssh-key import`](#mw-user-ssh-key-import)
 * [`mw user ssh-key list`](#mw-user-ssh-key-list)
 
 ## `mw app copy [INSTALLATION-ID]`
@@ -3105,16 +3106,16 @@ FLAG DESCRIPTIONS
     to persistently set a default project for all commands that accept this flag.
 ```
 
-## `mw help [COMMANDS]`
+## `mw help [COMMAND]`
 
 Display help for mw.
 
 ```
 USAGE
-  $ mw help [COMMANDS] [-n]
+  $ mw help [COMMAND] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMAND  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -3123,7 +3124,7 @@ DESCRIPTION
   Display help for mw.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.15/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.16/src/commands/help.ts)_
 
 ## `mw login reset`
 
@@ -4679,14 +4680,14 @@ Create and import a new SSH key
 
 ```
 USAGE
-  $ mw user ssh-key create [-q] [--output <value>] [--no-passphrase] [--comment <value>] [--expiresAt <value>]
+  $ mw user ssh-key create [-q] [--expires <value>] [--output <value>] [--no-passphrase] [--comment <value>]
 
 FLAGS
-  -q, --quiet              suppress process output and only display a machine-readable summary.
-      --comment=<value>    A comment for the SSH key.
-      --expiresAt=<value>  Duration after which the SSH key should expire (example: '1y').
-      --no-passphrase      Use this flag to not set a passphrase for the SSH key.
-      --output=<value>     [default: mstudio-cli] A filename in your ~/.ssh directory to write the SSH key to.
+  -q, --quiet            suppress process output and only display a machine-readable summary.
+      --comment=<value>  A comment for the SSH key.
+      --expires=<value>  An interval after which the SSH key expires (examples: 30m, 30d, 1y).
+      --no-passphrase    Use this flag to not set a passphrase for the SSH key.
+      --output=<value>   [default: mstudio-cli] A filename in your ~/.ssh directory to write the SSH key to.
 
 DESCRIPTION
   Create and import a new SSH key
@@ -4742,6 +4743,29 @@ DESCRIPTION
   Get a specific SSH key
 ```
 
+## `mw user ssh-key import`
+
+Import an existing (local) SSH key
+
+```
+USAGE
+  $ mw user ssh-key import [-q] [--expires <value>] [--input <value>]
+
+FLAGS
+  -q, --quiet            suppress process output and only display a machine-readable summary.
+      --expires=<value>  An interval after which the SSH key expires (examples: 30m, 30d, 1y).
+      --input=<value>    [default: id_rsa.pub] A filename in your ~/.ssh directory containing the key to import.
+
+DESCRIPTION
+  Import an existing (local) SSH key
+
+FLAG DESCRIPTIONS
+  -q, --quiet  suppress process output and only display a machine-readable summary.
+
+    This flag controls if you want to see the process output or only a summary. When using mw non-interactively (e.g. in
+    scripts), you can use this flag to easily get the IDs of created resources for further processing.
+```
+
 ## `mw user ssh-key list`
 
 Get your stored ssh keys

package/dist/commands/ddev/init.d.ts

@@ -15,6 +15,7 @@ export declare class Init extends ExecRenderBaseCommand<typeof Init, void> {
     protected exec(): Promise<void>;
     protected render(): React.ReactNode;
     private addSSHCredentials;
+    private determineDDEVVersion;
     private installMittwaldPlugin;
     private initializeDDEVProject;
     private determineProjectName;

package/dist/commands/ddev/init.js

@@ -14,6 +14,10 @@ import { renderDDEVConfig } from "../../lib/ddev/config_render.js";
 import { loadDDEVConfig } from "../../lib/ddev/config_loader.js";
 import { Value } from "../../rendering/react/components/Value.js";
 import { ddevFlags } from "../../lib/ddev/flags.js";
+import { exec } from "child_process";
+import { promisify } from "util";
+import { compareSemVer } from "semver-parser";
+const execAsync = promisify(exec);
 export class Init extends ExecRenderBaseCommand {
     static summary = "Initialize a new ddev project in the current directory.";
     static description = "This command initializes a new ddev configuration for an existing app installation in the current directory.\n" +
@@ -50,9 +54,10 @@ export class Init extends ExecRenderBaseCommand {
         const appInstallationId = await this.withAppInstallationId(Init);
         const r = makeProcessRenderer(this.flags, "Initializing DDEV project");
         await assertDDEVIsInstalled(r);
+        const ddevVersion = await this.determineDDEVVersion(r);
         const config = await this.writeMittwaldConfiguration(r, appInstallationId);
         const projectName = await this.determineProjectName(r);
-        await this.initializeDDEVProject(r, config, projectName);
+        await this.initializeDDEVProject(r, config, projectName, ddevVersion);
         await this.installMittwaldPlugin(r);
         await this.addSSHCredentials(r);
         await r.complete(_jsx(DDEVInitSuccess, {}));
@@ -66,6 +71,12 @@ export class Init extends ExecRenderBaseCommand {
             "ssh",
         ]);
     }
+    async determineDDEVVersion(r) {
+        const { stdout } = await execAsync("ddev --version");
+        const version = stdout.trim().replace(/^ddev version +/, "");
+        r.addInfo(_jsx(InfoDDEVVersion, { version: version }));
+        return version;
+    }
     async installMittwaldPlugin(r) {
         const { "override-mittwald-plugin": mittwaldPlugin } = this.flags;
         await spawnInProcess(r, "installing mittwald plugin", "ddev", [
@@ -73,13 +84,17 @@ export class Init extends ExecRenderBaseCommand {
             mittwaldPlugin,
         ]);
     }
-    async initializeDDEVProject(r, config, projectName) {
-        await spawnInProcess(r, "initializing DDEV project", "ddev", [
+    async initializeDDEVProject(r, config, projectName, ddevVersion) {
+        const ddevFlags = [
             "config",
             "--project-name",
             projectName,
             ...ddevConfigToFlags(config),
-        ]);
+        ];
+        if (compareSemVer(ddevVersion, "1.22.7") < 0) {
+            ddevFlags.push("--create-docroot");
+        }
+        await spawnInProcess(r, "initializing DDEV project", "ddev", ddevFlags);
     }
     async determineProjectName(r) {
         const { "project-name": projectName } = this.flags;
@@ -118,3 +133,6 @@ async function writeContentsToFile(filename, data) {
 function InfoUsingExistingName({ name }) {
     return (_jsxs(_Fragment, { children: ["using existing project name: ", _jsx(Value, { children: name })] }));
 }
+function InfoDDEVVersion({ version }) {
+    return (_jsxs(_Fragment, { children: ["detected DDEV version: ", _jsx(Value, { children: version })] }));
+}

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

@@ -5,9 +5,10 @@ export default class Create extends ExecRenderBaseCommand<typeof Create, undefin
         output: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         "no-passphrase": import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
         comment: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-        expiresAt: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        expires: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
         quiet: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
     protected exec(): Promise<undefined>;
     protected render(): null;
+    private getPassphrase;
 }

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

@@ -1,20 +1,21 @@
 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 cp from "child_process";
 import * as path from "path";
 import * as os from "os";
 import * as fs from "fs/promises";
-import parseDuration from "parse-duration";
 import { ExecRenderBaseCommand } from "../../../rendering/react/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 { expirationDateFromFlagsOptional, expireFlags, } from "../../../lib/expires.js";
+import { spawnInProcess } from "../../../rendering/process/process_exec.js";
 export default class Create extends ExecRenderBaseCommand {
     static description = "Create and import a new SSH key";
     static flags = {
         ...processFlags,
+        ...expireFlags("SSH key"),
         output: Flags.string({
             description: "A filename in your ~/.ssh directory to write the SSH key to.",
             default: "mstudio-cli",
@@ -25,41 +26,21 @@ export default class Create extends ExecRenderBaseCommand {
         comment: Flags.string({
             description: "A comment for the SSH key.",
         }),
-        expiresAt: Flags.string({
-            description: "Duration after which the SSH key should expire (example: '1y').",
-        }),
     };
     async exec() {
-        const { flags } = await this.parse(Create);
         const cmd = "ssh-keygen";
-        const outputFile = path.join(os.homedir(), ".ssh", flags.output);
-        const args = ["-t", "rsa", "-f", outputFile];
-        const process = makeProcessRenderer(flags, "Creating a new SSH key");
-        let expiresAt;
-        if (flags["expiresAt"]) {
-            const parsedDuration = parseDuration(flags["expiresAt"]);
-            if (!parsedDuration) {
-                throw new Error("Invalid duration");
-            }
-            expiresAt = new Date();
-            expiresAt.setTime(new Date().getTime() + parsedDuration);
-        }
-        if (flags["no-passphrase"]) {
-            args.push("-N", "");
-        }
-        else {
-            const passphrase = await process.addInput(_jsx(Text, { children: "enter passphrase for SSH key" }), true);
-            args.push("-N", passphrase);
+        const outputFile = path.join(os.homedir(), ".ssh", this.flags.output);
+        const r = makeProcessRenderer(this.flags, "Creating a new SSH key");
+        const expiresAt = expirationDateFromFlagsOptional(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);
         }
-        if (flags.comment) {
-            args.push("-C", flags.comment);
-        }
-        const publicKey = await process.runStep("generating SSH key using ssh-keygen", async () => {
-            cp.spawnSync(cmd, args, { stdio: "ignore" });
-            return await fs.readFile(outputFile + ".pub", "utf-8");
-        });
-        process.addInfo(_jsxs(Text, { children: ["ssh key saved to ", _jsx(Filename, { filename: outputFile }), "."] }));
-        await process.runStep("importing SSH key", async () => {
+        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,
@@ -67,11 +48,22 @@ export default class Create extends ExecRenderBaseCommand {
                 },
             });
             assertStatus(response, 201);
-            return response;
         });
-        process.complete(_jsx(Success, { children: "Your SSH key was successfully created and imported to your user profile." }));
+        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/import.d.ts

@@ -0,0 +1,11 @@
+import { ExecRenderBaseCommand } from "../../../rendering/react/ExecRenderBaseCommand.js";
+export default class Import extends ExecRenderBaseCommand<typeof Import, undefined> {
+    static description: string;
+    static flags: {
+        input: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        expires: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        quiet: import("@oclif/core/lib/interfaces/parser.js").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 "../../../rendering/react/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 { expirationDateFromFlagsOptional, expireFlags, } from "../../../lib/expires.js";
+export default class Import extends ExecRenderBaseCommand {
+    static description = "Import an existing (local) SSH key";
+    static flags = {
+        ...processFlags,
+        ...expireFlags("SSH key"),
+        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 expiresAt = expirationDateFromFlagsOptional(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: expiresAt?.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/lib/ddev/config.d.ts

@@ -15,7 +15,19 @@ export interface DDEVConfig {
     web_environment: string[];
     docroot: string;
     database: DDEVDatabaseConfig;
+    hooks: DDEVHooks;
 }
+export type DDEVHookEvent = "start" | "import-db" | "import-files" | "composer" | "stop" | "config" | "exec" | "pull" | "push" | "snapshot" | "restore-snapshot";
+export type DDEVHooks = {
+    [k in `pre-${DDEVHookEvent}`]?: DDEVHook[];
+} & {
+    [k in `post-${DDEVHookEvent}`]?: DDEVHook[];
+};
+export type DDEVHook = {
+    exec: string;
+} | {
+    "exec-host": string;
+};
 export interface DDEVDatabaseConfig {
     type: string;
     version: string;

package/dist/lib/ddev/config_builder.d.ts

@@ -4,6 +4,7 @@ export declare class DDEVConfigBuilder {
     private apiClient;
     constructor(apiClient: MittwaldAPIV2Client);
     build(appInstallationId: string, type: string): Promise<Partial<DDEVConfig>>;
+    private buildHooks;
     private determineDocumentRoot;
     private determineProjectType;
     private determineDatabaseVersion;

package/dist/lib/ddev/config_builder.js

@@ -11,9 +11,10 @@ export class DDEVConfigBuilder {
     async build(appInstallationId, type) {
         const appInstallation = await this.getAppInstallation(appInstallationId);
         const systemSoftwares = await this.buildSystemSoftwareVersionMap(appInstallation);
+        type = await this.determineProjectType(appInstallation, type);
         return {
             override_config: true,
-            type: await this.determineProjectType(appInstallation, type),
+            type,
             webserver_type: "apache-fpm",
             php_version: this.determinePHPVersion(systemSoftwares),
             database: await this.determineDatabaseVersion(appInstallation),
@@ -21,6 +22,25 @@ export class DDEVConfigBuilder {
             web_environment: [
                 `MITTWALD_APP_INSTALLATION_ID=${appInstallation.shortId}`,
             ],
+            hooks: this.buildHooks(type),
+        };
+    }
+    buildHooks(type) {
+        const postPull = [
+            { "exec-host": "ddev config --project-name $DDEV_PROJECT" },
+            { "exec-host": "ddev restart" },
+        ];
+        if (type === "typo3") {
+            postPull.push({ exec: "typo3 cache:flush" }, { exec: "typo3 cache:warmup" });
+        }
+        if (type === "wordpress") {
+            postPull.push({ exec: "wp cache flush" });
+        }
+        if (type === "shopware6") {
+            postPull.push({ exec: "bin/console cache:clear" });
+        }
+        return {
+            "post-pull": postPull,
         };
     }
     async determineDocumentRoot(inst) {

package/dist/rendering/process/components/ProcessStateIcon.js

@@ -1,8 +1,8 @@
-import { jsxs as _jsxs, jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx } from "react/jsx-runtime";
 import { Text } from "ink";
 export const ProcessStateIcon = ({ step }) => {
     if (step.type === "info") {
-        return _jsxs(Text, { children: ["\u2139\uFE0F", "  "] });
+        return _jsx(Text, { children: "\uD83D\uDCA1 " });
     }
     else if (step.type === "confirm" || step.type === "input") {
         return _jsx(Text, { children: "\u2753" });

package/dist/rendering/react/hooks/useIncreaseInkStdoutColumns.js

@@ -4,6 +4,6 @@ export const useIncreaseInkStdoutColumns = () => {
     const stdout = useStdout().stdout;
     if (!stdout.isTTY) {
         // Not using Number.MAX_SAFE_INTEGER here because Ink will fail otherwise
-        stdout.columns = 100000;
+        stdout.columns = 100_000;
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.0.0-alpha.38",
+  "version": "1.0.0-alpha.39",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "author": {
@@ -65,6 +65,7 @@
     "pretty-bytes": "^6.1.0",
     "react": "^18.2.0",
     "semver": "^7.5.4",
+    "semver-parser": "^4.1.6",
     "shell-escape": "^0.2.0",
     "tempfile": "^5.0.0"
   },