@apimatic/cli 1.0.2-alpha.2 → 1.1.0-alpha.10

package/lib/prompts/portal/quickstart.js

@@ -0,0 +1,212 @@
+import fs from "fs";
+import * as path from "path";
+import treeify from "treeify";
+import { intro, outro, text, spinner, select, multiselect, log, isCancel, cancel, password } from "@clack/prompts";
+import { getMessageInCyanColor, getMessageInGreenColor, getMessageInOrangeColor, getMessageInMagentaColor, getMessageInRedColor, isValidUrl, directoryToJson } from "../../utils/utils.js";
+export class PortalQuickstartPrompts {
+    constructor() {
+        this.spin = spinner();
+        this.vscodeExtensionUrl = "\u001b[4mhttps://marketplace.visualstudio.com/items?itemName=apimatic-developers.apimatic-for-vscode\u001b[0m";
+        this.serverUrl = "\u001b[4mhttp://localhost:3000\u001b[0m";
+        this.referenceDocumentationUrl = "\u001b[4mhttps://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal\u001b[0m";
+        this.customizeTheSdksUrl = "\u001b[4mhttps://docs.apimatic.io/generate-sdks/codegen-settings/codegen-settings-overview\u001b[0m";
+        this.defaultPortalDirectoryPath = process.cwd();
+    }
+    displayWelcomeMessage() {
+        intro(`Hello there 👋`);
+        log.message(`This wizard will help you set up an API Portal via APIMatic's Docs as Code workflow in 4 simple steps.`);
+        log.message(`Let's get started! 🚀`);
+    }
+    async loginPrompt() {
+        log.message(`Please log in to continue.`);
+        const email = await text({
+            message: "Enter your registered email:",
+            validate: (input) => {
+                if (!input) {
+                    return getMessageInRedColor("Email is required.");
+                }
+                const emailRegex = /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
+                if (!emailRegex.test(input)) {
+                    return getMessageInRedColor("Please enter a valid email address.");
+                }
+            }
+        });
+        if (isCancel(email)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        const pass = await password({
+            message: "Enter your password:",
+            validate: (input) => {
+                if (!input) {
+                    return getMessageInRedColor("Password is required.");
+                }
+            }
+        });
+        if (isCancel(pass)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return { email: String(email).trim(), password: String(pass).trim() };
+    }
+    displayLoggingInMessage() {
+        this.spin.start(getMessageInMagentaColor("Logging in"));
+    }
+    displayLoggingInErrorMessage() {
+        this.spin.stop(getMessageInRedColor(`There was a problem logging in. Please verify your credentials and try again.`));
+    }
+    displayLoggedInMessage() {
+        this.spin.stop(getMessageInCyanColor("✅  Login successful!"));
+    }
+    async specPrompt() {
+        log.step(getMessageInOrangeColor(`Step 1 of 4: Import your OpenAPI Definition`));
+        const spec = await text({
+            message: `Provide a local path or a public URL for your OpenAPI Definition file:`,
+            placeholder: "Press Enter to use a sample OpenAPI file for APIMatic",
+            defaultValue: "",
+            validate: (input) => {
+                if (!input)
+                    return;
+                if (isValidUrl(input))
+                    return;
+                const dirPath = path.resolve((input !== null && input !== void 0 ? input : "").trim());
+                if (fs.existsSync(dirPath)) {
+                    if (fs.statSync(dirPath).isFile()) {
+                        return;
+                    }
+                    return getMessageInRedColor("Error: The specified path does not point to a valid API Definition file or a zip archive containing API definition files. Please try again.");
+                }
+                return getMessageInRedColor("Error: The specified file does not exist. Please enter a valid file path.");
+            }
+        });
+        if (isCancel(spec)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return String(spec).trim();
+    }
+    displaySpecValidationMessage() {
+        log.step(getMessageInOrangeColor(`Step 2 of 4: Validate and Lint your OpenAPI file`));
+        this.spin.start(getMessageInMagentaColor(`Running your API Definition through APIMatic's 1200+ CodeGen Specific validation and linting rules 🔍 `));
+    }
+    displaySpecValidationSuccessMessage() {
+        this.spin.stop(getMessageInCyanColor(`✅  Validation Successful.`));
+    }
+    displaySpecValidationErrorMessage() {
+        this.spin.stop(getMessageInRedColor(`Something went wrong while validating your spec.`));
+    }
+    displaySpecValidationFailureMessage() {
+        this.spin.stop(getMessageInRedColor(`❗ Oops, it looks like there are some errors in your API Definition.`));
+    }
+    async specValidationFailurePrompt() {
+        const useSampleSpec = await select({
+            message: `How would you like to proceed?`,
+            options: [
+                {
+                    value: "exit",
+                    label: `1. Fix the issues using APIMatic's interactive VS Code Extension: ${this.vscodeExtensionUrl}`
+                },
+                { value: "continue", label: `2. Use an example API spec instead (recommended)` }
+            ]
+        });
+        if (isCancel(useSampleSpec)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        if (useSampleSpec === "exit") {
+            outro(getMessageInCyanColor("Good luck fixing your API definition! 🛠️  Feel free to run this command again once you're done."));
+            return process.exit(0);
+        }
+    }
+    async sdkLanguagesPrompt() {
+        log.step(getMessageInOrangeColor(`Step 3 of 4: Select programming languages`));
+        const languages = (await multiselect({
+            message: "💻 Your API Portal will contain SDKs and SDK Documentation in the following Languages. Press enter to continue with all languages, or use the arrow keys and spacebar to customize your selection:",
+            options: [
+                { label: "HTTP", value: "http" },
+                { label: "Typescript", value: "typescript" },
+                { label: "Ruby", value: "ruby" },
+                { label: "Python", value: "python" },
+                { label: "Java", value: "java" },
+                { label: "C#", value: "csharp" },
+                { label: "PHP", value: "php" },
+                { label: "Go", value: "go" }
+            ],
+            initialValues: ["http", "typescript", "ruby", "python", "java", "csharp", "php", "go"]
+        }));
+        if (isCancel(languages)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return languages;
+    }
+    async buildDirectoryPrompt() {
+        log.step(getMessageInOrangeColor(`Step 4 of 4: Generate source files for Docs as Code`));
+        const directory = await text({
+            message: "Enter the directory path where you would like to setup the API Portal :",
+            placeholder: "Enter absolute path to the directory or leave it empty to use the current directory.",
+            defaultValue: "./",
+            validate: (input) => {
+                const dirPath = path.resolve((input !== null && input !== void 0 ? input : "").trim());
+                if (!fs.existsSync(dirPath) && dirPath != this.defaultPortalDirectoryPath) {
+                    return getMessageInRedColor("Error: The specified directory path does not exist. Please try again.");
+                }
+                if (dirPath !== this.defaultPortalDirectoryPath) {
+                    const files = fs.readdirSync(dirPath).filter((item) => !item.startsWith("."));
+                    if (files.length > 0) {
+                        return getMessageInRedColor("Error: The target directory is not empty. Please provide a path to an empty directory or clear its contents.");
+                    }
+                }
+                else if (fs.existsSync(dirPath) && fs.readdirSync(dirPath).length > 0) {
+                    return getMessageInRedColor("Error: The target directory is not empty. Please provide a path to an empty directory or clear its contents.");
+                }
+            }
+        });
+        if (isCancel(directory)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        if (directory === "./") {
+            return this.defaultPortalDirectoryPath;
+        }
+        else {
+            return String(directory).trim();
+        }
+    }
+    displayBuildDirectoryGenerationMessage() {
+        this.spin.start(getMessageInMagentaColor("Generating build directory... ⚙️"));
+    }
+    displayBuildDirectoryGenerationErrorMessage() {
+        this.spin.stop(getMessageInRedColor(`Something went wrong while setting up your build directory.`));
+    }
+    displayBuildDirectoryGenerationSuccessMessage(targetFolder) {
+        this.spin.stop(getMessageInCyanColor(`📁 Directory created at ${targetFolder}`));
+    }
+    displayBuildDirectoryAsTree(targetFolder) {
+        const buildDirectory = directoryToJson(targetFolder);
+        const tree = treeify.asTree(buildDirectory, true, true);
+        const coloredLogString = tree
+            .split("\n")
+            .map((line) => line.replace(/#.*/, (match) => getMessageInGreenColor(match)))
+            .join("\n");
+        log.info(coloredLogString);
+    }
+    displayPortalGenerationMessage() {
+        this.spin.start(getMessageInMagentaColor("Setting up portal"));
+    }
+    displayPortalGenerationSuccessMessage() {
+        this.spin.stop(getMessageInCyanColor("✅  Portal setup complete!"));
+    }
+    displayOutroMessage(directory) {
+        log.step(getMessageInCyanColor(`📢  Your API Portal is live at: ${this.serverUrl}\n`) +
+            getMessageInCyanColor(`Hot reload enabled! Edit files in ${directory} to see changes instantly reflected in your API Portal.\n`) +
+            getMessageInCyanColor(`Press CTRL+C to stop the server.`));
+        outro(getMessageInCyanColor(`What's next?\n`) +
+            getMessageInCyanColor(`- Check out the Interactive Playground in your API Portal.\n`) +
+            getMessageInCyanColor(`- Read the reference documentation to learn more about how you can customize this API Portal: ${this.referenceDocumentationUrl}`) +
+            getMessageInCyanColor(` \n`) +
+            getMessageInCyanColor(`- Review the SDK Documentation for your favourite programming language and download an SDK from the API Portal.\n`) +
+            getMessageInCyanColor(`- Check out how you can customize the SDKs using Code Generation settings: ${this.customizeTheSdksUrl}`));
+    }
+}
+//# sourceMappingURL=quickstart.js.map

package/lib/prompts/portal/quickstart.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/prompts/portal/quickstart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACnH,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,oBAAoB,EACpB,UAAU,EACV,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,OAAO,uBAAuB;IAApC;QACmB,SAAI,GAAG,OAAO,EAAE,CAAC;QACjB,uBAAkB,GACjC,+GAA+G,CAAC;QACjG,cAAS,GAAG,yCAAyC,CAAC;QACtD,8BAAyB,GACxC,oIAAoI,CAAC;QACtH,wBAAmB,GAClC,qGAAqG,CAAC;QACvF,+BAA0B,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAiR9D,CAAC;IA/QC,qBAAqB;QACnB,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACxB,GAAG,CAAC,OAAO,CACT,wGAAwG,CACzG,CAAC;QACF,GAAG,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,WAAW;QACf,GAAG,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAE1C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC;YACvB,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;gBACpD,CAAC;gBAED,MAAM,UAAU,GACd,sIAAsI,CAAC;gBAEzI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC5B,OAAO,oBAAoB,CAAC,qCAAqC,CAAC,CAAC;gBACrE,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC;YAC1B,OAAO,EAAE,sBAAsB;YAC/B,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;IACxE,CAAC;IAED,uBAAuB;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,4BAA4B;QAC1B,IAAI,CAAC,IAAI,CAAC,IAAI,CACZ,oBAAoB,CAAC,+EAA+E,CAAC,CACtG,CAAC;IACJ,CAAC;IAED,sBAAsB;QACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,UAAU;QACd,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,6CAA6C,CAAC,CAAC,CAAC;QAEjF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;YACtB,OAAO,EAAE,wEAAwE;YACjF,WAAW,EAAE,uDAAuD;YACpE,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,KAAK;oBAAE,OAAO;gBAEnB,IAAI,UAAU,CAAC,KAAK,CAAC;oBAAE,OAAO;gBAE9B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAEnD,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC3B,IAAI,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;wBAClC,OAAO;oBACT,CAAC;oBAED,OAAO,oBAAoB,CACzB,6IAA6I,CAC9I,CAAC;gBACJ,CAAC;gBAED,OAAO,oBAAoB,CAAC,2EAA2E,CAAC,CAAC;YAC3G,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,4BAA4B;QAC1B,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,kDAAkD,CAAC,CAAC,CAAC;QACtF,IAAI,CAAC,IAAI,CAAC,KAAK,CACb,wBAAwB,CACtB,wGAAwG,CACzG,CACF,CAAC;IACJ,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,iCAAiC;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,kDAAkD,CAAC,CAAC,CAAC;IAC3F,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,qEAAqE,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED,KAAK,CAAC,2BAA2B;QAC/B,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC;YACjC,OAAO,EAAE,gCAAgC;YACzC,OAAO,EAAE;gBACP;oBACE,KAAK,EAAE,MAAM;oBACb,KAAK,EAAE,qEAAqE,IAAI,CAAC,kBAAkB,EAAE;iBACtG;gBACD,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,kDAAkD,EAAE;aACjF;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,aAAa,KAAK,MAAM,EAAE,CAAC;YAC7B,KAAK,CACH,qBAAqB,CACnB,kGAAkG,CACnG,CACF,CAAC;YACF,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,2CAA2C,CAAC,CAAC,CAAC;QAE/E,MAAM,SAAS,GAAG,CAAC,MAAM,WAAW,CAAC;YACnC,OAAO,EACL,oMAAoM;YACtM,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;gBAC5C,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;gBACpC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;gBAChC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;gBAChC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;YACD,aAAa,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC;SACvF,CAAC,CAAa,CAAC;QAEhB,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,oBAAoB;QACxB,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,qDAAqD,CAAC,CAAC,CAAC;QAEzF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC;YAC3B,OAAO,EAAE,yEAAyE;YAClF,WAAW,EAAE,sFAAsF;YACnG,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAEnD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,IAAI,CAAC,0BAA0B,EAAE,CAAC;oBAC1E,OAAO,oBAAoB,CAAC,uEAAuE,CAAC,CAAC;gBACvG,CAAC;gBAED,IAAI,OAAO,KAAK,IAAI,CAAC,0BAA0B,EAAE,CAAC;oBAChD,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC9E,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACrB,OAAO,oBAAoB,CACzB,8GAA8G,CAC/G,CAAC;oBACJ,CAAC;gBACH,CAAC;qBAAM,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxE,OAAO,oBAAoB,CACzB,8GAA8G,CAC/G,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,0BAA0B,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED,sCAAsC;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,kCAAkC,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,2CAA2C;QACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,6DAA6D,CAAC,CAAC,CAAC;IACtG,CAAC;IAED,6CAA6C,CAAC,YAAoB;QAChE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,2BAA2B,YAAY,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,2BAA2B,CAAC,YAAoB;QAC9C,MAAM,cAAc,GAAG,eAAe,CAAC,YAAY,CAAuB,CAAC;QAE3E,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAExD,MAAM,gBAAgB,GAAG,IAAI;aAC1B,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;aAC5E,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,CAAC;IAED,8BAA8B;QAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,qCAAqC;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,mBAAmB,CAAC,SAAiB;QACnC,GAAG,CAAC,IAAI,CACN,qBAAqB,CAAC,mCAAmC,IAAI,CAAC,SAAS,IAAI,CAAC;YAC1E,qBAAqB,CACnB,qCAAqC,SAAS,2DAA2D,CAC1G;YACD,qBAAqB,CAAC,kCAAkC,CAAC,CAC5D,CAAC;QACF,KAAK,CACH,qBAAqB,CAAC,gBAAgB,CAAC;YACrC,qBAAqB,CAAC,8DAA8D,CAAC;YACrF,qBAAqB,CACnB,iGAAiG,IAAI,CAAC,yBAAyB,EAAE,CAClI;YACD,qBAAqB,CAAC,KAAK,CAAC;YAC5B,qBAAqB,CACnB,mHAAmH,CACpH;YACD,qBAAqB,CACnB,8EAA8E,IAAI,CAAC,mBAAmB,EAAE,CACzG,CACJ,CAAC;IACJ,CAAC;CACF"}

package/lib/prompts/portal/recipe/new-recipe.d.ts

@@ -0,0 +1,23 @@
+import treeify from "treeify";
+import { SdlEndpoint } from "../../../types/sdl/sdl.js";
+export declare class PortalRecipePrompts {
+    private readonly spin;
+    displayWelcomeMessage(): void;
+    recipeNamePrompt(): Promise<string>;
+    buildConfigFilePathPrompt(buildDirectoryPath: string): Promise<string>;
+    stepNamePrompt(defaultStepName: string): Promise<string>;
+    displayStepsInformation(): void;
+    stepTypeSelectionPrompt(): Promise<string>;
+    displayContentStepInfo(): void;
+    endpointGroupNamePrompt(endpointGroups: Map<string, SdlEndpoint[]>): Promise<string>;
+    endpointNamePrompt(endpointGroups: Map<string, SdlEndpoint[]>, endpointGroupName: string): Promise<string>;
+    endpointDescriptionPrompt(endpointGroups: Map<string, SdlEndpoint[]>, endpointGroupName: string, endpointName: string): Promise<string>;
+    addAnotherStepSelectionPrompt(): Promise<boolean>;
+    overwriteApiRecipeInTocPrompt(): Promise<boolean>;
+    displayStepAddedSuccessfullyMessage(): void;
+    displayRecipeGenerationSuccessMessage(buildDirectoryPath: string): void;
+    startProgressIndicatorWithMessage(message: string): void;
+    stopProgressIndicatorWithMessage(message: string): void;
+    displayBuildDirectoryStructureAsTree(buildDirectoryTreeObject: treeify.TreeObject): void;
+    logError(error: string): void;
+}

package/lib/prompts/portal/recipe/new-recipe.js

@@ -0,0 +1,193 @@
+import * as fs from "fs";
+import * as path from "path";
+import treeify from "treeify";
+import { intro, spinner, select, text, cancel, isCancel, outro, log, autocomplete } from "@clack/prompts";
+import { getMessageInGreenColor } from "../../../utils/utils.js";
+export class PortalRecipePrompts {
+    constructor() {
+        this.spin = spinner();
+    }
+    displayWelcomeMessage() {
+        intro(`Welcome to the API Recipe Generation Wizard. 🪄`);
+        log.step(`This wizard will guide you through the process of creating an API Recipe.`);
+        log.message(`An API Recipe is a collection of steps that allows you to define a single use case for your API Documentation portal.`);
+        log.message(`ℹ️  Learn more: https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes`);
+        log.message(`Let's get started! 🚀`);
+    }
+    async recipeNamePrompt() {
+        const recipeName = await text({
+            message: `📘 Enter a name for your API Recipe:`,
+            placeholder: "There will be a tab in the navbar of your API Documentation portal of this name.",
+            validate: (name) => {
+                if (!name) {
+                    return "Recipe name cannot be empty. Please provide a name for your API Recipe.";
+                }
+            }
+        });
+        if (isCancel(recipeName)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return recipeName.trim();
+    }
+    async buildConfigFilePathPrompt(buildDirectoryPath) {
+        const buildConfigFilePath = await text({
+            message: `⚠️ APIMATIC-BUILD.json is required and was not found in "${buildDirectoryPath}".\nPlease enter the path to your build config file (relative to this directory):`,
+            validate: (filePath) => {
+                if (!filePath) {
+                    return "Build config file path cannot be empty. Please provide a valid file path.";
+                }
+                if (!filePath.endsWith(".json")) {
+                    return "The content file must be a JSON (.json) file. Please provide a valid file path.";
+                }
+                const resolvedPath = path.resolve(buildDirectoryPath, filePath);
+                if (fs.existsSync(resolvedPath) && fs.statSync(resolvedPath).isFile()) {
+                    return;
+                }
+                return "The specified path is either not a valid relative file path or it doesn't exist. Please provide a valid relative file path.";
+            }
+        });
+        if (isCancel(buildConfigFilePath)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return path.resolve(buildDirectoryPath, buildConfigFilePath.trim());
+    }
+    async stepNamePrompt(defaultStepName) {
+        const stepName = await text({
+            message: `Enter a name for the step:`,
+            defaultValue: defaultStepName,
+            placeholder: `Press enter to use the default, i.e. ${defaultStepName}`
+        });
+        if (isCancel(stepName)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return stepName.trim();
+    }
+    displayStepsInformation() {
+        log.step(`🔧 Add Steps to your Recipe:`);
+        log.message(`You can add:`);
+        log.message(`1. 📄 Content Step: Display custom content, such as instructions or information related to your API.`);
+        log.message(`2. 🔗 Endpoint Step: Display an API endpoint, its playground and other relevant details.`);
+        log.message(`💡 Steps appear in the order you add them.`);
+        log.message(`📝 Let's proceed to adding steps to your API Recipe. `);
+    }
+    async stepTypeSelectionPrompt() {
+        const stepType = await select({
+            message: `➕ Select the type of step you want to add:`,
+            options: [
+                { value: "content", label: "Content Step", hint: "For displaying custom content" },
+                { value: "endpoint", label: "Endpoint Step", hint: "For displaying an API endpoint with its details" }
+            ]
+        });
+        if (isCancel(stepType)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return stepType;
+    }
+    displayContentStepInfo() {
+        log.step("📝 Opening markdown editor for you to add content in...");
+    }
+    async endpointGroupNamePrompt(endpointGroups) {
+        const groupNames = Array.from(endpointGroups.keys()).map((name) => ({
+            value: name,
+            label: name
+        }));
+        const endpointGroupName = await autocomplete({
+            message: `Select the endpoint group name:`,
+            maxItems: 10,
+            options: groupNames
+        });
+        if (isCancel(endpointGroupName)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return endpointGroupName.trim();
+    }
+    async endpointNamePrompt(endpointGroups, endpointGroupName) {
+        const endpoints = endpointGroups.get(endpointGroupName);
+        const endpointName = await autocomplete({
+            message: `Select the name of the endpoint:`,
+            maxItems: 10,
+            options: endpoints.map((endpoint) => ({
+                value: endpoint.Name,
+                label: endpoint.Name
+            }))
+        });
+        if (isCancel(endpointName)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return endpointName.trim();
+    }
+    async endpointDescriptionPrompt(endpointGroups, endpointGroupName, endpointName) {
+        const defaultDescription = endpointGroups.get(endpointGroupName).find((e) => e.Name === endpointName).Description;
+        const endpointDescription = await text({
+            message: `Enter a description for the endpoint:`,
+            placeholder: `Optional. Leave this empty to use the endpoint description defined in the API Specification`,
+            defaultValue: defaultDescription
+        });
+        if (isCancel(endpointDescription)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return endpointDescription.trim();
+    }
+    async addAnotherStepSelectionPrompt() {
+        const addAnotherStep = await select({
+            message: `Do you want to add another step?`,
+            options: [
+                { value: "yes", label: "Yes" },
+                { value: "no", label: "No" }
+            ]
+        });
+        if (isCancel(addAnotherStep)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return addAnotherStep === "yes";
+    }
+    async overwriteApiRecipeInTocPrompt() {
+        const overwriteApiRecipeInToc = await select({
+            message: `⚠️  A recipe with this name already exists. Do you want to overwrite it?`,
+            options: [
+                { value: "yes", label: "Yes" },
+                { value: "no", label: "No" }
+            ]
+        });
+        if (isCancel(overwriteApiRecipeInToc)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return overwriteApiRecipeInToc === "yes";
+    }
+    displayStepAddedSuccessfullyMessage() {
+        log.step(`✅  Step has been added successfully.`);
+    }
+    displayRecipeGenerationSuccessMessage(buildDirectoryPath) {
+        log.step(`🎉 Recipe has been added successfully!`);
+        log.message(`📦 Generated recipe has been added to build directory at: ${buildDirectoryPath}`);
+        outro(`▶ Run the command 'apimatic portal:serve' to preview your documentation portal.`);
+    }
+    startProgressIndicatorWithMessage(message) {
+        this.spin.start(message);
+    }
+    stopProgressIndicatorWithMessage(message) {
+        this.spin.stop(message);
+    }
+    displayBuildDirectoryStructureAsTree(buildDirectoryTreeObject) {
+        const tree = treeify.asTree(buildDirectoryTreeObject, true, true);
+        const coloredLogString = tree
+            .split("\n")
+            .map((line) => line.replace(/#.*/, (match) => getMessageInGreenColor(match)))
+            .join("\n");
+        log.step(`🛠️  You can edit the following files to customize your API Recipe :\n\n` + coloredLogString);
+        log.message(`💡 Modify the TOC file to change the position of the API Recipes section in the navbar.`);
+    }
+    logError(error) {
+        outro(error);
+    }
+}
+//# sourceMappingURL=new-recipe.js.map

package/lib/prompts/portal/recipe/new-recipe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"new-recipe.js","sourceRoot":"","sources":["../../../../src/prompts/portal/recipe/new-recipe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC1G,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAGjE,MAAM,OAAO,mBAAmB;IAAhC;QACmB,SAAI,GAAG,OAAO,EAAE,CAAC;IAwOpC,CAAC;IAtOQ,qBAAqB;QAC1B,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACzD,GAAG,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;QACtF,GAAG,CAAC,OAAO,CACT,uHAAuH,CACxH,CAAC;QACF,GAAG,CAAC,OAAO,CACT,+GAA+G,CAChH,CAAC;QACF,GAAG,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC;YAC5B,OAAO,EAAE,sCAAsC;YAC/C,WAAW,EAAE,kFAAkF;YAC/F,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;gBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,OAAO,yEAAyE,CAAC;gBACnF,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAQ,UAAqB,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,kBAA0B;QAC/D,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC;YACrC,OAAO,EAAE,4DAA4D,kBAAkB,mFAAmF;YAC1K,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACrB,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,2EAA2E,CAAC;gBACrF,CAAC;gBAED,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBAChC,OAAO,iFAAiF,CAAC;gBAC3F,CAAC;gBAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;gBAChE,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;oBACtE,OAAO;gBACT,CAAC;gBAED,OAAO,6HAA6H,CAAC;YACvI,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAClC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAG,mBAA8B,CAAC,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,eAAuB;QACjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC;YAC1B,OAAO,EAAE,4BAA4B;YACrC,YAAY,EAAE,eAAe;YAC7B,WAAW,EAAE,wCAAwC,eAAe,EAAE;SACvE,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAQ,QAAmB,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IAEM,uBAAuB;QAC5B,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QACzC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAC3B,GAAG,CAAC,OAAO,CACT,sGAAsG,CACvG,CAAC;QACF,GAAG,CAAC,OAAO,CAAC,0FAA0F,CAAC,CAAC;QACxG,GAAG,CAAC,OAAO,CAAC,4CAA4C,CAAC,CAAC;QAC1D,GAAG,CAAC,OAAO,CAAC,uDAAuD,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,uBAAuB;QAClC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC;YAC5B,OAAO,EAAE,4CAA4C;YACrD,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,+BAA+B,EAAE;gBAClF,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,iDAAiD,EAAE;aACvG;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,QAAkB,CAAC;IAC5B,CAAC;IAEM,sBAAsB;QAC3B,GAAG,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;IACtE,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,cAA0C;QAC7E,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAClE,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC,CAAC;QACJ,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC;YAC3C,OAAO,EAAE,iCAAiC;YAC1C,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,UAAU;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAQ,iBAA4B,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,cAA0C,EAAE,iBAAyB;QACnG,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACxD,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC;YACtC,OAAO,EAAE,kCAAkC;YAC3C,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,SAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACrC,KAAK,EAAE,QAAQ,CAAC,IAAI;gBACpB,KAAK,EAAE,QAAQ,CAAC,IAAI;aACrB,CAAC,CAAC;SACJ,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3B,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAQ,YAAuB,CAAC,IAAI,EAAE,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,cAA0C,EAAE,iBAAyB,EAAE,YAAoB;QAChI,MAAM,kBAAkB,GAAG,cAAc,CAAC,GAAG,CAAC,iBAAiB,CAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAE,CAAC,WAAW,CAAC;QACpH,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC;YACrC,OAAO,EAAE,uCAAuC;YAChD,WAAW,EAAE,6FAA6F;YAC1G,YAAY,EAAE,kBAAkB;SACjC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;YAClC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAQ,mBAA8B,CAAC,IAAI,EAAE,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,6BAA6B;QACxC,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC;YAClC,OAAO,EAAE,kCAAkC;YAC3C,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,cAAc,KAAK,KAAK,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,6BAA6B;QACxC,MAAM,uBAAuB,GAAG,MAAM,MAAM,CAAC;YAC3C,OAAO,EAAE,0EAA0E;YACnF,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,uBAAuB,KAAK,KAAK,CAAC;IAC3C,CAAC;IAEM,mCAAmC;QACxC,GAAG,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;IACnD,CAAC;IAEM,qCAAqC,CAAC,kBAA0B;QACrE,GAAG,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;QACnD,GAAG,CAAC,OAAO,CAAC,6DAA6D,kBAAkB,EAAE,CAAC,CAAC;QAC/F,KAAK,CACH,iFAAiF,CAClF,CAAC;IACJ,CAAC;IAEM,iCAAiC,CAAC,OAAe;QACtD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAEM,gCAAgC,CAAC,OAAe;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAEM,oCAAoC,CAAC,wBAA4C;QACtF,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,wBAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAElE,MAAM,gBAAgB,GAAG,IAAI;aAC1B,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;aAC5F,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,GAAG,CAAC,IAAI,CAAC,0EAA0E,GAAG,gBAAgB,CAAC,CAAC;QACxG,GAAG,CAAC,OAAO,CAAC,yFAAyF,CAAC,CAAC;IACzG,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CACF"}

package/lib/prompts/portal/serve.d.ts

@@ -0,0 +1,7 @@
+export declare class PortalServePrompts {
+    private readonly spin;
+    displayGeneratingPortalMessage(): void;
+    displayGeneratingPortalErrorMessage(): void;
+    displayGeneratedPortalMessage(portalDir: string): void;
+    displayOutroMessage(port: number): void;
+}

package/lib/prompts/portal/serve.js

@@ -0,0 +1,21 @@
+import { log, outro, spinner } from "@clack/prompts";
+import { getMessageInRedColor } from "../../utils/utils.js";
+export class PortalServePrompts {
+    constructor() {
+        this.spin = spinner();
+    }
+    displayGeneratingPortalMessage() {
+        this.spin.start(`Generating portal`);
+    }
+    displayGeneratingPortalErrorMessage() {
+        this.spin.stop(getMessageInRedColor(`There was an error while generating the portal.`));
+    }
+    displayGeneratedPortalMessage(portalDir) {
+        this.spin.stop(`Portal generated successfully at ${portalDir}`);
+    }
+    displayOutroMessage(port) {
+        log.message(`Server started at http://localhost:${port}`);
+        outro(`Press CTRL+C to stop the server.`);
+    }
+}
+//# sourceMappingURL=serve.js.map

package/lib/prompts/portal/serve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.js","sourceRoot":"","sources":["../../../src/prompts/portal/serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,MAAM,OAAO,kBAAkB;IAA/B;QACmB,SAAI,GAAG,OAAO,EAAE,CAAC;IAkBpC,CAAC;IAhBC,8BAA8B;QAC5B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,iDAAiD,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED,6BAA6B,CAAC,SAAiB;QAC7C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oCAAoC,SAAS,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,mBAAmB,CAAC,IAAY;QAC9B,GAAG,CAAC,OAAO,CAAC,sCAAsC,IAAI,EAAE,CAAC,CAAC;QAC1D,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/lib/prompts/portal/toc/new-toc.d.ts

@@ -0,0 +1,10 @@
+export declare class PortalNewTocPrompts {
+    private readonly spin;
+    overwriteExistingTocPrompt(): Promise<boolean>;
+    startProgressIndicatorWithMessage(message: string): void;
+    stopProgressIndicatorWithMessage(message: string): void;
+    displayOutroMessage(tocPath: string): void;
+    logError(error: string): void;
+    displayWarning(message: string): void;
+    displayInfo(message: string): void;
+}

package/lib/prompts/portal/toc/new-toc.js

@@ -0,0 +1,42 @@
+import { cancel, outro, select, spinner, isCancel, log } from "@clack/prompts";
+export class PortalNewTocPrompts {
+    constructor() {
+        this.spin = spinner();
+    }
+    async overwriteExistingTocPrompt() {
+        const useExistingFile = await select({
+            message: `A toc file already exists at the specified destination path, do you want to overwrite it?`,
+            options: [
+                { value: "yes", label: "Yes" },
+                { value: "no", label: "No" }
+            ]
+        });
+        if (isCancel(useExistingFile)) {
+            cancel("Operation cancelled.");
+            return process.exit(1);
+        }
+        if (useExistingFile === "no") {
+            outro("Please enter a different destination path or delete the existing toc file and try again.");
+        }
+        return useExistingFile === "yes";
+    }
+    startProgressIndicatorWithMessage(message) {
+        this.spin.start(message);
+    }
+    stopProgressIndicatorWithMessage(message) {
+        this.spin.stop(message);
+    }
+    displayOutroMessage(tocPath) {
+        outro(`✅ TOC file successfully created at: ${tocPath}`);
+    }
+    logError(error) {
+        outro(error);
+    }
+    displayWarning(message) {
+        log.warning(message);
+    }
+    displayInfo(message) {
+        log.step(message);
+    }
+}
+//# sourceMappingURL=new-toc.js.map

package/lib/prompts/portal/toc/new-toc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"new-toc.js","sourceRoot":"","sources":["../../../../src/prompts/portal/toc/new-toc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAE/E,MAAM,OAAO,mBAAmB;IAAhC;QACmB,SAAI,GAAG,OAAO,EAAE,CAAC;IA8CpC,CAAC;IA5CC,KAAK,CAAC,0BAA0B;QAC9B,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC;YACnC,OAAO,EAAE,2FAA2F;YACpG,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBAC9B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;SACF,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YAC7B,KAAK,CAAC,0FAA0F,CAAC,CAAC;QACpG,CAAC;QAED,OAAO,eAAe,KAAK,KAAK,CAAC;IACnC,CAAC;IAED,iCAAiC,CAAC,OAAe;QAC/C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED,gCAAgC,CAAC,OAAe;QAC9C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED,mBAAmB,CAAC,OAAe;QACjC,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAED,cAAc,CAAC,OAAe;QAC5B,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAED,WAAW,CAAC,OAAe;QACzB,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;CACF"}

package/lib/services/portal/server.d.ts

@@ -0,0 +1,14 @@
+import { PortalServerConfig } from "../../types/portal/quickstart.js";
+export declare class PortalServerService {
+    private server;
+    private liveReloadServer;
+    private readonly app;
+    private readonly port;
+    private readonly liveReloadPort;
+    constructor();
+    private findAvailablePort;
+    private createLiveReloadServer;
+    setupServer(generatedPortalPath: string): Promise<void>;
+    startServer(config: PortalServerConfig, noReload?: boolean, displayShutdownMessages?: boolean): Promise<boolean>;
+    stopServer(): Promise<void>;
+}