@apimatic/cli 1.1.0-alpha.9 → 1.1.0-beta.2

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,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAEhF,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;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAErE,MAAM,OAAO,cAAc;IAQzB,YAAY,SAAwB,EAAE,eAAgC,EAAE,UAAyB,IAAI;QAPpF,YAAO,GAA0B,IAAI,qBAAqB,EAAE,CAAC;QAC7D,oBAAe,GAAoB,IAAI,eAAe,EAAE,CAAC;QACzD,kBAAa,GAAkB,IAAI,aAAa,EAAE,CAAC;QAWpD,YAAO,GAAG,KAAK,EAC7B,cAA6B,EAC7B,eAA8B,EAC9B,KAAc,EACd,SAAkB,EAClB,kBAA2B,IAAI,EACR,EAAE;YACzB,IAAI,cAAc,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;gBAC5C,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;gBACpD,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;YAC/B,CAAC;YAED,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;YACtD,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;gBAC/C,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;YAC/B,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,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;gBACvC,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;YAClC,CAAC;YAED,OAAO,MAAM,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;gBAC/C,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;gBACnD,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAE3D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAChD,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CACpG,CAAC;gBAEF,IAAI,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;oBACrB,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;oBAC7B,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;wBAClC,IAAI,CAAC,OAAO,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;oBACnD,CAAC;yBACI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBACnC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;oBAC5C,CAAC;yBAAM,CAAC;wBACN,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;wBACnD,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;wBAC/D,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBAChD,IAAI,CAAC,OAAO,CAAC,+BAA+B,CAAC,UAAU,CAAC,CAAC;oBAC3D,CAAC;oBACD,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC/B,CAAC;gBAED,MAAM,iBAAiB,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACjE,MAAM,aAAa,CAAC,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;gBAEvD,IAAI,eAAe,EAAE,CAAC;oBACpB,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;gBAChD,CAAC;gBAED,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QA9DA,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CA4DF"}

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

@@ -0,0 +1,16 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+import { CommandMetadata } from "../../types/common/command-metadata.js";
+export declare class PortalQuickstartAction {
+    private readonly prompts;
+    private readonly zipService;
+    private readonly fileService;
+    private readonly configDir;
+    private readonly commandMetadata;
+    private readonly fileDownloadService;
+    private readonly buildFileUrl;
+    private readonly defaultSpecUrl;
+    private readonly repositoryFolderName;
+    constructor(configDir: DirectoryPath, commandMetadata: CommandMetadata);
+    readonly execute: () => Promise<ActionResult>;
+}

package/lib/actions/portal/quickstart.js

