@mittwald/cli 1.4.3 → 1.5.0

package/dist/lib/resources/stack/env.js

@@ -0,0 +1,11 @@
+import * as fs from "fs/promises";
+import { parse } from "envfile";
+import { pathExists } from "../../util/fs/pathExists.js";
+export async function collectEnvironment(base, envFile) {
+    if (!(await pathExists(envFile))) {
+        return base;
+    }
+    const defs = await fs.readFile(envFile, { encoding: "utf-8" });
+    const parsed = parse(defs);
+    return { ...base, ...parsed };
+}

package/dist/lib/resources/stack/flags.d.ts

@@ -0,0 +1,5 @@
+export declare const stackFlags: import("../../context/FlagSetBuilder.js").ContextFlags<"stack">, stackArgs: import("../../context/FlagSetBuilder.js").ContextArgs<"stack">, withStackId: (apiClient: import("@mittwald/api-client").MittwaldAPIV2Client, command: "flag" | "arg" | import("../../context/FlagSetBuilder.js").CommandType<"stack">, flags: {
+    [k: string]: unknown;
+}, args: {
+    [k: string]: unknown;
+}, cfg: import("@oclif/core").Config) => Promise<string>;

package/dist/lib/resources/stack/flags.js

@@ -0,0 +1,2 @@
+import FlagSetBuilder from "../../context/FlagSetBuilder.js";
+export const { flags: stackFlags, args: stackArgs, withId: withStackId, } = new FlagSetBuilder("stack", "s").build();

package/dist/lib/resources/stack/loader.d.ts

@@ -0,0 +1,5 @@
+import type { MittwaldAPIV2 } from "@mittwald/api-client";
+type StackRequest = MittwaldAPIV2.Paths.V2StacksStackId.Put.Parameters.RequestBody;
+export declare function loadStackFromFile(file: string, environment: Record<string, string | undefined>): Promise<StackRequest>;
+export declare function loadStackFromStr(input: string, environment: Record<string, string | undefined>): Promise<StackRequest>;
+export {};

package/dist/lib/resources/stack/loader.js

@@ -0,0 +1,47 @@
+import yaml from "js-yaml";
+import * as fs from "fs";
+function loadStackYAMLFromFile(file) {
+    if (file === "-") {
+        return fs.readFileSync(process.stdin.fd, { encoding: "utf-8" });
+    }
+    return fs.readFileSync(file, { encoding: "utf-8" });
+}
+export async function loadStackFromFile(file, environment) {
+    const input = loadStackYAMLFromFile(file);
+    return loadStackFromStr(input, environment);
+}
+export async function loadStackFromStr(input, environment) {
+    const stack = yaml.load(input);
+    const stackWithSubstitutedEnvironment = substituteEnvironmentVariables(stack, environment);
+    return stackWithSubstitutedEnvironment;
+}
+/**
+ * This function aims to be a (more-or-less) complete implementation of Docker
+ * Compose's variable interpolation feature.
+ *
+ * @param input Input object; may be anything coming out of a YAML file.
+ * @param environment A record of environment variables
+ * @see https://docs.docker.com/compose/how-tos/environment-variables/variable-interpolation/
+ */
+function substituteEnvironmentVariables(input, environment) {
+    if (typeof input === "string") {
+        return input.replace(/\$\{(\w+)(:?-(.*))?}/g, (_, key, defExpr, def = "") => {
+            const useDefaultIfNonEmpty = defExpr && defExpr.startsWith(":");
+            if (useDefaultIfNonEmpty) {
+                return environment[key] || def;
+            }
+            return key in environment ? environment[key] : def;
+        });
+    }
+    if (Array.isArray(input)) {
+        return input.map((item) => substituteEnvironmentVariables(item, environment));
+    }
+    if (input && typeof input === "object") {
+        const result = {};
+        for (const [key, value] of Object.entries(input)) {
+            result[key] = substituteEnvironmentVariables(value, environment);
+        }
+        return result;
+    }
+    return input;
+}

package/dist/lib/resources/stack/loader.test.d.ts

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

package/dist/lib/resources/stack/loader.test.js

