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

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, commandName, 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, commandName, 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, commandName, 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, commandName);
+        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

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

@@ -0,0 +1 @@
+{"version":3,"file":"new-toc.js","sourceRoot":"","sources":["../../../../src/actions/portal/toc/new-toc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,+CAA+C,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,4DAA4D,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,uDAAuD,CAAC;AAEzF,OAAO,EAAE,aAAa,EAAE,MAAM,oDAAoD,CAAC;AAEnF,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D,MAAM,OAAO,kBAAkB;IAQ7B;QAHiB,yBAAoB,GAAW,SAAkB,CAAC;QAClD,4BAAuB,GAAW,qBAA8B,CAAC;QAGhF,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,aAAa,EAAE,CAAC,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAChD,IAAI,CAAC,aAAa,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,SAAS,CACpB,cAA6B,EAC7B,SAAiB,EACjB,WAAmB,EACnB,YAA4B,EAC5B,QAAiB,KAAK,EACtB,kBAA2B,KAAK,EAChC,eAAwB,KAAK;QAE7B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC3E,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAA;YAC7E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACpE,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,CAAC;gBAChC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,KAAM,CAAC,CAAC;YACjD,CAAC;YAED,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAChE,cAAc,EACd,SAAS,EACT,WAAW,EACX,eAAe,EACf,YAAY,CACb,CAAC;YAEF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;YAEtE,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAC9C,cAAc,EACd,MAAM,EACN,eAAe,EACf,YAAY,EACZ,aAAa,CACd,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAC1D,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;YAE5D,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAC1C,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,GAAI,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC3E,OAAO,MAAM,CAAC,OAAO,CAAC,6DAA6D,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,OAAe,EAAE,QAAgB;QACpE,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,OAAiB,EAAE,KAAc;QAC/D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACnE,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,MAAM,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAChC,cAA6B,EAC7B,SAAiB,EACjB,WAAmB,EACnB,eAAwB,EACxB,YAAqB;QAErB,IAAI,CAAC,eAAe,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,OAAO,EAAE,cAAc,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,iCAAiC,CAAC,kEAAkE,CAAC,CAAC;QACnH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QAEpE,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC,kDAAkD,cAAc,EAAE,CAAC,CAAC;YAClH,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,+EAA+E,CAAC,CAAC;YAC1G,OAAO,EAAE,cAAc,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACnD,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,cAAc,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QAEvG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC,MAAM,SAAS,CAAC,KAAM,EAAE,CAAC,CAAC;YACxE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,+EAA+E,CAAC,CAAC;YAC1G,OAAO,EAAE,cAAc,EAAE,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACnD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAC3C,wEAAwE,CACzE,CAAC;QACF,OAAO,SAAS,CAAC,KAAM,CAAC;IAC1B,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,cAA6B;QAC9D,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;QAE1E,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC;YAC9D,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,8CAA8C,iBAAiB,EAAE,CAAC,CAAC;YAC5F,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAAC;YACvE,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,QAAQ,EAAE,EAAE,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjH,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,cAA6B,EAAE,oBAAoC;QAClG,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;YAC5E,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QACD,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,OAAiB,EAAE,KAAc;QAC9D,IAAI,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAC7D,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,cAA6B;;QAC9D,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,cAAc,CAAC,CAAC;QACtD,MAAM,oBAAoB,GAAG,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE5D,IAAI,CAAC,CAAC,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YACrC,OAAO,oBAAoB,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,oBAAoB,EAAE,CAAC;YAC9D,IAAI,CAAA,MAAA,WAAW,CAAC,cAAc,0CAAE,aAAa,KAAI,IAAI,EAAE,CAAC;gBACtD,OAAO,oBAAoB,CAAC;YAC9B,CAAC;YACD,OAAO,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACvF,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,oBAAoB,CAAC;QAC9B,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,cAA6B;;QAC3D,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACzF,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;QAEvE,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;YAC/C,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YAElE,IAAI,CAAA,MAAA,WAAW,CAAC,cAAc,0CAAE,WAAW,KAAI,IAAI,EAAE,CAAC;gBACpD,OAAO,iBAAiB,CAAC;YAC3B,CAAC;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACtF,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,iBAAiB,CAAC;QAC3B,CAAC;IACH,CAAC;CACF"}

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

@@ -0,0 +1,14 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+import { LanguagePlatform } from "../../types/sdk/generate.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: (specDirectory: DirectoryPath, sdkDirectory: DirectoryPath, platform: LanguagePlatform, commandName: string, force: boolean, zipSdk: boolean) => Promise<ActionResult>;
+    private convertSimplePlatformToPlatform;
+}

