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

package/lib/actions/portal/copilot.js

@@ -0,0 +1,49 @@
+import { ApiService } from "../../infrastructure/services/api-service.js";
+import { PortalCopilotPrompts } from "../../prompts/portal/copilot.js";
+import { ActionResult } from "../action-result.js";
+import { BuildContext } from "../../types/build-context.js";
+export class CopilotAction {
+    constructor(configDir, authKey = null) {
+        this.apiService = new ApiService();
+        this.prompts = new PortalCopilotPrompts();
+        this.configDir = configDir;
+        this.authKey = authKey;
+    }
+    async execute(buildDirectory, enable) {
+        const buildContext = new BuildContext(buildDirectory);
+        if (!(await buildContext.validate())) {
+            return ActionResult.error("'src' directory is empty or not valid.");
+        }
+        const buildJson = await buildContext.getBuildFileContents();
+        if (buildJson.apiCopilotConfig != null && !(await this.prompts.confirmOverwrite()))
+            return ActionResult.error("Exiting without making any change.");
+        const response = await this.apiService.getAccountInfo(this.configDir, this.authKey);
+        if (response.isErr()) {
+            return ActionResult.error(response._unsafeUnwrapErr());
+        }
+        const apiCopilotKey = await this.selectCopilotKey(response._unsafeUnwrap());
+        if (apiCopilotKey === null) {
+            return ActionResult.error("No copilot key found for the current subscription. Please contact support at support@apimatic.io.");
+        }
+        const welcomeMessage = await this.prompts.getWelcomeMessage();
+        if (welcomeMessage === undefined)
+            return ActionResult.error("Exiting without making any change.");
+        buildJson.apiCopilotConfig = {
+            isEnabled: enable,
+            key: apiCopilotKey,
+            welcomeMessage: welcomeMessage
+        };
+        await buildContext.updateBuildFileContents(buildJson);
+        this.prompts.copilotConfigured(buildJson.apiCopilotConfig);
+        return ActionResult.success();
+    }
+    async selectCopilotKey(subscription) {
+        if (subscription === undefined ||
+            subscription.ApiCopilotKeys === undefined ||
+            subscription.ApiCopilotKeys.length === 0) {
+            return null;
+        }
+        return await this.prompts.selectCopilotKey(subscription.ApiCopilotKeys);
+    }
+}
+//# sourceMappingURL=copilot.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"copilot.js","sourceRoot":"","sources":["../../../src/actions/portal/copilot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8CAA8C,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,MAAM,OAAO,aAAa;IAMxB,YAAY,SAAwB,EAAE,UAAyB,IAAI;QALlD,eAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,YAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAKpD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,cAA6B,EAAE,MAAe;QACjE,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;QAEtD,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACrC,OAAO,YAAY,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,oBAAoB,EAAE,CAAC;QAE5D,IAAI,SAAS,CAAC,gBAAgB,IAAI,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAChF,OAAO,YAAY,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpF,IAAI,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;YACrB,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;QAC5E,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;YAC3B,OAAO,YAAY,CAAC,KAAK,CAAC,mGAAmG,CAAC,CAAC;QACjI,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC9D,IAAI,cAAc,KAAK,SAAS;YAC9B,OAAO,YAAY,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAElE,SAAS,CAAC,gBAAgB,GAAG;YAC3B,SAAS,EAAE,MAAM;YACjB,GAAG,EAAE,aAAa;YAClB,cAAc,EAAE,cAAc;SAC/B,CAAC;QAEF,MAAM,YAAY,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;QAEtD,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC3D,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,YAA0C;QACvE,IACE,YAAY,KAAK,SAAS;YAC1B,YAAY,CAAC,cAAc,KAAK,SAAS;YACzC,YAAY,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EACxC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC;CACF"}

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

@@ -0,0 +1,13 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+export declare class GenerateAction {
+    private readonly prompts;
+    private readonly zipArchiver;
+    private readonly fileService;
+    private readonly portalService;
+    private readonly configDir;
+    private readonly authKey;
+    constructor(configDir: DirectoryPath, authKey?: string | null);
+    readonly execute: (buildDirectory: DirectoryPath, portalDirectory: DirectoryPath, force: boolean, zipPortal: boolean) => Promise<ActionResult>;
+    private parseError;
+}

package/lib/actions/portal/generate.js

