@apimatic/cli 0.0.0-alpha.3 → 1.0.0-beta.1

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
 $ 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.22 win32-x64 node-v23.4.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -29,230 +34,403 @@ USAGE
 
 # Commands
 <!-- commands -->
-* [`apimatic api:transform`](#apimatic-apitransform)
-* [`apimatic api:validate`](#apimatic-apivalidate)
-* [`apimatic auth:login`](#apimatic-authlogin)
-* [`apimatic auth:logout`](#apimatic-authlogout)
-* [`apimatic auth:status`](#apimatic-authstatus)
+* [`apimatic api transform`](#apimatic-api-transform)
+* [`apimatic api validate`](#apimatic-api-validate)
+* [`apimatic auth login`](#apimatic-auth-login)
+* [`apimatic auth logout`](#apimatic-auth-logout)
+* [`apimatic auth status`](#apimatic-auth-status)
 * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
-* [`apimatic portal:generate`](#apimatic-portalgenerate)
-* [`apimatic sdk:generate`](#apimatic-sdkgenerate)
+* [`apimatic portal copilot`](#apimatic-portal-copilot)
+* [`apimatic portal generate`](#apimatic-portal-generate)
+* [`apimatic portal quickstart`](#apimatic-portal-quickstart)
+* [`apimatic portal recipe new`](#apimatic-portal-recipe-new)
+* [`apimatic portal serve`](#apimatic-portal-serve)
+* [`apimatic portal toc new`](#apimatic-portal-toc-new)
+* [`apimatic sdk generate`](#apimatic-sdk-generate)
 
-## `apimatic api:transform`
+## `apimatic api transform`
 
-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.
+Transform API specifications between different formats.
 
 ```
 USAGE
-  $ apimatic api:transform
-
-OPTIONS
-  -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
-                             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
-                             if the API specification is publicly available.
+  $ apimatic api transform --format
+    apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apiblueprint|raml|raml10|postman10|postman2
+    0|graphqlschema [--file <value>] [--url <value>] [-d <value>] [-f] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: ./] directory to save the 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=<option>      (required) specification format to transform API specification into
+                             <options: apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apibluep
+                             rint|raml|raml10|postman10|postman20|graphqlschema>
+      --url=<value>          URL to the API specification file to transform (publicly accessible)
+
+DESCRIPTION
+  Transform API specifications between different formats.
+
+  Transform API specifications from one format to another.
+  Supports multiple 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
+  apimatic api transform --format=OPENAPI3YAML --file=./specs/sample.json --destination=./
 
-  $ apimatic api:transform --format=RAML --url="https://petstore.swagger.io/v2/swagger.json"  --destination="D:/"
-  Success! Your transformed file is located at D:/swagger_raml.yaml
+  apimatic api transform --format=RAML --url="https://petstore.swagger.io/v2/swagger.json" --destination=./
 ```
 
-_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`
+## `apimatic api validate`
 
-Validate the syntactic and semantic correctness of an API specification
+Validate API specification for syntactic and semantic correctness.
 
 ```
 USAGE
-  $ apimatic api:validate
+  $ apimatic api validate [--file <value>] [--url <value>] [-k <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
+  -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 API specification file to validate (publicly accessible)
 
-  --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 API specification for syntactic and semantic correctness.
+
+  Validate your API specification to ensure it adheres to syntactic and semantic standards.
 
 EXAMPLES
-  $ apimatic api:validate --file="./specs/sample.json"
-  Specification file provided is valid
+  apimatic api validate --file=./specs/sample.json
 
-  $ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
-  Specification file provided is valid
+  apimatic api validate --url="https://petstore.swagger.io/v2/swagger.json"
 ```
 
-_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`
+## `apimatic auth login`
 
-Login using your APIMatic credentials or an API Key
+Login to your APIMatic account.
 
 ```
 USAGE
-  $ apimatic auth:login
+  $ apimatic auth login [-k <value>]
 
-OPTIONS
-  --auth-key=auth-key  Set authentication key for all commands
+FLAGS
+  -k, --auth-key=<value>  Sets authentication key for all commands.
 
-EXAMPLES
-  $ apimatic auth:login
-  Please enter your registered email: apimatic-user@gmail.com
-  Please enter your password: *********
+DESCRIPTION
+  Login to your APIMatic account.
 
-  You have successfully logged into APIMatic
+  Login using your APIMatic credentials or an API Key
 
-  $ apimatic auth:login --auth-key=xxxxxx
-  Authentication key successfully set
+EXAMPLES
+  apimatic auth login
+
+  apimatic auth login --auth-key={api-key}
 ```
 
-_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`
+## `apimatic auth logout`
 
-Clear local login credentials
+Clears the local login credentials.
 
 ```
 USAGE
-  $ apimatic auth:logout
+  $ apimatic auth logout
+
+DESCRIPTION
+  Clears the local login credentials.
+
+  Clears the local login credentials. This will also clear any cached credentials from the CLI.
 
-EXAMPLE
-  $ apimatic auth:logout
-  Logged out
+EXAMPLES
+  apimatic auth logout
 ```
 
-_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`
+## `apimatic auth status`
 
-View current authentication state
+View the currently logged in user.
 
 ```
 USAGE
-  $ apimatic auth:status
+  $ apimatic auth status
+
+DESCRIPTION
+  View the currently logged in user.
 
-EXAMPLE
-  $ apimatic auth:status
-  Currently logged in as apimatic-client@gmail.com
+EXAMPLES
+  apimatic auth status
 ```
 
-_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
+  SHELL  (zsh|bash|powershell) Shell type
 
-OPTIONS
+FLAGS
   -r, --refresh-cache  Refresh cache (ignores displaying instructions)
 
+DESCRIPTION
+  Display autocomplete installation instructions.
+
 EXAMPLES
   $ apimatic autocomplete
+
   $ apimatic autocomplete bash
+
   $ apimatic autocomplete zsh
+
+  $ apimatic autocomplete powershell
+
   $ 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.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
 
-OPTIONS
-  --all  see all commands in CLI
+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`
+## `apimatic portal copilot`
 
-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)
+Configure API Copilot for your API Documentation portal
 
 ```
 USAGE
-  $ apimatic portal:generate
-
-OPTIONS
-  -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
-
-EXAMPLE
-  $ apimatic portal:generate --folder="./portal/" --destination="D:/"
-  Your portal has been generated at D:/
+  $ apimatic portal copilot [-i <value>] [--disable] [-f] [-k <value>]
+
+FLAGS
+  -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.
+      --disable           marks the API Copilot as disabled in the configuration
+
+DESCRIPTION
+  Configure API Copilot for your API Documentation portal
+
+  Displays available API Copilots associated with your account and allows you to select which one to integrate with your
+  portal. Each APIMatic account includes one Copilot by default. The selected Copilot will be added to your
+  'APIMATIC-BUILD.json' file
+
+EXAMPLES
+  apimatic portal copilot --input=./
+
+  apimatic portal copilot --input=./ --disable
 ```
 
-_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/copilot.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/copilot.ts)_
 
-## `apimatic sdk:generate`
+## `apimatic portal generate`
 
-Generate SDK for your APIs
+Generate an API Documentation portal.
 
 ```
 USAGE
-  $ apimatic sdk:generate
+  $ apimatic portal generate [-i <value>] [-d <value>] [-f] [--zip] [-k <value>]
+
+FLAGS
+  -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
+  Generate an API Documentation portal.
+
+  Generate an 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/gu
+  ides/generating-on-prem-api-portal/build-file-reference)
+
+EXAMPLES
+  apimatic portal generate
+
+  apimatic portal generate --input="./" --destination="./portal"
+```
 
-OPTIONS
-  -f, --force                overwrite if an SDK already exists in the destination
-  --auth-key=auth-key        override current authentication state with an authentication key
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/generate.ts)_
 
-  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download the
-                             generated SDK to
+## `apimatic portal quickstart`
 
-  --file=file                path to the API specification to generate SDKs for
+Get started with your first API Portal in four easy steps.
 
-  --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
+```
+USAGE
+  $ apimatic portal quickstart
 
-  --url=url                  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.
+DESCRIPTION
+  Get started with your first API Portal in four easy steps.
 
-  --zip                      download the generated SDK as a .zip archive
+  Create your first API Portal using APIMatic's Docs as Code offering.
 
 EXAMPLES
-  $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
-  Generating SDK... done
-  Downloading SDK... done
-  Success! Your SDK is located at swagger_sdk_csharp
-
-  $ apimatic sdk:generate --platform="CSHARP" --url=https://petstore.swagger.io/v2/swagger.json
-  Generating SDK... done
-  Downloading SDK... done
-  Success! Your SDK is located at swagger_sdk_csharp
+  apimatic portal quickstart
+```
+
+_See code: [src/commands/portal/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/quickstart.ts)_
+
+## `apimatic portal recipe new`
+
+Add an API Recipe to your API documentation portal.
+
+```
+USAGE
+  $ apimatic portal recipe new [--name <value>] [-i <value>] [-f]
+
+FLAGS
+  -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.
+      --name=<value>   name for the recipe
+
+DESCRIPTION
+  Add an API Recipe to your API documentation portal.
+
+  This command adds a new API Recipe file to your 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
+
+  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)_
+
+## `apimatic portal serve`
+
+Generate and serve an API Documentation Portal with hot reload.
+
+```
+USAGE
+  $ apimatic portal serve [-p 3000] [-i <value>] [-d <value>] [-o] [--no-reload] [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  [default: <input>/portal] path where the portal will be generated.
+  -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=3000            [default: 3000] port to serve the portal.
+      --no-reload            disable hot reload.
+
+DESCRIPTION
+  Generate and serve an API Documentation Portal with hot reload.
+
+  Requires an input directory with API specifications, a config file, and optionally markdown guides. Supports disabling
+  hot reload and opening the portal in the default browser.
+
+EXAMPLES
+  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)_
+
+## `apimatic portal toc new`
+
+Generate a Table of Contents (TOC) file for your API documentation portal
+
+```
+USAGE
+  $ apimatic portal toc new [-d <value>] [-i <value>] [-f] [--expand-endpoints] [--expand-models]
+
+FLAGS
+  -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
+  Generate a Table of Contents (TOC) file for your API documentation portal
+
+  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=./src/content/
+
+  apimatic portal toc new --input=./
+
+  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 an SDK for your API
+
+```
+USAGE
+  $ apimatic sdk generate -l csharp|java|php|python|ruby|typescript|go [--spec <value>] [-d <value>] [-f] [--zip]
+    [-k <value>]
+
+FLAGS
+  -d, --destination=<value>  directory 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.
+  -l, --language=<option>    (required) programming language for SDK generation
+                             <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 an SDK for your API
+
+  Generate Software Development Kits (SDKs) from API specifications.
+  Supports multiple programming languages including Java, C#, Python, JavaScript, and more.
+
+EXAMPLES
+  apimatic sdk generate --language=java
+
+  apimatic sdk generate --language=csharp --spec=./src/spec
+
+  apimatic sdk generate --language=python --destination=./sdk --zip
 ```
 
-_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/v1.1.0-alpha.21/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/action-result.d.ts

@@ -0,0 +1,13 @@
+export declare class ActionResult {
+    private readonly message;
+    private readonly resultType;
+    private constructor();
+    static success(): ActionResult;
+    static failed(): ActionResult;
+    static cancelled(): ActionResult;
+    static stopped(): ActionResult;
+    getMessage(): string;
+    getExitCode(): number;
+    isFailed(): boolean;
+    mapAll<T>(onSuccess: () => T, onFailure: () => T, onCancel: () => T): T;
+}

package/lib/actions/action-result.js

@@ -0,0 +1,44 @@
+var ResultType;
+(function (ResultType) {
+    ResultType[ResultType["Success"] = 0] = "Success";
+    ResultType[ResultType["Cancel"] = 130] = "Cancel";
+    ResultType[ResultType["Failure"] = 1] = "Failure";
+})(ResultType || (ResultType = {}));
+export class ActionResult {
+    constructor(resultType, message) {
+        this.resultType = resultType;
+        this.message = message;
+    }
+    static success() {
+        return new ActionResult(ResultType.Success, " Succeeded ");
+    }
+    static failed() {
+        return new ActionResult(ResultType.Failure, " Failed ");
+    }
+    static cancelled() {
+        return new ActionResult(ResultType.Cancel, " Cancelled ");
+    }
+    static stopped() {
+        return new ActionResult(ResultType.Cancel, " Stopped ");
+    }
+    getMessage() {
+        return this.message;
+    }
+    getExitCode() {
+        return this.resultType.valueOf();
+    }
+    isFailed() {
+        return this.resultType === ResultType.Failure;
+    }
+    mapAll(onSuccess, onFailure, onCancel) {
+        switch (this.resultType) {
+            case ResultType.Success:
+                return onSuccess();
+            case ResultType.Failure:
+                return onFailure();
+            case ResultType.Cancel:
+                return onCancel();
+        }
+    }
+}
+//# 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,IAAK,UAIJ;AAJD,WAAK,UAAU;IACb,iDAAU,CAAA;IACV,iDAAY,CAAA;IACZ,iDAAU,CAAA;AACZ,CAAC,EAJI,UAAU,KAAV,UAAU,QAId;AAED,MAAM,OAAO,YAAY;IAIvB,YAAoB,UAAsB,EAAE,OAAe;QACzD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,YAAY,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,YAAY,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM,CAAC,SAAS;QACd,OAAO,IAAI,YAAY,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,YAAY,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC1D,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,UAAU,KAAK,UAAU,CAAC,OAAO,CAAC;IAChD,CAAC;IAEM,MAAM,CAAI,SAAkB,EAAE,SAAkB,EAAE,QAAiB;QACxE,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,UAAU,CAAC,OAAO;gBACrB,OAAO,SAAS,EAAE,CAAC;YACrB,KAAK,UAAU,CAAC,OAAO;gBACrB,OAAO,SAAS,EAAE,CAAC;YACrB,KAAK,UAAU,CAAC,MAAM;gBACpB,OAAO,QAAQ,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;CACF"}

package/lib/actions/api/transform.d.ts

@@ -0,0 +1,15 @@
+import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { ActionResult } from "../action-result.js";
+import { ExportFormats } from "@apimatic/sdk";
+import { CommandMetadata } from "../../types/common/command-metadata.js";
+import { ResourceInput } from "../../types/file/resource-input.js";
+export declare class TransformAction {
+    private readonly prompts;
+    private readonly validatePrompts;
+    private readonly transformationService;
+    private readonly configDir;
+    private readonly commandMetadata;
+    private readonly authKey;
+    constructor(configDir: DirectoryPath, commandMetadata: CommandMetadata, authKey?: string | null);
+    readonly execute: (resourcePath: ResourceInput, format: ExportFormats, destination: DirectoryPath, force: boolean) => Promise<ActionResult>;
+}