@apimatic/cli 1.1.0-alpha.1 → 1.1.0-alpha.10

package/README.md

@@ -1,5 +1,6 @@
 @apimatic/cli
 =============
+apimatic is in Alpha.
 
 The official CLI for APIMatic.
 
@@ -8,18 +9,22 @@ The official CLI for APIMatic.
 [![Downloads/week](https://img.shields.io/npm/dw/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
 [![License](https://img.shields.io/npm/l/@apimatic/cli.svg)](https://github.com/apimatic/apimatic-cli/blob/master/package.json)
 
-<!-- toc -->
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
+# Getting Started
+
+To get started with APIMatic's CLI using a step by step wizard, run the following command: 
+
+```sh-session
+$ apimatic portal:quickstart
+```
+
 # Usage
 <!-- usage -->
 ```sh-session
-$ npm install -g @apimatic/cli@1.0.1-alpha.3
+$ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
-$ apimatic (-v|--version|version)
-@apimatic/cli/0.0.0-alpha.3 linux-x64 node-v16.13.0
+$ apimatic (--version)
+@apimatic/cli/1.1.0-alpha.10 win32-x64 node-v23.4.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -37,6 +42,10 @@ USAGE
 * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
 * [`apimatic portal:generate`](#apimatic-portalgenerate)
+* [`apimatic portal:quickstart`](#apimatic-portalquickstart)
+* [`apimatic portal:recipe:new`](#apimatic-portalrecipenew)
+* [`apimatic portal:serve`](#apimatic-portalserve)
+* [`apimatic portal:toc:new`](#apimatic-portaltocnew)
 * [`apimatic sdk:generate`](#apimatic-sdkgenerate)
 
 ## `apimatic api:transform`
@@ -45,24 +54,25 @@ Transform API specifications from one format to another. Supports [10+ different
 
 ```
 USAGE
-  $ apimatic api:transform
+  $ apimatic api:transform --format <value> [--file <value>] [--url <value>] [--destination <value>] [-f]
+    [--auth-key <value>]
 
-OPTIONS
+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
+  Transform API specifications from one format to another. Supports [10+ different
+  formats](https://www.apimatic.io/transformer/#supported-formats) including OpenApi/Swagger, RAML, WSDL and Postman
+  Collections.
+
 EXAMPLES
   $ apimatic api:transform --format="OpenApi3Json" --file="./specs/sample.json" --destination="D:/"
   Success! Your transformed file is located at D:/Transformed_OpenApi3Json.json
@@ -71,7 +81,7 @@ EXAMPLES
   Success! Your transformed file is located at D:/swagger_raml.yaml
 ```
 
-_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/api/transform.ts)_
 
 ## `apimatic api:validate`
 
@@ -79,14 +89,16 @@ Validate the syntactic and semantic correctness of an API specification
 
 ```
 USAGE
-  $ apimatic api:validate
+  $ apimatic api:validate [--file <value>] [--url <value>] [--auth-key <value>]
 
-OPTIONS
-  --auth-key=auth-key  override current authentication state with an authentication key
-  --file=file          Path to the API specification file to validate
+FLAGS
+  --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.
 
-  --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.
+DESCRIPTION
+  Validate the syntactic and semantic correctness of an API specification
 
 EXAMPLES
   $ apimatic api:validate --file="./specs/sample.json"
@@ -96,7 +108,7 @@ EXAMPLES
   Specification file provided is valid
 ```
 
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/api/validate.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/api/validate.ts)_
 
 ## `apimatic auth:login`
 
@@ -104,23 +116,25 @@ Login using your APIMatic credentials or an API Key
 
 ```
 USAGE
-  $ apimatic auth:login
+  $ apimatic auth:login [--auth-key <value>]
+
+FLAGS
+  --auth-key=<value>  Set authentication key for all commands
 
-OPTIONS
-  --auth-key=auth-key  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
   Authentication key successfully set
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/login.ts)_
 
 ## `apimatic auth:logout`
 
@@ -130,12 +144,15 @@ Clear local login credentials
 USAGE
   $ apimatic auth:logout
 
-EXAMPLE
+DESCRIPTION
+  Clear local login credentials
+
+EXAMPLES
   $ apimatic auth:logout
   Logged out
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/logout.ts)_
 
 ## `apimatic auth:status`
 
@@ -145,27 +162,33 @@ View current authentication state
 USAGE
   $ apimatic auth:status
 
-EXAMPLE
+DESCRIPTION
+  View current authentication state
+
+EXAMPLES
   $ apimatic auth:status
   Currently logged in as apimatic-client@gmail.com
 ```
 
-_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/status.ts)_
 
 ## `apimatic autocomplete [SHELL]`
 
-display autocomplete installation instructions
+Display autocomplete installation instructions.
 
 ```
 USAGE
-  $ apimatic autocomplete [SHELL]
+  $ apimatic autocomplete [SHELL] [-r]
 
 ARGUMENTS
   SHELL  shell type
 
-OPTIONS
+FLAGS
   -r, --refresh-cache  Refresh cache (ignores displaying instructions)
 
+DESCRIPTION
+  Display autocomplete installation instructions.
+
 EXAMPLES
   $ apimatic autocomplete
   $ apimatic autocomplete bash
@@ -173,74 +196,199 @@ EXAMPLES
   $ apimatic autocomplete --refresh-cache
 ```
 
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/main/src/commands/autocomplete/index.ts)_
 
 ## `apimatic help [COMMAND]`
 
-display help for apimatic
+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.
 
-OPTIONS
-  --all  see all commands in CLI
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for apimatic.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.14/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/main/src/commands/help.ts)_
 
 ## `apimatic portal:generate`
 
-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://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)
+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/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
 ```
 USAGE
-  $ apimatic portal:generate
+  $ apimatic portal:generate [--folder <value>] [--destination <value>] [-f] [--zip] [--auth-key <value>]
 
-OPTIONS
+FLAGS
   -f, --force                overwrite if a portal 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] path to the downloaded portal
-  --folder=folder            [default: ./] path to the input directory containing API specifications and config files
-  --zip                      download the generated portal as a .zip archive
+      --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
+  rm-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
-EXAMPLE
+EXAMPLES
   $ apimatic portal:generate --folder="./portal/" --destination="D:/"
   Your portal has been generated at D:/
 ```
 
-_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/portal/generate.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/generate.ts)_
 
-## `apimatic sdk:generate`
+## `apimatic portal:quickstart`
 
-Generate SDK for your APIs
+Create your first API Portal using APIMatic's Docs as Code offering.
 
 ```
 USAGE
-  $ apimatic sdk:generate
+  $ apimatic portal:quickstart
 
-OPTIONS
-  -f, --force                overwrite if an SDK already exists in the destination
-  --auth-key=auth-key        override current authentication state with an authentication key
+DESCRIPTION
+  Create your first API Portal using APIMatic's Docs as Code offering.
+
+EXAMPLES
+  $ apimatic portal:quickstart
+```
 
-  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download the
-                             generated SDK to
+_See code: [src/commands/portal/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/quickstart.ts)_
 
-  --file=file                path to the API specification to generate SDKs for
+## `apimatic portal:recipe:new`
 
-  --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
+Generate an API Recipe for a static API Documentation portal.
 
-  --url=url                  URL to the API specification to generate SDKs for. Can be used in place of the --file
+```
+USAGE
+  $ apimatic portal:recipe:new [--name <value>] [--folder <value>] [--build-config <value>]
+
+FLAGS
+  --build-config=<value>  path to the APIMATIC-BUILD.json file. Defaults to the APIMATIC-BUILD.json file in the build
+                          directory if not provided.
+  --folder=<value>        [default: C:\Users\Ali\Desktop\apimatic-cli] path to the build directory containing specs,
+                          content, and build config file. Defaults to the current working directory if not provided.
+  --name=<value>          name for the recipe
+
+DESCRIPTION
+  Generate an API Recipe for a static API Documentation portal.
+
+  To learn more about API Recipes, visit:
+  https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes
+
+EXAMPLES
+  $ apimatic portal:recipe:new --name="My API Recipe" --folder="./build-folder" --build-config-file="./build-folder/APIMATIC-BUILD.json"
+  Generated recipe has been added to build directory at: C:/build-folder/
+
+  $ apimatic portal:recipe:new
+  Generated recipe has been added to build directory at: C:/
+```
+
+_See code: [src/commands/portal/recipe/new.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/recipe/new.ts)_
+
+## `apimatic portal:serve`
+
+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>]
+
+FLAGS
+  -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.
+  -s, --source=<value>       [default: ./] Source directory containing specs, content, and build file. By default, the
+                             current directory is used.
+      --auth-key=<value>     Override current authentication state with an authentication key.
+      --no-reload            Disable hot reload.
+
+DESCRIPTION
+  Generate and deploy a Docs as Code portal with hot reload.
+
+EXAMPLES
+  $ 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/alpha/src/commands/portal/serve.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: C:\Users\Ali\Desktop\apimatic-cli] 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.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/toc/new.ts)_
+
+## `apimatic sdk:generate`
+
+Generate SDK for your APIs
+
+```
+USAGE
+  $ 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=<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
 
-  --zip                      download the generated SDK as a .zip archive
+DESCRIPTION
+  Generate SDK for your APIs
 
 EXAMPLES
   $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
@@ -254,5 +402,5 @@ EXAMPLES
   Success! Your SDK is located at swagger_sdk_csharp
 ```
 
-_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/sdk/generate.ts)_
 <!-- commandsstop -->

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

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

@@ -0,0 +1,7 @@
+import { PortalPaths, GenerateFlags } from "../../types/portal/generate.js";
+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,54 @@
+import * as path from "path";
+import fsExtra from "fs-extra";
+import { PortalService } from "../../infrastructure/services/portal-service.js";
+import { Result } from "../../types/common/result.js";
+import { getGeneratedFilesPaths, validateAndZipPortalSource, deleteFile, extractZipFile, getMessageInRedColor } from "../../utils/utils.js";
+import { PortalGeneratePrompts } from "../../prompts/portal/generate.js";
+export class PortalGenerateAction {
+    constructor() {
+        this.prompts = new PortalGeneratePrompts();
+    }
+    async generatePortal(paths, flags, configDir) {
+        var _a;
+        this.prompts.displayPortalGenerationMessage();
+        const pathsToIgnore = getGeneratedFilesPaths(paths.sourceFolderPath, paths.generatedPortalArtifactsFolderPath);
+        //TODO: Refactor this method, carries dual responsibility.
+        const sourceBuildInputZipFilePath = await 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 PortalService();
+        const portalGenerationResult = await docsPortalService.generateOnPremPortal(generatePortalParams, configDir);
+        await 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 extractZipFile(paths.generatedPortalArtifactsZipFilePath, paths.generatedPortalArtifactsFolderPath);
+            await deleteFile(paths.generatedPortalArtifactsZipFilePath);
+            this.prompts.displayPortalGenerationSuccessMessage();
+            this.prompts.displayOutroMessage(paths.generatedPortalArtifactsFolderPath);
+        }
+        else {
+            this.prompts.displayPortalGenerationErrorMessage();
+            this.prompts.logError(getMessageInRedColor(`${portalGenerationResult.error}`));
+        }
+    }
+    async saveGeneratedPortalStreamToZipFile(data, generatedPortalArtifactsZipFilePath) {
+        const writeStream = fsExtra.createWriteStream(generatedPortalArtifactsZipFilePath);
+        await new Promise((resolve, reject) => {
+            data
+                .pipe(writeStream)
+                .on("finish", () => resolve())
+                .on("error", (error) => reject(Result.failure(`Failed to save downloaded portal to file: ${error.message}`)));
+        });
+    }
+}
+//# sourceMappingURL=generate.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/actions/portal/generate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,iDAAiD,CAAC;AAEhF,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC1B,UAAU,EACV,cAAc,EACd,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAEzE,MAAM,OAAO,oBAAoB;IAG/B;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,KAAkB,EAAE,KAAoB,EAAE,SAAiB;;QAC9E,IAAI,CAAC,OAAO,CAAC,8BAA8B,EAAE,CAAC;QAC9C,MAAM,aAAa,GAAG,sBAAsB,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAE/G,0DAA0D;QAC1D,MAAM,2BAA2B,GAAG,MAAM,0BAA0B,CAClE,KAAK,CAAC,gBAAgB,EACtB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,EACvD,aAAa,CACd,CAAC;QAEF,MAAM,oBAAoB,GAAyB;YACjD,2BAA2B,EAAE,2BAA2B;YACxD,kCAAkC,EAAE,KAAK,CAAC,kCAAkC;YAC5E,mCAAmC,EAAE,KAAK,CAAC,mCAAmC;YAC9E,eAAe,EAAE,MAAA,KAAK,CAAC,UAAU,CAAC,mCAAI,IAAI;YAC1C,eAAe,EAAE,KAAK,CAAC,GAAG;SAC3B,CAAC;QAEF,MAAM,iBAAiB,GAAG,IAAI,aAAa,EAAE,CAAC;QAC9C,MAAM,sBAAsB,GAAG,MAAM,iBAAiB,CAAC,oBAAoB,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;QAC7G,MAAM,UAAU,CAAC,2BAA2B,CAAC,CAAC;QAE9C,IAAI,sBAAsB,CAAC,SAAS,EAAE,EAAE,CAAC;YACvC,MAAM,IAAI,CAAC,kCAAkC,CAC3C,sBAAsB,CAAC,KAAM,EAC7B,KAAK,CAAC,mCAAmC,CAC1C,CAAC;YAEF,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;gBACd,IAAI,CAAC,OAAO,CAAC,qCAAqC,EAAE,CAAC;gBACrD,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;gBAC5E,OAAO;YACT,CAAC;YAED,MAAM,cAAc,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;YAC1G,MAAM,UAAU,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;YAE5D,IAAI,CAAC,OAAO,CAAC,qCAAqC,EAAE,CAAC;YACrD,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,CAAC,mCAAmC,EAAE,CAAC;YACnD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,GAAG,sBAAsB,CAAC,KAAM,EAAE,CAAC,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,kCAAkC,CAC9C,IAA2B,EAC3B,mCAA2C;QAE3C,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,mCAAmC,CAAC,CAAC;QACnF,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,IAAI;iBACD,IAAI,CAAC,WAAW,CAAC;iBACjB,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;iBAC7B,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,6CAA6C,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QAClH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

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

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