@@ -0,0 +1,61 @@
+import { PortalGeneratePrompts } from "../../prompts/portal/generate.js";
+import { ZipService } from "../../infrastructure/zip-service.js";
+import { FileService } from "../../infrastructure/file-service.js";
+import { PortalService } from "../../infrastructure/services/portal-service.js";
+import { FilePath } from "../../types/file/filePath.js";
+import { FileName } from "../../types/file/fileName.js";
+import { ActionResult } from "../action-result.js";
+import { BuildContext } from "../../types/build-context.js";
+import { PortalContext } from "../../types/portal-context.js";
+import { withDirPath } from "../../infrastructure/tmp-extensions.js";
+export class GenerateAction {
+    constructor(configDir, authKey = null) {
+        this.prompts = new PortalGeneratePrompts();
+        this.zipArchiver = new ZipService();
+        this.fileService = new FileService();
+        this.portalService = new PortalService();
+        this.execute = async (buildDirectory, portalDirectory, force, zipPortal) => {
+            if (buildDirectory.isEqual(portalDirectory)) {
+                return ActionResult.error(`The 'src' and 'portal' directory cannot be the same: "${portalDirectory}"`);
+            }
+            const buildContext = new BuildContext(buildDirectory);
+            if (!await buildContext.validate()) {
+                return ActionResult.error(`The 'src' directory is either empty or invalid: "${buildDirectory}"`);
+            }
+            const portalContext = new PortalContext(portalDirectory);
+            if (!force && (await portalContext.exists()) && !(await this.prompts.overwritePortal(portalDirectory))) {
+                return ActionResult.error("Please enter a different destination folder or remove the existing files and try again.");
+            }
+            return await withDirPath(async (tempDirectory) => {
+                this.prompts.displayPortalGenerationMessage();
+                const buildZipPath = new FilePath(tempDirectory, new FileName("build.zip"));
+                await this.zipArchiver.archive(buildDirectory, buildZipPath);
+                const response = await this.portalService.generatePortal(buildZipPath, this.configDir, this.authKey);
+                if (!response.isSuccess()) {
+                    this.prompts.displayPortalGenerationErrorMessage();
+                    return ActionResult.error(await this.parseError(response.error, portalDirectory, tempDirectory));
+                }
+                const tempPortalFilePath = new FilePath(tempDirectory, new FileName("portal.zip"));
+                await this.fileService.writeFile(tempPortalFilePath, response.value);
+                await portalContext.save(tempPortalFilePath, zipPortal);
+                this.prompts.displayPortalGenerationSuccessMessage();
+                return ActionResult.success();
+            });
+        };
+        this.configDir = configDir;
+        this.authKey = authKey;
+    }
+    async parseError(error, portalDirectory, tempDirectory) {
+        if (typeof error === 'string') {
+            return error;
+        }
+        const tempErrorFilePath = new FilePath(tempDirectory, new FileName("error.zip"));
+        await this.fileService.writeFile(tempErrorFilePath, error);
+        await this.fileService.cleanDirectory(portalDirectory);
+        await this.zipArchiver.unArchive(tempErrorFilePath, portalDirectory);
+        const errorReportPath = portalDirectory.join("apimatic-debug");
+        return "An error occurred during portal generation due to an issue with the input. An error report has been written at the destination path: " +
+            errorReportPath;
+    }
+}
+//# sourceMappingURL=generate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/actions/portal/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAEhF,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAGrE,MAAM,OAAO,cAAc;IAQzB,YAAY,SAAwB,EAAE,UAAyB,IAAI;QAPlD,YAAO,GAA0B,IAAI,qBAAqB,EAAE,CAAC;QAC7D,gBAAW,GAAe,IAAI,UAAU,EAAE,CAAC;QAC3C,gBAAW,GAAgB,IAAI,WAAW,EAAE,CAAC;QAC7C,kBAAa,GAAkB,IAAI,aAAa,EAAE,CAAC;QASpD,YAAO,GAAG,KAAK,EAC7B,cAA6B,EAC7B,eAA8B,EAC9B,KAAc,EACd,SAAkB,EACK,EAAE;YAEzB,IAAI,cAAc,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;gBAC5C,OAAO,YAAY,CAAC,KAAK,CAAC,yDAAyD,eAAe,GAAG,CAAC,CAAC;YACzG,CAAC;YAED,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACnC,OAAO,YAAY,CAAC,KAAK,CAAC,oDAAoD,cAAc,GAAG,CAAC,CAAC;YACnG,CAAC;YAED,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,eAAe,CAAC,CAAC;YACzD,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,aAAa,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC;gBACvG,OAAO,YAAY,CAAC,KAAK,CACvB,yFAAyF,CAC1F,CAAC;YACJ,CAAC;YAED,OAAO,MAAM,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC/C,IAAI,CAAC,OAAO,CAAC,8BAA8B,EAAE,CAAC;gBAE9C,MAAM,YAAY,GAAG,IAAI,QAAQ,CAAC,aAAa,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC5E,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;gBAE7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAErG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC1B,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,CAAC;oBACnD,OAAO,YAAY,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAM,EAAE,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC;gBACpG,CAAC;gBAED,MAAM,kBAAkB,GAAG,IAAI,QAAQ,CAAC,aAAa,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;gBACnF,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,kBAAkB,EAAyB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAE5F,MAAM,aAAa,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC;gBACxD,IAAI,CAAC,OAAO,CAAC,qCAAqC,EAAE,CAAC;gBAErD,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAA;QAhDC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAgDO,KAAK,CAAC,UAAU,CAAC,KAAqC,EAAE,eAA8B,EAAE,aAA4B;QAC1H,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,QAAQ,CAAC,aAAa,EAAE,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;QACjF,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,iBAAiB,EAAyB,KAAK,CAAC,CAAC;QAElF,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;QACvD,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QAErE,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC/D,OAAO,uIAAuI;YAC5I,eAAe,CAAC;IACpB,CAAC;CACF"}

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

@@ -0,0 +1,24 @@
+import { Result } from "../../../types/common/result.js";
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+export declare class PortalRecipeAction {
+    private readonly prompts;
+    private readonly sdlParser;
+    private readonly BUILD_FILE_NAME;
+    constructor();
+    createRecipe(buildDirectoryPath: DirectoryPath, configDir: string, name?: string): Promise<Result<string, string>>;
+    private createRecipeFileName;
+    private toPascalCase;
+    private validateBuildDirectoryPath;
+    private promptUserAndBuildNewRecipe;
+    private promptUserAndAddContentStepToRecipe;
+    private promptUserAndAddEndpointStepToRecipe;
+    private parseTocFile;
+    private createPermalink;
+    private getBuildConfigFilePath;
+    private parseBuildConfig;
+    private checkRecipeAlreadyExists;
+    private getBuildDirectoryStructure;
+    private extractEndpointGroupsFromSdl;
+    private getSpecFolderPath;
+    private getContentFolderPath;
+}

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