package/lib/actions/sdk/generate.js

@@ -0,0 +1,72 @@
+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 { withDirPath } from "../../infrastructure/tmp-extensions.js";
+import { SdkContext } from "../../types/sdk-context.js";
+import { Platforms } from "@apimatic/sdk";
+import { SpecContext } from "../../types/spec-context.js";
+import { SdkGeneratePrompts } from "../../prompts/sdk/generate.js";
+import { LanguagePlatform } from "../../types/sdk/generate.js";
+export class GenerateAction {
+    constructor(configDir, authKey = null) {
+        this.prompts = new SdkGeneratePrompts();
+        this.zipArchiver = new ZipService();
+        this.fileService = new FileService();
+        this.portalService = new PortalService();
+        this.execute = async (specDirectory, sdkDirectory, platform, commandName, force, zipSdk) => {
+            if (specDirectory.isEqual(sdkDirectory)) {
+                return ActionResult.error(`The spec directory and sdk directory cannot be the same: "${specDirectory}"`);
+            }
+            const specContext = new SpecContext(specDirectory);
+            if (!(await specContext.validate())) {
+                return ActionResult.error(`Unable to locate a valid "src" directory. Navigate to the directory containing your APIMatic Portal source or set up a new project by running apimatic portal:quickstart.`);
+            }
+            const sdkContext = new SdkContext(sdkDirectory, platform);
+            if (!force && (await sdkContext.exists()) && !(await this.prompts.overwriteSdk(sdkDirectory))) {
+                return ActionResult.error("Please enter a different destination folder or remove the existing files and try again.");
+            }
+            return await withDirPath(async (tempDirectory) => {
+                this.prompts.displaySdkGenerationMessage();
+                const specZipPath = new FilePath(tempDirectory, new FileName("spec.zip"));
+                await this.zipArchiver.archive(specDirectory, specZipPath);
+                const sdkPlatform = this.convertSimplePlatformToPlatform(platform);
+                const response = await this.portalService.generateSdk(specZipPath, sdkPlatform, this.configDir, commandName, this.authKey);
+                if (!response.isSuccess()) {
+                    this.prompts.displaySdkGenerationErrorMessage();
+                    return ActionResult.error(response.error);
+                }
+                const tempSdkFilePath = new FilePath(tempDirectory, new FileName("sdk.zip"));
+                await this.fileService.writeFile(tempSdkFilePath, response.value);
+                await sdkContext.save(tempSdkFilePath, zipSdk);
+                this.prompts.displaySdkGenerationSuccessMessage();
+                return ActionResult.success();
+            });
+        };
+        this.configDir = configDir;
+        this.authKey = authKey;
+    }
+    convertSimplePlatformToPlatform(languagePlatform) {
+        switch (languagePlatform) {
+            case LanguagePlatform.CSHARP:
+                return Platforms.CsNetStandardLib;
+            case LanguagePlatform.JAVA:
+                return Platforms.JavaEclipseJreLib;
+            case LanguagePlatform.PHP:
+                return Platforms.PhpGenericLibV2;
+            case LanguagePlatform.PYTHON:
+                return Platforms.PythonGenericLib;
+            case LanguagePlatform.RUBY:
+                return Platforms.RubyGenericLib;
+            case LanguagePlatform.TYPESCRIPT:
+                return Platforms.TsGenericLib;
+            case LanguagePlatform.GO:
+                return Platforms.GoGenericLib;
+            default:
+                throw new Error(`Unknown LanguagePlatform: ${languagePlatform}`);
+        }
+    }
+}
+//# sourceMappingURL=generate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/actions/sdk/generate.ts"],"names":[],"mappings":"AAAA,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,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D,MAAM,OAAO,cAAc;IAQzB,YAAY,SAAwB,EAAE,UAAyB,IAAI;QAPlD,YAAO,GAAuB,IAAI,kBAAkB,EAAE,CAAC;QACvD,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,aAA4B,EAC5B,YAA2B,EAC3B,QAA0B,EAC1B,WAAmB,EACnB,KAAc,EACd,MAAe,EACQ,EAAE;YACzB,IAAI,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBACxC,OAAO,YAAY,CAAC,KAAK,CAAC,6DAA6D,aAAa,GAAG,CAAC,CAAC;YAC3G,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;YACnD,IAAI,CAAC,CAAC,MAAM,WAAW,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;gBACpC,OAAO,YAAY,CAAC,KAAK,CAAC,2KAA2K,CAAC,CAAC;YACzM,CAAC;YAED,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAC1D,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;gBAC9F,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,2BAA2B,EAAE,CAAC;gBAE3C,MAAM,WAAW,GAAG,IAAI,QAAQ,CAAC,aAAa,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC1E,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;gBAE3D,MAAM,WAAW,GAAG,IAAI,CAAC,+BAA+B,CAAC,QAA4B,CAAC,CAAC;gBACvF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE3H,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;oBAC1B,IAAI,CAAC,OAAO,CAAC,gCAAgC,EAAE,CAAC;oBAChD,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAM,CAAC,CAAC;gBAC7C,CAAC;gBAED,MAAM,eAAe,GAAG,IAAI,QAAQ,CAAC,aAAa,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC7E,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,eAAe,EAAyB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAEzF,MAAM,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;gBAC/C,IAAI,CAAC,OAAO,CAAC,kCAAkC,EAAE,CAAC;gBAElD,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAlDA,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAkDO,+BAA+B,CAAC,gBAAkC;QACxE,QAAQ,gBAAgB,EAAE,CAAC;YACzB,KAAK,gBAAgB,CAAC,MAAM;gBAC1B,OAAO,SAAS,CAAC,gBAAgB,CAAC;YACpC,KAAK,gBAAgB,CAAC,IAAI;gBACxB,OAAO,SAAS,CAAC,iBAAiB,CAAC;YACrC,KAAK,gBAAgB,CAAC,GAAG;gBACvB,OAAO,SAAS,CAAC,eAAe,CAAC;YACnC,KAAK,gBAAgB,CAAC,MAAM;gBAC1B,OAAO,SAAS,CAAC,gBAAgB,CAAC;YACpC,KAAK,gBAAgB,CAAC,IAAI;gBACxB,OAAO,SAAS,CAAC,cAAc,CAAC;YAClC,KAAK,gBAAgB,CAAC,UAAU;gBAC9B,OAAO,SAAS,CAAC,YAAY,CAAC;YAChC,KAAK,gBAAgB,CAAC,EAAE;gBACtB,OAAO,SAAS,CAAC,YAAY,CAAC;YAChC;gBACE,MAAM,IAAI,KAAK,CAAC,6BAA6B,gBAAgB,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;CACF"}