@@ -0,0 +1,51 @@
+import { describe, expect, it } from "@jest/globals";
+import { loadStackFromStr } from "./loader.js";
+describe("loadStackFromStr", () => {
+    it("should convert a stack YAML input to a stack definition", async () => {
+        const input = `services:
+  nginx:
+    image: nginx
+    ports:
+      - 80:80
+    environment:
+      FOO: bar
+    volumes:
+      data:/var/www
+volumes:
+  data:`;
+        const stack = await loadStackFromStr(input, {});
+        expect(stack).toHaveProperty("services.nginx.image", "nginx");
+    });
+    it("interpolates environment variables in a stack definition", async () => {
+        const input = `services:
+  nginx:
+    image: nginx:\${NGINX_VERSION}`;
+        const stack = await loadStackFromStr(input, { NGINX_VERSION: "0.1.0" });
+        expect(stack).toHaveProperty("services.nginx.image", "nginx:0.1.0");
+    });
+    it("interpolates environment variables with default values", async () => {
+        const input = `services:
+  nginx:
+    image: nginx:\${NGINX_VERSION:-latest}`;
+        const stack = await loadStackFromStr(input, {});
+        expect(stack).toHaveProperty("services.nginx.image", "nginx:latest");
+    });
+    it("interpolates environment variables with default values for non-empty variables", async () => {
+        const input = `services:
+  nginx:
+    image: nginx
+    environment:
+      FOO: \${FOO:-foo}`;
+        const stack = await loadStackFromStr(input, { FOO: "" });
+        expect(stack).toHaveProperty("services.nginx.environment.FOO", "foo");
+    });
+    it("interpolates environment variables with default values for empty variables", async () => {
+        const input = `services:
+  nginx:
+    image: nginx
+    environment:
+      FOO: \${FOO-foo}`;
+        const stack = await loadStackFromStr(input, { FOO: "" });
+        expect(stack).toHaveProperty("services.nginx.environment.FOO", "");
+    });
+});

package/dist/lib/resources/stack/sanitize.d.ts

@@ -0,0 +1,10 @@
+import type { MittwaldAPIV2 } from "@mittwald/api-client";
+type StackRequest = MittwaldAPIV2.Paths.V2StacksStackId.Put.Parameters.RequestBody;
+/**
+ * This function is needed to work around the mStudios supposedly docker-compose
+ * compatible container stack API.
+ *
+ * @param stack
+ */
+export declare function sanitizeStackDefinition(stack: StackRequest): StackRequest;
+export {};

package/dist/lib/resources/stack/sanitize.js

@@ -0,0 +1,43 @@
+/**
+ * This function is needed to work around the mStudios supposedly docker-compose
+ * compatible container stack API.
+ *
+ * @param stack
+ */
+export function sanitizeStackDefinition(stack) {
+    const sanitized = {
+        services: structuredClone(stack.services),
+        volumes: structuredClone(stack.volumes),
+    };
+    /* eslint-disable @typescript-eslint/no-explicit-any */
+    for (const serviceKey of Object.keys(sanitized.services ?? {})) {
+        const service = sanitized.services[serviceKey];
+        // mStudio requires "command" to be a string[]; in a docker-compose file, it
+        // can also be a regular string.
+        if (typeof service.command === "string") {
+            service.command = [service.command];
+        }
+        // descriptions are required for mStudio containers; docker compose has no
+        // equivalent field.
+        if (!service.description) {
+            service.description = serviceKey;
+        }
+        // mStudio calls it "envs", docker compose calls it "environment" 🫠
+        const serviceWithEnvironment = service;
+        if (serviceWithEnvironment.environment) {
+            service.envs = serviceWithEnvironment.environment;
+            delete serviceWithEnvironment.environment;
+        }
+        if (!service.envs) {
+            service.envs = {};
+        }
+    }
+    // For mStudio, volume definitions must be empty objects, null is apparently
+    // not allowed.
+    for (const volumeKey of Object.keys(sanitized.volumes ?? {})) {
+        if (sanitized.volumes[volumeKey] === null) {
+            sanitized.volumes[volumeKey] = { name: volumeKey };
+        }
+    }
+    return sanitized;
+}

package/dist/lib/resources/stack/types.d.ts

@@ -0,0 +1,12 @@
+import type { MittwaldAPIV2 } from "@mittwald/api-client";
+type ContainerServiceDeclareRequest = MittwaldAPIV2.Components.Schemas.ContainerServiceDeclareRequest;
+export type ContainerServiceInput = ContainerServiceDeclareRequest & {
+    command?: string[] | string;
+    entrypoint?: string[] | string;
+    env_file?: string;
+    environment?: {
+        [k: string]: string;
+    };
+    ports?: string[];
+};
+export {};