@@ -0,0 +1,250 @@
+import * as path from "path";
+import fs from "fs";
+import fsExtra from "fs-extra";
+import { parse } from "yaml";
+import { tmpdir } from "os";
+import { execa } from "execa";
+import { PortalRecipePrompts } from "../../../prompts/portal/recipe/new-recipe.js";
+import { StepType } from "../../../types/recipe/recipe.js";
+import { Result } from "../../../types/common/result.js";
+import { PortalRecipe } from "../../../application/portal/recipe/portal-recipe.js";
+import { PortalRecipeGenerator } from "../../../application/portal/recipe/recipe-generator.js";
+import { SdlParser } from "../../../application/portal/toc/sdl-parser.js";
+import { PortalService } from "../../../infrastructure/services/portal-service.js";
+export class PortalRecipeAction {
+    constructor() {
+        this.BUILD_FILE_NAME = "APIMATIC-BUILD.json";
+        this.prompts = new PortalRecipePrompts();
+        this.sdlParser = new SdlParser(new PortalService());
+    }
+    async createRecipe(buildDirectoryPath, configDir, name) {
+        this.prompts.displayWelcomeMessage();
+        const recipeName = name !== null && name !== void 0 ? name : (await this.prompts.recipeNamePrompt());
+        const recipeFileName = this.createRecipeFileName(recipeName);
+        const validateBuildDirectoryPathResult = await this.validateBuildDirectoryPath(buildDirectoryPath);
+        if (validateBuildDirectoryPathResult.isFailed()) {
+            return Result.failure(`Unable to generate API Recipe: ${validateBuildDirectoryPathResult.error}`);
+        }
+        //TODO: Create a type for the build config and use that here instead of any.
+        const buildConfigFilePath = await this.getBuildConfigFilePath(buildDirectoryPath);
+        const buildConfigResult = await this.parseBuildConfig(buildConfigFilePath);
+        if (buildConfigResult.isFailed()) {
+            return Result.failure(`Unable to generate API Recipe: ${buildConfigResult.error}`);
+        }
+        const contentFolderPath = this.getContentFolderPath(buildConfigResult.value, buildDirectoryPath);
+        const tocFilePath = path.join(contentFolderPath, "content", "toc.yml");
+        //TODO: Replace any type of tocFileResult.value to concrete type.
+        const tocFileResult = await this.parseTocFile(tocFilePath);
+        if (tocFileResult.isFailed()) {
+            return Result.failure(`Unable to generate API Recipe: ${tocFileResult.error}`);
+        }
+        const recipeAlreadyExists = this.checkRecipeAlreadyExists(tocFileResult.value, recipeName, recipeFileName);
+        if (recipeAlreadyExists && !(await this.prompts.overwriteApiRecipeInTocPrompt())) {
+            return Result.cancelled("Operation was cancelled by the user.");
+        }
+        const recipeResult = await this.promptUserAndBuildNewRecipe(buildConfigResult.value, contentFolderPath, recipeName, configDir);
+        if (recipeResult.isFailed()) {
+            return Result.failure(`Unable to generate API Recipe: ${recipeResult.error}`);
+        }
+        const recipeGenerator = new PortalRecipeGenerator();
+        await recipeGenerator.createRecipe(recipeResult.value, buildConfigResult.value, tocFileResult.value, tocFilePath, recipeName, recipeFileName, buildConfigFilePath, contentFolderPath);
+        const buildDirectoryStructure = await this.getBuildDirectoryStructure(recipeFileName);
+        this.prompts.displayBuildDirectoryStructureAsTree(buildDirectoryStructure);
+        this.prompts.displayRecipeGenerationSuccessMessage(contentFolderPath);
+        return Result.success("Generated recipe successfully.");
+    }
+    createRecipeFileName(recipeName) {
+        return this.toPascalCase(recipeName.trim());
+    }
+    toPascalCase(str) {
+        return str
+            .split(" ")
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+            .join("");
+    }
+    async validateBuildDirectoryPath(buildDirectoryPath) {
+        if (!(await fsExtra.pathExists(buildDirectoryPath.toString()))) {
+            return Result.failure(`Portal build input folder ${buildDirectoryPath.toString()} does not exist.`);
+        }
+        return Result.success("Portal build input folder path validated successfully.");
+    }
+    //TODO: Figure out a better way to do this without the while loop.
+    async promptUserAndBuildNewRecipe(buildConfig, contentFolderPath, recipeName, configDir) {
+        const recipe = new PortalRecipe(recipeName);
+        let endpointGroups;
+        let idx = 1;
+        let addAnotherStep = true;
+        this.prompts.displayStepsInformation();
+        while (addAnotherStep) {
+            const stepType = await this.prompts.stepTypeSelectionPrompt();
+            const stepName = await this.prompts.stepNamePrompt("Step " + idx);
+            switch (stepType) {
+                case StepType.Content: {
+                    const addContentStepResult = await this.promptUserAndAddContentStepToRecipe(recipe, stepName);
+                    if (addContentStepResult.isFailed()) {
+                        return Result.failure(addContentStepResult.error);
+                    }
+                    break;
+                }
+                case StepType.Endpoint: {
+                    if (!endpointGroups) {
+                        const extractEndpointGroupsFromSdlResult = await this.extractEndpointGroupsFromSdl(buildConfig, contentFolderPath, configDir);
+                        if (extractEndpointGroupsFromSdlResult.isFailed()) {
+                            return Result.failure(`${extractEndpointGroupsFromSdlResult.error}`);
+                        }
+                        endpointGroups = extractEndpointGroupsFromSdlResult.value;
+                    }
+                    await this.promptUserAndAddEndpointStepToRecipe(recipe, endpointGroups, stepName);
+                    break;
+                }
+            }
+            addAnotherStep = await this.prompts.addAnotherStepSelectionPrompt();
+            idx++;
+        }
+        return Result.success(recipe.toSerializableRecipe());
+    }
+    async promptUserAndAddContentStepToRecipe(recipe, stepName) {
+        this.prompts.displayContentStepInfo();
+        let editor = process.env.EDITOR;
+        let editorArgs = [];
+        const tempFilePath = path.join(tmpdir(), `recipe-markdown-content-${Date.now()}.txt`);
+        const template = `# The Heading Goes Here\n\nThis is placeholder text for your API Recipe content step. Feel free to edit this. Save your changes and then close the file once you're done.`;
+        await fsExtra.writeFile(tempFilePath, template, "utf-8");
+        try {
+            if (!editor) {
+                if (process.platform === "win32") {
+                    await execa("cmd", ["/c", "start", "/wait", "notepad", tempFilePath], { stdio: "ignore" });
+                }
+                else if (process.platform === "darwin" || process.platform === "linux") {
+                    editor = "vim";
+                    try {
+                        await execa(editor, [tempFilePath], { stdio: "inherit" });
+                    }
+                    catch (_a) {
+                        // User exiting vim can throw a non-zero exit code leading to exception, ignore it.
+                    }
+                }
+            }
+            else {
+                if (editor === "code" || editor.endsWith("code.cmd") || editor.endsWith("code.exe")) {
+                    editorArgs.push("--wait");
+                }
+                editorArgs.push(tempFilePath);
+                await execa(editor, editorArgs, { stdio: "ignore" });
+            }
+            const fileContent = await fsExtra.readFile(tempFilePath, "utf-8");
+            recipe.addContentStep(stepName, stepName, fileContent);
+            this.prompts.displayStepAddedSuccessfullyMessage();
+            return Result.success("Added content step successfully.");
+        }
+        catch (error) {
+            return Result.failure(`Unable to add content step. Please try again later.`);
+        }
+        finally {
+            await fsExtra.unlink(tempFilePath);
+        }
+    }
+    async promptUserAndAddEndpointStepToRecipe(recipe, endpointGroups, stepName) {
+        const endpointGroupName = await this.prompts.endpointGroupNamePrompt(endpointGroups);
+        const endpointName = await this.prompts.endpointNamePrompt(endpointGroups, endpointGroupName);
+        const description = await this.prompts.endpointDescriptionPrompt(endpointGroups, endpointGroupName, endpointName);
+        const endpointPermalink = await this.createPermalink([endpointGroupName, endpointName]);
+        recipe.addEndpointStep(stepName, stepName, description, endpointPermalink);
+        this.prompts.displayStepAddedSuccessfullyMessage();
+    }
+    //TODO: Replace any with concrete toc file object.
+    async parseTocFile(tocFilePath) {
+        // Check if the file exists
+        if (!fs.existsSync(tocFilePath)) {
+            return Result.failure(`toc.yml file not found at ${tocFilePath}. Please run 'apimatic:toc:new' to create your toc.yml file first.`);
+        }
+        try {
+            const tocContent = await fs.promises.readFile(tocFilePath, "utf-8");
+            return Result.success(parse(tocContent));
+        }
+        catch (_a) {
+            return Result.failure(`Unable to parse the toc.yml file located at ${tocFilePath}. Please make sure that the toc.yml is a valid YAML file.`);
+        }
+    }
+    async createPermalink(pathPieces) {
+        return `$e/${pathPieces.map(encodeURIComponent).join("/")}`;
+    }
+    async getBuildConfigFilePath(buildDirectoryPath) {
+        const files = await fs.promises.readdir(buildDirectoryPath.toString());
+        const buildFileExists = files.find((file) => file === this.BUILD_FILE_NAME);
+        if (!buildFileExists) {
+            return await this.prompts.buildConfigFilePathPrompt(buildDirectoryPath.toString());
+        }
+        return path.join(buildDirectoryPath.toString(), this.BUILD_FILE_NAME);
+    }
+    //TODO: Create a type for the build config and use that here instead of any.
+    async parseBuildConfig(buildConfigFilePath) {
+        try {
+            const fileData = await fs.promises.readFile(buildConfigFilePath, "utf-8");
+            return Result.success(JSON.parse(fileData));
+        }
+        catch (_a) {
+            return Result.failure(`There was an error parsing the build config file located at "${buildConfigFilePath}". Please check your build config file and try again later.`);
+        }
+    }
+    checkRecipeAlreadyExists(tocData, recipeName, recipeFileName) {
+        var _a;
+        let apiRecipesGroup = (_a = tocData.toc) === null || _a === void 0 ? void 0 : _a.find((item) => item.group === "API Recipes");
+        if (!apiRecipesGroup) {
+            return false;
+        }
+        // Check if recipe name or file name already exists
+        const existingRecipe = apiRecipesGroup.items.find((item) => item.page === recipeName || item.file === `recipes/${recipeFileName}.md`);
+        if (existingRecipe) {
+            return true;
+        }
+        return false;
+    }
+    async getBuildDirectoryStructure(recipeFileName) {
+        return {
+            content: {
+                "toc.yml : # Contains the API Recipes group with a new page for your API recipe": null
+            },
+            static: {
+                scripts: {
+                    recipes: {
+                        [`${recipeFileName}.js : # Generated recipe script file containing all of the steps`]: null
+                    }
+                }
+            }
+        };
+    }
+    async extractEndpointGroupsFromSdl(buildConfig, contentFolderPath, configDir) {
+        const specFolderPath = this.getSpecFolderPath(buildConfig, contentFolderPath);
+        if (!(await fsExtra.pathExists(specFolderPath))) {
+            return Result.failure(`API specification file not found at ${specFolderPath}.`);
+        }
+        this.prompts.startProgressIndicatorWithMessage("Extracting endpoint groups and endpoints from the API specification.");
+        const endpointGroupsResult = await this.sdlParser.getEndpointGroupsFromSdl(specFolderPath, configDir);
+        if (endpointGroupsResult.isFailed()) {
+            this.prompts.stopProgressIndicatorWithMessage("Unable to extract endpoints from your API specification.");
+            return Result.failure(`${endpointGroupsResult.error}`);
+        }
+        this.prompts.stopProgressIndicatorWithMessage("Successfully extracted endpoint groups and endpoints from the API specification.");
+        return Result.success(endpointGroupsResult.value);
+    }
+    //TODO: Replace type of buildConfig from any to actual BuildConfig type after creating it.
+    getSpecFolderPath(buildConfig, contentFolderPath) {
+        var _a;
+        const apiSpecPath = (_a = buildConfig.generatePortal) === null || _a === void 0 ? void 0 : _a.apiSpecPath;
+        if (apiSpecPath) {
+            return path.join(contentFolderPath, apiSpecPath);
+        }
+        return path.join(contentFolderPath, "spec");
+    }
+    //TODO: Replace type of buildConfig from any to actual BuildConfig type after creating it.
+    getContentFolderPath(buildConfig, buildDirectoryPath) {
+        var _a;
+        const contentFolder = (_a = buildConfig.generatePortal) === null || _a === void 0 ? void 0 : _a.contentFolder;
+        if (contentFolder) {
+            return path.join(buildDirectoryPath.toString(), contentFolder);
+        }
+        return buildDirectoryPath.toString();
+    }
+}
+//# sourceMappingURL=new-recipe.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"new-recipe.js","sourceRoot":"","sources":["../../../../src/actions/portal/recipe/new-recipe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AACnF,OAAO,EAAsB,QAAQ,EAAiB,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,qDAAqD,CAAC;AACnF,OAAO,EAAE,qBAAqB,EAAE,MAAM,wDAAwD,CAAC;AAC/F,OAAO,EAAE,SAAS,EAAE,MAAM,+CAA+C,CAAC;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,oDAAoD,CAAC;AAInF,MAAM,OAAO,kBAAkB;IAK7B;QAFiB,oBAAe,GAAW,qBAAqB,CAAC;QAG/D,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;IACtD,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,kBAAiC,EACjC,SAAiB,EACjB,IAAa;QAEb,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAErC,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnE,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAE7D,MAAM,gCAAgC,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,kBAAkB,CAAC,CAAC;QACnG,IAAI,gCAAgC,CAAC,QAAQ,EAAE,EAAE,CAAC;YAChD,OAAO,MAAM,CAAC,OAAO,CAAC,kCAAkC,gCAAgC,CAAC,KAAM,EAAE,CAAC,CAAC;QACrG,CAAC;QAED,4EAA4E;QAC5E,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;QAClF,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAC3E,IAAI,iBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC;YACjC,OAAO,MAAM,CAAC,OAAO,CAAC,kCAAkC,iBAAiB,CAAC,KAAM,EAAE,CAAC,CAAC;QACtF,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;QACjG,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACvE,iEAAiE;QACjE,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,aAAa,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,kCAAkC,aAAa,CAAC,KAAM,EAAE,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;QAC3G,IAAI,mBAAmB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,CAAC,EAAE,CAAC;YACjF,OAAO,MAAM,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAClE,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,2BAA2B,CACzD,iBAAiB,CAAC,KAAK,EACvB,iBAAiB,EACjB,UAAU,EACV,SAAS,CACV,CAAC;QACF,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC5B,OAAO,MAAM,CAAC,OAAO,CAAC,kCAAkC,YAAY,CAAC,KAAM,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACpD,MAAM,eAAe,CAAC,YAAY,CAChC,YAAY,CAAC,KAAM,EACnB,iBAAiB,CAAC,KAAM,EACxB,aAAa,CAAC,KAAK,EACnB,WAAW,EACX,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,iBAAiB,CAClB,CAAC;QAEF,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAEtF,IAAI,CAAC,OAAO,CAAC,oCAAoC,CAAC,uBAAqC,CAAC,CAAC;QACzF,IAAI,CAAC,OAAO,CAAC,qCAAqC,CAAC,iBAAiB,CAAC,CAAC;QACtE,OAAO,MAAM,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAC1D,CAAC;IAEO,oBAAoB,CAAC,UAAkB;QAC7C,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAEO,YAAY,CAAC,GAAW;QAC9B,OAAO,GAAG;aACP,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;aACzE,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,kBAAiC;QACxE,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC;YAC/D,OAAO,MAAM,CAAC,OAAO,CAAC,6BAA6B,kBAAkB,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACtG,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,wDAAwD,CAAC,CAAC;IAClF,CAAC;IAED,kEAAkE;IAC1D,KAAK,CAAC,2BAA2B,CACvC,WAAgB,EAChB,iBAAyB,EACzB,UAAkB,EAClB,SAAiB;QAEjB,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,cAAsD,CAAC;QAC3D,IAAI,GAAG,GAAW,CAAC,CAAC;QACpB,IAAI,cAAc,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACvC,OAAO,cAAc,EAAE,CAAC;YACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC;YAClE,QAAQ,QAAQ,EAAE,CAAC;gBACjB,KAAK,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;oBACtB,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,mCAAmC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAC9F,IAAI,oBAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC;wBACpC,OAAO,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAM,CAAC,CAAC;oBACrD,CAAC;oBACD,MAAM;gBACR,CAAC;gBACD,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACvB,IAAI,CAAC,cAAc,EAAE,CAAC;wBACpB,MAAM,kCAAkC,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAChF,WAAW,EACX,iBAAiB,EACjB,SAAS,CACV,CAAC;wBACF,IAAI,kCAAkC,CAAC,QAAQ,EAAE,EAAE,CAAC;4BAClD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,kCAAkC,CAAC,KAAM,EAAE,CAAC,CAAC;wBACxE,CAAC;wBACD,cAAc,GAAG,kCAAkC,CAAC,KAAM,CAAC;oBAC7D,CAAC;oBACD,MAAM,IAAI,CAAC,oCAAoC,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;oBAClF,MAAM;gBACR,CAAC;YACH,CAAC;YACD,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,CAAC;YACpE,GAAG,EAAE,CAAC;QACR,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,mCAAmC,CAC/C,MAAoB,EACpB,QAAgB;QAEhB,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACtC,IAAI,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;QAChC,IAAI,UAAU,GAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,2BAA2B,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACtF,MAAM,QAAQ,GAAG,2KAA2K,CAAC;QAC7L,MAAM,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEzD,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;oBACjC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC7F,CAAC;qBAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;oBACzE,MAAM,GAAG,KAAK,CAAC;oBACf,IAAI,CAAC;wBACH,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;oBAC5D,CAAC;oBAAC,WAAM,CAAC;wBACP,mFAAmF;oBACrF,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,MAAM,KAAK,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBACpF,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC5B,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC9B,MAAM,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAClE,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;YAEvD,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,CAAC;YACnD,OAAO,MAAM,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,MAAM,CAAC,OAAO,CAAC,qDAAqD,CAAC,CAAC;QAC/E,CAAC;gBAAS,CAAC;YACT,MAAM,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,oCAAoC,CAChD,MAAoB,EACpB,cAA0C,EAC1C,QAAgB;QAEhB,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;QAC9F,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,cAAc,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;QAClH,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC,CAAC;QACxF,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;QAC3E,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,CAAC;IACrD,CAAC;IAED,kDAAkD;IAC1C,KAAK,CAAC,YAAY,CAAC,WAAmB;QAC5C,2BAA2B;QAC3B,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,OAAO,MAAM,CAAC,OAAO,CACnB,6BAA6B,WAAW,oEAAoE,CAC7G,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACpE,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3C,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,MAAM,CAAC,OAAO,CACnB,+CAA+C,WAAW,2DAA2D,CACtH,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,UAAoB;QAChD,OAAO,MAAM,UAAU,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC9D,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,kBAAiC;QACpE,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,eAAe,CAAC,CAAC;QAC5E,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrF,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IACxE,CAAC;IAED,4EAA4E;IACpE,KAAK,CAAC,gBAAgB,CAAC,mBAA2B;QACxD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YAC1E,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9C,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,MAAM,CAAC,OAAO,CACnB,gEAAgE,mBAAmB,6DAA6D,CACjJ,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,wBAAwB,CAAC,OAAY,EAAE,UAAkB,EAAE,cAAsB;;QACvF,IAAI,eAAe,GAAG,MAAA,OAAO,CAAC,GAAG,0CAAE,IAAI,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,CAAC;QACrF,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mDAAmD;QACnD,MAAM,cAAc,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAC/C,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,cAAc,KAAK,CACxF,CAAC;QACF,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,cAAsB;QAC7D,OAAO;YACL,OAAO,EAAE;gBACP,gFAAgF,EAAE,IAAI;aACvF;YACD,MAAM,EAAE;gBACN,OAAO,EAAE;oBACP,OAAO,EAAE;wBACP,CAAC,GAAG,cAAc,kEAAkE,CAAC,EAAE,IAAI;qBAC5F;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,4BAA4B,CACxC,WAAgB,EAChB,iBAAyB,EACzB,SAAiB;QAEjB,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;QAC9E,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;YAChD,OAAO,MAAM,CAAC,OAAO,CAAC,uCAAuC,cAAc,GAAG,CAAC,CAAC;QAClF,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,iCAAiC,CAC5C,sEAAsE,CACvE,CAAC;QAEF,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAEtG,IAAI,oBAAoB,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC,0DAA0D,CAAC,CAAC;YAC1G,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,oBAAoB,CAAC,KAAM,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAC3C,kFAAkF,CACnF,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAM,CAAC,CAAC;IACrD,CAAC;IAED,0FAA0F;IAClF,iBAAiB,CAAC,WAAgB,EAAE,iBAAyB;;QACnE,MAAM,WAAW,GAAG,MAAA,WAAW,CAAC,cAAc,0CAAE,WAAW,CAAC;QAC5D,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,0FAA0F;IAClF,oBAAoB,CAAC,WAAgB,EAAE,kBAAiC;;QAC9E,MAAM,aAAa,GAAG,MAAA,WAAW,CAAC,cAAc,0CAAE,aAAa,CAAC;QAChE,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,kBAAkB,CAAC,QAAQ,EAAE,CAAC;IACvC,CAAC;CACF"}

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