package/lib/application/portal/recipe/portal-recipe.d.ts

@@ -0,0 +1,8 @@
+import { SerializableRecipe } from "../../../types/recipe/recipe.js";
+export declare class PortalRecipe {
+    private readonly recipe;
+    constructor(name: string);
+    addContentStep(key: string, name: string, content: string): this;
+    addEndpointStep(key: string, name: string, description: string, endpointPermalink: string): this;
+    toSerializableRecipe(): SerializableRecipe;
+}

package/lib/application/portal/recipe/portal-recipe.js

@@ -0,0 +1,33 @@
+export class PortalRecipe {
+    constructor(name) {
+        this.recipe = {
+            name,
+            steps: []
+        };
+    }
+    addContentStep(key, name, content) {
+        this.recipe.steps.push({
+            key,
+            name,
+            type: 'content',
+            config: { content }
+        });
+        return this;
+    }
+    addEndpointStep(key, name, description, endpointPermalink) {
+        this.recipe.steps.push({
+            key,
+            name,
+            type: 'endpoint',
+            config: {
+                description,
+                endpointPermalink,
+            }
+        });
+        return this;
+    }
+    toSerializableRecipe() {
+        return this.recipe;
+    }
+}
+//# sourceMappingURL=portal-recipe.js.map

package/lib/application/portal/recipe/portal-recipe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal-recipe.js","sourceRoot":"","sources":["../../../../src/application/portal/recipe/portal-recipe.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,YAAY;IAGvB,YAAY,IAAY;QACtB,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI;YACJ,KAAK,EAAE,EAAE;SACV,CAAC;IACJ,CAAC;IAED,cAAc,CAAC,GAAW,EAAE,IAAY,EAAE,OAAe;QACvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACrB,GAAG;YACH,IAAI;YACJ,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,EAAE,OAAO,EAAE;SACpB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,eAAe,CACb,GAAW,EACX,IAAY,EACZ,WAAmB,EACnB,iBAAyB;QAEzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YACrB,GAAG;YACH,IAAI;YACJ,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE;gBACN,WAAW;gBACX,iBAAiB;aAClB;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oBAAoB;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}

