@mittwald/cli 1.0.0-alpha.22 → 1.0.0-alpha.24

package/README.md

@@ -188,7 +188,7 @@ USAGE
 * [`mw user api-token get APITOKENID`](#mw-user-api-token-get-apitokenid)
 * [`mw user api-token list`](#mw-user-api-token-list)
 * [`mw user api-token revoke ID`](#mw-user-api-token-revoke-id)
-* [`mw user get`](#mw-user-get)
+* [`mw user get USER-ID`](#mw-user-get-user-id)
 * [`mw user session get TOKENID`](#mw-user-session-get-tokenid)
 * [`mw user session list`](#mw-user-session-list)
 * [`mw user ssh-key create`](#mw-user-ssh-key-create)
@@ -265,13 +265,15 @@ Creates new custom PHP installation.
 
 ```
 USAGE
-  $ mw app create php [-p <value>] [-q] [--site-title <value>] [-w] [--json]
+  $ mw app create php --document-root <value> [-p <value>] [-q] [--site-title <value>] [-w] [--json]
 
 FLAGS
   -p, --project-id=<value>  ID or short ID of a project; this flag is optional if a default project is set in the
                             context
   -q, --quiet               suppress process output and only display a machine-readable summary.
   -w, --wait                Wait for your custom PHP to be ready.
+  --document-root=<value>   (required) [default: /] The document root from which your custom PHP will be served
+                            (relative to the installation path)
   --json
   --site-title=<value>      Site Title for your custom PHP installation.
 
@@ -289,6 +291,13 @@ FLAG DESCRIPTIONS
     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.
 
+  --document-root=<value>
+
+    The document root from which your custom PHP will be served (relative to the installation path)
+
+    This is the document root from which the files of your application will be served by the web server. This directory
+    is specified relative to the installation path.
+
   --site-title=<value>  Site Title for your custom PHP installation.
 
     Site Title which will be displayed in the Tab and at the top of the Frontend of your custom PHP installation.
@@ -2283,23 +2292,30 @@ Get all deliveryboxes by project ID
 
 ```
 USAGE
-  $ mw mail deliverybox list --project-id <value> [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
+  $ mw mail deliverybox list [-p <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
     csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]
 
 FLAGS
-  -x, --extended        show extra columns
-  --columns=<value>     only show provided columns (comma-separated)
-  --csv                 output is csv format [alias: --output=csv]
-  --filter=<value>      filter property by partial string matching, ex: name=foo
-  --no-header           hide table header from output
-  --no-truncate         do not truncate output to fit screen
-  --output=<option>     output in a more machine friendly format
-                        <options: csv|json|yaml>
-  --project-id=<value>  (required) Project ID the deliveryboxes are related to
-  --sort=<value>        property to sort by (prepend '-' for descending)
+  -p, --project-id=<value>  ID or short ID of a project; this flag is optional if a default project is set in the
+                            context
+  -x, --extended            show extra columns
+  --columns=<value>         only show provided columns (comma-separated)
+  --csv                     output is csv format [alias: --output=csv]
+  --filter=<value>          filter property by partial string matching, ex: name=foo
+  --no-header               hide table header from output
+  --no-truncate             do not truncate output to fit screen
+  --output=<option>         output in a more machine friendly format
+                            <options: csv|json|yaml>
+  --sort=<value>            property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Get all deliveryboxes by project ID
+
+FLAG DESCRIPTIONS
+  -p, --project-id=<value>  ID or short ID of a project; this flag is optional if a default project is set in the context
+
+    May contain a short ID or a full ID of a project; you can also use the "mw context set --project-id=<VALUE>" command
+    to persistently set a default project for all commands that accept this flag.
 ```
 
 ## `mw org delete [ORG-ID]`
@@ -3389,13 +3405,17 @@ FLAG DESCRIPTIONS
     scripts), you can use this flag to easily get the IDs of created resources for further processing.
 ```
 
-## `mw user get`
+## `mw user get USER-ID`
 
 Get profile information for a user.
 
 ```
 USAGE
-  $ mw user get [-o json|yaml |  | ]
+  $ mw user get USER-ID [-o json|yaml |  | ]
+
+ARGUMENTS
+  USER-ID  [default: self] The user ID to get information for; defaults to the special value 'self', which references to
+           the currently authenticated user.
 
 FLAGS
   -o, --output=<option>  output in a more machine friendly format

package/dist/esm/commands/app/create/php.d.ts

@@ -1,10 +1,10 @@
 import { ExecRenderBaseCommand } from "../../../rendering/react/ExecRenderBaseCommand.js";
 import React from "react";
 import { AppInstallationResult, AppInstaller } from "../../../lib/app/Installer.js";
-export declare const phpInstaller: AppInstaller<"site-title" | "wait">;
+export declare const phpInstaller: AppInstaller<"site-title" | "document-root" | "wait">;
 export default class InstallPhp extends ExecRenderBaseCommand<typeof InstallPhp, AppInstallationResult> {
     static description: string;
-    static flags: import("@oclif/core/lib/interfaces/parser.js").FlagInput<import("../../../lib/app/flags.js").RelevantFlags<readonly ("site-title" | "wait")[]>>;
+    static flags: import("@oclif/core/lib/interfaces/parser.js").FlagInput<import("../../../lib/app/flags.js").RelevantFlags<readonly ("site-title" | "document-root" | "wait")[]>>;
     protected exec(): Promise<{
         appInstallationId: string;
     }>;

package/dist/esm/commands/app/create/php.js

@@ -1,6 +1,6 @@
 import { ExecRenderBaseCommand } from "../../../rendering/react/ExecRenderBaseCommand.js";
 import { AppInstaller, } from "../../../lib/app/Installer.js";
-export const phpInstaller = new AppInstaller("34220303-cb87-4592-8a95-2eb20a97b2ac", "custom PHP", ["site-title", "wait"]);
+export const phpInstaller = new AppInstaller("34220303-cb87-4592-8a95-2eb20a97b2ac", "custom PHP", ["document-root", "site-title", "wait"]);
 export default class InstallPhp extends ExecRenderBaseCommand {
     static description = phpInstaller.description;
     static flags = phpInstaller.flags;

package/dist/esm/commands/mail/deliverybox/list.d.ts

@@ -1,12 +1,19 @@
 import { Simplify } from "@mittwald/api-client-commons";
-import { MittwaldAPIV2 } from "@mittwald/api-client";
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
 import { SuccessfulResponse } from "../../../types.js";
-import { GeneratedMailDeliveryboxList, PathParams, Response } from "../../../generated/mail/deliveryboxList.js";
 import { ListColumns } from "../../../Formatter.js";
+import { ListBaseCommand } from "../../../ListBaseCommand.js";
 type ResponseItem = Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdDeliveryboxes.Get.Responses.$200.Content.ApplicationJson[number]>;
-export default class List extends GeneratedMailDeliveryboxList<ResponseItem> {
+export type PathParams = MittwaldAPIV2.Paths.V2ProjectsProjectIdDeliveryboxes.Get.Parameters.Path;
+export type Response = Awaited<ReturnType<MittwaldAPIV2Client["mail"]["deliveryboxList"]>>;
+export declare class List extends ListBaseCommand<typeof List, ResponseItem, Response> {
+    static description: string;
+    static args: {};
+    static flags: {
+        "project-id": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string>;
+    };
+    getData(): Promise<Response>;
     protected mapData(data: SuccessfulResponse<Response, 200>["data"]): MittwaldAPIV2.Components.Schemas.MailDeliverybox[];
-    protected mapParams(input: PathParams): Promise<PathParams>;
     protected getColumns(data: ResponseItem[]): ListColumns<ResponseItem>;
 }
 export {};

package/dist/esm/commands/mail/deliverybox/list.js

@@ -1,15 +1,20 @@
-import { GeneratedMailDeliveryboxList, } from "../../../generated/mail/deliveryboxList.js";
-import { normalizeProjectIdToUuid } from "../../../Helpers.js";
 import { formatRelativeDate } from "../../../lib/viewhelpers/date.js";
-export default class List extends GeneratedMailDeliveryboxList {
+import { ListBaseCommand } from "../../../ListBaseCommand.js";
+import { projectFlags, withProjectId } from "../../../lib/project/flags.js";
+export class List extends ListBaseCommand {
+    static description = "Get all deliveryboxes by project ID";
+    static args = {};
+    static flags = {
+        ...projectFlags,
+        ...ListBaseCommand.baseFlags,
+    };
+    async getData() {
+        const projectId = await withProjectId(this.apiClient, List, this.flags, this.args, this.config);
+        return await this.apiClient.mail.deliveryboxList({ projectId });
+    }
     mapData(data) {
-        console.log(data);
         return data;
     }
-    async mapParams(input) {
-        input.projectId = await normalizeProjectIdToUuid(this.apiClient, input.projectId);
-        return super.mapParams(input);
-    }
     getColumns(data) {
         const baseColumns = super.getColumns(data);
         return {

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

@@ -1,3 +1,15 @@
-import { GeneratedUserGetUser } from "../../generated/user/getUser.js";
-export default class Get extends GeneratedUserGetUser {
+import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
+import { GetBaseCommand } from "../../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/lib/interfaces/parser.js").CompletableFlag<any>;
+    };
+    static args: {
+        "user-id": import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+    };
+    protected getData(): Promise<APIResponse>;
 }
+export {};

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

@@ -1,6 +1,20 @@
-/* eslint-disable */
-/* prettier-ignore */
-/* This file is auto-generated with acg (@mittwald/api-code-generator) */
-import { GeneratedUserGetUser } from "../../generated/user/getUser.js";
-export default class Get extends GeneratedUserGetUser {
+import { GetBaseCommand } from "../../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/esm/lib/app/flags.d.ts

@@ -19,6 +19,7 @@ interface AvailableFlags {
     "shop-lang": OptionFlag<string | undefined>;
     "shop-currency": OptionFlag<string | undefined>;
     "install-mode": OptionFlag<string>;
+    "document-root": OptionFlag<string>;
     wait: BooleanFlag<boolean | undefined>;
 }
 export type RelevantFlags<TFlags extends readonly AvailableFlagName[]> = ProcessFlags & Pick<AvailableFlags, TFlags[number]>;

package/dist/esm/lib/app/flags.js

@@ -96,6 +96,12 @@ function buildFlagsWithDescription(appName) {
             options: ["composer", "symlink"],
             default: "composer",
         }),
+        "document-root": Flags.string({
+            required: true,
+            summary: `The document root from which your ${appName} will be served (relative to the installation path)`,
+            description: "This is the document root from which the files of your application will be served by the web server. This directory is specified relative to the installation path.",
+            default: "/",
+        }),
         wait: Flags.boolean({
             char: "w",
             description: `Wait for your ${appName} to be ready.`,

package/dist/esm/lib/app/install.js

@@ -16,5 +16,28 @@ export async function triggerAppInstallation(apiClient, process, projectId, flag
         assertStatus(result, 201);
         return [result.data.id, result.headers["etag"]];
     });
+    await process.runStep("waiting for installation to be retrievable", async () => {
+        for (let attempts = 0; attempts < 10; attempts++) {
+            const result = await apiClient.app.getAppinstallation({
+                appInstallationId,
+            });
+            if (result.status === 200) {
+                return result.data;
+            }
+            await new Promise((resolve) => setTimeout(resolve, 100));
+        }
+    });
+    if ("document-root" in flags && flags["document-root"] !== "/") {
+        await process.runStep("setting document root", async () => {
+            const result = await apiClient.app.patchAppinstallation({
+                appInstallationId,
+                headers: { "if-event-reached": eventId },
+                data: {
+                    customDocumentRoot: flags["document-root"],
+                },
+            });
+            assertStatus(result, 204);
+        });
+    }
     return [appInstallationId, eventId];
 }

package/dist/esm/rendering/react/components/AppInstallation/AppInstallationDetails.js

@@ -20,6 +20,7 @@ export const AppInstallationDetails = ({ app, appInstallation }) => {
                 Name: _jsx(Value, { children: app.name }),
             } })),
         "Installation Path": _jsx(Value, { children: appInstallation.installationPath }),
+        "Document root (in installation path)": (_jsx(Value, { children: appInstallation.customDocumentRoot ?? "/" })),
         Description: _jsx(Value, { children: appInstallation.description }),
         Status: customInstallation ? (_jsx(Text, { children: "custom application" })) : (_jsx(AppInstallationStatus, { appInstallation: appInstallation, desired: desiredAppVersion, current: currentAppVersion })),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.0.0-alpha.22",
+  "version": "1.0.0-alpha.24",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "author": {

package/dist/esm/generated/mail/deliveryboxList.d.ts

@@ -1,13 +0,0 @@
-import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
-import { ListBaseCommand } from "../../ListBaseCommand.js";
-export type PathParams = MittwaldAPIV2.Paths.V2ProjectsProjectIdDeliveryboxes.Get.Parameters.Path;
-export type Response = Awaited<ReturnType<MittwaldAPIV2Client["mail"]["deliveryboxList"]>>;
-export declare abstract class GeneratedMailDeliveryboxList<TItem extends Record<string, unknown>> extends ListBaseCommand<typeof GeneratedMailDeliveryboxList, TItem, Response> {
-    static description: string;
-    static args: {};
-    static flags: {
-        "project-id": import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
-    };
-    getData(): Promise<Response>;
-    protected mapParams(input: PathParams): Promise<PathParams> | PathParams;
-}

package/dist/esm/generated/mail/deliveryboxList.js

@@ -1,22 +0,0 @@
-import { Flags } from "@oclif/core";
-import { ListBaseCommand } from "../../ListBaseCommand.js";
-export class GeneratedMailDeliveryboxList extends ListBaseCommand {
-    static description = "Get all deliveryboxes by project ID";
-    static args = {};
-    static flags = {
-        ...ListBaseCommand.baseFlags,
-        "project-id": Flags.string({
-            description: "Project ID the deliveryboxes are related to",
-            required: true,
-        }),
-    };
-    async getData() {
-        const pathParams = {
-            projectId: this.flags["project-id"],
-        };
-        return await this.apiClient.mail.deliveryboxList((await this.mapParams(pathParams)));
-    }
-    mapParams(input) {
-        return input;
-    }
-}

package/dist/esm/generated/user/getUser.d.ts

@@ -1,14 +0,0 @@
-import { MittwaldAPIV2, MittwaldAPIV2Client } from "@mittwald/api-client";
-import { GetBaseCommand } from "../../GetBaseCommand.js";
-export type PathParams = MittwaldAPIV2.Paths.V2UsersUserId.Get.Parameters.Path;
-type APIResponse = Awaited<ReturnType<MittwaldAPIV2Client["user"]["getUser"]>>;
-export declare abstract class GeneratedUserGetUser extends GetBaseCommand<typeof GeneratedUserGetUser, APIResponse> {
-    static description: string;
-    static flags: {
-        [x: string]: import("@oclif/core/lib/interfaces/parser.js").CompletableFlag<any>;
-    };
-    static args: {};
-    protected getData(): Promise<APIResponse>;
-    protected mapParams(input: PathParams): Promise<PathParams> | PathParams;
-}
-export {};

package/dist/esm/generated/user/getUser.js

@@ -1,16 +0,0 @@
-import { GetBaseCommand } from "../../GetBaseCommand.js";
-export class GeneratedUserGetUser extends GetBaseCommand {
-    static description = "Get profile information for a user.";
-    static flags = {
-        ...GetBaseCommand.baseFlags,
-    };
-    static args = {};
-    async getData() {
-        return await this.apiClient.user.getUser({
-            ...(await this.mapParams(this.args)),
-        });
-    }
-    mapParams(input) {
-        return input;
-    }
-}