package/dist/lib/resources/stack/types.js

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

package/dist/lib/util/pager.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Prints the given content to a pager, such as `less`. This function respects
+ * the `PAGER` environment variable.
+ *
+ * @param content
+ */
+export declare function printToPager(content: string): void;

package/dist/lib/util/pager.js

@@ -0,0 +1,21 @@
+import tempfile from "tempfile";
+import fs from "fs";
+import cp from "child_process";
+/**
+ * Prints the given content to a pager, such as `less`. This function respects
+ * the `PAGER` environment variable.
+ *
+ * @param content
+ */
+export function printToPager(content) {
+    const t = tempfile();
+    try {
+        fs.writeFileSync(t, content, { encoding: "utf8" });
+        cp.spawnSync(process.env.PAGER || "less", [t], {
+            stdio: "inherit",
+        });
+    }
+    finally {
+        fs.unlinkSync(t);
+    }
+}

package/dist/rendering/process/process.d.ts

@@ -54,7 +54,7 @@ export declare class RunnableHandler {
 export interface ProcessRenderer {
     start(): void;
     addStep(title: ReactNode): RunnableHandler;
-    runStep<TRes>(title: ReactNode, fn: () => Promise<TRes>): Promise<TRes>;
+    runStep<TRes>(title: ReactNode, fn: (() => Promise<TRes>) | Promise<TRes>): Promise<TRes>;
     addInfo(title: ReactNode): void;
     addConfirmation(question: ReactNode): Promise<boolean>;
     addInput(question: ReactNode, mask?: boolean): Promise<string>;

package/dist/rendering/process/process_fancy.d.ts

@@ -8,7 +8,7 @@ export declare class FancyProcessRenderer implements ProcessRenderer {
     constructor(title: string);
     start(): void;
     addStep(title: ReactNode): RunnableHandler;
-    runStep<TRes>(title: ReactNode, fn: () => Promise<TRes>): Promise<TRes>;
+    runStep<TRes>(title: ReactNode, fn: (() => Promise<TRes>) | Promise<TRes>): Promise<TRes>;
     addInfo(title: ReactNode): void;
     addInput(question: React.ReactElement, mask?: boolean): Promise<string>;
     addSelect<TVal>(question: React.ReactNode, options: {

package/dist/rendering/process/process_fancy.js

@@ -40,7 +40,8 @@ export class FancyProcessRenderer {
     async runStep(title, fn) {
         const step = this.addStep(title);
         try {
-            const result = await fn();
+            const promise = typeof fn === "function" ? fn() : fn;
+            const result = await promise;
             step.complete();
             return result;
         }

package/dist/rendering/process/process_flags.js

@@ -4,7 +4,7 @@ import { SilentProcessRenderer } from "./process_quiet.js";
 export const processFlags = {
     quiet: Flags.boolean({
         char: "q",
-        summary: "suppress process output and only display a machine-readable summary.",
+        summary: "suppress process output and only display a machine-readable summary",
         description: "This flag controls if you want to see the process output or only a summary. When using <%= config.bin %> non-interactively (e.g. in scripts), you can use this flag to easily get the IDs of created resources for further processing.",
     }),
 };

package/dist/rendering/process/process_quiet.d.ts

@@ -4,7 +4,7 @@ export declare class SilentProcessRenderer implements ProcessRenderer {
     private cleanupFns;
     start(): void;
     addStep(title: ReactNode): RunnableHandler;
-    runStep<TRes>(unusedTitle: ReactNode, fn: () => Promise<TRes>): Promise<TRes>;
+    runStep<TRes>(unusedTitle: ReactNode, fn: (() => Promise<TRes>) | Promise<TRes>): Promise<TRes>;
     addInfo(): void;
     complete(): Promise<void>;
     error(err: unknown): Promise<void>;

package/dist/rendering/process/process_quiet.js

@@ -11,6 +11,9 @@ export class SilentProcessRenderer {
         });
     }
     runStep(unusedTitle, fn) {
+        if (fn instanceof Promise) {
+            return fn;
+        }
         return fn();
     }
     addInfo() {

package/dist/rendering/setup/FlagSupportedSetup.d.ts

@@ -8,5 +8,5 @@ export declare abstract class FlagSupportedSetup<TFlags extends FlagInput, TSett
     protected constructor(flagsInput: TFlags, settings: TSettings);
     getSetup(flags: InferredFlags<TFlags>): TSettings & TSetupObject;
     protected abstract getFlagsOutput(flags: InferredFlags<TFlags>): TSetupObject;
-    static build: <TFlags extends FlagInput, TSettings, TOutput>(flags: TFlags_1, defaultSettings: TSettings_1, buildFlagsOutput: (flags: InferredFlags<TFlags_1>, settings: TSettings_1) => TOutput) => Class<FlagSupportedSetup<TFlags_1, TSettings_1, TOutput>, [Partial<TSettings_1>] | []>;
+    static build: <TFlags_1 extends FlagInput, TSettings_1, TOutput>(flags: TFlags_1, defaultSettings: TSettings_1, buildFlagsOutput: (flags: InferredFlags<TFlags_1>, settings: TSettings_1) => TOutput) => Class<FlagSupportedSetup<TFlags_1, TSettings_1, TOutput>, [Partial<TSettings_1>] | []>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "author": {
@@ -43,7 +43,7 @@
   ],
   "dependencies": {
     "@mittwald/api-client": "^4.131.0",
-    "@mittwald/react-use-promise": "^3.0.4",
+    "@mittwald/react-use-promise": "^2.6.0",
     "@oclif/core": "^4.0.18",
     "@oclif/plugin-autocomplete": "^3.0.3",
     "@oclif/plugin-help": "^6.0.5",
@@ -52,12 +52,14 @@
     "axios-retry": "^4.0.0",
     "chalk": "^5.3.0",
     "date-fns": "^4.0.0",
+    "docker-names": "^1.2.1",
+    "envfile": "^7.1.0",
     "ink": "^5.0.1",
     "ink-link": "^4.0.0",
     "ink-text-input": "^6.0.0",
     "js-yaml": "^4.1.0",
-    "marked": "^12.0.0",
-    "marked-terminal": "^6.0.0",
+    "marked": "^15.0.12",
+    "marked-terminal": "^7.3.0",
     "open": "^10.0.3",
     "parse-duration": "^2.0.1",
     "pretty-bytes": "^6.1.0",
@@ -73,31 +75,27 @@
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@oclif/test": "^4.0.4",
-    "@types/chalk": "^2.2.0",
     "@types/js-yaml": "^4.0.9",
-    "@types/marked-terminal": "^3.1.3",
     "@types/node": "^22.7.5",
-    "@types/parse-duration": "^0.3.0",
-    "@types/pretty-bytes": "^5.2.0",
     "@types/react": "^18",
     "@types/semver": "^7.5.0",
     "@types/shell-escape": "^0.2.3",
-    "@typescript-eslint/eslint-plugin": "^8.3.0",
-    "@typescript-eslint/parser": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.35.0",
+    "@typescript-eslint/parser": "^8.35.0",
     "@yarnpkg/pnpify": "^4.0.0-rc.48",
-    "eslint": "^9.9.1",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-json": "^4.0.0",
-    "eslint-plugin-prettier": "^5.1.3",
+    "eslint": "^9.29.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-json": "^4.0.1",
+    "eslint-plugin-prettier": "^5.5.1",
     "globals": "^16.0.0",
     "jest": "^29.7.0",
     "license-checker-rseidelsohn": "^4.2.6",
     "nock": "^14.0.0",
     "oclif": "^4.14.31",
-    "prettier": "^3.2.5",
-    "prettier-plugin-jsdoc": "^1.3.0",
+    "prettier": "~3.5.3",
+    "prettier-plugin-jsdoc": "^1.3.2",
     "prettier-plugin-package": "^1.4.0",
-    "prettier-plugin-sort-json": "^4.0.0",
+    "prettier-plugin-sort-json": "^4.1.1",
     "rimraf": "^5.0.1",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
@@ -127,6 +125,9 @@
           }
         }
       },
+      "registry": {
+        "description": "Manage container registries"
+      },
       "article": {
         "description": "Query available hosting articles"
       },
@@ -202,6 +203,9 @@
       "ssh-user": {
         "description": "Manage SSH users of your projects"
       },
+      "stack": {
+        "description": "Manage container stacks"
+      },
       "user": {
         "description": "Manage your own user account",
         "subtopics": {