package/lib/application/portal/recipe/recipe-generator.d.ts

@@ -0,0 +1,16 @@
+import { SerializableRecipe } from "../../../types/recipe/recipe.js";
+export declare class PortalRecipeGenerator {
+    createRecipe(recipe: SerializableRecipe, buildConfig: any, tocFileContent: any, tocFilePath: string, recipeName: string, recipeFileName: string, buildConfigFilePath: string, contentFolderPath: string): Promise<void>;
+    private addRecipeToToc;
+    private registerRecipeInBuildConfigFile;
+    private writeRecipesConfigToBuildConfigFile;
+    private createMarkdownFile;
+    private createScriptFromRecipe;
+    private saveGeneratedRecipeScriptToBuildDirectory;
+    private generateVerifyFunction;
+    private addContentStepToScript;
+    private addEndpointStepToScript;
+    private getMarkdownFileContent;
+    private formatScript;
+    private toPascalCase;
+}

package/lib/application/portal/recipe/recipe-generator.js

@@ -0,0 +1,147 @@
+import * as path from "path";
+import fs from "fs";
+import prettier from "prettier";
+import { stringify } from "yaml";
+export class PortalRecipeGenerator {
+    //TODO: Replace tocFileContent any type with concrete type.
+    async createRecipe(recipe, buildConfig, tocFileContent, tocFilePath, recipeName, recipeFileName, buildConfigFilePath, contentFolderPath) {
+        await this.addRecipeToToc(tocFileContent, tocFilePath, recipeName, recipeFileName);
+        await this.registerRecipeInBuildConfigFile(buildConfig, recipeName, recipeFileName, buildConfigFilePath);
+        await this.createMarkdownFile(recipeFileName, contentFolderPath);
+        const generatedRecipeScript = await this.createScriptFromRecipe(recipe);
+        const generatedRecipeScriptsDirectoryPath = path.join(contentFolderPath, "static", "scripts", "recipes");
+        await this.saveGeneratedRecipeScriptToBuildDirectory(generatedRecipeScript, generatedRecipeScriptsDirectoryPath, recipeFileName);
+    }
+    async addRecipeToToc(tocData, tocFilePath, recipeName, recipeFileName) {
+        let toc = tocData.toc;
+        let apiRecipesGroup = toc.find((item) => item.group === "API Recipes");
+        if (!apiRecipesGroup) {
+            // If the group doesn't exist, create and insert it after the last group
+            apiRecipesGroup = {
+                group: "API Recipes",
+                items: []
+            };
+            // Insert after the last group section, before any generate sections
+            let lastGroupIdx = -1;
+            for (let i = 0; i < toc.length; i++) {
+                if (toc[i].group)
+                    lastGroupIdx = i;
+            }
+            toc.splice(lastGroupIdx + 1, 0, apiRecipesGroup);
+        }
+        // Only add the recipe if it doesn't already exist
+        const existingRecipe = apiRecipesGroup.items.find((item) => item.page === recipeName || item.file === `recipes/${recipeFileName}.md`);
+        if (!existingRecipe) {
+            apiRecipesGroup.items.push({
+                page: recipeName,
+                file: `recipes/${recipeFileName}.md`
+            });
+            await fs.promises.writeFile(tocFilePath, stringify(tocData));
+        }
+    }
+    async registerRecipeInBuildConfigFile(buildConfig, recipeName, recipeFileName, buildConfigFilePath) {
+        if (!buildConfig.recipes) {
+            buildConfig.recipes = {};
+        }
+        const recipesConfig = buildConfig.recipes;
+        if (!recipesConfig.workflows) {
+            recipesConfig.workflows = [];
+        }
+        const existingIndex = recipesConfig.workflows.findIndex((workflow) => workflow.permalink === `page:recipes/${recipeFileName}`);
+        const newWorkflow = {
+            name: recipeName,
+            permalink: `page:recipes/${recipeFileName}`,
+            functionName: this.toPascalCase(recipeName),
+            scriptPath: `./static/scripts/recipes/${recipeFileName}.js`
+        };
+        if (existingIndex !== -1) {
+            // Replace the existing workflow
+            recipesConfig.workflows[existingIndex] = newWorkflow;
+        }
+        else {
+            // Add as new workflow
+            recipesConfig.workflows.push(newWorkflow);
+        }
+        await this.writeRecipesConfigToBuildConfigFile(recipesConfig, buildConfigFilePath);
+    }
+    async writeRecipesConfigToBuildConfigFile(recipesConfig, buildConfigFilePath) {
+        const fileData = await fs.promises.readFile(buildConfigFilePath, "utf-8");
+        const buildConfig = JSON.parse(fileData);
+        buildConfig.recipes = recipesConfig;
+        await fs.promises.writeFile(buildConfigFilePath, JSON.stringify(buildConfig, null, 2));
+    }
+    async createMarkdownFile(recipeFileName, contentFolder) {
+        const directory = path.join(contentFolder, "content", "recipes");
+        const markdownFileContent = this.getMarkdownFileContent();
+        fs.mkdirSync(directory, { recursive: true });
+        fs.writeFileSync(`${directory}/${recipeFileName}.md`, markdownFileContent);
+    }
+    async createScriptFromRecipe(recipe) {
+        let script = `export default function ${this.toPascalCase(recipe.name)}(workflowCtx, portal) {`;
+        script += "return {";
+        recipe.steps.forEach((step, index) => {
+            script += `"${step.key}": {`;
+            script += `name: "${step.name}",`;
+            script += "stepCallback: async () => {";
+            if (step.type === "content") {
+                script += this.addContentStepToScript(step.config);
+            }
+            else if (step.type === "endpoint") {
+                script += this.addEndpointStepToScript(step.config);
+            }
+            script += "},";
+            script += "}";
+            if (index < recipe.steps.length - 1) {
+                script += ",";
+            }
+        });
+        script += "};";
+        script += "}";
+        return script;
+    }
+    async saveGeneratedRecipeScriptToBuildDirectory(generatedRecipeScript, generatedRecipeScriptsDirectoryPath, recipeFileName, format = false) {
+        if (format) {
+            generatedRecipeScript = await this.formatScript(generatedRecipeScript);
+        }
+        fs.mkdirSync(generatedRecipeScriptsDirectoryPath, { recursive: true });
+        await fs.promises.writeFile(`${generatedRecipeScriptsDirectoryPath}/${recipeFileName}.js`, generatedRecipeScript, "utf8");
+    }
+    generateVerifyFunction() {
+        return `if (response.StatusCode == 200) { return true; } else { setError("API Call wasn't able to get a valid response. Please try again."); return false; }`;
+    }
+    addContentStepToScript(contentConfig) {
+        return `return workflowCtx.showContent(${JSON.stringify(contentConfig.content)});`;
+    }
+    addEndpointStepToScript(endpointConfig) {
+        let script = "return workflowCtx.showEndpoint({";
+        if (endpointConfig.description !== "") {
+            script += `description: ${JSON.stringify(endpointConfig.description)},`;
+        }
+        script += `endpointPermalink: "${endpointConfig.endpointPermalink}",`;
+        script += "verify: (response, setError) => {";
+        script += this.generateVerifyFunction();
+        script += "},";
+        script += "});";
+        return script;
+    }
+    getMarkdownFileContent() {
+        return `# This is a Guided Walkthrough File
+This is the starter content`;
+    }
+    async formatScript(code) {
+        return prettier.format(code, {
+            parser: "babel",
+            semi: true,
+            singleQuote: false,
+            tabWidth: 2,
+            trailingComma: "es5"
+        });
+    }
+    toPascalCase(str) {
+        return str
+            .split(" ")
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+            .join("");
+    }
+}
+//# sourceMappingURL=recipe-generator.js.map