@@ -0,0 +1,146 @@
+import { getAuthInfo } from "../../client-utils/auth-manager.js";
+import { FileService } from "../../infrastructure/file-service.js";
+import { withDirPath } from "../../infrastructure/tmp-extensions.js";
+import { ZipService } from "../../infrastructure/zip-service.js";
+import { PortalQuickstartPrompts } from "../../prompts/portal/quickstart.js";
+import { UrlPath } from "../../types/file/urlPath.js";
+import { LoginAction } from "../auth/login.js";
+import { ActionResult } from "../action-result.js";
+import { PortalServeAction } from "./serve.js";
+import { ValidateAction } from "../api/validate.js";
+import { BuildContext } from "../../types/build-context.js";
+import { TempContext } from "../../types/temp-context.js";
+import { FileDownloadService } from "../../infrastructure/services/file-download-service.js";
+import { getLanguagesConfig } from "../../types/build/build.js";
+import { SpecContext } from "../../types/spec-context.js";
+const defaultPort = 3000;
+export class PortalQuickstartAction {
+    constructor(configDir, commandMetadata) {
+        this.prompts = new PortalQuickstartPrompts();
+        this.zipService = new ZipService();
+        this.fileService = new FileService();
+        this.fileDownloadService = new FileDownloadService();
+        this.buildFileUrl = new UrlPath(`https://github.com/apimatic/sample-docs-as-code-portal/archive/refs/heads/master.zip`);
+        this.defaultSpecUrl = new UrlPath(`https://raw.githubusercontent.com/apimatic/sample-docs-as-code-portal/refs/heads/master/src/spec/openapi.json`);
+        this.repositoryFolderName = "sample-docs-as-code-portal-master/src";
+        this.execute = async () => {
+            const storedAuth = await getAuthInfo(this.configDir.toString());
+            if (!(storedAuth === null || storedAuth === void 0 ? void 0 : storedAuth.authKey)) {
+                const loginResult = await new LoginAction(this.configDir, this.commandMetadata).execute();
+                if (loginResult.isFailed()) {
+                    return ActionResult.failed();
+                }
+            }
+            return await withDirPath(async (tempDirectory) => {
+                // Step 1/4
+                this.prompts.importSpecStep();
+                let specPath;
+                while (!specPath) {
+                    const inputPath = await this.prompts.specPathPrompt(this.defaultSpecUrl);
+                    if (!inputPath) {
+                        this.prompts.noSpecSpecified();
+                        return ActionResult.cancelled();
+                    }
+                    if (inputPath instanceof UrlPath) {
+                        const downloadFileResult = await this.prompts.downloadSpecFile(this.fileDownloadService.downloadFile(inputPath));
+                        if (downloadFileResult.isErr()) {
+                            this.prompts.serviceError(downloadFileResult.error);
+                        }
+                        else {
+                            const specContext = new SpecContext(tempDirectory);
+                            specPath = await specContext.save(downloadFileResult.value.stream, downloadFileResult.value.filename);
+                        }
+                    }
+                    else {
+                        const fileExists = await this.fileService.fileExists(inputPath);
+                        if (!fileExists) {
+                            this.prompts.specFileDoesNotExist();
+                        }
+                        else {
+                            specPath = inputPath;
+                        }
+                    }
+                }
+                // Step 2/4
+                this.prompts.validateSpecStep();
+                const validateAction = new ValidateAction(this.configDir, this.commandMetadata);
+                const validationResult = await validateAction.execute(specPath, false);
+                if (validationResult.isFailed()) {
+                    this.prompts.specValidationFailed();
+                    if (!(await this.prompts.useDefaultSpecPrompt())) {
+                        this.prompts.fixYourSpec();
+                        return ActionResult.cancelled();
+                    }
+                    const downloadFileResult = await this.prompts.downloadSpecFile(this.fileDownloadService.downloadFile(this.defaultSpecUrl));
+                    if (downloadFileResult.isErr()) {
+                        this.prompts.serviceError(downloadFileResult.error);
+                    }
+                    else {
+                        const specContext = new SpecContext(tempDirectory);
+                        specPath = await specContext.save(downloadFileResult.value.stream, downloadFileResult.value.filename);
+                    }
+                }
+                // Step 3/4
+                this.prompts.selectLanguagesStep();
+                const languages = await this.prompts.selectLanguagesPrompt();
+                if (!languages) {
+                    this.prompts.noLanguagesSelected();
+                    return ActionResult.cancelled();
+                }
+                // Step 4/4
+                this.prompts.selectInputDirectoryStep();
+                let inputDirectory;
+                while (true) {
+                    inputDirectory = await this.prompts.inputDirectoryPathPrompt();
+                    if (!inputDirectory) {
+                        this.prompts.noInputDirectoryProvided();
+                        return ActionResult.cancelled();
+                    }
+                    if (!(await this.fileService.directoryExists(inputDirectory))) {
+                        this.prompts.inputDirectoryPathDoesNotExist(inputDirectory);
+                        // TODO: Prompt user if he wants to create the directory
+                        continue;
+                    }
+                    if (!(await this.fileService.directoryEmpty(inputDirectory))) {
+                        this.prompts.inputDirectoryNotEmpty(inputDirectory);
+                        continue;
+                    }
+                    break;
+                }
+                const masterBuildFile = await this.prompts.downloadBuildDirectory(this.fileDownloadService.downloadFile(this.buildFileUrl));
+                if (masterBuildFile.isErr()) {
+                    this.prompts.serviceError(masterBuildFile.error);
+                    return ActionResult.failed();
+                }
+                const tempContext = new TempContext(tempDirectory);
+                const masterBuildFilePath = await tempContext.save(masterBuildFile.value.stream);
+                await this.zipService.unArchive(masterBuildFilePath, tempDirectory);
+                const extractedFolder = tempDirectory.join(this.repositoryFolderName);
+                const tempBuildContext = new BuildContext(extractedFolder);
+                await tempBuildContext.deleteWorkflowDir();
+                const buildFile = await tempBuildContext.getBuildFileContents();
+                buildFile.generatePortal.languageConfig = getLanguagesConfig(languages);
+                await tempBuildContext.updateBuildFileContents(buildFile);
+                const sourceDirectory = inputDirectory.join("src");
+                await this.fileService.copyDirectoryContents(extractedFolder, sourceDirectory);
+                const specDirectory = sourceDirectory.join("spec");
+                const specContext = new SpecContext(specDirectory);
+                await specContext.replaceDefaultSpec(specPath);
+                const buildDirectoryStructure = await this.fileService.getDirectory(sourceDirectory);
+                this.prompts.printDirectoryStructure(inputDirectory, buildDirectoryStructure);
+                const portalDirectory = inputDirectory.join("portal");
+                const portalServeAction = new PortalServeAction(this.configDir, this.commandMetadata, null);
+                const result = await portalServeAction.execute(sourceDirectory, portalDirectory, defaultPort, true, false, () => {
+                    this.prompts.nextSteps();
+                });
+                if (result.isFailed()) {
+                    return ActionResult.failed();
+                }
+                return ActionResult.success();
+            });
+        };
+        this.configDir = configDir;
+        this.commandMetadata = commandMetadata;
+    }
+}
+//# sourceMappingURL=quickstart.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"quickstart.js","sourceRoot":"","sources":["../../../src/actions/portal/quickstart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,wDAAwD,CAAC;AAC7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE1D,MAAM,WAAW,GAAW,IAAa,CAAC;AAE1C,MAAM,OAAO,sBAAsB;IAWjC,YAAY,SAAwB,EAAE,eAAgC;QAVrD,YAAO,GAA4B,IAAI,uBAAuB,EAAE,CAAC;QACjE,eAAU,GAAe,IAAI,UAAU,EAAE,CAAC;QAC1C,gBAAW,GAAgB,IAAI,WAAW,EAAE,CAAC;QAG7C,wBAAmB,GAAG,IAAI,mBAAmB,EAAE,CAAC;QAChD,iBAAY,GAAG,IAAI,OAAO,CAAC,sFAAsF,CAAC,CAAC;QACnH,mBAAc,GAAG,IAAI,OAAO,CAAC,+GAA+G,CAAC,CAAC;QAC9I,yBAAoB,GAAG,uCAAgD,CAAC;QAOzE,YAAO,GAAG,KAAK,IAA2B,EAAE;YAC1D,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAA,EAAE,CAAC;gBACzB,MAAM,WAAW,GAAG,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE,CAAC;gBAC1F,IAAI,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAC3B,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC/B,CAAC;YACH,CAAC;YAED,OAAO,MAAM,WAAW,CAAe,KAAK,EAAE,aAA4B,EAAyB,EAAE;gBACnG,WAAW;gBACX,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAE9B,IAAI,QAA8B,CAAC;gBACnC,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACjB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;oBACzE,IAAI,CAAC,SAAS,EAAE,CAAC;wBACf,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;wBAC/B,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;oBAClC,CAAC;oBAED,IAAI,SAAS,YAAY,OAAO,EAAE,CAAC;wBACjC,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC5D,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,SAAS,CAAC,CACjD,CAAC;wBACF,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,CAAC;4BAC/B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;wBACtD,CAAC;6BAAM,CAAC;4BACN,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;4BACnD,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;wBACxG,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;wBAChE,IAAI,CAAC,UAAU,EAAE,CAAC;4BAChB,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;wBACtC,CAAC;6BAAM,CAAC;4BACN,QAAQ,GAAG,SAAS,CAAC;wBACvB,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,WAAW;gBACX,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAChC,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;gBAChF,MAAM,gBAAgB,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAEvE,IAAI,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAChC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;oBACpC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC,EAAE,CAAC;wBACjD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;wBAC3B,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;oBAClC,CAAC;oBACD,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAC5D,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAC3D,CAAC;oBACF,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,CAAC;wBAC/B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;oBACtD,CAAC;yBAAM,CAAC;wBACN,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;wBACnD,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACxG,CAAC;gBACH,CAAC;gBAED,WAAW;gBACX,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;gBACnC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBAC7D,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;oBACnC,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;gBAClC,CAAC;gBAED,WAAW;gBACX,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;gBACxC,IAAI,cAAyC,CAAC;gBAC9C,OAAO,IAAI,EAAE,CAAC;oBACZ,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;oBAC/D,IAAI,CAAC,cAAc,EAAE,CAAC;wBACpB,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;wBACxC,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;oBAClC,CAAC;oBAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;wBAC9D,IAAI,CAAC,OAAO,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;wBAC5D,wDAAwD;wBACxD,SAAS;oBACX,CAAC;oBAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;wBAC7D,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;wBACpD,SAAS;oBACX,CAAC;oBACD,MAAM;gBACR,CAAC;gBAED,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAC/D,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CACzD,CAAC;gBACF,IAAI,eAAe,CAAC,KAAK,EAAE,EAAE,CAAC;oBAC5B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;oBACjD,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC/B,CAAC;gBACD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;gBACnD,MAAM,mBAAmB,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;gBACpE,MAAM,eAAe,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;gBAEtE,MAAM,gBAAgB,GAAG,IAAI,YAAY,CAAC,eAAe,CAAC,CAAC;gBAC3D,MAAM,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;gBAE3C,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,oBAAoB,EAAE,CAAC;gBAChE,SAAS,CAAC,cAAe,CAAC,cAAc,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBACzE,MAAM,gBAAgB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;gBAE1D,MAAM,eAAe,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnD,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;gBAE/E,MAAM,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;gBACnD,MAAM,WAAW,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBAE/C,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;gBACrF,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;gBAE9E,MAAM,eAAe,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtD,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;gBAC5F,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE;oBAC9G,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;gBAC3B,CAAC,CAAC,CAAC;gBACH,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;oBACtB,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC/B,CAAC;gBACD,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAzIA,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;CAwIF"}

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

