feat: prompt framework and refactoring

.gitignore

@@ -179,4 +179,5 @@ tmp/
 test-source/
 test-destination/
 test-portal/
-/.idea/
+/.idea/
+.github/copilot-instructions.md

README.md

@@ -24,7 +24,7 @@ $ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
 $ apimatic (--version)
-@apimatic/cli/1.1.0-alpha.21 win32-x64 node-v23.4.0
+@apimatic/cli/1.1.0-alpha.22 win32-x64 node-v23.4.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -51,39 +51,41 @@ USAGE
 
 ## `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 --format <value> [--file <value>] [--url <value>] [-d <value>] [-f] [-k <value>]
+  $ 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 download transformed file to
+  -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=<value>       (required) specification format to transform API specification into
-                             APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|
-                             RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA
-      --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.
+      --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 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.
+
+  Transform API specifications from one format to another.
+  Supports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.
 
 EXAMPLES
-  $ apimatic api transform --format=OPENAPI3YAML --file="./specs/sample.json" --destination="D:/"
+  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:/"
+  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/alpha/src/commands/api/transform.ts)_
 
 ## `apimatic api validate`
 
-Validate the syntactic and semantic correctness of an API specification
+Validate API specification for syntactic and semantic correctness.
 
 ```
 USAGE
@@ -92,23 +94,24 @@ USAGE
 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 specification file to validate. Can be used in place of the --file option if the
-                          API specification is publicly available.
+      --url=<value>       URL to the API specification file to validate (publicly accessible)
 
 DESCRIPTION
-  Validate the syntactic and semantic correctness of an API specification
+  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"
+  apimatic api validate --file=./specs/sample.json
 
-  $ apimatic api validate --url=https://petstore.swagger.io/v2/swagger.json
+  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/alpha/src/commands/api/validate.ts)_
 
 ## `apimatic auth login`
 
-Login using your APIMatic credentials or an API Key
+Login to your APIMatic account.
 
 ```
 USAGE
@@ -118,12 +121,14 @@ FLAGS
   -k, --auth-key=<value>  Sets authentication key for all commands.
 
 DESCRIPTION
+  Login to your APIMatic account.
+
   Login using your APIMatic credentials or an API Key
 
 EXAMPLES
-  $ apimatic auth login
+  apimatic auth login
 
-  $ apimatic auth login --auth-key={api-key}
+  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)_
@@ -139,8 +144,10 @@ USAGE
 DESCRIPTION
   Clears the local login credentials.
 
+  Clears the local login credentials. This will also clear any cached credentials from the CLI.
+
 EXAMPLES
-  $ apimatic auth logout
+  apimatic auth logout
 ```
 
 _See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/logout.ts)_
@@ -157,7 +164,7 @@ DESCRIPTION
   View the currently logged in user.
 
 EXAMPLES
-  $ apimatic auth status
+  apimatic auth status
 ```
 
 _See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/auth/status.ts)_
@@ -233,19 +240,19 @@ DESCRIPTION
 
   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
+  'APIMATIC-BUILD.json' file
 
 EXAMPLES
-  $ apimatic portal copilot --input="./"
+  apimatic portal copilot --input=./
 
-  $ apimatic portal copilot --input="./" --disable
+  apimatic portal copilot --input=./ --disable
 ```
 
 _See code: [src/commands/portal/copilot.ts](https://github.com/apimatic/apimatic-cli/blob/alpha/src/commands/portal/copilot.ts)_
 
 ## `apimatic portal generate`
 
-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/guides/generating-on-prem-api-portal/build-file-reference)
+Generate an API Documentation portal.
 
 ```
 USAGE
@@ -260,86 +267,96 @@ FLAGS
       --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
 
-  $ apimatic portal generate --input="./" --destination="./portal"
+  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)_
 
 ## `apimatic portal quickstart`
 
-Create your first API Portal using APIMatic's Docs as Code offering.
+Get started with your first API Portal in four easy steps.
 
 ```
 USAGE
   $ apimatic portal quickstart
 
 DESCRIPTION
+  Get started with your first API Portal in four easy steps.
+
   Create your first API Portal using APIMatic's Docs as Code offering.
 
 EXAMPLES
-  $ apimatic portal quickstart
+  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.
+Add an API Recipe to your API documentation portal.
 
 ```
 USAGE
-  $ apimatic portal recipe new [--name <value>] [-i <value>]
+  $ 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.
+  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
 
-  $ apimatic portal recipe new --name="My API Recipe" --input="./"
+  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 deploy a Docs as Code portal with hot reload.
+Generate and serve an API Documentation Portal with hot reload.
 
 ```
 USAGE
-  $ apimatic portal serve [-p <value>] [-i <value>] [-d <value>] [-o] [--no-reload] [-k <value>]
+  $ 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=<value>         [default: 3000] port to serve the portal.
-      --no-reload            Disable hot reload.
+  -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 deploy a Docs as Code portal with hot reload.
+  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
 
-  $ apimatic portal serve --input="./" --destination="./portal" --port=3000 --open --no-reload
+  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)_
@@ -353,7 +370,7 @@ 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.
+  -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.
@@ -374,11 +391,11 @@ DESCRIPTION
   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 --destination=./src/content/
 
-  $ apimatic portal toc new --input="./"
+  apimatic portal toc new --input=./
 
-  $ apimatic portal toc new --input="./" --destination="./src/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)_
@@ -393,21 +410,26 @@ USAGE
     [-k <value>]
 
 FLAGS
-  -d, --destination=<value>  [default: ./sdk/<language>] path where the sdk will be generated.
+  -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) language for which the sdk will be generated.
+  -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.
+      --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=java
+
+  apimatic sdk generate --language=csharp --spec=./src/spec
 
-  $ 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/v1.1.0-alpha.21/src/commands/sdk/generate.ts)_

eslint.config.js

@@ -12,6 +12,9 @@ export default [
       sourceType: "module",
       globals: {
         process: "readonly",
+        setTimeout: "readonly",
+        clearTimeout: "readonly",
+        URL: "readonly",
         NodeJS: true,
       },
     },