@mittwald/cli 1.0.0-alpha.41 → 1.0.0-alpha.43

package/dist/rendering/react/components/Error/ErrorStack.d.ts

@@ -0,0 +1,4 @@
+/** Render the stack trace of an error. */
+export default function ErrorStack({ err }: {
+    err: Error;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/rendering/react/components/Error/ErrorStack.js

@@ -0,0 +1,7 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Box } from "ink";
+import ErrorText from "./ErrorText.js";
+/** Render the stack trace of an error. */
+export default function ErrorStack({ err }) {
+    return (_jsxs(Box, { marginX: 2, marginY: 1, flexDirection: "column", rowGap: 1, children: [_jsx(ErrorText, { dimColor: true, bold: true, children: "ERROR STACK TRACE" }), _jsx(ErrorText, { dimColor: true, children: "Please provide this when opening a bug report." }), _jsx(ErrorText, { dimColor: true, children: err.stack })] }));
+}

package/dist/rendering/react/components/Error/ErrorText.d.ts

@@ -0,0 +1,3 @@
+import { TextProps } from "ink";
+/** A pre-styled text for displaying errors. */
+export default function ErrorText(props: TextProps): import("react/jsx-runtime").JSX.Element;

package/dist/rendering/react/components/Error/ErrorText.js

@@ -0,0 +1,6 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Text } from "ink";
+/** A pre-styled text for displaying errors. */
+export default function ErrorText(props) {
+    return (_jsx(Text, { color: "red", ...props, children: props.children }));
+}

package/dist/rendering/react/components/Error/GenericError.d.ts