@@ -0,0 +1,15 @@
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+import { CommandMetadata } from "../../../types/common/command-metadata.js";
+import { ActionResult } from "../../action-result.js";
+export declare class PortalRecipeAction {
+    private readonly configDirectory;
+    private readonly commandMetadata;
+    private readonly prompts;
+    private readonly launcherService;
+    private readonly fileService;
+    private readonly portalService;
+    constructor(configDirectory: DirectoryPath, commandMetadata: CommandMetadata);
+    execute(buildDirectory: DirectoryPath, name?: string): Promise<ActionResult>;
+    private promptForContent;
+    private getTocStructure;
+}

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

@@ -0,0 +1,177 @@
+import { PortalRecipePrompts } from "../../../prompts/portal/recipe/new-recipe.js";
+import { StepType } from "../../../types/recipe/recipe.js";
+import { PortalService } from "../../../infrastructure/services/portal-service.js";
+import { getEndpointDescription, getEndpointGroupsFromSdl } from "../../../types/sdl/sdl.js";
+import { ActionResult } from "../../action-result.js";
+import { TocContext } from "../../../types/toc-context.js";
+import { FileName } from "../../../types/file/fileName.js";
+import { PortalRecipe } from "../../../application/portal/recipe/portal-recipe.js";
+import { PortalRecipeGenerator } from "../../../application/portal/recipe/recipe-generator.js";
+import { BuildContext } from "../../../types/build-context.js";
+import { ContentContext } from "../toc/new-toc.js";
+import { SpecContext } from "../../../types/spec-context.js";
+import { LauncherService } from "../../../infrastructure/launcher-service.js";
+import { FileService } from "../../../infrastructure/file-service.js";
+import { FilePath } from "../../../types/file/filePath.js";
+import { withDirPath } from "../../../infrastructure/tmp-extensions.js";
+import { TempContext } from "../../../types/temp-context.js";
+import { RecipeContext } from "../../../types/recipe-context.js";
+export class PortalRecipeAction {
+    constructor(configDirectory, commandMetadata) {
+        this.configDirectory = configDirectory;
+        this.commandMetadata = commandMetadata;
+        this.prompts = new PortalRecipePrompts();
+        this.launcherService = new LauncherService();
+        this.fileService = new FileService();
+        this.portalService = new PortalService();
+    }
+    async execute(buildDirectory, name) {
+        this.prompts.displayWelcomeMessage();
+        const buildContext = new BuildContext(buildDirectory);
+        if (!(await buildContext.validate())) {
+            this.prompts.invalidBuildDirectory(buildDirectory);
+            return ActionResult.failed();
+        }
+        const recipeName = name !== null && name !== void 0 ? name : (await this.prompts.recipeNamePrompt());
+        if (!recipeName) {
+            this.prompts.recipeNameEmpty();
+            return ActionResult.cancelled();
+        }
+        const contentDirectory = buildDirectory.join("content");
+        const contentContext = new ContentContext(contentDirectory);
+        if (!(await contentContext.exists())) {
+            this.prompts.contentFolderNotFound();
+            return ActionResult.failed();
+        }
+        const specDirectory = buildDirectory.join("spec");
+        const specContext = new SpecContext(specDirectory);
+        if (!(await specContext.validate())) {
+            this.prompts.specFileEmptyInvalid();
+            return ActionResult.failed();
+        }
+        // Setup TOC context
+        const tocContext = new TocContext(contentDirectory);
+        const tocData = await tocContext.parseTocData();
+        // Setup recipe context
+        const recipeContext = new RecipeContext(recipeName);
+        const recipeScriptFileName = recipeContext.getRecipeScriptFileName();
+        const recipeMarkdownFileName = recipeContext.getRecipeMarkdownFileName();
+        // Check if the recipe already exists
+        const recipeAlreadyExists = recipeContext.exists(tocData, recipeName, recipeMarkdownFileName);
+        if (recipeAlreadyExists && !(await this.prompts.overwriteApiRecipeInTocPrompt(recipeName))) {
+            return ActionResult.cancelled();
+        }
+        // Build the recipe
+        const recipe = new PortalRecipe(recipeName);
+        let stepIndex = 0;
+        this.prompts.displayStepsInformation();
+        let endpointGroups;
+        do {
+            const stepType = await this.prompts.stepTypeSelectionPrompt();
+            if (!stepType)
+                return ActionResult.cancelled();
+            const stepName = await this.prompts.stepNamePrompt(`Step ${++stepIndex}`);
+            if (!stepName)
+                return ActionResult.cancelled();
+            switch (stepType) {
+                case StepType.Content: {
+                    const contentResult = await this.promptForContent();
+                    recipe.addContentStep(stepName, contentResult);
+                    this.prompts.displayStepAddedSuccessfullyMessage();
+                    break;
+                }
+                case StepType.Endpoint: {
+                    if (!endpointGroups) {
+                        const sdlResult = await withDirPath(async (tempDirectory) => {
+                            const tempContext = new TempContext(tempDirectory);
+                            const specZipPath = await tempContext.zip(specDirectory);
+                            const specFileStream = await this.fileService.getStream(specZipPath);
+                            try {
+                                return await this.prompts.generateSdl(this.portalService.generateSdl(specFileStream, this.configDirectory, this.commandMetadata));
+                            }
+                            finally {
+                                specFileStream.close();
+                            }
+                        });
+                        if (sdlResult.isErr()) {
+                            this.prompts.serviceError(sdlResult.error);
+                            return ActionResult.failed();
+                        }
+                        endpointGroups = getEndpointGroupsFromSdl(sdlResult.value);
+                    }
+                    const endpointGroupName = await this.prompts.endpointGroupNamePrompt(endpointGroups);
+                    if (!endpointGroupName)
+                        return ActionResult.cancelled();
+                    const endpointName = await this.prompts.endpointNamePrompt(endpointGroups, endpointGroupName);
+                    if (!endpointName)
+                        return ActionResult.cancelled();
+                    const defaultDescription = getEndpointDescription(endpointGroups, endpointGroupName, endpointName);
+                    const description = await this.prompts.endpointDescriptionPrompt(defaultDescription);
+                    if (!description)
+                        return ActionResult.cancelled();
+                    recipe.addEndpointStep(stepName, description, endpointGroupName, endpointName);
+                    this.prompts.displayStepAddedSuccessfullyMessage();
+                    break;
+                }
+            }
+        } while (await this.prompts.addAnotherStepSelectionPrompt());
+        const serializableRecipe = recipe.toSerializableRecipe();
+        // Generate the recipe
+        const recipeGenerator = new PortalRecipeGenerator();
+        await recipeGenerator.createRecipe(serializableRecipe, tocData, tocContext.tocPath, recipeName, recipeScriptFileName, recipeMarkdownFileName, buildContext, buildDirectory);
+        const tocStructure = this.getTocStructure(recipeScriptFileName);
+        this.prompts.recipeCreated();
+        this.prompts.displayRecipeStructure(tocStructure);
+        this.prompts.nextSteps();
+        return ActionResult.success();
+    }
+    async promptForContent() {
+        return await withDirPath(async (tempDir) => {
+            const tempFile = new FilePath(tempDir, new FileName(`recipe-markdown-content.md`));
+            const defaultContent = "# The Heading Goes Here\n\n" +
+                "This 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 this.fileService.writeContents(tempFile, defaultContent);
+            this.prompts.openRecipeMarkdownEditor();
+            await this.launcherService.openInEditor(tempFile);
+            const fileContent = await this.fileService.getContents(tempFile);
+            return fileContent.replace(/\r\n|\r/g, "\n");
+        });
+    }
+    getTocStructure(recipeFileName) {
+        return {
+            name: "src",
+            items: [
+                {
+                    name: "content",
+                    items: [
+                        {
+                            name: "toc.yml",
+                            description: "# Contains the API Recipes group with a new page for your API recipe"
+                        }
+                    ]
+                },
+                {
+                    name: "static",
+                    items: [
+                        {
+                            name: "scripts",
+                            items: [
+                                {
+                                    name: "recipes",
+                                    items: [
+                                        {
+                                            name: `${recipeFileName}`,
+                                            description: "# Generated recipe script file containing all of the steps"
+                                        }
+                                    ]
+                                }
+                            ]
+                        }
+                    ]
+                }
+            ]
+        };
+    }
+}
+//# 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,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AACnF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oDAAoD,CAAC;AACnF,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAe,MAAM,2BAA2B,CAAC;AAG1G,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,qDAAqD,CAAC;AACnF,OAAO,EAAE,qBAAqB,EAAE,MAAM,wDAAwD,CAAC;AAC/F,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAGjE,MAAM,OAAO,kBAAkB;IAM7B,YAA6B,eAA8B,EAAmB,eAAgC;QAAjF,oBAAe,GAAf,eAAe,CAAe;QAAmB,oBAAe,GAAf,eAAe,CAAiB;QAL7F,YAAO,GAAwB,IAAI,mBAAmB,EAAE,CAAC;QACzD,oBAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QACxC,gBAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QAChC,kBAAa,GAAG,IAAI,aAAa,EAAE,CAAC;IAE4D,CAAC;IAE3G,KAAK,CAAC,OAAO,CAAC,cAA6B,EAAE,IAAa;QAC/D,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAErC,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;YACnD,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;QAC/B,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;YAC/B,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC;QAED,MAAM,gBAAgB,GAAG,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxD,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC,CAAC;QAE5D,IAAI,CAAC,CAAC,MAAM,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;YACrC,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;QAC/B,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;QAEnD,IAAI,CAAC,CAAC,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACpC,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;QAC/B,CAAC;QAED,oBAAoB;QACpB,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,YAAY,EAAE,CAAC;QAEhD,uBAAuB;QACvB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC;QACpD,MAAM,oBAAoB,GAAG,aAAa,CAAC,uBAAuB,EAAE,CAAC;QACrE,MAAM,sBAAsB,GAAG,aAAa,CAAC,yBAAyB,EAAE,CAAC;QAEzE,qCAAqC;QACrC,MAAM,mBAAmB,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC;QAC9F,IAAI,mBAAmB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YAC3F,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC;QAED,mBAAmB;QACnB,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;QAE5C,IAAI,SAAS,GAAW,CAAC,CAAC;QAE1B,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;QAEvC,IAAI,cAAsD,CAAC;QAE3D,GAAG,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;YAC9D,IAAI,CAAC,QAAQ;gBAAE,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;YAE/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YAC1E,IAAI,CAAC,QAAQ;gBAAE,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;YAE/C,QAAQ,QAAQ,EAAE,CAAC;gBACjB,KAAK,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;oBACtB,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACpD,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;oBAC/C,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,CAAC;oBACnD,MAAM;gBACR,CAAC;gBAED,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACvB,IAAI,CAAC,cAAc,EAAE,CAAC;wBACpB,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;4BAC1D,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;4BACnD,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;4BAEzD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;4BAErE,IAAI,CAAC;gCACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CACnC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,CAC3F,CAAC;4BACJ,CAAC;oCAAS,CAAC;gCACT,cAAc,CAAC,KAAK,EAAE,CAAC;4BACzB,CAAC;wBACH,CAAC,CAAC,CAAC;wBAEH,IAAI,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC;4BACtB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;4BAC3C,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;wBAC/B,CAAC;wBACD,cAAc,GAAG,wBAAwB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAC7D,CAAC;oBAED,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;oBACrF,IAAI,CAAC,iBAAiB;wBAAE,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;oBACxD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;oBAC9F,IAAI,CAAC,YAAY;wBAAE,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;oBAEnD,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,cAAc,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;oBACnG,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,CAAC;oBACrF,IAAI,CAAC,WAAW;wBAAE,OAAO,YAAY,CAAC,SAAS,EAAE,CAAC;oBAElD,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,YAAY,CAAC,CAAC;oBAC/E,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,CAAC;oBACnD,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC,QAAQ,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE;QAE7D,MAAM,kBAAkB,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAEzD,sBAAsB;QACtB,MAAM,eAAe,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACpD,MAAM,eAAe,CAAC,YAAY,CAChC,kBAAkB,EAClB,OAAO,EACP,UAAU,CAAC,OAAO,EAClB,UAAU,EACV,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EACZ,cAAc,CACf,CAAC;QAEF,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACzB,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,OAAO,MAAM,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACzC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,CAAC,CAAC;YACnF,MAAM,cAAc,GAClB,6BAA6B;gBAC7B,6DAA6D;gBAC7D,qFAAqF,CAAC;YAExF,MAAM,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC/D,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;YACxC,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,cAAwB;QAC9C,OAAO;YACL,IAAI,EAAE,KAAK;YACX,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,SAAS;oBACf,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,SAAS;4BACf,WAAW,EAAE,sEAAsE;yBACpF;qBACF;iBACF;gBACD;oBACE,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,SAAS;4BACf,KAAK,EAAE;gCACL;oCACE,IAAI,EAAE,SAAS;oCACf,KAAK,EAAE;wCACL;4CACE,IAAI,EAAE,GAAG,cAAc,EAAE;4CACzB,WAAW,EAAE,4DAA4D;yCAC1E;qCACF;iCACF;6BACF;yBACF;qBACF;iBACF;aACF;SACF,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,15 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+import { CommandMetadata } from "../../types/common/command-metadata.js";
+export declare class PortalServeAction {
+    private readonly prompts;
+    private readonly networkService;
+    private readonly launcherService;
+    private readonly application;
+    private readonly configDir;
+    private readonly commandMetadata;
+    private readonly authKey;
+    constructor(configDir: DirectoryPath, commandMetadata: CommandMetadata, authKey?: string | null);
+    execute(buildDirectory: DirectoryPath, portalDirectory: DirectoryPath, port: number, openInBrowser: boolean, hotReload: boolean, onAfterServe?: () => void): Promise<ActionResult>;
+    private clearStandardInput;
+}