package/lib/application/portal/recipe/recipe-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipe-generator.js","sourceRoot":"","sources":["../../../../src/application/portal/recipe/recipe-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAGjC,MAAM,OAAO,qBAAqB;IAChC,2DAA2D;IACpD,KAAK,CAAC,YAAY,CACvB,MAA0B,EAC1B,WAAgB,EAChB,cAAmB,EACnB,WAAmB,EACnB,UAAkB,EAClB,cAAsB,EACtB,mBAA2B,EAC3B,iBAAyB;QAEzB,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;QACnF,MAAM,IAAI,CAAC,+BAA+B,CAAC,WAAW,EAAE,UAAU,EAAE,cAAc,EAAE,mBAAmB,CAAC,CAAC;QACzG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;QAEjE,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QACxE,MAAM,mCAAmC,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACzG,MAAM,IAAI,CAAC,yCAAyC,CAClD,qBAAqB,EACrB,mCAAmC,EACnC,cAAc,CACf,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,OAAY,EACZ,WAAmB,EACnB,UAAkB,EAClB,cAAsB;QAEtB,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACtB,IAAI,eAAe,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC,CAAC;QAE5E,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,wEAAwE;YACxE,eAAe,GAAG;gBAChB,KAAK,EAAE,aAAa;gBACpB,KAAK,EAAE,EAAE;aACV,CAAC;YACF,oEAAoE;YACpE,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC;YACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACpC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK;oBAAE,YAAY,GAAG,CAAC,CAAC;YACrC,CAAC;YACD,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;QACnD,CAAC;QAED,kDAAkD;QAClD,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,cAAc,EAAE,CAAC;YACpB,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC;gBACzB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,WAAW,cAAc,KAAK;aACrC,CAAC,CAAC;YACH,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,+BAA+B,CAC3C,WAAgB,EAChB,UAAkB,EAClB,cAAsB,EACtB,mBAA2B;QAE3B,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACzB,WAAW,CAAC,OAAO,GAAG,EAAE,CAAC;QAC3B,CAAC;QACD,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC;QAE1C,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;YAC7B,aAAa,CAAC,SAAS,GAAG,EAAE,CAAC;QAC/B,CAAC;QACD,MAAM,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,SAAS,CACrD,CAAC,QAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,KAAK,gBAAgB,cAAc,EAAE,CAC3E,CAAC;QAEF,MAAM,WAAW,GAAG;YAClB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,gBAAgB,cAAc,EAAE;YAC3C,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;YAC3C,UAAU,EAAE,4BAA4B,cAAc,KAAK;SAC5D,CAAC;QAEF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;YACzB,gCAAgC;YAChC,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,WAAW,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,sBAAsB;YACtB,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,IAAI,CAAC,mCAAmC,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAC,mCAAmC,CAAC,aAAqB,EAAE,mBAA2B;QAClG,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEzC,WAAW,CAAC,OAAO,GAAG,aAAa,CAAC;QAEpC,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,cAAsB,EAAE,aAAqB;QAC5E,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACjE,MAAM,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE1D,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7C,EAAE,CAAC,aAAa,CAAC,GAAG,SAAS,IAAI,cAAc,KAAK,EAAE,mBAAmB,CAAC,CAAC;IAC7E,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,MAA0B;QAC7D,IAAI,MAAM,GAAW,2BAA2B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC;QACxG,MAAM,IAAI,UAAU,CAAC;QAErB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACnC,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,MAAM,CAAC;YAC7B,MAAM,IAAI,UAAU,IAAI,CAAC,IAAI,IAAI,CAAC;YAClC,MAAM,IAAI,6BAA6B,CAAC;YAExC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,IAAI,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAA2B,CAAC,CAAC;YAC1E,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBACpC,MAAM,IAAI,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,MAA4B,CAAC,CAAC;YAC5E,CAAC;YAED,MAAM,IAAI,IAAI,CAAC;YACf,MAAM,IAAI,GAAG,CAAC;YAEd,IAAI,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,GAAG,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,IAAI,CAAC;QACf,MAAM,IAAI,GAAG,CAAC;QAEd,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,yCAAyC,CACrD,qBAA6B,EAC7B,mCAA2C,EAC3C,cAAsB,EACtB,SAAkB,KAAK;QAEvB,IAAI,MAAM,EAAE,CAAC;YACX,qBAAqB,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QACzE,CAAC;QAED,EAAE,CAAC,SAAS,CAAC,mCAAmC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,GAAG,mCAAmC,IAAI,cAAc,KAAK,EAC7D,qBAAqB,EACrB,MAAM,CACP,CAAC;IACJ,CAAC;IAEO,sBAAsB;QAC5B,OAAO,sJAAsJ,CAAC;IAChK,CAAC;IAEO,sBAAsB,CAAC,aAAgC;QAC7D,OAAO,kCAAkC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC;IACrF,CAAC;IAEO,uBAAuB,CAAC,cAAkC;QAChE,IAAI,MAAM,GAAG,mCAAmC,CAAC;QACjD,IAAI,cAAc,CAAC,WAAW,KAAK,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,gBAAgB,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,CAAC;QAC1E,CAAC;QACD,MAAM,IAAI,uBAAuB,cAAc,CAAC,iBAAiB,IAAI,CAAC;QACtE,MAAM,IAAI,mCAAmC,CAAC;QAC9C,MAAM,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACxC,MAAM,IAAI,IAAI,CAAC;QACf,MAAM,IAAI,KAAK,CAAC;QAChB,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,sBAAsB;QAC5B,OAAO;4BACiB,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAY;QACrC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,KAAK;YAClB,QAAQ,EAAE,CAAC;YACX,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;IACL,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;CACF"}