@@ -0,0 +1,12 @@
+interface GenericErrorProps {
+    err: Error;
+    withStack: boolean;
+    withIssue?: boolean;
+    title?: string;
+}
+/**
+ * Render a generic error to the terminal. This is used for errors that don't
+ * have a specific rendering function.
+ */
+export default function GenericError({ err, withStack, withIssue, title, }: GenericErrorProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/rendering/react/components/Error/GenericError.js

@@ -0,0 +1,13 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { Box } from "ink";
+import ErrorStack from "./ErrorStack.js";
+import ErrorText from "./ErrorText.js";
+import ErrorBox from "./ErrorBox.js";
+const issueURL = "https://github.com/mittwald/cli/issues/new";
+/**
+ * Render a generic error to the terminal. This is used for errors that don't
+ * have a specific rendering function.
+ */
+export default function GenericError({ err, withStack, withIssue = true, title = "Error", }) {
+    return (_jsxs(_Fragment, { children: [_jsxs(ErrorBox, { children: [_jsx(ErrorText, { bold: true, underline: true, children: title.toUpperCase() }), _jsx(ErrorText, { children: "An error occurred while executing this command:" }), _jsx(Box, { marginX: 2, children: _jsx(ErrorText, { children: err.toString() }) }), withIssue ? (_jsxs(ErrorText, { children: ["If you believe this to be a bug, please open an issue at ", issueURL, "."] })) : undefined] }), withStack && "stack" in err ? _jsx(ErrorStack, { err: err }) : undefined] }));
+}

package/dist/rendering/react/components/Error/InvalidArgsError.d.ts

@@ -0,0 +1,5 @@
+import { RequiredArgsError } from "@oclif/core/lib/parser/errors.js";
+/** Render an error for invalid command arguments. */
+export default function InvalidArgsError({ err }: {
+    err: RequiredArgsError;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/rendering/react/components/Error/InvalidArgsError.js

@@ -0,0 +1,8 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Text } from "ink";
+import ErrorBox from "./ErrorBox.js";
+/** Render an error for invalid command arguments. */
+export default function InvalidArgsError({ err }) {
+    const color = "yellow";
+    return (_jsxs(ErrorBox, { borderColor: color, children: [_jsx(Text, { color: color, bold: true, underline: true, children: "INVALID COMMAND ARGUMENTS" }), _jsxs(Text, { color: color, children: ["The arguments that you provided for this command were invalid.", " ", err.message] })] }));
+}

package/dist/rendering/react/components/Error/InvalidFlagsError.d.ts

@@ -0,0 +1,5 @@
+import { FailedFlagValidationError } from "@oclif/core/lib/parser/errors.js";
+/** Render an error for invalid command flags. */
+export default function InvalidFlagsError({ err, }: {
+    err: FailedFlagValidationError;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/rendering/react/components/Error/InvalidFlagsError.js

@@ -0,0 +1,8 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Text } from "ink";
+import ErrorBox from "./ErrorBox.js";
+/** Render an error for invalid command flags. */
+export default function InvalidFlagsError({ err, }) {
+    const color = "yellow";
+    return (_jsxs(ErrorBox, { borderColor: color, children: [_jsx(Text, { color: color, bold: true, underline: true, children: "INVALID COMMAND FLAGS" }), _jsxs(Text, { color: color, children: ["The flags that you provided for this command were invalid. ", err.message] })] }));
+}

package/dist/rendering/react/components/Error/UnexpectedShortIDPassedErrorBox.d.ts

@@ -0,0 +1,4 @@
+import UnexpectedShortIDPassedError from "../../../../lib/error/UnexpectedShortIDPassedError.js";
+export default function UnexpectedShortIDPassedErrorBox({ err, }: {
+    err: UnexpectedShortIDPassedError;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/rendering/react/components/Error/UnexpectedShortIDPassedErrorBox.js

@@ -0,0 +1,7 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Text, Newline } from "ink";
+import ErrorBox from "./ErrorBox.js";
+export default function UnexpectedShortIDPassedErrorBox({ err, }) {
+    const color = "yellow";
+    return (_jsxs(ErrorBox, { borderColor: color, children: [_jsx(Text, { color: color, bold: true, underline: true, children: "UNEXPECTED RESOURCE TYPE" }), _jsxs(Text, { color: color, children: ["Whoops! It looks like you passed an ID for an unexpected resource type.", _jsx(Newline, {}), err.message] })] }));
+}

package/dist/rendering/react/components/ErrorBoundary.d.ts

@@ -0,0 +1,20 @@
+import { Component, PropsWithChildren } from "react";
+interface ErrorBoundaryProps {
+    onError?: (error: Error) => void;
+}
+interface ErrorBoundaryState {
+    error?: Error;
+}
+/**
+ * ErrorBoundary is a component that catches rendering errors in its children
+ * and displays an appropriately-styled error message.
+ *
+ * @see https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
+ */
+export default class ErrorBoundary extends Component<PropsWithChildren<ErrorBoundaryProps>, ErrorBoundaryState> {
+    constructor(props: PropsWithChildren<ErrorBoundaryProps>);
+    static getDerivedStateFromError(error: unknown): ErrorBoundaryState;
+    componentDidCatch(error: Error): void;
+    render(): string | number | boolean | Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
+}
+export {};

package/dist/rendering/react/components/ErrorBoundary.js

@@ -0,0 +1,32 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Component } from "react";
+import { ErrorBox } from "./ErrorBox.js";
+/**
+ * ErrorBoundary is a component that catches rendering errors in its children
+ * and displays an appropriately-styled error message.
+ *
+ * @see https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
+ */
+export default class ErrorBoundary extends Component {
+    constructor(props) {
+        super(props);
+        this.state = {};
+    }
+    static getDerivedStateFromError(error) {
+        if (error instanceof Error) {
+            return { error };
+        }
+        return {};
+    }
+    componentDidCatch(error) {
+        if (this.props.onError) {
+            this.props.onError(error);
+        }
+    }
+    render() {
+        if (this.state.error) {
+            return _jsx(ErrorBox, { err: this.state.error });
+        }
+        return this.props.children;
+    }
+}

package/dist/rendering/react/components/ErrorBox.d.ts

@@ -2,7 +2,6 @@ import { FC } from "react";
 /**
  * Render an error to the terminal.
  *
- * @class
  * @param err The error to render. May be anything, although different errors
  *   will be rendered differently.
  */

package/dist/rendering/react/components/ErrorBox.js

@@ -1,55 +1,16 @@
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { Box, Text } from "ink";
+import { jsx as _jsx } from "react/jsx-runtime";
 import { FailedFlagValidationError, RequiredArgsError, } from "@oclif/core/lib/parser/errors.js";
-import { ApiClientError, } from "@mittwald/api-client-commons";
+import { ApiClientError } from "@mittwald/api-client-commons";
 import InteractiveInputRequiredError from "../../../lib/error/InteractiveInputRequiredError.js";
-const color = "red";
-const issueURL = "https://github.com/mittwald/cli/issues/new";
-const boxProps = {
-    width: 80,
-    flexDirection: "column",
-    borderColor: color,
-    borderStyle: "round",
-    paddingX: 1,
-    rowGap: 1,
-};
-const ErrorStack = ({ err }) => {
-    return (_jsxs(Box, { marginX: 2, marginY: 1, flexDirection: "column", rowGap: 1, children: [_jsx(Text, { color: color, dimColor: true, bold: true, children: "ERROR STACK TRACE" }), _jsx(Text, { color: color, dimColor: true, children: "Please provide this when opening a bug report." }), _jsx(Text, { color: color, dimColor: true, children: err.stack })] }));
-};
-const GenericError = ({ err, withStack, withIssue = true, title = "Error" }) => {
-    return (_jsxs(_Fragment, { children: [_jsxs(Box, { ...boxProps, borderColor: color, children: [_jsx(Text, { color: color, bold: true, underline: true, children: title.toUpperCase() }), _jsx(Text, { color: color, children: "An error occurred while executing this command:" }), _jsx(Box, { marginX: 2, children: _jsx(Text, { color: color, children: err.toString() }) }), withIssue ? (_jsxs(Text, { color: color, children: ["If you believe this to be a bug, please open an issue at ", issueURL, "."] })) : undefined] }), withStack && "stack" in err ? _jsx(ErrorStack, { err: err }) : undefined] }));
-};
-const InvalidFlagsError = ({ err }) => {
-    const color = "yellow";
-    return (_jsxs(Box, { ...boxProps, borderColor: color, children: [_jsx(Text, { color: color, bold: true, underline: true, children: "INVALID COMMAND FLAGS" }), _jsxs(Text, { color: color, children: ["The flags that you provided for this command were invalid. ", err.message] })] }));
-};
-const InvalidArgsError = ({ err }) => {
-    const color = "yellow";
-    return (_jsxs(Box, { ...boxProps, borderColor: color, children: [_jsx(Text, { color: color, bold: true, underline: true, children: "INVALID COMMAND ARGUMENTS" }), _jsxs(Text, { color: color, children: ["The arguments that you provided for this command were invalid.", " ", err.message] })] }));
-};
-const RequestHeaders = ({ headers }) => {
-    const lines = headers.trim().split("\r\n");
-    const requestLine = lines.shift();
-    const values = lines.map((line) => line.split(": ", 2));
-    const maxKeyLength = Math.max(...values.map(([key]) => key.length));
-    return (_jsxs(Box, { flexDirection: "column", children: [_jsx(Text, { bold: true, underline: true, children: requestLine }), values.map(([key, value]) => (_jsxs(Box, { flexDirection: "row", children: [_jsxs(Text, { dimColor: true, children: [key.toLowerCase().padEnd(maxKeyLength, " "), " "] }), _jsx(Text, { bold: true, children: key === "x-access-token" ? "[redacted]" : value })] }, key)))] }));
-};
-const Response = ({ status, statusText, body, headers }) => {
-    const keys = Object.keys(headers);
-    const maxKeyLength = Math.max(...keys.map((key) => key.length));
-    return (_jsxs(Box, { flexDirection: "column", children: [_jsxs(Text, { bold: true, underline: true, children: [status, " ", statusText] }, "status"), keys.map((key) => (_jsxs(Box, { flexDirection: "row", children: [_jsxs(Text, { dimColor: true, children: [key.toLowerCase().padEnd(maxKeyLength, " "), " "] }), _jsx(Text, { bold: true, children: key === "x-access-token" ? "[redacted]" : headers[key] })] }, key))), _jsx(Box, { marginTop: 1, children: _jsx(Text, { children: JSON.stringify(body, undefined, 2) }) }, "body")] }));
-};
-const HttpMessages = ({ err }) => {
-    const response = err.response ? (_jsx(Response, { status: err.response.status, statusText: err.response.statusText, body: err.response.data, headers: err.response.headers })) : (_jsx(Text, { children: "no response received" }));
-    return (_jsxs(Box, { marginX: 2, marginY: 1, flexDirection: "column", rowGap: 1, children: [_jsx(RequestHeaders, { headers: err.request._header }), response] }));
-};
-const ApiError = ({ err, withStack, withHTTPMessages }) => {
-    return (_jsxs(_Fragment, { children: [_jsxs(Box, { ...boxProps, children: [_jsx(Text, { color: color, bold: true, underline: true, children: "API CLIENT ERROR" }), _jsxs(Text, { color: color, children: ["An error occurred while communicating with the API: ", err.message] }), _jsx(Text, { children: JSON.stringify(err.response?.data, undefined, 2) })] }), withHTTPMessages === "full" ? _jsx(HttpMessages, { err: err }) : undefined, withStack && "stack" in err ? _jsx(ErrorStack, { err: err }) : undefined] }));
-};
+import UnexpectedShortIDPassedError from "../../../lib/error/UnexpectedShortIDPassedError.js";
+import GenericError from "./Error/GenericError.js";
+import InvalidFlagsError from "./Error/InvalidFlagsError.js";
+import InvalidArgsError from "./Error/InvalidArgsError.js";
+import APIError from "./Error/APIError.js";
+import UnexpectedShortIDPassedErrorBox from "./Error/UnexpectedShortIDPassedErrorBox.js";
 /**
  * Render an error to the terminal.
  *
- * @class
  * @param err The error to render. May be anything, although different errors
  *   will be rendered differently.
  */
@@ -61,11 +22,14 @@ export const ErrorBox = ({ err }) => {
         return _jsx(InvalidArgsError, { err: err });
     }
     else if (err instanceof ApiClientError) {
-        return _jsx(ApiError, { err: err, withStack: true, withHTTPMessages: "body" });
+        return _jsx(APIError, { err: err, withStack: true, withHTTPMessages: "body" });
     }
     else if (err instanceof InteractiveInputRequiredError) {
         return (_jsx(GenericError, { err: err, withStack: false, withIssue: false, title: "Input required" }));
     }
+    else if (err instanceof UnexpectedShortIDPassedError) {
+        return _jsx(UnexpectedShortIDPassedErrorBox, { err: err });
+    }
     else if (err instanceof Error) {
         return _jsx(GenericError, { err: err, withStack: true });
     }

package/package.json

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