package/lib/actions/portal/serve.js

@@ -0,0 +1,118 @@
+import { createServer as createLiveReloadServer } from "livereload";
+import connectLiveReload from "connect-livereload";
+import express from "express";
+import chokidar from "chokidar";
+import crypto from "crypto";
+import { Mutex } from "async-mutex";
+import { PortalServePrompts } from "../../prompts/portal/serve.js";
+import { ActionResult } from "../action-result.js";
+import { GenerateAction } from "./generate.js";
+import { NetworkService } from "../../infrastructure/network-service.js";
+import { UrlPath } from "../../types/file/urlPath.js";
+import { LauncherService } from "../../infrastructure/launcher-service.js";
+import { DebounceService } from "../../infrastructure/debounce-service.js";
+export class PortalServeAction {
+    constructor(configDir, commandMetadata, authKey = null) {
+        this.prompts = new PortalServePrompts();
+        this.networkService = new NetworkService();
+        this.launcherService = new LauncherService();
+        this.application = express();
+        this.configDir = configDir;
+        this.commandMetadata = commandMetadata;
+        this.authKey = authKey;
+    }
+    async execute(buildDirectory, portalDirectory, port, openInBrowser, hotReload, onAfterServe) {
+        const generatePortalAction = new GenerateAction(this.configDir, this.commandMetadata, this.authKey);
+        const result = await generatePortalAction.execute(buildDirectory, portalDirectory, true, false);
+        if (result.isFailed()) {
+            return ActionResult.failed();
+        }
+        const servePort = await this.networkService.getServerPort([port, 3000, 3001, 3002]);
+        if (servePort != port && !onAfterServe) {
+            this.prompts.usingFallbackPort(port, servePort);
+        }
+        const liveReloadPort = await this.networkService.getServerPort([35729, 35730, 35731, 35732]);
+        const liveReloadServer = createLiveReloadServer({ port: liveReloadPort });
+        const server = this.application
+            .use(connectLiveReload())
+            .use(express.static(portalDirectory.toString(), { extensions: ["html"] }))
+            .listen(servePort);
+        const portalUrl = new UrlPath(`http://localhost:${servePort}`);
+        this.prompts.portalServed(portalUrl);
+        if (openInBrowser) {
+            await this.launcherService.openUrlInBrowser(portalUrl);
+        }
+        this.prompts.promptForExit();
+        if (!hotReload) {
+            if (onAfterServe) {
+                onAfterServe();
+            }
+            this.clearStandardInput();
+            await this.prompts.blockExecution();
+            liveReloadServer.close();
+            server.close();
+            return ActionResult.success();
+        }
+        this.prompts.hotReloadEnabled(buildDirectory);
+        const watcher = chokidar.watch(buildDirectory.toString(), {
+            ignored: [/(^|[/\\])\..+/],
+            ignoreInitial: true,
+            persistent: true,
+            awaitWriteFinish: true,
+            atomic: true
+        });
+        const deletedDirectories = new Set();
+        // TODO: Verify if we need mutex and eventQueue after refactoring.
+        const eventQueue = new Map();
+        const mutex = new Mutex();
+        const debounceService = new DebounceService();
+        watcher
+            .on("all", async (event, path) => {
+            // triggers folder deletion as a single event
+            if (event == "unlinkDir") {
+                deletedDirectories.add(path);
+            }
+            if (event == "unlink") {
+                for (const dir of deletedDirectories) {
+                    if (path.startsWith(dir)) {
+                        return;
+                    }
+                }
+            }
+            const eventId = `${Date.now()}-${crypto.randomUUID()}`;
+            await mutex.runExclusive(async () => {
+                eventQueue.clear();
+                eventQueue.set(eventId, path);
+            });
+            await debounceService.batchSingleRequest(async () => {
+                this.prompts.changesDetected();
+                // TODO: Verify if this is needed.
+                if (!eventQueue.has(eventId)) {
+                    return;
+                }
+                await generatePortalAction.execute(buildDirectory, portalDirectory, true, false, false);
+                liveReloadServer.refresh(portalDirectory.toString());
+                this.clearStandardInput();
+            });
+        })
+            .on("error", async () => {
+            this.prompts.watcherError();
+        });
+        // Wait for SIGINT or SIGTERM
+        this.clearStandardInput();
+        await this.prompts.blockExecution();
+        await watcher.close();
+        debounceService.close();
+        liveReloadServer.close();
+        server.close();
+        return ActionResult.success();
+    }
+    // This clears the standard input to allow interrupts like CTRL+C to work properly.
+    clearStandardInput() {
+        if (process.platform !== "darwin" && process.stdin.isTTY) {
+            process.stdin.setRawMode(false);
+            process.stdin.pause();
+        }
+    }
+}
+//# 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":"AAAA,OAAO,EAAE,YAAY,IAAI,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,iBAAiB,MAAM,oBAAoB,CAAC;AACnD,OAAO,OAAoB,MAAM,SAAS,CAAC;AAC3C,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAE3E,MAAM,OAAO,iBAAiB;IAS5B,YAAmB,SAAwB,EAAE,eAAgC,EAAE,UAAyB,IAAI;QAR3F,YAAO,GAAuB,IAAI,kBAAkB,EAAE,CAAC;QACvD,mBAAc,GAAmB,IAAI,cAAc,EAAE,CAAC;QACtD,oBAAe,GAAoB,IAAI,eAAe,EAAE,CAAC;QACzD,gBAAW,GAAY,OAAO,EAAE,CAAC;QAMhD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAClB,cAA6B,EAC7B,eAA8B,EAC9B,IAAY,EACZ,aAAsB,EACtB,SAAkB,EAClB,YAAyB;QAEzB,MAAM,oBAAoB,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpG,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAChG,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;YACtB,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC;QAC/B,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACpF,IAAI,SAAS,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAC7F,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW;aAC5B,GAAG,CAAC,iBAAiB,EAAE,CAAC;aACxB,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;aACzE,MAAM,CAAC,SAAS,CAAC,CAAC;QAErB,MAAM,SAAS,GAAG,IAAI,OAAO,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QAE7B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,YAAY,EAAE,CAAC;gBACjB,YAAY,EAAE,CAAC;YACjB,CAAC;YAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAEpC,gBAAgB,CAAC,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;QAE9C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE;YACxD,OAAO,EAAE,CAAC,eAAe,CAAC;YAC1B,aAAa,EAAE,IAAI;YACnB,UAAU,EAAE,IAAI;YAChB,gBAAgB,EAAE,IAAI;YACtB,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QAEH,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC7C,kEAAkE;QAClE,MAAM,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;QAE1B,MAAM,eAAe,GAAoB,IAAI,eAAe,EAAE,CAAC;QAE/D,OAAO;aACJ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,6CAA6C;YAC7C,IAAI,KAAK,IAAI,WAAW,EAAE,CAAC;gBACzB,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,KAAK,IAAI,QAAQ,EAAE,CAAC;gBACtB,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;oBACrC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;wBACzB,OAAO;oBACT,CAAC;gBACH,CAAC;YACH,CAAC;YACD,MAAM,OAAO,GAAW,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;YAC/D,MAAM,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;gBAClC,UAAU,CAAC,KAAK,EAAE,CAAC;gBACnB,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YAEH,MAAM,eAAe,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;gBAE/B,kCAAkC;gBAClC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7B,OAAO;gBACT,CAAC;gBAED,MAAM,oBAAoB,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;gBAExF,gBAAgB,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACrD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;aACD,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACtB,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEL,6BAA6B;QAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAEpC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,eAAe,CAAC,KAAK,EAAE,CAAC;QACxB,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IAED,mFAAmF;IAC3E,kBAAkB;QACxB,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACzD,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAChC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;CACF"}

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

@@ -1,17 +1,21 @@
-import { Result } from "../../../types/common/result";
+import { TocGroup } from "../../../types/toc/toc.js";
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+import { CommandMetadata } from "../../../types/common/command-metadata.js";
+import { ActionResult } from "../../action-result.js";
+export declare class ContentContext {
+    private readonly contentDirectory;
+    private readonly fileService;
+    constructor(contentDirectory: DirectoryPath);
+    exists(): Promise<boolean>;
+    extractContentGroups(): Promise<TocGroup[]>;
+}
 export declare class PortalNewTocAction {
+    private readonly configDirectory;
+    private readonly commandMetadata;
     private readonly prompts;
-    private readonly sdlParser;
     private readonly tocGenerator;
-    private readonly contentParser;
-    constructor();
-    createToc(workingDirectory: string, configDir: string, destination?: string, 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;
+    private readonly fileService;
+    private readonly portalService;
+    constructor(configDirectory: DirectoryPath, commandMetadata: CommandMetadata);
+    execute(buildDirectory: DirectoryPath, tocDirectory?: DirectoryPath, force?: boolean, expandEndpoints?: boolean, expandModels?: boolean): Promise<ActionResult>;
 }