package/lib/application/portal/serve/portal-watcher.d.ts

@@ -0,0 +1,11 @@
+import chokidar from "chokidar";
+import { ServePaths } from "../../../types/portal/serve.js";
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+import { ActionResult } from "../../../actions/action-result.js";
+export declare class PortalWatcher {
+    private watcherHandler;
+    constructor();
+    watchAndRegeneratePortalOnChange(paths: ServePaths, commandName: string, generatePortal: (buildDirectory: DirectoryPath, portalDirectory: DirectoryPath, commandName: string, force: boolean, zipPortal: boolean) => Promise<ActionResult>): Promise<chokidar.FSWatcher>;
+    cancelPendingOperations(): void;
+    protected handleFileChange(paths: ServePaths, eventQueue: Map<string, string>, eventId: string, commandName: string, generatePortal: (buildDirectory: DirectoryPath, portalDirectory: DirectoryPath, commandName: string, force: boolean, zipPortal: boolean) => Promise<ActionResult>): Promise<void>;
+}

package/lib/application/portal/serve/portal-watcher.js

@@ -0,0 +1,64 @@
+import chokidar from "chokidar";
+import crypto from "crypto";
+import console from "console";
+import { Mutex } from "async-mutex";
+import { WatcherHandler } from "./watcher-handler.js";
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+export class PortalWatcher {
+    constructor() {
+        this.watcherHandler = new WatcherHandler();
+    }
+    async watchAndRegeneratePortalOnChange(paths, commandName, generatePortal) {
+        //Regex matches any hidden files and folders.
+        const watcher = chokidar.watch(paths.sourceDirectoryPath, {
+            ignored: [/(^|[/\\])\..+/],
+            ignoreInitial: true,
+            persistent: true,
+            awaitWriteFinish: true,
+            atomic: true
+        });
+        const deletedDirectories = new Set();
+        const eventQueue = new Map();
+        const mutex = new Mutex();
+        watcher
+            .on("all", async (event, path) => {
+            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 this.watcherHandler.execute(async () => {
+                await this.handleFileChange(paths, eventQueue, eventId, commandName, generatePortal);
+            });
+        })
+            .on("error", () => {
+            console.error("An unexpected error occurred while watching your build folder for changes. Please try again later. If the issue persists, contact our team at support@apimatic.io");
+            watcher.close();
+        });
+        return watcher;
+    }
+    // TODO: Remove this method. Figure out a better way to do this.
+    cancelPendingOperations() {
+        if (this.watcherHandler) {
+            this.watcherHandler.cancel();
+        }
+    }
+    async handleFileChange(paths, eventQueue, eventId, commandName, generatePortal) {
+        if (!eventQueue.has(eventId)) {
+            return;
+        }
+        const result = await generatePortal(new DirectoryPath(paths.sourceDirectoryPath), new DirectoryPath(paths.destinationDirectoryPath), commandName, true, false);
+        result.map((error) => console.log(error));
+    }
+}
+//# sourceMappingURL=portal-watcher.js.map

