@apimatic/cli 1.1.0-alpha.2 → 1.1.0-alpha.20

package/lib/prompts/portal/copilot.js

@@ -0,0 +1,54 @@
+import { select, cancel, isCancel, outro, confirm, log, text, } from "@clack/prompts";
+import { getMessageInCyanColor } from "../../utils/utils.js";
+export class PortalCopilotPrompts {
+    async selectCopilotKey(keys) {
+        const selectedKey = await select({
+            message: "Select the ID for the API Copilot you would like to add to this API Portal:",
+            maxItems: 10,
+            options: keys.map((key) => ({
+                value: key,
+                label: key
+            }))
+        });
+        if (isCancel(selectedKey)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return selectedKey;
+    }
+    copilotConfigured(apiCopilotConfig) {
+        outro(`API Copilot configured successfully!
+
+    Copilot ID: ${getMessageInCyanColor(apiCopilotConfig.key)}
+    Welcome Message: ${getMessageInCyanColor(apiCopilotConfig.welcomeMessage)}
+    Status: ${getMessageInCyanColor(apiCopilotConfig.isEnabled ? "Enabled" : "Disabled")}
+
+  Configuration saved to: APIMATIC-BUILD.json
+
+Run 'apimatic portal:serve' to preview your API Portal and try out the API Copilot.`);
+    }
+    async confirmOverwrite() {
+        const shouldOverwrite = await confirm({
+            message: "API Copilot configuration already exists. Do you want to overwrite?",
+            initialValue: false
+        });
+        if (isCancel(shouldOverwrite)) {
+            return false;
+        }
+        return shouldOverwrite;
+    }
+    logError(error) {
+        log.error(error);
+    }
+    async getWelcomeMessage() {
+        const welcomeMessage = await text({
+            message: "Enter a welcome message for your API Copilot:",
+            placeholder: "Enter your welcome message here..."
+        });
+        if (isCancel(welcomeMessage)) {
+            return undefined;
+        }
+        return welcomeMessage;
+    }
+}
+//# sourceMappingURL=copilot.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"copilot.js","sourceRoot":"","sources":["../../../src/prompts/portal/copilot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,GAAI,MAAM,gBAAgB,CAAC;AAEvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,MAAM,OAAO,oBAAoB;IACxB,KAAK,CAAC,gBAAgB,CAAC,IAAc;QAC1C,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC;YAC/B,OAAO,EAAE,6EAA6E;YACtF,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC1B,KAAK,EAAE,GAAG;gBACV,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;SACJ,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,iBAAiB,CAAC,gBAA+B;QACtD,KAAK,CACH;;kBAEY,qBAAqB,CAAC,gBAAgB,CAAC,GAAG,CAAC;uBACtC,qBAAqB,CAAC,gBAAgB,CAAC,cAAc,CAAC;cAC/D,qBAAqB,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;;;;oFAIJ,CAC/E,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC;YACpC,OAAO,EAAE,qEAAqE;YAC9E,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC;YAChC,OAAO,EAAE,+CAA+C;YACxD,WAAW,EAAE,oCAAoC;SAClD,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,cAAc,CAAC;IACxB,CAAC;CACF"}

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

@@ -0,0 +1,11 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+export declare class PortalGeneratePrompts {
+    private readonly spin;
+    overwritePortal(directory: DirectoryPath): Promise<boolean>;
+    displayPortalGenerationMessage(): void;
+    displayPortalGenerationSuccessMessage(): void;
+    displayPortalGenerationErrorMessage(): void;
+    displayOutroMessage(generatedPortalPath: string): void;
+    logError(error: string): void;
+    private cleanUpStandardInput;
+}

package/lib/prompts/portal/generate.js

@@ -0,0 +1,42 @@
+import { outro, spinner, isCancel, confirm, log } from "@clack/prompts";
+import { getMessageInRedColor, getMessageInMagentaColor, getMessageInCyanColor } from "../../utils/utils.js";
+export class PortalGeneratePrompts {
+    constructor() {
+        this.spin = spinner();
+    }
+    async overwritePortal(directory) {
+        const overwrite = await confirm({
+            message: `The destination '${directory}' is not empty, do you want to overwrite?`,
+            initialValue: false
+        });
+        if (isCancel(overwrite)) {
+            return false;
+        }
+        return overwrite;
+    }
+    displayPortalGenerationMessage() {
+        this.spin.start(getMessageInMagentaColor("Generating portal"));
+    }
+    displayPortalGenerationSuccessMessage() {
+        this.spin.stop(getMessageInCyanColor("Portal generated successfully."));
+        this.cleanUpStandardInput();
+    }
+    displayPortalGenerationErrorMessage() {
+        this.spin.stop(getMessageInRedColor(`Portal Generation failed.`), 1);
+        this.cleanUpStandardInput();
+    }
+    displayOutroMessage(generatedPortalPath) {
+        outro(`The generated portal can be found at ${generatedPortalPath}`);
+    }
+    logError(error) {
+        log.error(error);
+    }
+    //This clears the standard input to allow interrupts like CTRL+C to work properly.
+    cleanUpStandardInput() {
+        if (process.stdin.isTTY) {
+            process.stdin.setRawMode(false);
+            process.stdin.pause();
+        }
+    }
+}
+//# sourceMappingURL=generate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/prompts/portal/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAG7G,MAAM,OAAO,qBAAqB;IAAlC;QACmB,SAAI,GAAG,OAAO,EAAE,CAAC;IA4CpC,CAAC;IA1CQ,KAAK,CAAC,eAAe,CAAC,SAAwB;QACnD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;YAC9B,OAAO,EAAE,oBAAoB,SAAS,2CAA2C;YACjF,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,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,gCAAgC,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,mBAAmB,CAAC,mBAA2B;QAC7C,KAAK,CAAC,wCAAwC,mBAAmB,EAAE,CAAC,CAAC;IACvE,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAED,kFAAkF;IAC1E,oBAAoB;QAC1B,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAChC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;CACF"}

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

@@ -0,0 +1,30 @@
+import { BasePrompts } from "./common/base-prompts.js";
+export declare class PortalQuickstartPrompts extends BasePrompts {
+    private readonly vscodeExtensionUrl;
+    private readonly serverUrl;
+    private readonly referenceDocumentationUrl;
+    private readonly customizeTheSdksUrl;
+    private readonly defaultPortalDirectoryPath;
+    displayWelcomeMessage(): void;
+    loginPrompt(): Promise<{
+        email: string;
+        password: string;
+    }>;
+    removeQuotes(str: string): string;
+    specPrompt(): Promise<string>;
+    displaySpecValidationMessage(): void;
+    displaySpecValidationSuccessMessage(): void;
+    displaySpecValidationErrorMessage(): void;
+    displaySpecValidationFailureMessage(): void;
+    specValidationFailurePrompt(): Promise<void>;
+    sdkLanguagesPrompt(): Promise<string[]>;
+    workingDirectoryPrompt(): Promise<string>;
+    displayBuildDirectoryGenerationMessage(): void;
+    displayBuildDirectoryGenerationErrorMessage(): void;
+    displayBuildDirectoryGenerationSuccessMessage(targetFolder: string): void;
+    displayBuildDirectoryAsTree(targetFolder: string): void;
+    displayOutroMessage(buildDirectory: string): void;
+    getLoggedInFirst(): void;
+    displayLoggedInMessage(email: string): void;
+    logError(error: string): void;
+}

package/lib/prompts/portal/quickstart.js

@@ -0,0 +1,240 @@
+import fs from "fs";
+import * as path from "path";
+import treeify from "treeify";
+import { intro, outro, text, select, multiselect, log, isCancel, cancel, password } from "@clack/prompts";
+import { getMessageInCyanColor, getMessageInGreenColor, getMessageInOrangeColor, getMessageInMagentaColor, getMessageInRedColor, isValidUrl, directoryToJson } from "../../utils/utils.js";
+import { BasePrompts } from "./common/base-prompts.js";
+import axios from "axios";
+export class PortalQuickstartPrompts extends BasePrompts {
+    constructor() {
+        super(...arguments);
+        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/cli-getting-started/advanced-portal-setup\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() };
+    }
+    removeQuotes(str) {
+        const quotes = ['"', "'"];
+        for (const quote of quotes) {
+            if (str.startsWith(quote) && str.endsWith(quote) && str.length > 1) {
+                return this.removeQuotes(str.slice(1, -1)); // Recursive call
+            }
+        }
+        return str;
+    }
+    async specPrompt() {
+        log.step(getMessageInOrangeColor(`Step 1 of 4: Import your OpenAPI Definition`));
+        while (true) {
+            const spec = await text({
+                message: `Provide a local path or a public URL for your OpenAPI definition file:`,
+                placeholder: "Provide absolute URL/local path or press Enter to use a sample OpenAPI file from APIMatic.",
+                defaultValue: "https://raw.githubusercontent.com/apimatic/static-portal-workflow/refs/heads/master/spec/openapi.json",
+                validate: (input) => {
+                    var _a;
+                    if (!input)
+                        return;
+                    const cleanedPath = this.removeQuotes((_a = input.trim()) !== null && _a !== void 0 ? _a : "");
+                    if (!isValidUrl(cleanedPath)) {
+                        const dirPath = path.resolve(cleanedPath);
+                        if (!fs.existsSync(dirPath)) {
+                            return getMessageInRedColor("Error: The specified file does not exist. Please enter a valid file path.");
+                        }
+                        if (!fs.statSync(dirPath).isFile()) {
+                            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; // pass sync validation
+                },
+            });
+            if (isCancel(spec)) {
+                cancel("Operation cancelled.");
+                process.exit(0);
+            }
+            const cleanedPath = this.removeQuotes(String(spec).trim());
+            // Async validation for URLs
+            if (isValidUrl(cleanedPath)) {
+                try {
+                    const response = await axios.head(cleanedPath);
+                    const contentType = response.headers["content-type"];
+                    if (contentType === null || contentType === void 0 ? void 0 : contentType.includes("text/html")) {
+                        log.error(getMessageInRedColor(`Invalid URL. Please check the URL and ensure it points to a valid OpenAPI definition.`));
+                        continue; // re-prompt
+                    }
+                }
+                catch (err) {
+                    log.error(getMessageInRedColor(`Failed to reach the URL. Please check your internet connection or the URL.`));
+                    continue; // re-prompt
+                }
+            }
+            return cleanedPath; // valid local file or valid URL
+        }
+    }
+    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.`), 1);
+    }
+    displaySpecValidationFailureMessage() {
+        this.spin.stop(getMessageInRedColor(`❗ Oops, it looks like there are some errors in your API Definition.`), 1);
+    }
+    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 workingDirectoryPrompt() {
+        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 (Requires an empty directory):",
+            placeholder: "Provide absolute path to the directory or press Enter to use the current directory.",
+            defaultValue: "./",
+            validate: (input) => {
+                var _a;
+                const cleanedPath = this.removeQuotes((_a = input === null || input === void 0 ? void 0 : input.trim()) !== null && _a !== void 0 ? _a : "");
+                const dirPath = path.resolve(cleanedPath);
+                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)) {
+                    // For ignoring hidden files and folders in the current directory in MacOS.
+                    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.");
+                    }
+                }
+            }
+        });
+        if (isCancel(directory)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        if (directory === "./") {
+            return this.defaultPortalDirectoryPath;
+        }
+        else {
+            return this.removeQuotes(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.`), 1);
+    }
+    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.step(coloredLogString);
+    }
+    displayOutroMessage(buildDirectory) {
+        log.step(getMessageInCyanColor(`📢  Your API Portal is live at: ${this.serverUrl}\n`) +
+            getMessageInCyanColor(`Hot reload enabled! Edit files in ${buildDirectory} 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(`- Use the API Playground or an SDK to call your API.\n`) +
+            getMessageInCyanColor(`- Customize the Portal theme, add API recipes and enable AI features: ${this.referenceDocumentationUrl}`));
+    }
+    getLoggedInFirst() {
+        log.step("You need to be logged in to continue.");
+    }
+    displayLoggedInMessage(email) {
+        log.success(`Successfully logged in as ${email}`);
+    }
+    logError(error) {
+        log.error(error);
+    }
+}
+//# 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,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1G,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,oBAAoB,EACpB,UAAU,EACV,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,OAAO,uBAAwB,SAAQ,WAAW;IAAxD;;QACmB,uBAAkB,GACjC,+GAA+G,CAAC;QACjG,cAAS,GAAG,yCAAyC,CAAC;QACtD,8BAAyB,GACxC,sFAAsF,CAAC;QACxE,wBAAmB,GAClC,qGAAqG,CAAC;QACvF,+BAA0B,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA+S9D,CAAC;IA7SC,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;IAGD,YAAY,CAAC,GAAW;QACtB,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAE1B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnE,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB;YAC/D,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,CAAC,UAAU;QAChB,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,6CAA6C,CAAC,CAAC,CAAC;QAEjF,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;gBACtB,OAAO,EAAE,wEAAwE;gBACjF,WAAW,EAAE,4FAA4F;gBACzG,YAAY,EACV,uGAAuG;gBACzG,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;;oBAClB,IAAI,CAAC,KAAK;wBAAE,OAAO;oBAEnB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,MAAA,KAAK,CAAC,IAAI,EAAE,mCAAI,EAAE,CAAC,CAAC;oBAE1D,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;wBAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;wBAE1C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;4BAC5B,OAAO,oBAAoB,CAAC,2EAA2E,CAAC,CAAC;wBAC3G,CAAC;wBAED,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;4BACnC,OAAO,oBAAoB,CACzB,6IAA6I,CAC9I,CAAC;wBACJ,CAAC;oBACH,CAAC;oBAED,OAAO,CAAC,uBAAuB;gBACjC,CAAC;aACF,CAAC,CAAC;YAEH,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnB,MAAM,CAAC,sBAAsB,CAAC,CAAC;gBAC/B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAE3D,4BAA4B;YAC5B,IAAI,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC5B,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;oBAErD,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;wBACvC,GAAG,CAAC,KAAK,CACP,oBAAoB,CAClB,uFAAuF,CACxF,CACF,CAAC;wBACF,SAAS,CAAC,YAAY;oBACxB,CAAC;gBACH,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,GAAG,CAAC,KAAK,CACP,oBAAoB,CAAC,4EAA4E,CAAC,CACnG,CAAC;oBACF,SAAS,CAAC,YAAY;gBACxB,CAAC;YACH,CAAC;YAED,OAAO,WAAW,CAAC,CAAC,gCAAgC;QACtD,CAAC;IACH,CAAC;IAGC,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,wBAAwB,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,iCAAiC;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,kDAAkD,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED,mCAAmC;QACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,qEAAqE,CAAC,EAAE,CAAC,CAAC,CAAC;IACjH,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,sBAAsB;QAC1B,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,qDAAqD,CAAC,CAAC,CAAC;QAEzF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC;YAC3B,OAAO,EAAE,sGAAsG;YAC/G,WAAW,EAAE,qFAAqF;YAClG,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;;gBAClB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,EAAE,mCAAI,EAAE,CAAC,CAAC;gBAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAE1C,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,EAAE,CAAC;oBAClC,2EAA2E;oBAC3E,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;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,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,sCAAsC;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,+BAA+B,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,2CAA2C;QACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,6DAA6D,CAAC,EAAE,CAAC,CAAC,CAAC;IACzG,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,mBAAmB,CAAC,cAAsB;QACxC,GAAG,CAAC,IAAI,CACN,qBAAqB,CAAC,mCAAmC,IAAI,CAAC,SAAS,IAAI,CAAC;YAC5E,qBAAqB,CACnB,qCAAqC,cAAc,2DAA2D,CAC/G;YACD,qBAAqB,CAAC,kCAAkC,CAAC,CAC1D,CAAC;QACF,KAAK,CACH,qBAAqB,CAAC,gBAAgB,CAAC;YACvC,qBAAqB,CAAC,wDAAwD,CAAC;YAC/E,qBAAqB,CACnB,yEAAyE,IAAI,CAAC,yBAAyB,EAAE,CAC1G,CACF,CAAC;IACJ,CAAC;IAED,gBAAgB;QACd,GAAG,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAA;IACnD,CAAC;IAED,sBAAsB,CAAC,KAAa;QAClC,GAAG,CAAC,OAAO,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;CACF"}

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

@@ -0,0 +1,24 @@
+import treeify from "treeify";
+import { SdlEndpoint } from "../../../types/sdl/sdl.js";
+export declare class PortalRecipePrompts {
+    private readonly spin;
+    displayWelcomeMessage(): void;
+    recipeNamePrompt(): Promise<string>;
+    removeQuotes(str: string): 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,203 @@
+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: "This name will be displayed in your API Documentation portal sidebar.",
+            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();
+    }
+    //Todo: Find a better place for this function
+    removeQuotes(str) {
+        const quotes = ['"', "'"];
+        for (const quote of quotes) {
+            if (str.startsWith(quote) && str.endsWith(quote) && str.length > 1) {
+                return this.removeQuotes(str.slice(1, -1)); // Recursive call
+            }
+        }
+        return str;
+    }
+    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.";
+                }
+                const cleanedPath = this.removeQuotes(filePath.trim());
+                const resolvedPath = path.resolve(buildDirectoryPath, cleanedPath);
+                if (!resolvedPath.endsWith(".json")) {
+                    return "The content file must be a JSON (.json) file. Please provide a valid file path.";
+                }
+                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, this.removeQuotes(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 API 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" }
+            ],
+            initialValue: "yes"
+        });
+        if (isCancel(addAnotherStep)) {
+            cancel("Operation cancelled.");
+            return process.exit(0);
+        }
+        return addAnotherStep === "yes";
+    }
+    async overwriteApiRecipeInTocPrompt() {
+        const overwriteApiRecipeInToc = await select({
+            message: `⚠️  An API 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.message(`🎉 Your new API Recipe has been added to the source 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);
+    }
+    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;IAmPpC,CAAC;IAjPQ,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,uEAAuE;YACpF,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;IACD,6CAA6C;IAC7C,YAAY,CAAC,GAAW;QACtB,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAE1B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnE,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB;YAC/D,CAAC;QACH,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACM,KAAK,CAAC,yBAAyB,CAAC,kBAA0B;QAC/D,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC;YACrC,OAAO,EAAE,6DAA6D,kBAAkB,mFAAmF;YAC3K,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACrB,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,2EAA2E,CAAC;gBACrF,CAAC;gBACD,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBACvD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;gBAEnE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBACpC,OAAO,iFAAiF,CAAC;gBAC3F,CAAC;gBAGD,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,EAAE,IAAI,CAAC,YAAY,CAAE,mBAA8B,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACrG,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,kCAAkC,CAAC,CAAC;QAC7C,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;YACD,YAAY,EAAE,KAAK;SACpB,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,+EAA+E;YACxF,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,mCAAmC,CAAC,CAAC;IAChD,CAAC;IAEM,qCAAqC,CAAC,kBAA0B;QACrE,GAAG,CAAC,OAAO,CAAC,qEAAqE,kBAAkB,EAAE,CAAC,CAAC;QACvG,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;IAC1G,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;CACF"}