@@ -0,0 +1,14 @@
+import { PortalServePrompts } from "../../prompts/portal/serve.js";
+import { ServeFlags, ServePaths } from "../../types/portal/serve.js";
+import { ServeHandler } from "../../application/portal/serve/serve-handler.js";
+import { Result } from "../../types/common/result.js";
+import { PortalService } from "../../infrastructure/services/portal-service.js";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+export declare class PortalServeAction {
+    protected readonly prompts: PortalServePrompts;
+    protected readonly serveHandler: ServeHandler;
+    protected readonly docsPortalService: PortalService;
+    constructor(prompts: PortalServePrompts, serveHandler: ServeHandler, docsPortalService: PortalService);
+    servePortal(flags: ServeFlags, paths: ServePaths, generatePortal: (buildDirectory: DirectoryPath, portalDirectory: DirectoryPath, force: boolean, zipPortal: boolean) => Promise<ActionResult>): Promise<Result<string, string>>;
+}

package/lib/actions/portal/serve.js

@@ -0,0 +1,24 @@
+import { Result } from "../../types/common/result.js";
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+export class PortalServeAction {
+    constructor(prompts, serveHandler, docsPortalService) {
+        this.prompts = prompts;
+        this.serveHandler = serveHandler;
+        this.docsPortalService = docsPortalService;
+    }
+    async servePortal(flags, paths, generatePortal) {
+        const result = await generatePortal(new DirectoryPath(paths.sourceDirectoryPath), new DirectoryPath(paths.destinationDirectoryPath), false, false);
+        return result.mapAll(async () => {
+            const setupServerResult = await this.serveHandler.setupServer(paths.destinationDirectoryPath);
+            if (setupServerResult.isFailed()) {
+                return Result.failure(setupServerResult.error);
+            }
+            const startServerResult = await this.serveHandler.startServer(paths, flags, generatePortal);
+            if (startServerResult.isFailed()) {
+                return Result.failure(startServerResult.error);
+            }
+            return Result.success(`Portal was successfully served.`);
+        }, async (message) => Result.failure(message));
+    }
+}
+//# sourceMappingURL=serve.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"serve.js","sourceRoot":"","sources":["../../../src/actions/portal/serve.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAGlE,MAAM,OAAO,iBAAiB;IAK5B,YAAmB,OAA2B,EAAE,YAA0B,EAAE,iBAAgC;QAC1G,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,WAAW,CACtB,KAAiB,EACjB,KAAiB,EACjB,cAK0B;QAE1B,MAAM,MAAM,GAAG,MAAM,cAAc,CACjC,IAAI,aAAa,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAC5C,IAAI,aAAa,CAAC,KAAK,CAAC,wBAAwB,CAAC,EACjD,KAAK,EACL,KAAK,CACN,CAAC;QAEF,OAAO,MAAM,CAAC,MAAM,CAClB,KAAK,IAAI,EAAE;YACT,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC9F,IAAI,iBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAM,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YAC5F,IAAI,iBAAiB,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjC,OAAO,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAM,CAAC,CAAC;YAClD,CAAC;YAED,OAAO,MAAM,CAAC,OAAO,CAAC,iCAAiC,CAAC,CAAC;QAC3D,CAAC,EACD,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAC3C,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,20 @@
+import { Result } from "../../../types/common/result.js";
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+export declare class PortalNewTocAction {
+    private readonly prompts;
+    private readonly sdlParser;
+    private readonly tocGenerator;
+    private readonly contentParser;
+    private readonly DEFAULT_TOC_FILENAME;
+    private readonly APIMATIC_BUILD_FILENAME;
+    constructor();
+    createToc(buildDirectory: DirectoryPath, configDir: string, tocDirectory?: DirectoryPath, force?: boolean, expandEndpoints?: boolean, expandModels?: boolean): Promise<Result<string, string>>;
+    private writeToc;
+    private handleExistingToc;
+    private extractSdlComponents;
+    private extractContentGroups;
+    private getDestinationPath;
+    private checkExistingToc;
+    private getContentFolderPath;
+    private getSpecFolderPath;
+}

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

