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

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
 $ apimatic (-v|--version|version)
-@apimatic/cli/1.0.1-alpha.1 linux-x64 node-v14.18.1
+@apimatic/cli/1.0.1-alpha.10 linux-x64 node-v16.13.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
@@ -29,100 +29,78 @@ USAGE
 
 # Commands
 <!-- commands -->
-* [`apimatic api`](#apimatic-api)
 * [`apimatic api:transform`](#apimatic-apitransform)
 * [`apimatic api:validate`](#apimatic-apivalidate)
-* [`apimatic auth`](#apimatic-auth)
 * [`apimatic auth:login`](#apimatic-authlogin)
 * [`apimatic auth:logout`](#apimatic-authlogout)
 * [`apimatic auth:status`](#apimatic-authstatus)
 * [`apimatic autocomplete [SHELL]`](#apimatic-autocomplete-shell)
 * [`apimatic help [COMMAND]`](#apimatic-help-command)
-* [`apimatic portal`](#apimatic-portal)
 * [`apimatic portal:generate`](#apimatic-portalgenerate)
-* [`apimatic sdk`](#apimatic-sdk)
 * [`apimatic sdk:generate`](#apimatic-sdkgenerate)
 
-## `apimatic api`
-
-lists all commands related to the APIMatic API.
-
-```
-USAGE
-  $ apimatic api
-
-EXAMPLE
-  $ apimatic api --help
-```
-
-_See code: [src/commands/api/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/api/index.ts)_
-
 ## `apimatic api:transform`
 
-Transforms your API specification to any supported format of your choice from amongst[10+ different formats](https://www.apimatic.io/transformer/#supported-formats).
+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.
 
 ```
 USAGE
   $ apimatic api:transform
 
 OPTIONS
-  --auth-key=auth-key        override current auth-key
+  -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/src/commands/api] path to
-                             transformed file
+  --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
-                             (OpenApi3Json|OpenApi3Yaml|APIMATIC|WADL2009|WADL2006|WSDL|
-                             Swagger10|Swagger20|SwaggerYaml|RAML|RAML10|Postman10|Postman20)
+                             APIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|
+                             RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA
 
-  --url=url                  URL to the API specification file to transform
+  --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.
 
-EXAMPLE
+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=RAML --url="https://petstore.swagger.io/v2/swagger.json"  --destination="D:/"
+  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/v1.0.1-alpha.1/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/api/transform.ts)_
 
 ## `apimatic api:validate`
 
-Validates the provided API specification file for any syntactical and semantic errors
+Validate the syntactic and semantic correctness of an API specification
 
 ```
 USAGE
   $ apimatic api:validate
 
 OPTIONS
-  --auth-key=auth-key  override current auth-key
-  --file=file          path to the API specification file to validate
-  --url=url            URL to the specification file to validate
+  --auth-key=auth-key  override current authentication state with an authentication key
+  --file=file          Path to the API specification file to validate
 
-EXAMPLE
+  --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.
+
+EXAMPLES
   $ apimatic api:validate --file="./specs/sample.json"
   Specification file provided is valid
-```
-
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/api/validate.ts)_
-
-## `apimatic auth`
-
-invokes subcommands related to authentication.
 
-```
-USAGE
-  $ apimatic auth
-
-EXAMPLE
-  $ apimatic auth --help
+  $ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
+  Specification file provided is valid
 ```
 
-_See code: [src/commands/auth/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/index.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/api/validate.ts)_
 
 ## `apimatic auth:login`
 
-login to your APIMatic account
+Login using your APIMatic credentials or an API Key
 
 ```
 USAGE
@@ -131,19 +109,22 @@ USAGE
 OPTIONS
   --auth-key=auth-key  Set authentication key for all commands
 
-EXAMPLE
+EXAMPLES
   $ apimatic auth:login
   Please 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/v1.0.1-alpha.1/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/auth/login.ts)_
 
 ## `apimatic auth:logout`
 
-logout of APIMatic
+Clear local login credentials
 
 ```
 USAGE
@@ -154,11 +135,11 @@ EXAMPLE
   Logged out
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/auth/logout.ts)_
 
 ## `apimatic auth:status`
 
-checks current logged-in account
+View current authentication state
 
 ```
 USAGE
@@ -169,7 +150,7 @@ EXAMPLE
   Currently logged in as apimatic-client@gmail.com
 ```
 
-_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/auth/status.ts)_
 
 ## `apimatic autocomplete [SHELL]`
 
@@ -209,56 +190,29 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.7/src/commands/help.ts)_
-
-## `apimatic portal`
-
-invokes subcommands related to the API Portal.
-
-```
-USAGE
-  $ apimatic portal
-
-EXAMPLE
-  $apimatic portal --help
-```
-
-_See code: [src/commands/portal/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/portal/index.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.12/src/commands/help.ts)_
 
 ## `apimatic portal:generate`
 
-Generate static docs portal on premise
+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)
 
 ```
 USAGE
   $ apimatic portal:generate
 
 OPTIONS
-  --auth-key=auth-key        override current auth-key
-  --destination=destination  [default: ./] path to the downloaded portal
-  --folder=folder            folder to generate the portal with
-  --zip                      zip the portal
+  -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:/
 ```
 
-_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/portal/generate.ts)_
-
-## `apimatic sdk`
-
-invokes subcommands related to your SDKs.
-
-```
-USAGE
-  $ apimatic sdk
-
-EXAMPLE
-  $apimatic sdk --help
-```
-
-_See code: [src/commands/sdk/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/sdk/index.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/portal/generate.ts)_
 
 ## `apimatic sdk:generate`
 
@@ -269,9 +223,13 @@ USAGE
   $ apimatic sdk:generate
 
 OPTIONS
-  --auth-key=auth-key        override current auth-key
-  --destination=destination  [default: ./] path to downloaded SDK (used with download flag)
-  --file=file                path to the API specification to generate SDK
+  -f, --force                overwrite if an SDK already exists in the destination
+  --auth-key=auth-key        override current authentication state with an authentication key
+
+  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli] directory to download the
+                             generated SDK to
+
+  --file=file                path to the API specification to generate SDKs for
 
   --platform=platform        (required) language platform for sdk
                              Simple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT
@@ -279,14 +237,22 @@ OPTIONS
                              JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB|PYTHON_GENERIC_LIB|RUBY_GENERIC_LIB|
                              TS_GENERIC_LIB
 
-  --url=url                  URL to the API specification to generate SDK
+  --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.
 
-  --zip                      zip the SDK (used with download flag)
+  --zip                      download the generated SDK as a .zip archive
 
-EXAMPLE
+EXAMPLES
   $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
-  SDK generated successfully
+  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
 ```
 
-_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.10/src/commands/sdk/generate.ts)_
 <!-- commandsstop -->

package/bin/run

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable no-undef */
+/* eslint-disable @typescript-eslint/no-var-requires */
 
-require('@oclif/command').run()
-.then(require('@oclif/command/flush'))
-.catch(require('@oclif/errors/handle'))
+require("@oclif/command").run().then(require("@oclif/command/flush")).catch(require("@oclif/errors/handle"));

package/lib/client-utils/sdk-client.d.ts

@@ -1,4 +1,4 @@
-import { Client } from "@apimatic/apimatic-sdk-for-js";
+import { Client } from "@apimatic/sdk";
 export declare class SDKClient {
     private static instance;
     private static authAPI;

package/lib/client-utils/sdk-client.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDKClient = void 0;
 const base64 = require("base-64");
 const axios_1 = require("axios");
-const apimatic_sdk_for_js_1 = require("@apimatic/apimatic-sdk-for-js");
+const sdk_1 = require("@apimatic/sdk");
 const auth_manager_1 = require("./auth-manager");
 const env_1 = require("../config/env");
 class SDKClient {
@@ -84,7 +84,7 @@ class SDKClient {
     }
     async getClient(overrideAuthKey, configDir) {
         if (overrideAuthKey) {
-            return new apimatic_sdk_for_js_1.Client({
+            return new sdk_1.Client({
                 timeout: 0,
                 authorization: `X-Auth-Key ${overrideAuthKey}`
             });
@@ -95,7 +95,7 @@ class SDKClient {
             storedAuthInfo = { email: "", authKey: "" };
         }
         if (storedAuthInfo.authKey !== "") {
-            return new apimatic_sdk_for_js_1.Client({
+            return new sdk_1.Client({
                 timeout: 0,
                 authorization: `X-Auth-Key ${storedAuthInfo.authKey}`
             });

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

@@ -1,4 +1,3 @@
-import { ApiValidationSummary } from "@apimatic/apimatic-sdk-for-js";
 import { flags, Command } from "@oclif/command";
 export default class Transform extends Command {
     static description: string;
@@ -8,8 +7,8 @@ export default class Transform extends Command {
         file: flags.IOptionFlag<string>;
         url: flags.IOptionFlag<string>;
         destination: flags.IOptionFlag<string>;
+        force: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         "auth-key": flags.IOptionFlag<string | undefined>;
     };
-    printValidationMessages: (apiValidationSummary: ApiValidationSummary | undefined) => void;
     run(): Promise<void>;
 }

package/lib/commands/api/transform.js

@@ -2,90 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
 const path = require("path");
-const cli_ux_1 = require("cli-ux");
-const apimatic_sdk_for_js_1 = require("@apimatic/apimatic-sdk-for-js");
+const sdk_1 = require("@apimatic/sdk");
 const command_1 = require("@oclif/command");
 const sdk_client_1 = require("../../client-utils/sdk-client");
 const utils_1 = require("../../utils/utils");
-const DestinationFormats = {
-    OpenApi3Json: "json",
-    OpenApi3Yaml: "yaml",
-    APIMATIC: "json",
-    WADL2009: "xml",
-    WSDL: "xml",
-    Swagger10: "json",
-    Swagger20: "json",
-    SwaggerYaml: "yaml",
-    RAML: "yaml",
-    RAML10: "yaml",
-    Postman10: "json",
-    Postman20: "json"
-};
-async function getTransformationId({ file, url, format }, transformationController) {
-    cli_ux_1.default.action.start("Transforming API specification");
-    let generation;
-    if (file) {
-        const fileDescriptor = new apimatic_sdk_for_js_1.FileWrapper(fs.createReadStream(file));
-        generation = await transformationController.transformViaFile(fileDescriptor, format);
-    }
-    else if (url) {
-        const body = {
-            url: url,
-            exportFormat: format
-        };
-        generation = await transformationController.transformViaURL(body);
-    }
-    else {
-        throw new Error("Please provide a specification file");
-    }
-    cli_ux_1.default.action.stop();
-    return generation.result;
-}
-async function downloadTransformationFile({ id, destinationFilePath, transformationController }) {
-    cli_ux_1.default.action.start("Downloading Transformed file");
-    const { result } = await transformationController.downloadTransformedFile(id);
-    if (result.readable) {
-        await utils_1.writeFileUsingReadableStream(result, destinationFilePath);
-    }
-    else {
-        throw new Error("Couldn't save transformation file");
-    }
-    cli_ux_1.default.action.stop();
-    return destinationFilePath;
-}
-// Get valid platform from user's input, convert simple platform to valid Platforms enum value
-function getValidFormat(format) {
-    if (Object.keys(apimatic_sdk_for_js_1.ExportFormats).find((exportFormat) => exportFormat === format)) {
-        return apimatic_sdk_for_js_1.ExportFormats[format];
-    }
-    else {
-        const formats = Object.keys(apimatic_sdk_for_js_1.ExportFormats).join("|");
-        throw new Error(`Please provide a valid platform i.e. ${formats}`);
-    }
-}
+const transform_1 = require("../../types/api/transform");
+const transform_2 = require("../../controllers/api/transform");
+const formats = Object.keys(sdk_1.ExportFormats).join("|");
 class Transform extends command_1.Command {
-    constructor() {
-        super(...arguments);
-        this.printValidationMessages = (apiValidationSummary) => {
-            const warnings = (apiValidationSummary === null || apiValidationSummary === void 0 ? void 0 : apiValidationSummary.warnings) || [];
-            const errors = (apiValidationSummary === null || apiValidationSummary === void 0 ? void 0 : apiValidationSummary.errors.join("\n")) || "";
-            warnings.forEach((warning) => {
-                this.warn(utils_1.replaceHTML(warning));
-            });
-            if (apiValidationSummary && apiValidationSummary.errors.length > 0) {
-                this.error(utils_1.replaceHTML(errors));
-            }
-        };
-    }
     async run() {
         const { flags } = this.parse(Transform);
         const fileName = flags.file ? utils_1.getFileNameFromPath(flags.file) : utils_1.getFileNameFromPath(flags.url);
-        const destinationFormat = DestinationFormats[flags.format];
+        const destinationFormat = transform_1.DestinationFormats[flags.format];
         const destinationFilePath = path.join(flags.destination, `${fileName}_${flags.format}.${destinationFormat}`.toLowerCase());
-        if (fs.existsSync(destinationFilePath)) {
+        // Check if destination file already exist and throw error if force flag is not set
+        if (fs.existsSync(destinationFilePath) && !flags.force) {
             throw new Error(`Can't download transformed file to path ${destinationFilePath}, because it already exists`);
         }
         try {
+            // Check if paths provided are valid
             if (flags.file && !(await fs.pathExists(flags.file))) {
                 throw new Error(`Transformation file: ${flags.file} does not exist`);
             }
@@ -94,10 +29,10 @@ class Transform extends command_1.Command {
             }
             const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
             const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
-            const transformationController = new apimatic_sdk_for_js_1.TransformationController(client);
-            const { id, apiValidationSummary } = await getTransformationId(flags, transformationController);
-            this.printValidationMessages(apiValidationSummary);
-            const savedTransformationFile = await downloadTransformationFile({
+            const transformationController = new sdk_1.TransformationController(client);
+            const { id, apiValidationSummary } = await transform_2.getTransformationId(flags, transformationController);
+            transform_2.printValidationMessages(apiValidationSummary, this.warn, this.error);
+            const savedTransformationFile = await transform_2.downloadTransformationFile({
                 id,
                 destinationFilePath,
                 transformationController
@@ -105,7 +40,6 @@ class Transform extends command_1.Command {
             this.log(`Success! Your transformed file is located at ${savedTransformationFile}`);
         }
         catch (error) {
-            cli_ux_1.default.action.stop();
             if (error.result) {
                 const apiError = error;
                 // TODO: Hopefully, this type-cast won't be necessary when the SDK is
@@ -136,22 +70,36 @@ class Transform extends command_1.Command {
     }
 }
 exports.default = Transform;
-Transform.description = `Transforms your API specification to any supported format of your choice from amongst[10+ different formats](https://www.apimatic.io/transformer/#supported-formats).`;
+Transform.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.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=RAML --url="https://petstore.swagger.io/v2/swagger.json"  --destination="D:/"
+Success! Your transformed file is located at D:/swagger_raml.yaml
 `
 ];
 Transform.flags = {
     format: command_1.flags.string({
-        parse: (format) => getValidFormat(format.toUpperCase()),
+        parse: (format) => transform_2.getValidFormat(format.toUpperCase()),
         required: true,
         description: `specification format to transform API specification into
-(OpenApi3Json|OpenApi3Yaml|APIMATIC|WADL2009|WADL2006|WSDL|
-Swagger10|Swagger20|SwaggerYaml|RAML|RAML10|Postman10|Postman20)`
+${formats}`
+    }),
+    file: command_1.flags.string({
+        parse: (input) => path.resolve(input),
+        default: "",
+        description: "path to the API specification file to transform"
+    }),
+    url: command_1.flags.string({
+        default: "",
+        description: "URL to the API specification file to transform. Can be used in place of the --file option if the API specification is publicly available."
+    }),
+    destination: command_1.flags.string({
+        parse: (input) => path.resolve(input),
+        default: path.resolve("./"),
+        description: "directory to download transformed file to"
     }),
-    file: command_1.flags.string({ default: "", description: "path to the API specification file to transform" }),
-    url: command_1.flags.string({ default: "", description: "URL to the API specification file to transform" }),
-    destination: command_1.flags.string({ default: __dirname, description: "path to transformed file" }),
-    "auth-key": command_1.flags.string({ description: "override current auth-key" })
+    force: command_1.flags.boolean({ char: "f", default: false, description: "overwrite if same file exist in the destination" }),
+    "auth-key": command_1.flags.string({ description: "override current authentication state with an authentication key" })
 };

package/lib/commands/api/validate.d.ts

@@ -1,4 +1,3 @@
-import { ApiValidationSummary } from "@apimatic/apimatic-sdk-for-js";
 import { flags, Command } from "@oclif/command";
 export default class Validate extends Command {
     static description: string;
@@ -8,6 +7,5 @@ export default class Validate extends Command {
         url: flags.IOptionFlag<string>;
         "auth-key": flags.IOptionFlag<string | undefined>;
     };
-    printValidationMessages: ({ warnings, errors }: ApiValidationSummary) => void;
     run(): Promise<void>;
 }

package/lib/commands/api/validate.js

@@ -1,40 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
-const cli_ux_1 = require("cli-ux");
-const apimatic_sdk_for_js_1 = require("@apimatic/apimatic-sdk-for-js");
+const sdk_1 = require("@apimatic/sdk");
 const command_1 = require("@oclif/command");
 const sdk_client_1 = require("../../client-utils/sdk-client");
 const utils_1 = require("../../utils/utils");
-async function getValidation({ file, url }, apiValidationController) {
-    let validation;
-    cli_ux_1.default.action.start("Validating specification file");
-    if (file) {
-        const fileDescriptor = new apimatic_sdk_for_js_1.FileWrapper(fs.createReadStream(file));
-        validation = await apiValidationController.validateAPIViaFile(fileDescriptor);
-    }
-    else if (url) {
-        validation = await apiValidationController.validateAPIViaURL(url);
-    }
-    else {
-        throw new Error("Please provide a specification file");
-    }
-    cli_ux_1.default.action.stop();
-    return validation.result;
-}
+const transform_1 = require("../../controllers/api/transform");
+const validate_1 = require("../../controllers/api/validate");
 class Validate extends command_1.Command {
-    constructor() {
-        super(...arguments);
-        this.printValidationMessages = ({ warnings, errors }) => {
-            warnings.forEach((warning) => {
-                this.warn(`${utils_1.replaceHTML(warning)}`);
-            });
-            if (errors.length > 0) {
-                const singleLineError = errors.join("\n");
-                this.error(utils_1.replaceHTML(singleLineError));
-            }
-        };
-    }
     async run() {
         const { flags } = this.parse(Validate);
         try {
@@ -43,9 +16,9 @@ class Validate extends command_1.Command {
             }
             const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
             const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
-            const apiValidationController = new apimatic_sdk_for_js_1.APIValidationExternalApisController(client);
-            const validationSummary = await getValidation(flags, apiValidationController);
-            this.printValidationMessages(validationSummary);
+            const apiValidationController = new sdk_1.APIValidationExternalApisController(client);
+            const validationSummary = await validate_1.getValidation(flags, apiValidationController);
+            transform_1.printValidationMessages(validationSummary, this.warn, this.error);
             validationSummary.success
                 ? this.log("Specification file provided is valid")
                 : this.error("Specification file provided is invalid");
@@ -71,15 +44,21 @@ class Validate extends command_1.Command {
     }
 }
 exports.default = Validate;
-Validate.description = "Validates the provided API specification file for any syntactical and semantic errors";
+Validate.description = "Validate the syntactic and semantic correctness of an API specification";
 Validate.examples = [
     `$ apimatic api:validate --file="./specs/sample.json"
 Specification file provided is valid
+`,
+    `$ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json
+Specification file provided is valid
 `
 ];
 Validate.flags = {
-    file: command_1.flags.string({ default: "", description: "path to the API specification file to validate" }),
-    url: command_1.flags.string({ default: "", description: "URL to the specification file to validate" }),
+    file: command_1.flags.string({ default: "", description: "Path to the API specification file to validate" }),
+    url: command_1.flags.string({
+        default: "",
+        description: "URL to the specification file to validate. Can be used in place of the --file option if the API specification is publicly available."
+    }),
     // docs: flags.boolean({ default: false, description: "Validate specification for docs generation" }), // Next tier, not included in API spec
-    "auth-key": command_1.flags.string({ description: "override current auth-key" })
+    "auth-key": command_1.flags.string({ description: "override current authentication state with an authentication key" })
 };

package/lib/commands/auth/login.js

@@ -44,14 +44,16 @@ class Login extends command_1.Command {
     }
 }
 exports.default = Login;
-Login.description = "login to your APIMatic account";
+Login.description = "Login using your APIMatic credentials or an API Key";
 Login.examples = [
     `$ apimatic auth:login
 Please 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`
 ];
 Login.flags = {
     "auth-key": command_1.flags.string({ default: "", description: "Set authentication key for all commands" })

package/lib/commands/auth/logout.js

@@ -15,7 +15,7 @@ class Login extends command_1.Command {
     }
 }
 exports.default = Login;
-Login.description = "logout of APIMatic";
+Login.description = "Clear local login credentials";
 Login.examples = [
     `$ apimatic auth:logout
 Logged out

package/lib/commands/auth/status.js

@@ -15,7 +15,7 @@ class Status extends command_1.Command {
     }
 }
 exports.default = Status;
-Status.description = "checks current logged-in account";
+Status.description = "View current authentication state";
 Status.examples = [
     `$ apimatic auth:status
 Currently logged in as apimatic-client@gmail.com