package/lib/application/portal/serve/portal-watcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal-watcher.js","sourceRoot":"","sources":["../../../../src/application/portal/serve/portal-watcher.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAGrE,MAAM,OAAO,aAAa;IAGxB;QACE,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAC3C,KAAiB,EACjB,WAAmB,EACnB,cAM0B;QAE1B,6CAA6C;QAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,mBAAmB,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,MAAM,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC;QAE1B,OAAO;aACJ,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,IAAI,KAAK,IAAI,WAAW,EAAE,CAAC;gBACzB,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YAED,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;YAED,MAAM,OAAO,GAAW,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;YAE/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,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;gBAC3C,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;YACvF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;aACD,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAChB,OAAO,CAAC,KAAK,CACX,mKAAmK,CACpK,CAAC;YACF,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC;QAEL,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,gEAAgE;IACzD,uBAAuB;QAC5B,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAES,KAAK,CAAC,gBAAgB,CAC9B,KAAiB,EACjB,UAA+B,EAC/B,OAAe,EACf,WAAmB,EACnB,cAM0B;QAE1B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,cAAc,CACjC,IAAI,aAAa,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAC5C,IAAI,aAAa,CAAC,KAAK,CAAC,wBAAwB,CAAC,EACjD,WAAW,EACX,IAAI,EACJ,KAAK,CACN,CAAC;QACF,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;CACF"}

package/lib/application/portal/serve/serve-handler.d.ts

@@ -0,0 +1,16 @@
+import { Result } from "../../../types/common/result.js";
+import { ServeFlags, ServePaths } from "../../../types/portal/serve.js";
+import { DirectoryPath } from "../../../types/file/directoryPath.js";
+import { ActionResult } from "../../../actions/action-result.js";
+export declare class ServeHandler {
+    private server;
+    private liveReloadServer;
+    private readonly app;
+    private readonly portalWatcher;
+    constructor();
+    setupServer(generatedPortalArtifactsDirectoryPath: string): Promise<Result<string, string>>;
+    startServer(paths: ServePaths, flags: ServeFlags, commandName: string, generatePortal: (buildDirectory: DirectoryPath, portalDirectory: DirectoryPath, commandName: string, force: boolean, zipPortal: boolean) => Promise<ActionResult>, displayShutdownMessages?: boolean): Promise<Result<boolean, string>>;
+    private stopServer;
+    private createLiveReloadServer;
+    private getPortForReloadServer;
+}