@apimatic/cli 1.1.0-alpha.7 → 1.1.0-alpha.9

package/README.md

@@ -17,10 +17,6 @@ To get started with APIMatic's CLI using a step by step wizard, run the followin
 $ apimatic portal:quickstart
 ```
 
-<!-- toc -->
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
 # Usage
 <!-- usage -->
 ```sh-session
@@ -28,7 +24,7 @@ $ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
 $ apimatic (--version)
-@apimatic/cli/0.0.0-alpha.0 win32-x64 node-v20.18.3
+@apimatic/cli/1.1.0-alpha.8 win32-x64 node-v23.4.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -46,6 +42,7 @@ USAGE
 * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
 * [`apimatic portal:generate`](#apimatic-portalgenerate)
+* [`apimatic portal:toc:new`](#apimatic-portaltocnew)
 * [`apimatic portal:quickstart`](#apimatic-portalquickstart)
 * [`apimatic portal:serve`](#apimatic-portalserve)
 * [`apimatic sdk:generate`](#apimatic-sdkgenerate)
@@ -61,18 +58,13 @@ USAGE
 
 FLAGS
   -f, --force                overwrite if same file exist in the destination
-  --auth-key=auth-key        override current authentication state with an authentication key
-
-  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download
-                             transformed file to
-
-  --file=file                path to the API specification file to transform
-
-  --format=format            (required) specification format to transform API specification into
+      --auth-key=<value>     override current authentication state with an authentication key
+      --destination=<value>  [default: ./] directory to download transformed file to
+      --file=<value>         path to the API specification file to transform
+      --format=<value>       (required) specification format to transform API specification into
                              APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|
                              RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA
-
-  --url=url                  URL to the API specification file to transform. Can be used in place of the --file option
+      --url=<value>          URL to the API specification file to transform. Can be used in place of the --file option
                              if the API specification is publicly available.
 
 DESCRIPTION
@@ -99,11 +91,10 @@ USAGE
   $ apimatic api:validate [--file <value>] [--url <value>] [--auth-key <value>]
 
 FLAGS
-  --auth-key=auth-key  override current authentication state with an authentication key
-  --file=file          Path to the API specification file to validate
-
-  --url=url            URL to the specification file to validate. Can be used in place of the --file option if the API
-                       specification is publicly available.
+  --auth-key=<value>  override current authentication state with an authentication key
+  --file=<value>      Path to the API specification file to validate
+  --url=<value>       URL to the specification file to validate. Can be used in place of the --file option if the API
+                      specification is publicly available.
 
 DESCRIPTION
   Validate the syntactic and semantic correctness of an API specification
@@ -127,16 +118,15 @@ USAGE
   $ apimatic auth:login [--auth-key <value>]
 
 FLAGS
-  --auth-key=auth-key  Set authentication key for all commands
+  --auth-key=<value>  Set authentication key for all commands
 
 DESCRIPTION
   Login using your APIMatic credentials or an API Key
 
 EXAMPLES
   $ apimatic auth:login
-  Please enter your registered email: apimatic-user@gmail.com
+  Enter your registered email: apimatic-user@gmail.com
   Please enter your password: *********
-
   You have successfully logged into APIMatic
 
   $ apimatic auth:login --auth-key=xxxxxx
@@ -213,10 +203,13 @@ Display help for apimatic.
 
 ```
 USAGE
-  $ apimatic help [COMMAND]
+  $ apimatic help [COMMAND...] [-n]
 
 ARGUMENTS
-  COMMAND  command to show help for
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
 
 DESCRIPTION
   Display help for apimatic.
@@ -234,6 +227,11 @@ USAGE
 
 FLAGS
   -f, --force                overwrite if a portal exists in the destination
+      --auth-key=<value>     override current authentication state with an authentication key
+      --destination=<value>  [default: ./generated_portal] path to the downloaded portal
+      --folder=<value>       [default: ./] path to the input directory containing API specifications and config files
+      --zip                  download the generated portal as a .zip archive
+
 DESCRIPTION
   Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a
   config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platfo
@@ -246,22 +244,66 @@ EXAMPLES
 
 _See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/generate.ts)_
 
+## `apimatic portal:toc:new`
+
+Generates a TOC file based on the content directory and spec folder provided in your working directory
+
+```
+USAGE
+  $ apimatic portal:toc:new [--destination <value>] [--folder <value>] [--force] [--expand-endpoints]
+    [--expand-models]
+
+FLAGS
+  --destination=<value>  optional path where the generated TOC file will be saved. Defaults to the current working
+                         directory if not provided.
+  --expand-endpoints     include individual entries for each endpoint in the generated TOC. Requires a valid API
+                         specification in the working directory.
+  --expand-models        include individual entries for each model in the generated TOC. Requires a valid API
+                         specification in the working directory.
+  --folder=<value>       [default: ./] path to the working directory containing the API project
+                         files. Defaults to the current working directory if not specified.
+  --force                overwrite the TOC file if one already exists at the destination.
+
+DESCRIPTION
+  Generates a TOC file based on the content directory and spec folder provided in your working directory
+
+  This command generates a new Table of Contents (TOC) file used in the
+  generation of your API documentation portal.
+
+  The output is a YAML file with the .yml extension.
+
+  To learn more about the TOC file and APIMatic build directory structure, visit:
+  https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal
+
+EXAMPLES
+  $ apimatic portal:toc:new --destination="./portal/content/"
+  A new toc file has been created at ./portal/content/toc.yml
+
+  $ apimatic portal:toc:new --folder="./my-project" 
+  A new toc file has been created at ./my-project/content/toc.yml
+
+  $ apimatic portal:toc:new --folder="./my-project" --destination="./portal/content/"
+  A new toc file has been created at ./portal/content/toc.yml
+```
+
+_See code: [src/commands/portal/toc/new/toc.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/toc/new/toc.ts)_
+
 ## `apimatic portal:quickstart`
 
-Create your first API Portal using APIMatic’s Docs as Code offering.
+Create your first API Portal using APIMatic's Docs as Code offering.
 
 ```
 USAGE
   $ apimatic portal:quickstart
 
 DESCRIPTION
-  Create your first API Portal using APIMatic’s Docs as Code offering.
+  Create your first API Portal using APIMatic's Docs as Code offering.
 
 EXAMPLES
   $ apimatic portal:quickstart
 ```
 
-_See code: [src/commands/portal/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.11/src/commands/portal/quickstart.ts)_
+_See code: [src/commands/portal/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/quickstart.ts)_
 
 ## `apimatic portal:serve`
 
@@ -269,10 +311,11 @@ Generate and deploy a Docs as Code portal with hot reload.
 
 ```
 USAGE
-  $ apimatic portal:serve [-p <value>] [-d <value>] [-s <value>] [-o] [--no-reload] [-i <value>] [--auth-key <value>]
+  $ apimatic portal:serve [-p <value>] [-d <value>] [-s <value>] [-o] [--no-reload] [-i <value>] [--auth-key
+    <value>]
 
 FLAGS
-  -d, --destination=<value>  [default: ./api-portal] Directory to store and serve the generated portal.
+  -d, --destination=<value>  [default: ./generated_portal] Directory to store and serve the generated portal.
   -i, --ignore=<value>       Comma-separated list of files/directories to ignore.
   -o, --open                 Open the portal in the default browser.
   -p, --port=<value>         [default: 3000] Port to serve the portal.
@@ -285,10 +328,10 @@ DESCRIPTION
   Generate and deploy a Docs as Code portal with hot reload.
 
 EXAMPLES
-  $ apimatic portal:serve --source="./" --destination="./api-portal" --port=3000 --open --no-reload
+  $ apimatic portal:serve --source="./" --destination="./generated_portal" --port=3000 --open --no-reload
 ```
 
-_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.11/src/commands/portal/serve.ts)_
+_See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/serve.ts)_
 
 ## `apimatic sdk:generate`
 
@@ -296,24 +339,19 @@ Generate SDK for your APIs
 
 ```
 USAGE
-  $ apimatic sdk:generate --platform <value> [--file <value>] [--url <value>] [--destination <value>] [-f] [--zip] [--auth-key <value>]
+  $ apimatic sdk:generate --platform <value> [--file <value>] [--url <value>] [--destination <value>] [-f] [--zip]
+    [--auth-key <value>]
 
 FLAGS
   -f, --force                overwrite if an SDK already exists in the destination
-  --auth-key=auth-key        override current authentication state with an authentication key
-
-  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download the
-                             generated SDK to
-
-  --file=file                path to the API specification to generate SDKs for
-
-  --platform=platform        (required) language platform for sdk
-                             Simple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT
-                             Legacy: CS_NET_STANDARD_LIB|CS_PORTABLE_NET_LIB|CS_UNIVERSAL_WINDOWS_PLATFORM_LIB|
-                             JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB|PYTHON_GENERIC_LIB|RUBY_GENERIC_LIB|
-                             TS_GENERIC_LIB
-
-  --url=url                  URL to the API specification to generate SDKs for. Can be used in place of the --file
+      --auth-key=<value>     override current authentication state with an authentication key
+      --destination=<value>  [default: ./] directory to download the generated SDK to
+      --file=<value>         path to the API specification to generate SDKs for
+      --platform=<value>     (required) language platform for sdk
+                             Simple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT|GO
+                             Legacy: CS_NET_STANDARD_LIB|JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB_V2|PYTHON_GENERIC_LIB|RUBY
+                             _GENERIC_LIB|TS_GENERIC_LIB|GO_GENERIC_LIB
+      --url=<value>          URL to the API specification to generate SDKs for. Can be used in place of the --file
                              option if the API specification is publicly available.
       --zip                  download the generated SDK as a .zip archive
 

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

@@ -0,0 +1,7 @@
+import { PortalPaths, GenerateFlags } from "../../types/portal/generate";
+export declare class PortalGenerateAction {
+    private readonly prompts;
+    constructor();
+    generatePortal(paths: PortalPaths, flags: GenerateFlags, configDir: string): Promise<void>;
+    private saveGeneratedPortalStreamToZipFile;
+}

package/lib/actions/portal/generate.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortalGenerateAction = void 0;
+const path = require("path");
+const fs = require("fs-extra");
+const portal_service_1 = require("../../infrastructure/services/portal-service");
+const result_1 = require("../../types/common/result");
+const utils_1 = require("../../utils/utils");
+const generate_1 = require("../../prompts/portal/generate");
+class PortalGenerateAction {
+    constructor() {
+        this.prompts = new generate_1.PortalGeneratePrompts();
+    }
+    async generatePortal(paths, flags, configDir) {
+        var _a;
+        this.prompts.displayPortalGenerationMessage();
+        const pathsToIgnore = (0, utils_1.getGeneratedFilesPaths)(paths.sourceFolderPath, paths.generatedPortalArtifactsFolderPath);
+        //TODO: Refactor this method, carries dual responsibility.
+        const sourceBuildInputZipFilePath = await (0, utils_1.validateAndZipPortalSource)(paths.sourceFolderPath, path.join(paths.sourceFolderPath, ".portal_source.zip"), pathsToIgnore);
+        const generatePortalParams = {
+            sourceBuildInputZipFilePath: sourceBuildInputZipFilePath,
+            generatedPortalArtifactsFolderPath: paths.generatedPortalArtifactsFolderPath,
+            generatedPortalArtifactsZipFilePath: paths.generatedPortalArtifactsZipFilePath,
+            overrideAuthKey: (_a = flags["auth-key"]) !== null && _a !== void 0 ? _a : null,
+            generateZipFile: flags.zip
+        };
+        const docsPortalService = new portal_service_1.PortalService();
+        const portalGenerationResult = await docsPortalService.generateOnPremPortal(generatePortalParams, configDir);
+        await (0, utils_1.deleteFile)(sourceBuildInputZipFilePath);
+        if (portalGenerationResult.isSuccess()) {
+            await this.saveGeneratedPortalStreamToZipFile(portalGenerationResult.value, paths.generatedPortalArtifactsZipFilePath);
+            if (flags.zip) {
+                this.prompts.displayPortalGenerationSuccessMessage();
+                this.prompts.displayOutroMessage(paths.generatedPortalArtifactsZipFilePath);
+                return;
+            }
+            await (0, utils_1.extractZipFile)(paths.generatedPortalArtifactsZipFilePath, paths.generatedPortalArtifactsFolderPath);
+            await (0, utils_1.deleteFile)(paths.generatedPortalArtifactsZipFilePath);
+            this.prompts.displayPortalGenerationSuccessMessage();
+            this.prompts.displayOutroMessage(paths.generatedPortalArtifactsFolderPath);
+        }
+        else {
+            this.prompts.displayPortalGenerationErrorMessage();
+            this.prompts.logError((0, utils_1.getMessageInRedColor)(`${portalGenerationResult.error}`));
+        }
+    }
+    async saveGeneratedPortalStreamToZipFile(data, generatedPortalArtifactsZipFilePath) {
+        const writeStream = fs.createWriteStream(generatedPortalArtifactsZipFilePath);
+        await new Promise((resolve, reject) => {
+            data
+                .pipe(writeStream)
+                .on("finish", () => resolve())
+                .on("error", (error) => reject(result_1.Result.failure(`Failed to save downloaded portal to file: ${error.message}`)));
+        });
+    }
+}
+exports.PortalGenerateAction = PortalGenerateAction;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJhdGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvYWN0aW9ucy9wb3J0YWwvZ2VuZXJhdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsNkJBQTZCO0FBQzdCLCtCQUErQjtBQUMvQixpRkFBNkU7QUFFN0Usc0RBQW1EO0FBQ25ELDZDQU0yQjtBQUMzQiw0REFBc0U7QUFFdEUsTUFBYSxvQkFBb0I7SUFHL0I7UUFDRSxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksZ0NBQXFCLEVBQUUsQ0FBQztJQUM3QyxDQUFDO0lBRUQsS0FBSyxDQUFDLGNBQWMsQ0FBQyxLQUFrQixFQUFFLEtBQW9CLEVBQUUsU0FBaUI7O1FBQzlFLElBQUksQ0FBQyxPQUFPLENBQUMsOEJBQThCLEVBQUUsQ0FBQztRQUM5QyxNQUFNLGFBQWEsR0FBRyxJQUFBLDhCQUFzQixFQUFDLEtBQUssQ0FBQyxnQkFBZ0IsRUFBRSxLQUFLLENBQUMsa0NBQWtDLENBQUMsQ0FBQztRQUUvRywwREFBMEQ7UUFDMUQsTUFBTSwyQkFBMkIsR0FBRyxNQUFNLElBQUEsa0NBQTBCLEVBQ2xFLEtBQUssQ0FBQyxnQkFBZ0IsRUFDdEIsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLEVBQUUsb0JBQW9CLENBQUMsRUFDdkQsYUFBYSxDQUNkLENBQUM7UUFFRixNQUFNLG9CQUFvQixHQUF5QjtZQUNqRCwyQkFBMkIsRUFBRSwyQkFBMkI7WUFDeEQsa0NBQWtDLEVBQUUsS0FBSyxDQUFDLGtDQUFrQztZQUM1RSxtQ0FBbUMsRUFBRSxLQUFLLENBQUMsbUNBQW1DO1lBQzlFLGVBQWUsRUFBRSxNQUFBLEtBQUssQ0FBQyxVQUFVLENBQUMsbUNBQUksSUFBSTtZQUMxQyxlQUFlLEVBQUUsS0FBSyxDQUFDLEdBQUc7U0FDM0IsQ0FBQztRQUVGLE1BQU0saUJBQWlCLEdBQUcsSUFBSSw4QkFBYSxFQUFFLENBQUM7UUFDOUMsTUFBTSxzQkFBc0IsR0FBRyxNQUFNLGlCQUFpQixDQUFDLG9CQUFvQixDQUFDLG9CQUFvQixFQUFFLFNBQVMsQ0FBQyxDQUFDO1FBQzdHLE1BQU0sSUFBQSxrQkFBVSxFQUFDLDJCQUEyQixDQUFDLENBQUM7UUFFOUMsSUFBSSxzQkFBc0IsQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDO1lBQ3ZDLE1BQU0sSUFBSSxDQUFDLGtDQUFrQyxDQUMzQyxzQkFBc0IsQ0FBQyxLQUFNLEVBQzdCLEtBQUssQ0FBQyxtQ0FBbUMsQ0FDMUMsQ0FBQztZQUVGLElBQUksS0FBSyxDQUFDLEdBQUcsRUFBRSxDQUFDO2dCQUNkLElBQUksQ0FBQyxPQUFPLENBQUMscUNBQXFDLEVBQUUsQ0FBQztnQkFDckQsSUFBSSxDQUFDLE9BQU8sQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLENBQUMsbUNBQW1DLENBQUMsQ0FBQztnQkFDNUUsT0FBTztZQUNULENBQUM7WUFFRCxNQUFNLElBQUEsc0JBQWMsRUFBQyxLQUFLLENBQUMsbUNBQW1DLEVBQUUsS0FBSyxDQUFDLGtDQUFrQyxDQUFDLENBQUM7WUFDMUcsTUFBTSxJQUFBLGtCQUFVLEVBQUMsS0FBSyxDQUFDLG1DQUFtQyxDQUFDLENBQUM7WUFFNUQsSUFBSSxDQUFDLE9BQU8sQ0FBQyxxQ0FBcUMsRUFBRSxDQUFDO1lBQ3JELElBQUksQ0FBQyxPQUFPLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDLGtDQUFrQyxDQUFDLENBQUM7UUFDN0UsQ0FBQzthQUFNLENBQUM7WUFDTixJQUFJLENBQUMsT0FBTyxDQUFDLG1DQUFtQyxFQUFFLENBQUM7WUFDbkQsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQ25CLElBQUEsNEJBQW9CLEVBQUMsR0FBRyxzQkFBc0IsQ0FBQyxLQUFNLEVBQUUsQ0FBQyxDQUN6RCxDQUFDO1FBQ0osQ0FBQztJQUNILENBQUM7SUFFTyxLQUFLLENBQUMsa0NBQWtDLENBQzlDLElBQTJCLEVBQzNCLG1DQUEyQztRQUUzQyxNQUFNLFdBQVcsR0FBRyxFQUFFLENBQUMsaUJBQWlCLENBQUMsbUNBQW1DLENBQUMsQ0FBQztRQUM5RSxNQUFNLElBQUksT0FBTyxDQUFPLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxFQUFFO1lBQzFDLElBQUk7aUJBQ0QsSUFBSSxDQUFDLFdBQVcsQ0FBQztpQkFDakIsRUFBRSxDQUFDLFFBQVEsRUFBRSxHQUFHLEVBQUUsQ0FBQyxPQUFPLEVBQUUsQ0FBQztpQkFDN0IsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsTUFBTSxDQUFDLGVBQU0sQ0FBQyxPQUFPLENBQUMsNkNBQTZDLEtBQUssQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNsSCxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7Q0FDRjtBQW5FRCxvREFtRUMifQ==

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

@@ -0,0 +1,17 @@
+import { Result } from "../../../types/common/result";
+export declare class PortalNewTocAction {
+    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;
+}

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

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortalNewTocAction = void 0;
+const path = require("path");
+const fs = require("fs-extra");
+const new_toc_1 = require("../../../prompts/portal/toc/new-toc");
+const result_1 = require("../../../types/common/result");
+const utils_1 = require("../../../utils/utils");
+const sdl_parser_1 = require("../../../application/portal/toc/sdl-parser");
+const toc_structure_generator_1 = require("../../../application/portal/toc/toc-structure-generator");
+const toc_content_parser_1 = require("../../../application/portal/toc/toc-content-parser");
+const portal_service_1 = require("../../../infrastructure/services/portal-service");
+const DEFAULT_TOC_FILENAME = "toc.yml";
+const APIMATIC_BUILD_FILENAME = "APIMATIC-BUILD.json";
+class PortalNewTocAction {
+    constructor() {
+        this.prompts = new new_toc_1.PortalNewTocPrompts();
+        this.sdlParser = new sdl_parser_1.SdlParser(new portal_service_1.PortalService());
+        this.tocGenerator = new toc_structure_generator_1.TocStructureGenerator();
+        this.contentParser = new toc_content_parser_1.TocContentParser();
+    }
+    async createToc(workingDirectory, configDir, destination, force = false, expandEndpoints = false, expandModels = false) {
+        try {
+            const tocDir = await this.getDestinationPath(workingDirectory, destination);
+            const tocPath = path.join(tocDir, DEFAULT_TOC_FILENAME);
+            const tocCheckResult = await this.handleExistingToc(tocPath, force);
+            if (!tocCheckResult.isSuccess()) {
+                return tocCheckResult;
+            }
+            const { endpointGroups, models } = await this.extractSdlComponents(workingDirectory, configDir, expandEndpoints, expandModels);
+            const contentGroups = await this.extractContentGroups(workingDirectory);
+            const toc = this.tocGenerator.createTocStructure(endpointGroups, models, expandEndpoints, expandModels, contentGroups);
+            const yamlString = this.tocGenerator.transformToYaml(toc);
+            await this.writeToc(tocPath, yamlString, "utf8");
+            this.prompts.displayOutroMessage(tocPath);
+            return result_1.Result.success(tocPath);
+        }
+        catch (error) {
+            this.prompts.logError((0, utils_1.getMessageInRedColor)(`${error}`));
+            return result_1.Result.failure(`❌ An unexpected error occurred while generating the TOC file.`);
+        }
+    }
+    async writeToc(path, content, encoding) {
+        await fs.ensureFile(path);
+        await fs.writeFile(path, content, encoding);
+    }
+    async handleExistingToc(tocPath, force) {
+        const shouldContinue = await this.checkExistingToc(tocPath, force);
+        if (!shouldContinue) {
+            return result_1.Result.cancelled("Operation was cancelled by the user.");
+        }
+        return result_1.Result.success("TOC check passed.");
+    }
+    async extractSdlComponents(workingDirectory, 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(workingDirectory);
+        if (!(await fs.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, workingDirectory, 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(workingDirectory) {
+        const contentFolderPath = await this.getContentFolderPath(workingDirectory);
+        if (!(await fs.pathExists(contentFolderPath))) {
+            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, contentFolderPath);
+    }
+    async getDestinationPath(workingDirectory, providedDestination) {
+        if (providedDestination === undefined) {
+            const inferredDestination = await this.getContentFolderPath(workingDirectory);
+            return inferredDestination;
+        }
+        return providedDestination;
+    }
+    async checkExistingToc(tocPath, force) {
+        if ((await fs.pathExists(tocPath)) && !force) {
+            return await this.prompts.overwriteExistingTocPrompt();
+        }
+        return true;
+    }
+    async getContentFolderPath(workingDirectory) {
+        var _a;
+        const buildFilePath = path.join(workingDirectory, APIMATIC_BUILD_FILENAME);
+        const defaultContentFolder = path.join(workingDirectory, "content");
+        if (!(await fs.pathExists(buildFilePath))) {
+            return defaultContentFolder;
+        }
+        try {
+            const buildConfig = await fs.readJson(buildFilePath, "utf8");
+            if (((_a = buildConfig.generatePortal) === null || _a === void 0 ? void 0 : _a.contentFolder) == null) {
+                return defaultContentFolder;
+            }
+            return path.join(workingDirectory, buildConfig.generatePortal.contentFolder, "content");
+        }
+        catch (_b) {
+            return defaultContentFolder;
+        }
+    }
+    async getSpecFolderPath(workingDirectory) {
+        var _a;
+        const buildFilePath = path.join(workingDirectory, APIMATIC_BUILD_FILENAME);
+        const defaultSpecFolder = path.join(workingDirectory, "spec");
+        if (!(await fs.pathExists(buildFilePath))) {
+            return defaultSpecFolder;
+        }
+        try {
+            const buildConfig = await fs.readJson(buildFilePath, "utf8");
+            if (((_a = buildConfig.generatePortal) === null || _a === void 0 ? void 0 : _a.apiSpecPath) == null) {
+                return defaultSpecFolder;
+            }
+            return path.join(workingDirectory, buildConfig.generatePortal.apiSpecPath);
+        }
+        catch (_b) {
+            return defaultSpecFolder;
+        }
+    }
+}
+exports.PortalNewTocAction = PortalNewTocAction;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmV3LXRvYy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hY3Rpb25zL3BvcnRhbC90b2MvbmV3LXRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw2QkFBNkI7QUFDN0IsK0JBQStCO0FBQy9CLGlFQUEwRTtBQUMxRSx5REFBc0Q7QUFDdEQsZ0RBQTREO0FBQzVELDJFQUF1RTtBQUN2RSxxR0FBZ0c7QUFDaEcsMkZBQXNGO0FBRXRGLG9GQUFnRjtBQUVoRixNQUFNLG9CQUFvQixHQUFHLFNBQVMsQ0FBQztBQUN2QyxNQUFNLHVCQUF1QixHQUFHLHFCQUFxQixDQUFDO0FBRXRELE1BQWEsa0JBQWtCO0lBTTdCO1FBQ0UsSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLDZCQUFtQixFQUFFLENBQUM7UUFDekMsSUFBSSxDQUFDLFNBQVMsR0FBRyxJQUFJLHNCQUFTLENBQUMsSUFBSSw4QkFBYSxFQUFFLENBQUMsQ0FBQztRQUNwRCxJQUFJLENBQUMsWUFBWSxHQUFHLElBQUksK0NBQXFCLEVBQUUsQ0FBQztRQUNoRCxJQUFJLENBQUMsYUFBYSxHQUFHLElBQUkscUNBQWdCLEVBQUUsQ0FBQztJQUM5QyxDQUFDO0lBRUQsS0FBSyxDQUFDLFNBQVMsQ0FDYixnQkFBd0IsRUFDeEIsU0FBaUIsRUFDakIsV0FBb0IsRUFDcEIsUUFBaUIsS0FBSyxFQUN0QixrQkFBMkIsS0FBSyxFQUNoQyxlQUF3QixLQUFLO1FBRTdCLElBQUksQ0FBQztZQUNILE1BQU0sTUFBTSxHQUFHLE1BQU0sSUFBSSxDQUFDLGtCQUFrQixDQUFDLGdCQUFnQixFQUFFLFdBQVcsQ0FBQyxDQUFDO1lBQzVFLE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLG9CQUFvQixDQUFDLENBQUM7WUFDeEQsTUFBTSxjQUFjLEdBQUcsTUFBTSxJQUFJLENBQUMsaUJBQWlCLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDO1lBQ3BFLElBQUksQ0FBQyxjQUFjLENBQUMsU0FBUyxFQUFFLEVBQUUsQ0FBQztnQkFDaEMsT0FBTyxjQUFjLENBQUM7WUFDeEIsQ0FBQztZQUVELE1BQU0sRUFBRSxjQUFjLEVBQUUsTUFBTSxFQUFFLEdBQUcsTUFBTSxJQUFJLENBQUMsb0JBQW9CLENBQ2hFLGdCQUFnQixFQUNoQixTQUFTLEVBQ1QsZUFBZSxFQUNmLFlBQVksQ0FDYixDQUFDO1lBRUYsTUFBTSxhQUFhLEdBQUcsTUFBTSxJQUFJLENBQUMsb0JBQW9CLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztZQUV4RSxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsWUFBWSxDQUFDLGtCQUFrQixDQUM5QyxjQUFjLEVBQ2QsTUFBTSxFQUNOLGVBQWUsRUFDZixZQUFZLEVBQ1osYUFBYSxDQUNkLENBQUM7WUFDRixNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsWUFBWSxDQUFDLGVBQWUsQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUMxRCxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLENBQUMsQ0FBQztZQUVqRCxJQUFJLENBQUMsT0FBTyxDQUFDLG1CQUFtQixDQUFDLE9BQU8sQ0FBQyxDQUFDO1lBQzFDLE9BQU8sZUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNqQyxDQUFDO1FBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztZQUNmLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLElBQUEsNEJBQW9CLEVBQUMsR0FBRyxLQUFLLEVBQUUsQ0FBQyxDQUFDLENBQUM7WUFDeEQsT0FBTyxlQUFNLENBQUMsT0FBTyxDQUFDLCtEQUErRCxDQUFDLENBQUM7UUFDekYsQ0FBQztJQUNILENBQUM7SUFFTyxLQUFLLENBQUMsUUFBUSxDQUFDLElBQVksRUFBRSxPQUFlLEVBQUUsUUFBZ0I7UUFDcEUsTUFBTSxFQUFFLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzFCLE1BQU0sRUFBRSxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsT0FBTyxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFFTyxLQUFLLENBQUMsaUJBQWlCLENBQUMsT0FBZSxFQUFFLEtBQWM7UUFDN0QsTUFBTSxjQUFjLEdBQUcsTUFBTSxJQUFJLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQ25FLElBQUksQ0FBQyxjQUFjLEVBQUUsQ0FBQztZQUNwQixPQUFPLGVBQU0sQ0FBQyxTQUFTLENBQUMsc0NBQXNDLENBQUMsQ0FBQztRQUNsRSxDQUFDO1FBQ0QsT0FBTyxlQUFNLENBQUMsT0FBTyxDQUFDLG1CQUFtQixDQUFDLENBQUM7SUFDN0MsQ0FBQztJQUVPLEtBQUssQ0FBQyxvQkFBb0IsQ0FDaEMsZ0JBQXdCLEVBQ3hCLFNBQWlCLEVBQ2pCLGVBQXdCLEVBQ3hCLFlBQXFCO1FBRXJCLElBQUksQ0FBQyxlQUFlLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztZQUN0QyxPQUFPLEVBQUUsY0FBYyxFQUFFLElBQUksR0FBRyxFQUFFLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxDQUFDO1FBQ25ELENBQUM7UUFFRCxJQUFJLENBQUMsT0FBTyxDQUFDLGlDQUFpQyxDQUFDLGtFQUFrRSxDQUFDLENBQUM7UUFDbkgsTUFBTSxjQUFjLEdBQUcsTUFBTSxJQUFJLENBQUMsaUJBQWlCLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUV0RSxJQUFJLENBQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxVQUFVLENBQUMsY0FBYyxDQUFDLENBQUMsRUFBRSxDQUFDO1lBQzNDLElBQUksQ0FBQyxPQUFPLENBQUMsZ0NBQWdDLENBQUMsa0RBQWtELGNBQWMsRUFBRSxDQUFDLENBQUM7WUFDbEgsSUFBSSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsK0VBQStFLENBQUMsQ0FBQztZQUMxRyxPQUFPLEVBQUUsY0FBYyxFQUFFLElBQUksR0FBRyxFQUFFLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxDQUFDO1FBQ25ELENBQUM7UUFFRCxNQUFNLFNBQVMsR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsdUJBQXVCLENBQUMsY0FBYyxFQUFFLGdCQUFnQixFQUFFLFNBQVMsQ0FBQyxDQUFDO1FBRTVHLElBQUksQ0FBQyxTQUFTLENBQUMsU0FBUyxFQUFFLEVBQUUsQ0FBQztZQUMzQixJQUFJLENBQUMsT0FBTyxDQUFDLGdDQUFnQyxDQUFDLE1BQU0sU0FBUyxDQUFDLEtBQU0sRUFBRSxDQUFDLENBQUM7WUFDeEUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsK0VBQStFLENBQUMsQ0FBQztZQUMxRyxPQUFPLEVBQUUsY0FBYyxFQUFFLElBQUksR0FBRyxFQUFFLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxDQUFDO1FBQ25ELENBQUM7UUFFRCxJQUFJLENBQUMsT0FBTyxDQUFDLGdDQUFnQyxDQUFDLDBFQUEwRSxDQUFDLENBQUM7UUFDMUgsT0FBTyxTQUFTLENBQUMsS0FBTSxDQUFDO0lBQzFCLENBQUM7SUFFTyxLQUFLLENBQUMsb0JBQW9CLENBQUMsZ0JBQXdCO1FBQ3pELE1BQU0saUJBQWlCLEdBQUcsTUFBTSxJQUFJLENBQUMsb0JBQW9CLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUU1RSxJQUFJLENBQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxVQUFVLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxFQUFFLENBQUM7WUFDOUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsOENBQThDLGlCQUFpQixFQUFFLENBQUMsQ0FBQztZQUM1RixJQUFJLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyw0Q0FBNEMsQ0FBQyxDQUFDO1lBQ3ZFLE9BQU8sRUFBRSxDQUFDO1FBQ1osQ0FBQztRQUVELE9BQU8sTUFBTSxJQUFJLENBQUMsYUFBYSxDQUFDLGtCQUFrQixDQUFDLGlCQUFpQixFQUFFLGlCQUFpQixDQUFDLENBQUM7SUFDM0YsQ0FBQztJQUVPLEtBQUssQ0FBQyxrQkFBa0IsQ0FBQyxnQkFBd0IsRUFBRSxtQkFBNEI7UUFDckYsSUFBSSxtQkFBbUIsS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUN0QyxNQUFNLG1CQUFtQixHQUFHLE1BQU0sSUFBSSxDQUFDLG9CQUFvQixDQUFDLGdCQUFnQixDQUFDLENBQUM7WUFDOUUsT0FBTyxtQkFBbUIsQ0FBQztRQUM3QixDQUFDO1FBQ0QsT0FBTyxtQkFBbUIsQ0FBQztJQUM3QixDQUFDO0lBRU8sS0FBSyxDQUFDLGdCQUFnQixDQUFDLE9BQWUsRUFBRSxLQUFjO1FBQzVELElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQzdDLE9BQU8sTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDLDBCQUEwQixFQUFFLENBQUM7UUFDekQsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVPLEtBQUssQ0FBQyxvQkFBb0IsQ0FBQyxnQkFBd0I7O1FBQ3pELE1BQU0sYUFBYSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsdUJBQXVCLENBQUMsQ0FBQztRQUMzRSxNQUFNLG9CQUFvQixHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFFcEUsSUFBSSxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsVUFBVSxDQUFDLGFBQWEsQ0FBQyxDQUFDLEVBQUUsQ0FBQztZQUMxQyxPQUFPLG9CQUFvQixDQUFDO1FBQzlCLENBQUM7UUFFRCxJQUFJLENBQUM7WUFDSCxNQUFNLFdBQVcsR0FBRyxNQUFNLEVBQUUsQ0FBQyxRQUFRLENBQUMsYUFBYSxFQUFFLE1BQU0sQ0FBQyxDQUFDO1lBRTdELElBQUksQ0FBQSxNQUFBLFdBQVcsQ0FBQyxjQUFjLDBDQUFFLGFBQWEsS0FBSSxJQUFJLEVBQUUsQ0FBQztnQkFDdEQsT0FBTyxvQkFBb0IsQ0FBQztZQUM5QixDQUFDO1lBQ0QsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLGdCQUFnQixFQUFFLFdBQVcsQ0FBQyxjQUFjLENBQUMsYUFBYSxFQUFFLFNBQVMsQ0FBQyxDQUFDO1FBQzFGLENBQUM7UUFBQyxXQUFNLENBQUM7WUFDUCxPQUFPLG9CQUFvQixDQUFDO1FBQzlCLENBQUM7SUFDSCxDQUFDO0lBRU8sS0FBSyxDQUFDLGlCQUFpQixDQUFDLGdCQUF3Qjs7UUFDdEQsTUFBTSxhQUFhLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSx1QkFBdUIsQ0FBQyxDQUFDO1FBQzNFLE1BQU0saUJBQWlCLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUU5RCxJQUFJLENBQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxVQUFVLENBQUMsYUFBYSxDQUFDLENBQUMsRUFBRSxDQUFDO1lBQzFDLE9BQU8saUJBQWlCLENBQUM7UUFDM0IsQ0FBQztRQUVELElBQUksQ0FBQztZQUNILE1BQU0sV0FBVyxHQUFHLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyxhQUFhLEVBQUUsTUFBTSxDQUFDLENBQUM7WUFFN0QsSUFBSSxDQUFBLE1BQUEsV0FBVyxDQUFDLGNBQWMsMENBQUUsV0FBVyxLQUFJLElBQUksRUFBRSxDQUFDO2dCQUNwRCxPQUFPLGlCQUFpQixDQUFDO1lBQzNCLENBQUM7WUFDRCxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsV0FBVyxDQUFDLGNBQWMsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUM3RSxDQUFDO1FBQUMsV0FBTSxDQUFDO1lBQ1AsT0FBTyxpQkFBaUIsQ0FBQztRQUMzQixDQUFDO0lBQ0gsQ0FBQztDQUNGO0FBdEtELGdEQXNLQyJ9

package/lib/application/portal/toc/sdl-parser.d.ts

@@ -0,0 +1,13 @@
+import { PortalService } from "../../../infrastructure/services/portal-service";
+import { TocEndpoint, TocModel } from "../../../types/toc/toc";
+import { Result } from "../../../types/common/result";
+export declare class SdlParser {
+    private readonly portalService;
+    constructor(portalService: PortalService);
+    getTocComponentsFromSdl(specFolderPath: string, workingDirectory: string, configDir: string): Promise<Result<{
+        endpointGroups: Map<string, TocEndpoint[]>;
+        models: TocModel[];
+    }, string>>;
+    private extractEndpointGroups;
+    private extractModels;
+}

package/lib/application/portal/toc/sdl-parser.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdlParser = void 0;
+const path = require("path");
+const utils_1 = require("../../../utils/utils");
+const result_1 = require("../../../types/common/result");
+class SdlParser {
+    constructor(portalService) {
+        this.portalService = portalService;
+    }
+    async getTocComponentsFromSdl(specFolderPath, workingDirectory, configDir) {
+        const sourceSpecInputZipFilePath = await (0, utils_1.validateAndZipPortalSource)(specFolderPath, path.join(workingDirectory, ".spec_source.zip"));
+        try {
+            const result = await this.portalService.generateSdl(sourceSpecInputZipFilePath, configDir);
+            if (!result.isSuccess()) {
+                return result_1.Result.failure("Failed to extract endpoints/models from the specification. Please validate your spec using APIMatic's interactive VS Code extension");
+            }
+            const sdl = result.value;
+            const endpointGroups = this.extractEndpointGroups(sdl);
+            const models = this.extractModels(sdl);
+            return result_1.Result.success({ endpointGroups, models });
+        }
+        finally {
+            await (0, utils_1.deleteFile)(sourceSpecInputZipFilePath);
+        }
+    }
+    extractEndpointGroups(sdl) {
+        const endpointGroups = new Map();
+        const endpoints = sdl.Endpoints.map((e) => ({
+            generate: null,
+            from: "endpoint",
+            endpointName: e.Name,
+            endpointGroup: e.Group
+        }));
+        endpoints.forEach((endpoint) => {
+            const group = endpoint.endpointGroup;
+            if (!endpointGroups.has(group)) {
+                endpointGroups.set(group, []);
+            }
+            endpointGroups.get(group).push(endpoint);
+        });
+        return endpointGroups;
+    }
+    extractModels(sdl) {
+        return sdl.CustomTypes.map((e) => ({
+            generate: null,
+            from: "model",
+            modelName: e.Name
+        }));
+    }
+}
+exports.SdlParser = SdlParser;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2RsLXBhcnNlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHBsaWNhdGlvbi9wb3J0YWwvdG9jL3NkbC1wYXJzZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsNkJBQTZCO0FBRTdCLGdEQUE4RTtBQUU5RSx5REFBc0Q7QUFHdEQsTUFBYSxTQUFTO0lBQ3BCLFlBQTZCLGFBQTRCO1FBQTVCLGtCQUFhLEdBQWIsYUFBYSxDQUFlO0lBQUcsQ0FBQztJQUU3RCxLQUFLLENBQUMsdUJBQXVCLENBQUMsY0FBc0IsRUFBRSxnQkFBd0IsRUFBRSxTQUFpQjtRQUMvRixNQUFNLDBCQUEwQixHQUFHLE1BQU0sSUFBQSxrQ0FBMEIsRUFDakUsY0FBYyxFQUNkLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsa0JBQWtCLENBQUMsQ0FDaEQsQ0FBQztRQUVGLElBQUksQ0FBQztZQUNILE1BQU0sTUFBTSxHQUFHLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxXQUFXLENBQUMsMEJBQTBCLEVBQUUsU0FBUyxDQUFDLENBQUM7WUFFM0YsSUFBSSxDQUFDLE1BQU0sQ0FBQyxTQUFTLEVBQUUsRUFBRSxDQUFDO2dCQUN4QixPQUFPLGVBQU0sQ0FBQyxPQUFPLENBQUMscUlBQXFJLENBQUMsQ0FBQTtZQUM5SixDQUFDO1lBRUQsTUFBTSxHQUFHLEdBQVMsTUFBTSxDQUFDLEtBQU0sQ0FBQTtZQUMvQixNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMscUJBQXFCLENBQUMsR0FBRyxDQUFDLENBQUM7WUFDdkQsTUFBTSxNQUFNLEdBQUcsSUFBSSxDQUFDLGFBQWEsQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUV2QyxPQUFPLGVBQU0sQ0FBQyxPQUFPLENBQUMsRUFBRSxjQUFjLEVBQUUsTUFBTSxFQUFFLENBQUMsQ0FBQztRQUNwRCxDQUFDO2dCQUFTLENBQUM7WUFDVCxNQUFNLElBQUEsa0JBQVUsRUFBQywwQkFBMEIsQ0FBQyxDQUFDO1FBQy9DLENBQUM7SUFDSCxDQUFDO0lBRU8scUJBQXFCLENBQUMsR0FBUTtRQUNwQyxNQUFNLGNBQWMsR0FBRyxJQUFJLEdBQUcsRUFBeUIsQ0FBQztRQUV4RCxNQUFNLFNBQVMsR0FBRyxHQUFHLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQWMsRUFBZSxFQUFFLENBQUMsQ0FBQztZQUNwRSxRQUFRLEVBQUUsSUFBSTtZQUNkLElBQUksRUFBRSxVQUFVO1lBQ2hCLFlBQVksRUFBRSxDQUFDLENBQUMsSUFBSTtZQUNwQixhQUFhLEVBQUUsQ0FBQyxDQUFDLEtBQUs7U0FDdkIsQ0FBQyxDQUFDLENBQUM7UUFFSixTQUFTLENBQUMsT0FBTyxDQUFDLENBQUMsUUFBcUIsRUFBRSxFQUFFO1lBQzFDLE1BQU0sS0FBSyxHQUFHLFFBQVEsQ0FBQyxhQUFhLENBQUM7WUFDckMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztnQkFDL0IsY0FBYyxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDaEMsQ0FBQztZQUNELGNBQWMsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFFLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQzVDLENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQUVPLGFBQWEsQ0FBQyxHQUFRO1FBQzVCLE9BQU8sR0FBRyxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFXLEVBQVksRUFBRSxDQUFDLENBQUM7WUFDckQsUUFBUSxFQUFFLElBQUk7WUFDZCxJQUFJLEVBQUUsT0FBTztZQUNiLFNBQVMsRUFBRSxDQUFDLENBQUMsSUFBSTtTQUNsQixDQUFDLENBQUMsQ0FBQztJQUNOLENBQUM7Q0FDRjtBQXRERCw4QkFzREMifQ==

package/lib/application/portal/toc/toc-content-parser.d.ts

@@ -0,0 +1,5 @@
+import { TocGroup } from "../../../types/toc/toc";
+export declare class TocContentParser {
+    parseContentFolder(contentFolderPath: string, workingDirectory: string): Promise<TocGroup[]>;
+    private normalizePath;
+}

package/lib/application/portal/toc/toc-content-parser.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TocContentParser = void 0;
+const path = require("path");
+const fs = require("fs-extra");
+class TocContentParser {
+    async parseContentFolder(contentFolderPath, workingDirectory) {
+        const items = await fs.readdir(contentFolderPath);
+        const contentItems = [];
+        for (const item of items) {
+            const itemPath = path.join(contentFolderPath, item);
+            const stats = await fs.stat(itemPath);
+            if (stats.isDirectory()) {
+                const subItems = await this.parseContentFolder(itemPath, workingDirectory);
+                if (subItems.length > 0) {
+                    contentItems.push({
+                        group: item,
+                        items: subItems[0].items // Take items from the Custom Content group
+                    });
+                }
+            }
+            else if (stats.isFile() && item.endsWith(".md")) {
+                const relativePath = path.relative(workingDirectory, itemPath);
+                const pageName = path.basename(item, ".md");
+                contentItems.push({
+                    page: pageName,
+                    file: this.normalizePath(relativePath)
+                });
+            }
+        }
+        // Return empty array if no markdown files were found
+        if (contentItems.length === 0) {
+            return [];
+        }
+        // Wrap everything under a "Custom Content" group
+        return [{
+                group: "Custom Content",
+                items: contentItems
+            }];
+    }
+    normalizePath(path) {
+        return path.replace(/\\/g, '/');
+    }
+}
+exports.TocContentParser = TocContentParser;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidG9jLWNvbnRlbnQtcGFyc2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcGxpY2F0aW9uL3BvcnRhbC90b2MvdG9jLWNvbnRlbnQtcGFyc2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZCQUE2QjtBQUM3QiwrQkFBK0I7QUFHL0IsTUFBYSxnQkFBZ0I7SUFDM0IsS0FBSyxDQUFDLGtCQUFrQixDQUFDLGlCQUF5QixFQUFFLGdCQUF3QjtRQUMxRSxNQUFNLEtBQUssR0FBRyxNQUFNLEVBQUUsQ0FBQyxPQUFPLENBQUMsaUJBQWlCLENBQUMsQ0FBQztRQUNsRCxNQUFNLFlBQVksR0FBaUMsRUFBRSxDQUFDO1FBRXRELEtBQUssTUFBTSxJQUFJLElBQUksS0FBSyxFQUFFLENBQUM7WUFDekIsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxJQUFJLENBQUMsQ0FBQztZQUNwRCxNQUFNLEtBQUssR0FBRyxNQUFNLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7WUFFdEMsSUFBSSxLQUFLLENBQUMsV0FBVyxFQUFFLEVBQUUsQ0FBQztnQkFDeEIsTUFBTSxRQUFRLEdBQUcsTUFBTSxJQUFJLENBQUMsa0JBQWtCLENBQUMsUUFBUSxFQUFFLGdCQUFnQixDQUFDLENBQUM7Z0JBQzNFLElBQUksUUFBUSxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztvQkFDeEIsWUFBWSxDQUFDLElBQUksQ0FBQzt3QkFDaEIsS0FBSyxFQUFFLElBQUk7d0JBQ1gsS0FBSyxFQUFFLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsMkNBQTJDO3FCQUNyRSxDQUFDLENBQUM7Z0JBQ0wsQ0FBQztZQUNILENBQUM7aUJBQU0sSUFBSSxLQUFLLENBQUMsTUFBTSxFQUFFLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO2dCQUNsRCxNQUFNLFlBQVksR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLGdCQUFnQixFQUFFLFFBQVEsQ0FBQyxDQUFDO2dCQUMvRCxNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQztnQkFFNUMsWUFBWSxDQUFDLElBQUksQ0FBQztvQkFDaEIsSUFBSSxFQUFFLFFBQVE7b0JBQ2QsSUFBSSxFQUFFLElBQUksQ0FBQyxhQUFhLENBQUMsWUFBWSxDQUFDO2lCQUN2QyxDQUFDLENBQUM7WUFDTCxDQUFDO1FBQ0gsQ0FBQztRQUVELHFEQUFxRDtRQUNyRCxJQUFJLFlBQVksQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDOUIsT0FBTyxFQUFFLENBQUM7UUFDWixDQUFDO1FBRUQsaURBQWlEO1FBQ2pELE9BQU8sQ0FBQztnQkFDTixLQUFLLEVBQUUsZ0JBQWdCO2dCQUN2QixLQUFLLEVBQUUsWUFBWTthQUNwQixDQUFDLENBQUM7SUFDTCxDQUFDO0lBRU8sYUFBYSxDQUFDLElBQVk7UUFDaEMsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssRUFBRSxHQUFHLENBQUMsQ0FBQztJQUNsQyxDQUFDO0NBQ0Y7QUEzQ0QsNENBMkNDIn0=

package/lib/application/portal/toc/toc-structure-generator.d.ts

@@ -0,0 +1,6 @@
+import { Toc, TocGroup, TocEndpoint, TocModel } from "../../../types/toc/toc";
+export declare class TocStructureGenerator {
+    createTocStructure(endpointGroups: Map<string, TocEndpoint[]>, models: TocModel[], expandEndpoints?: boolean, expandModels?: boolean, contentGroups?: TocGroup[]): Toc;
+    transformToYaml(toc: Toc): string;
+    private transformKeys;
+}