@apimatic/cli 1.1.0-alpha.14 → 1.1.0-alpha.15

package/README.md

@@ -41,6 +41,7 @@ USAGE
 * [`apimatic auth:status`](#apimatic-authstatus)
 * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
+* [`apimatic portal:copilot`](#apimatic-portalcopilot)
 * [`apimatic portal:generate`](#apimatic-portalgenerate)
 * [`apimatic portal:quickstart`](#apimatic-portalquickstart)
 * [`apimatic portal:recipe:new`](#apimatic-portalrecipenew)
@@ -54,13 +55,12 @@ Transform API specifications from one format to another. Supports [10+ different
 
 ```
 USAGE
-  $ apimatic api:transform --format <value> [--file <value>] [--url <value>] [--destination <value>] [-f]
-    [--auth-key <value>]
+  $ apimatic api:transform --format <value> [--file <value>] [--url <value>] [-d <value>] [-f] [-k <value>]
 
 FLAGS
-  -f, --force                overwrite if same file exist in the destination
-      --auth-key=<value>     override current authentication state with an authentication key
-      --destination=<value>  [default: ./] directory to download transformed file to
+  -d, --destination=<value>  [default: ./] directory to download transformed file to
+  -f, --force                overwrite changes without asking for user consent.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
       --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|
@@ -87,13 +87,13 @@ Validate the syntactic and semantic correctness of an API specification
 
 ```
 USAGE
-  $ apimatic api:validate [--file <value>] [--url <value>] [--auth-key <value>]
+  $ apimatic api:validate [--file <value>] [--url <value>] [-k <value>]
 
 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.
+  -k, --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
@@ -112,10 +112,10 @@ Login using your APIMatic credentials or an API Key
 
 ```
 USAGE
-  $ apimatic auth:login [--auth-key <value>]
+  $ apimatic auth:login [-k <value>]
 
 FLAGS
-  --auth-key=<value>  Set authentication key for all commands
+  -k, --auth-key=<value>  Sets authentication key for all commands.
 
 DESCRIPTION
   Login using your APIMatic credentials or an API Key
@@ -123,21 +123,21 @@ DESCRIPTION
 EXAMPLES
   $ apimatic auth:login
 
-  $ apimatic auth:login --auth-key=xxxxxx
+  $ apimatic auth:login --auth-key={api-key}
 ```
 
 _See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/login.ts)_
 
 ## `apimatic auth:logout`
 
-Clear local login credentials
+Clears the local login credentials.
 
 ```
 USAGE
   $ apimatic auth:logout
 
 DESCRIPTION
-  Clear local login credentials
+  Clears the local login credentials.
 
 EXAMPLES
   $ apimatic auth:logout
@@ -147,14 +147,14 @@ _See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cl
 
 ## `apimatic auth:status`
 
-View current authentication state
+View the currently logged in user.
 
 ```
 USAGE
   $ apimatic auth:status
 
 DESCRIPTION
-  View current authentication state
+  View the currently logged in user.
 
 EXAMPLES
   $ apimatic auth:status
@@ -208,20 +208,46 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/main/src/commands/help.ts)_
 
+## `apimatic portal:copilot`
+
+Adds the API Copilot configuration in APIMATIC-BUILD.json
+
+```
+USAGE
+  $ apimatic portal:copilot [-i <value>] [-m <value>] [--disable] [-k <value>]
+
+FLAGS
+  -i, --input=<value>            [default: ./] path to the parent directory containing the 'src' directory, which
+                                 includes API specifications and configuration files.
+  -k, --auth-key=<value>         override current authentication state with an authentication key.
+  -m, --welcome-message=<value>  welcome message for the API copilot
+      --disable                  marks the API Copilot as disabled in the configuration
+
+DESCRIPTION
+  Adds the API Copilot configuration in APIMATIC-BUILD.json
+
+EXAMPLES
+  $ apimatic portal:copilot --input="./" --welcome-message="Welcome to our API!"
+
+  $ apimatic portal:copilot --input="./"
+```
+
+_See code: [src/commands/portal/copilot.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/copilot.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://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
 ```
 USAGE
-  $ apimatic portal:generate [--folder <value>] [--destination <value>] [-f] [--zip] [--auth-key <value>]
+  $ apimatic portal:generate [-i <value>] [-d <value>] [-f] [--zip] [-k <value>]
 
 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: <folder>/portal] path to the generated portal
-      --folder=<value>       [default: ./] path to the parent directory containing the 'build' folder, 
-                             which includes API specifications and configuration files.
+  -d, --destination=<value>  [default: <input>/portal] path where the portal will be generated.
+  -f, --force                overwrite changes without asking for user consent.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
       --zip                  download the generated portal as a .zip archive
 
 DESCRIPTION
@@ -230,7 +256,9 @@ DESCRIPTION
   rm-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)
 
 EXAMPLES
-  $ apimatic portal:generate --folder="./portal/" --destination="D:/"
+  $ apimatic portal:generate
+
+  $ apimatic portal:generate --input="./" --destination="./portal"
 ```
 
 _See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/generate.ts)_
@@ -258,12 +286,12 @@ Generate an API Recipe for a static API Documentation portal.
 
 ```
 USAGE
-  $ apimatic portal:recipe:new [--name <value>] [--folder <value>]
+  $ apimatic portal:recipe:new [--name <value>] [-i <value>]
 
 FLAGS
-  --folder=<value>        [default: ./] path to the parent directory containing the 
-                          'build' folder, which includes API specifications and configuration files.
-  --name=<value>          name for the recipe
+  -i, --input=<value>  [default: ./] path to the parent directory containing the 'src' directory, which includes API
+                       specifications and configuration files.
+      --name=<value>   name for the recipe
 
 DESCRIPTION
   Generate an API Recipe for a static API Documentation portal.
@@ -272,9 +300,9 @@ DESCRIPTION
   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"
-
   $ apimatic portal:recipe:new
+
+  $ apimatic portal:recipe:new --name="My API Recipe" --input="./"
 ```
 
 _See code: [src/commands/portal/recipe/new.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/recipe/new.ts)_
@@ -285,25 +313,26 @@ Generate and deploy a Docs as Code portal with hot reload.
 
 ```
 USAGE
-  $ apimatic portal:serve [-p <value>] [-destination <value>] [--folder <value>] [-o] [--no-reload] [-i <value>] [--auth-key
-    <value>]
+  $ apimatic portal:serve [-p <value>] [-i <value>] [-d <value>] [-o] [--no-reload] [-i <value>] [-k <value>]
 
 FLAGS
+  -d, --destination=<value>  [default: <input>/portal] path where the portal will be generated.
   -i, --ignore=<value>       Comma-separated list of file and directory paths to exclude from portal generation and hot
                              reload.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
   -o, --open                 Open the portal in the default browser.
-  -p, --port=<value>         Port to serve the portal.
-      --auth-key=<value>     Override current authentication state with an authentication key.
-      --folder=<value>       [default: ./] Path to the parent directory containing the 'build' folder, 
-                             which includes API specifications and configuration files.
-      --destination=<value>  [default: <folder>/portal] Path to the generated portal.
+  -p, --port=<value>         [default: 3000] port to serve the portal.
       --no-reload            Disable hot reload.
 
 DESCRIPTION
   Generate and deploy a Docs as Code portal with hot reload.
 
 EXAMPLES
-  $ apimatic portal:serve --folder="./" --destination="./portal" --port=3000 --open --no-reload
+  $ apimatic portal:serve
+
+  $ apimatic portal:serve --input="./" --destination="./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)_
@@ -314,18 +343,17 @@ Generates a TOC file based on the content directory and spec folder provided in
 
 ```
 USAGE
-  $ apimatic portal:toc:new [--destination <value>] [--folder <value>] [--force] [--expand-endpoints]
-    [--expand-models]
+  $ apimatic portal:toc:new [-d <value>] [-i <value>] [-f] [--expand-endpoints] [--expand-models]
 
 FLAGS
-  --destination=<value>  [default: <folder>/build/content] optional path where the generated toc.yml file will be saved.
-  --expand-endpoints     include individual entries for each endpoint in the generated toc.yml. Requires a valid API
-                         specification in the working directory.
-  --expand-models        include individual entries for each model in the generated toc.yml. Requires a valid API
-                         specification in the working directory.
-  --folder=<value>       [default: ./] Path to the parent directory containing the 'build' folder, 
-                         which includes API specifications and configuration files.
-  --force                overwrite the toc.yml file if one already exists at the destination.
+  -d, --destination=<value>  [default: <input>/src/content] path where the 'toc.yml' will be generated.
+  -f, --force                overwrite changes without asking for user consent.
+  -i, --input=<value>        [default: ./] path to the parent directory containing the 'src' directory, which includes
+                             API specifications and configuration files.
+      --expand-endpoints     include individual entries for each endpoint in the generated 'toc.yml'. Requires a valid
+                             API specification in the working directory.
+      --expand-models        include individual entries for each model in the generated 'toc.yml'. Requires a valid API
+                             specification in the working directory.
 
 DESCRIPTION
   Generates a TOC file based on the content directory and spec folder provided in your working directory
@@ -339,45 +367,41 @@ DESCRIPTION
   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/"
+  $ apimatic portal:toc:new --destination="./src/content/"
 
-  $ apimatic portal:toc:new --folder="./my-project" 
+  $ apimatic portal:toc:new --input="./"
 
-  $ apimatic portal:toc:new --folder="./my-project" --destination="./portal/content/"
+  $ apimatic portal:toc:new --input="./" --destination="./src/content/"
 ```
 
 _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
+Generates SDK for your API
 
 ```
 USAGE
-  $ apimatic sdk:generate --platform <value> [--file <value>] [--url <value>] [--destination <value>] [-f] [--zip]
-    [--auth-key <value>]
+  $ apimatic sdk:generate --platform csharp|java|php|python|ruby|typescript|go [--spec <value>] [-d <value>] [-f]
+    [--zip] [-k <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.
+  -d, --destination=<value>  [default: <input>/sdk] path where the sdk will be generated.
+  -f, --force                overwrite changes without asking for user consent.
+  -k, --auth-key=<value>     override current authentication state with an authentication key.
+      --platform=<option>    (required) language platform for sdk
+                             <options: csharp|java|php|python|ruby|typescript|go>
+      --spec=<value>         [default: ./src/spec] path to the folder containing the API specification file.
       --zip                  download the generated SDK as a .zip archive
 
 DESCRIPTION
-  Generate SDK for your APIs
+  Generates SDK for your API
 
 EXAMPLES
-  $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
+  $ apimatic sdk:generate --platform="java"
 
-  $ apimatic sdk:generate --platform="CSHARP" --url=https://petstore.swagger.io/v2/swagger.json
+  $ apimatic sdk:generate --platform="csharp" --spec="./src/spec"
 ```
 
 _See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/sdk/generate.ts)_
-<!-- commandsstop -->
+<!-- commandsstop -->

package/lib/actions/{actionResult.js → action-result.js}

@@ -22,4 +22,4 @@ export class ActionResult {
         }
     }
 }
-//# sourceMappingURL=actionResult.js.map
+//# sourceMappingURL=action-result.js.map

package/lib/actions/action-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-result.js","sourceRoot":"","sources":["../../src/actions/action-result.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,YAAY;IAGvB,YAAoB,OAAgB;QAClC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAe;QAC1B,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,YAAY,EAAE,CAAC;IAC5B,CAAC;IAED,GAAG,CAAC,OAAkC;QACpC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,MAAM,CAAI,SAAiB,EAAE,OAA+B;QAC1D,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;aAAK,CAAC;YACL,OAAO,SAAS,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;CACF"}

package/lib/actions/auth/login.d.ts

@@ -0,0 +1,12 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { Result } from "neverthrow";
+export declare class LoginAction {
+    private readonly configDir;
+    private readonly authService;
+    private readonly apiService;
+    private readonly prompts;
+    constructor(configDir: DirectoryPath);
+    execute(apiKey?: string | undefined): Promise<Result<string, string>>;
+    private poolDeviceToken;
+    private verifyKeyAndSave;
+}

package/lib/actions/auth/login.js

@@ -0,0 +1,63 @@
+import { AuthService } from "../../infrastructure/services/auth-service.js";
+import { ApiService } from "../../infrastructure/services/api-service.js";
+import { err, ok } from "neverthrow";
+import { v4 as uuid } from "uuid";
+import open from "open";
+import { setAuthInfo } from "../../client-utils/auth-manager.js";
+import { LoginPrompts } from "../../prompts/auth/login.js";
+import { getErrorMessage } from "../../infrastructure/api-utils.js";
+export class LoginAction {
+    constructor(configDir) {
+        this.configDir = configDir;
+        this.authService = new AuthService();
+        this.apiService = new ApiService();
+        this.prompts = new LoginPrompts();
+    }
+    async execute(apiKey = undefined) {
+        if (!apiKey) {
+            const result = await this.poolDeviceToken();
+            return (await result.asyncMap(async (token) => {
+                return await this.verifyKeyAndSave(token);
+            })).andThen((r) => r);
+        }
+        else {
+            return await this.verifyKeyAndSave(apiKey);
+        }
+    }
+    async poolDeviceToken() {
+        const state = uuid();
+        this.prompts.openBrowser();
+        await open(this.authService.getDeviceLoginUrl(state));
+        const timeoutDuration = 5 * 60 * 1000; // 5 minutes in milliseconds
+        const startTime = Date.now();
+        const delayMs = 3 * 1000;
+        while (true) {
+            if (Date.now() - startTime > timeoutDuration) {
+                return err("Authentication timed out. Please try again.");
+            }
+            const result = await this.authService.getDeviceLoginToken(state);
+            const token = result.match((res) => res.apiKey, () => {
+                /* ignore errors */
+            });
+            if (token)
+                return ok(token);
+            // eslint-disable-next-line no-undef
+            await new Promise((resolve) => setTimeout(resolve, delayMs));
+        }
+    }
+    async verifyKeyAndSave(apiKey) {
+        const result = await this.apiService.getAccountInfo(this.configDir, apiKey);
+        return result.asyncMap(async (info) => {
+            await setAuthInfo(info.Email, apiKey, false, this.configDir);
+            return info.Email;
+        }).mapErr(e => {
+            switch (e) {
+                case "UNAUTHORIZED" /* ServiceError.UnAuthorized */:
+                    return "The provided auth key is invalid";
+                default:
+                    return getErrorMessage(e);
+            }
+        });
+    }
+}
+//# sourceMappingURL=login.js.map

package/lib/actions/auth/login.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../../src/actions/auth/login.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,+CAA+C,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,8CAA8C,CAAC;AAE1E,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAgB,MAAM,mCAAmC,CAAC;AAElF,MAAM,OAAO,WAAW;IAKtB,YAA6B,SAAwB;QAAxB,cAAS,GAAT,SAAS,CAAe;QAJpC,gBAAW,GAAG,IAAI,WAAW,EAAE,CAAC;QAChC,eAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,YAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEU,CAAC;IAElD,KAAK,CAAC,OAAO,CAAC,SAA6B,SAAS;QACzD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YAC5C,OAAO,CACL,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBACpC,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC,CAAC,CACH,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,MAAM,KAAK,GAAG,IAAI,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtD,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,4BAA4B;QACnE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC;QAEzB,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,eAAe,EAAE,CAAC;gBAC7C,OAAO,GAAG,CAAC,6CAA6C,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YACjE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CACxB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EACnB,GAAG,EAAE;gBACH,mBAAmB;YACrB,CAAC,CACF,CAAC;YACF,IAAI,KAAK;gBAAE,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;YAE5B,oCAAoC;YACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,MAAc;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACpC,MAAM,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7D,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;YACV,QAAQ,CAAC,EAAE,CAAC;gBACV;oBACE,OAAO,kCAAkC,CAAA;gBAC3C;oBACE,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,11 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+export declare class CopilotAction {
+    private readonly apiService;
+    private readonly prompts;
+    private readonly configDir;
+    private readonly authKey;
+    constructor(configDir: DirectoryPath, authKey?: string | null);
+    execute(buildDirectory: DirectoryPath, welcomeMessage: string, enable: boolean): Promise<ActionResult>;
+    private selectCopilotKey;
+}

package/lib/actions/portal/copilot.js

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

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

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

package/lib/actions/portal/{generatePortalAction.d.ts → generate.d.ts}

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

package/lib/actions/portal/{generatePortalAction.js → generate.js}

@@ -2,12 +2,13 @@ import { PortalGeneratePrompts } from "../../prompts/portal/generate.js";
 import { ZipService } from "../../infrastructure/zip-service.js";
 import { FileService } from "../../infrastructure/file-service.js";
 import { PortalService } from "../../infrastructure/services/portal-service.js";
-import { DirectoryPath } from "../../types/file/directoryPath.js";
-import { withDir } from "tmp-promise";
 import { FilePath } from "../../types/file/filePath.js";
 import { FileName } from "../../types/file/fileName.js";
-import { ActionResult } from "../actionResult.js";
-export class GeneratePortalAction {
+import { ActionResult } from "../action-result.js";
+import { BuildContext } from "../../types/build-context.js";
+import { PortalContext } from "../../types/portal-context.js";
+import { withDirPath } from "../../infrastructure/tmp-extensions.js";
+export class GenerateAction {
     constructor(configDir, authKey = null) {
         this.prompts = new PortalGeneratePrompts();
         this.zipArchiver = new ZipService();
@@ -15,17 +16,18 @@ export class GeneratePortalAction {
         this.portalService = new PortalService();
         this.execute = async (buildDirectory, portalDirectory, force, zipPortal) => {
             if (buildDirectory.isEqual(portalDirectory)) {
-                return ActionResult.error("'build' directory and 'portal' directory cannot be the same.");
+                return ActionResult.error(`The 'src' and 'portal' directory cannot be the same: "${portalDirectory}"`);
             }
-            if (!(await this.validateBuild(buildDirectory))) {
-                return ActionResult.error("'build' directory does not exist, is empty, or not valid");
+            const buildContext = new BuildContext(buildDirectory);
+            if (!await buildContext.validate()) {
+                return ActionResult.error(`The 'src' directory is either empty or invalid: "${buildDirectory}"`);
             }
-            if (!(await this.validatePortal(portalDirectory, force))) {
-                return ActionResult.error("'portal' directory is not empty.");
+            const portalContext = new PortalContext(portalDirectory);
+            if (!force && (await portalContext.exists()) && !(await this.prompts.overwritePortal(portalDirectory))) {
+                return ActionResult.error("Please enter a different destination folder or remove the existing files and try again.");
             }
-            return await withDir(async (tempDirResult) => {
+            return await withDirPath(async (tempDirectory) => {
                 this.prompts.displayPortalGenerationMessage();
-                const tempDirectory = new DirectoryPath(tempDirResult.path);
                 const buildZipPath = new FilePath(tempDirectory, new FileName("build.zip"));
                 await this.zipArchiver.archive(buildDirectory, buildZipPath);
                 const response = await this.portalService.generatePortal(buildZipPath, this.configDir, this.authKey);
@@ -33,33 +35,16 @@ export class GeneratePortalAction {
                     this.prompts.displayPortalGenerationErrorMessage();
                     return ActionResult.error(await this.parseError(response.error, portalDirectory, tempDirectory));
                 }
-                this.prompts.displayPortalGenerationSuccessMessage();
                 const tempPortalFilePath = new FilePath(tempDirectory, new FileName("portal.zip"));
                 await this.fileService.writeFile(tempPortalFilePath, response.value);
-                await this.fileService.cleanDirectory(portalDirectory);
-                if (zipPortal) {
-                    const portalFilePath = new FilePath(portalDirectory, new FileName("portal.zip"));
-                    await this.fileService.copy(tempPortalFilePath, portalFilePath);
-                }
-                else {
-                    await this.zipArchiver.unArchive(tempPortalFilePath, portalDirectory);
-                }
+                await portalContext.save(tempPortalFilePath, zipPortal);
+                this.prompts.displayPortalGenerationSuccessMessage();
                 return ActionResult.success();
-            }, { unsafeCleanup: true });
+            });
         };
         this.configDir = configDir;
         this.authKey = authKey;
     }
-    async validateBuild(buildDirectory) {
-        // TODO: add more checks here
-        return await this.fileService.directoryExists(buildDirectory);
-    }
-    async validatePortal(portalDirectory, forceCleanup) {
-        const isEmptyOrNotExists = await this.fileService.directoryEmpty(portalDirectory);
-        if (isEmptyOrNotExists)
-            return true;
-        return forceCleanup || (await this.prompts.overwritePortal(portalDirectory));
-    }
     async parseError(error, portalDirectory, tempDirectory) {
         if (typeof error === 'string') {
             return error;
@@ -73,4 +58,4 @@ export class GeneratePortalAction {
             errorReportPath;
     }
 }
-//# sourceMappingURL=generatePortalAction.js.map
+//# sourceMappingURL=generate.js.map

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

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

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

@@ -9,7 +9,6 @@ export declare class PortalRecipeAction {
     private createRecipeFileName;
     private toPascalCase;
     private validateBuildDirectoryPath;
-    private validateBuildConfigFilePath;
     private promptUserAndBuildNewRecipe;
     private promptUserAndAddContentStepToRecipe;
     private promptUserAndAddEndpointStepToRecipe;

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

@@ -68,12 +68,6 @@ export class PortalRecipeAction {
         }
         return Result.success("Portal build input folder path validated successfully.");
     }
-    async validateBuildConfigFilePath(buildConfigFilePath) {
-        if (buildConfigFilePath && !(await fsExtra.pathExists(buildConfigFilePath))) {
-            return Result.failure(`Portal build config file ${buildConfigFilePath} does not exist.`);
-        }
-        return Result.success("Portal build config file path validated successfully.");
-    }
     //TODO: Figure out a better way to do this without the while loop.
     async promptUserAndBuildNewRecipe(buildConfig, contentFolderPath, recipeName, configDir) {
         const recipe = new PortalRecipe(recipeName);