@@ -0,0 +1,133 @@
+import * as path from "path";
+import fsExtra from "fs-extra";
+import { PortalNewTocPrompts } from "../../../prompts/portal/toc/new-toc.js";
+import { Result } from "../../../types/common/result.js";
+import { getMessageInRedColor } from "../../../utils/utils.js";
+import { SdlParser } from "../../../application/portal/toc/sdl-parser.js";
+import { TocStructureGenerator } from "../../../application/portal/toc/toc-structure-generator.js";
+import { TocContentParser } from "../../../application/portal/toc/toc-content-parser.js";
+import { PortalService } from "../../../infrastructure/services/portal-service.js";
+import { FilePath } from "../../../types/file/filePath.js";
+import { FileName } from "../../../types/file/fileName.js";
+import { BuildContext } from "../../../types/build-context.js";
+export class PortalNewTocAction {
+    constructor() {
+        this.DEFAULT_TOC_FILENAME = "toc.yml";
+        this.APIMATIC_BUILD_FILENAME = "APIMATIC-BUILD.json";
+        this.prompts = new PortalNewTocPrompts();
+        this.sdlParser = new SdlParser(new PortalService());
+        this.tocGenerator = new TocStructureGenerator();
+        this.contentParser = new TocContentParser();
+    }
+    async createToc(buildDirectory, configDir, tocDirectory, force = false, expandEndpoints = false, expandModels = false) {
+        try {
+            const tocDir = await this.getDestinationPath(buildDirectory, tocDirectory);
+            const tocPath = new FilePath(tocDir, new FileName(this.DEFAULT_TOC_FILENAME));
+            const tocCheckResult = await this.handleExistingToc(tocPath, force);
+            if (!tocCheckResult.isSuccess()) {
+                return Result.cancelled(tocCheckResult.value);
+            }
+            const { endpointGroups, models } = await this.extractSdlComponents(buildDirectory, configDir, expandEndpoints, expandModels);
+            const contentGroups = await this.extractContentGroups(buildDirectory);
+            const toc = this.tocGenerator.createTocStructure(endpointGroups, models, expandEndpoints, expandModels, contentGroups);
+            const yamlString = this.tocGenerator.transformToYaml(toc);
+            await this.writeToc(tocPath.toString(), yamlString, "utf8");
+            this.prompts.displayOutroMessage(tocPath);
+            return Result.success(tocPath.toString());
+        }
+        catch (error) {
+            this.prompts.logError(getMessageInRedColor(`${error.message}`));
+            return Result.failure(`An unexpected error occurred while generating the TOC file.`);
+        }
+    }
+    async writeToc(path, content, encoding) {
+        await fsExtra.ensureFile(path);
+        await fsExtra.writeFile(path, content, encoding);
+    }
+    async handleExistingToc(tocPath, force) {
+        const shouldContinue = await this.checkExistingToc(tocPath, force);
+        if (!shouldContinue) {
+            return Result.cancelled("Operation was cancelled by the user.");
+        }
+        return Result.success("TOC check passed.");
+    }
+    async extractSdlComponents(buildDirectory, configDir, expandEndpoints, expandModels) {
+        if (!expandEndpoints && !expandModels) {
+            return { endpointGroups: new Map(), models: [] };
+        }
+        this.prompts.startProgressIndicatorWithMessage("Extracting endpoints and/or models from the API specification...");
+        const specFolderPath = await this.getSpecFolderPath(buildDirectory);
+        if (!(await fsExtra.pathExists(specFolderPath))) {
+            this.prompts.stopProgressIndicatorWithMessage(`⚠️ Could not find the specification folder at: ${specFolderPath}`);
+            this.prompts.displayInfo("Falling back to default TOC structure without expanded endpoints or models...");
+            return { endpointGroups: new Map(), models: [] };
+        }
+        const sdlResult = await this.sdlParser.getTocComponentsFromSdl(specFolderPath, configDir);
+        if (!sdlResult.isSuccess()) {
+            this.prompts.stopProgressIndicatorWithMessage(`⚠️ ${sdlResult.error}`);
+            this.prompts.displayInfo("Falling back to default TOC structure without expanded endpoints or models...");
+            return { endpointGroups: new Map(), models: [] };
+        }
+        this.prompts.stopProgressIndicatorWithMessage("Successfully extracted endpoints and/or models from the specification.");
+        return sdlResult.value;
+    }
+    async extractContentGroups(buildDirectory) {
+        const contentFolderPath = await this.getContentFolderPath(buildDirectory);
+        if (!(await fsExtra.pathExists(contentFolderPath.toString()))) {
+            this.prompts.displayInfo(`⚠️ Could not locate the content folder at: ${contentFolderPath}`);
+            this.prompts.displayInfo("Skipping custom content addition in TOC...");
+            return [];
+        }
+        return await this.contentParser.parseContentFolder(contentFolderPath.toString(), contentFolderPath.toString());
+    }
+    async getDestinationPath(buildDirectory, providedTocDirectory) {
+        if (providedTocDirectory === undefined) {
+            const inferredDestination = await this.getContentFolderPath(buildDirectory);
+            return inferredDestination;
+        }
+        return providedTocDirectory;
+    }
+    async checkExistingToc(tocPath, force) {
+        if ((await fsExtra.pathExists(tocPath.toString())) && !force) {
+            return await this.prompts.overwriteExistingTocPrompt(tocPath);
+        }
+        return true;
+    }
+    async getContentFolderPath(buildDirectory) {
+        var _a;
+        const buildContext = new BuildContext(buildDirectory);
+        const defaultContentFolder = buildDirectory.join("content");
+        if (!(await buildContext.validate())) {
+            return defaultContentFolder;
+        }
+        try {
+            const buildConfig = await buildContext.getBuildFileContents();
+            if (((_a = buildConfig.generatePortal) === null || _a === void 0 ? void 0 : _a.contentFolder) == null) {
+                return defaultContentFolder;
+            }
+            return buildDirectory.join(buildConfig.generatePortal.contentFolder).join("content");
+        }
+        catch (_b) {
+            return defaultContentFolder;
+        }
+    }
+    async getSpecFolderPath(buildDirectory) {
+        var _a;
+        const buildFilePath = path.join(buildDirectory.toString(), this.APIMATIC_BUILD_FILENAME);
+        const defaultSpecFolder = path.join(buildDirectory.toString(), "spec");
+        if (!(await fsExtra.pathExists(buildFilePath))) {
+            return defaultSpecFolder;
+        }
+        try {
+            const buildConfig = await fsExtra.readJson(buildFilePath, "utf8");
+            if (((_a = buildConfig.generatePortal) === null || _a === void 0 ? void 0 : _a.apiSpecPath) == null) {
+                return defaultSpecFolder;
+            }
+            return path.join(buildDirectory.toString(), buildConfig.generatePortal.apiSpecPath);
+        }
+        catch (_b) {
+            return defaultSpecFolder;
+        }
+    }
+}
+//# sourceMappingURL=new-toc.js.map