@apimatic/cli 1.0.1-alpha.6 → 1.0.2-alpha.2

package/README.md

@@ -1,10 +1,13 @@
 @apimatic/cli
 =============
+
 The official CLI for APIMatic.
+
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
 [![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)
@@ -16,43 +19,26 @@ $ npm install -g @apimatic/cli
 $ apimatic COMMAND
 running command...
 $ apimatic (-v|--version|version)
-@apimatic/cli/1.0.1-alpha.6 linux-x64 node-v16.13.0
+@apimatic/cli/0.0.0-alpha.3 linux-x64 node-v16.13.0
 $ apimatic --help [COMMAND]
 USAGE
   $ apimatic COMMAND
 ...
 ```
 <!-- usagestop -->
+
 # 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`
-
-Manage APIs
-
-```
-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.6/src/commands/api/index.ts)_
-
 ## `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.
@@ -71,8 +57,8 @@ OPTIONS
   --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. Can be used in place of the --file option
                              if the API specification is publicly available.
@@ -85,7 +71,7 @@ EXAMPLES
   Success! Your transformed file is located at D:/swagger_raml.yaml
 ```
 
-_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.6/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/api/transform.ts)_
 
 ## `apimatic api:validate`
 
@@ -110,21 +96,7 @@ EXAMPLES
   Specification file provided is valid
 ```
 
-_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.6/src/commands/api/validate.ts)_
-
-## `apimatic auth`
-
-Manage this CLI's authentication state.
-
-```
-USAGE
-  $ apimatic auth
-
-EXAMPLE
-  $ apimatic auth --help
-```
-
-_See code: [src/commands/auth/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.6/src/commands/auth/index.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/api/validate.ts)_
 
 ## `apimatic auth:login`
 
@@ -148,7 +120,7 @@ EXAMPLES
   Authentication key successfully set
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.6/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/login.ts)_
 
 ## `apimatic auth:logout`
 
@@ -163,7 +135,7 @@ EXAMPLE
   Logged out
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.6/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/logout.ts)_
 
 ## `apimatic auth:status`
 
@@ -178,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.6/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/auth/status.ts)_
 
 ## `apimatic autocomplete [SHELL]`
 
@@ -218,21 +190,7 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.10/src/commands/help.ts)_
-
-## `apimatic portal`
-
-Manage API documentation portals
-
-```
-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.6/src/commands/portal/index.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.14/src/commands/help.ts)_
 
 ## `apimatic portal:generate`
 
@@ -246,7 +204,7 @@ 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            path to the input directory containing API specifications and config files
+  --folder=folder            [default: ./] path to the input directory containing API specifications and config files
   --zip                      download the generated portal as a .zip archive
 
 EXAMPLE
@@ -254,21 +212,7 @@ EXAMPLE
   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.6/src/commands/portal/generate.ts)_
-
-## `apimatic sdk`
-
-Generate and manage SDKs for APIs
-
-```
-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.6/src/commands/sdk/index.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/portal/generate.ts)_
 
 ## `apimatic sdk:generate`
 
@@ -303,11 +247,12 @@ EXAMPLES
   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.6/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v0.0.0-alpha.3/src/commands/sdk/generate.ts)_
 <!-- commandsstop -->

package/lib/client-utils/auth-manager.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setAuthInfo = exports.getAuthInfo = void 0;
-const fs = require("fs-extra");
 const path = require("path");
+const fs = require("fs-extra");
 /**
  *
  * @param {string} configDir <- Directory with user configuration

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

@@ -1,8 +1,8 @@
 import { Client } from "@apimatic/sdk";
 export declare class SDKClient {
+    static client: Client;
     private static instance;
     private static authAPI;
-    static client: Client;
     /**
      * The static method that controls the access to the SDKClient instance.
      *

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

@@ -4,8 +4,8 @@ exports.SDKClient = void 0;
 const base64 = require("base-64");
 const axios_1 = require("axios");
 const sdk_1 = require("@apimatic/sdk");
-const auth_manager_1 = require("./auth-manager");
 const env_1 = require("../config/env");
+const auth_manager_1 = require("./auth-manager");
 class SDKClient {
     constructor() {
         this.setAuthKey = (authKey, configDir) => {

package/lib/commands/api/transform.js

@@ -1,18 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs-extra");
 const path = require("path");
-const cli_ux_1 = require("cli-ux");
-const sdk_1 = require("@apimatic/sdk");
+const fs = require("fs-extra");
 const command_1 = require("@oclif/command");
+const sdk_1 = require("@apimatic/sdk");
 const sdk_client_1 = require("../../client-utils/sdk-client");
 const utils_1 = require("../../utils/utils");
+const utils_2 = require("../../utils/utils");
 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 {
     async run() {
         const { flags } = this.parse(Transform);
-        const fileName = flags.file ? utils_1.getFileNameFromPath(flags.file) : utils_1.getFileNameFromPath(flags.url);
+        const fileName = flags.file ? utils_2.getFileNameFromPath(flags.file) : utils_2.getFileNameFromPath(flags.url);
         const destinationFormat = transform_1.DestinationFormats[flags.format];
         const destinationFilePath = path.join(flags.destination, `${fileName}_${flags.format}.${destinationFormat}`.toLowerCase());
         // Check if destination file already exist and throw error if force flag is not set
@@ -31,7 +32,12 @@ class Transform extends command_1.Command {
             const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
             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 logFunctions = {
+                log: this.log,
+                warn: this.warn,
+                error: this.error
+            };
+            utils_1.printValidationMessages(apiValidationSummary, logFunctions);
             const savedTransformationFile = await transform_2.downloadTransformationFile({
                 id,
                 destinationFilePath,
@@ -40,14 +46,13 @@ 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
                 // updated to throw the right exception type for this status code.
                 const result = apiError.result;
                 if (apiError.statusCode === 422 && result && "errors" in result && Array.isArray(result.errors)) {
-                    this.error(utils_1.replaceHTML(`${result.errors}`));
+                    this.error(utils_2.replaceHTML(`${result.errors}`));
                 }
                 else if (apiError.statusCode === 422 && apiError.body && typeof apiError.body === "string") {
                     this.error(JSON.parse(apiError.body)["dto.FileUrl"][0]);
@@ -85,8 +90,7 @@ Transform.flags = {
         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),

package/lib/commands/api/validate.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
-const sdk_1 = require("@apimatic/sdk");
 const command_1 = require("@oclif/command");
+const sdk_1 = require("@apimatic/sdk");
 const sdk_client_1 = require("../../client-utils/sdk-client");
-const utils_1 = require("../../utils/utils");
-const transform_1 = require("../../controllers/api/transform");
 const validate_1 = require("../../controllers/api/validate");
+const utils_1 = require("../../utils/utils");
 class Validate extends command_1.Command {
     async run() {
         const { flags } = this.parse(Validate);
@@ -18,7 +17,12 @@ class Validate extends command_1.Command {
             const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
             const apiValidationController = new sdk_1.APIValidationExternalApisController(client);
             const validationSummary = await validate_1.getValidation(flags, apiValidationController);
-            transform_1.printValidationMessages(validationSummary, this.warn, this.error);
+            const logFunctions = {
+                log: this.log,
+                warn: this.warn,
+                error: this.error
+            };
+            utils_1.printValidationMessages(validationSummary, logFunctions);
             validationSummary.success
                 ? this.log("Specification file provided is valid")
                 : this.error("Specification file provided is invalid");

package/lib/commands/auth/login.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
 const cli_ux_1 = require("cli-ux");
-const sdk_client_1 = require("../../client-utils/sdk-client");
+const command_1 = require("@oclif/command");
 const utils_1 = require("../../utils/utils");
+const sdk_client_1 = require("../../client-utils/sdk-client");
 class Login extends command_1.Command {
     async run() {
         const { flags } = this.parse(Login);

package/lib/commands/portal/generate.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs-extra");
 const path = require("path");
-const cli_ux_1 = require("cli-ux");
+const fs = require("fs-extra");
 const command_1 = require("@oclif/command");
 const sdk_1 = require("@apimatic/sdk");
 const sdk_client_1 = require("../../client-utils/sdk-client");
@@ -45,7 +44,6 @@ class PortalGenerate extends command_1.Command {
             this.log(`Your portal has been generated at ${generatedPortalPath}`);
         }
         catch (error) {
-            cli_ux_1.default.action.stop();
             if (error && error.response) {
                 const apiError = error;
                 const apiResponse = apiError.response;
@@ -60,7 +58,7 @@ class PortalGenerate extends command_1.Command {
                             return this.error(utils_1.replaceHTML(nestedErrors.message));
                         }
                     }
-                    else if (apiResponse.status === 401 && responseData.length > 0 && utils_1.isJSONParsable(responseData)) {
+                    else if (apiResponse.status === 401 && responseData.length > 0) {
                         this.error(utils_1.replaceHTML(responseData));
                     }
                     else if (apiResponse.status === 403 && apiResponse.statusText) {
@@ -82,7 +80,7 @@ PortalGenerate.description = "Generate and download a static API Documentation p
 PortalGenerate.flags = {
     folder: command_1.flags.string({
         parse: (input) => path.resolve(input),
-        default: "",
+        default: "./",
         description: "path to the input directory containing API specifications and config files"
     }),
     destination: command_1.flags.string({

package/lib/commands/sdk/generate.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs-extra");
 const path = require("path");
-const cli_ux_1 = require("cli-ux");
-const sdk_1 = require("@apimatic/sdk");
+const fs = require("fs-extra");
 const command_1 = require("@oclif/command");
 const sdk_client_1 = require("../../client-utils/sdk-client");
+const sdk_1 = require("@apimatic/sdk");
 const utils_1 = require("../../utils/utils");
 const generate_1 = require("../../controllers/sdk/generate");
 class SdkGenerate extends command_1.Command {
@@ -45,7 +44,6 @@ class SdkGenerate extends command_1.Command {
             this.log(`Success! Your SDK is located at ${sdkPath}`);
         }
         catch (error) {
-            cli_ux_1.default.action.stop();
             if (error.result) {
                 const apiError = error;
                 const result = apiError.result;
@@ -122,7 +120,8 @@ SdkGenerate.examples = [
 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
+    `
+$ 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

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

@@ -1,7 +1,5 @@
-import Command from "@oclif/command";
-import { ApiValidationSummary, ExportFormats, Transformation, TransformationController } from "@apimatic/sdk";
 import { DownloadTransformationParams, TransformationIdParams } from "../../types/api/transform";
+import { ExportFormats, Transformation, TransformationController } from "@apimatic/sdk";
 export declare const getTransformationId: ({ file, url, format }: TransformationIdParams, transformationController: TransformationController) => Promise<Transformation>;
 export declare const downloadTransformationFile: ({ id, destinationFilePath, transformationController }: DownloadTransformationParams) => Promise<string>;
 export declare const getValidFormat: (format: string) => ExportFormats;
-export declare const printValidationMessages: (apiValidationSummary: ApiValidationSummary | undefined, warn: Command["warn"], error: Command["error"]) => void;

package/lib/controllers/api/transform.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printValidationMessages = exports.getValidFormat = exports.downloadTransformationFile = exports.getTransformationId = void 0;
+exports.getValidFormat = exports.downloadTransformationFile = exports.getTransformationId = void 0;
 const cli_ux_1 = require("cli-ux");
 const fs = require("fs-extra");
-const sdk_1 = require("@apimatic/sdk");
 const utils_1 = require("../../utils/utils");
+const sdk_1 = require("@apimatic/sdk");
 exports.getTransformationId = async ({ file, url, format }, transformationController) => {
     cli_ux_1.default.action.start("Transforming API specification");
     let generation;
@@ -47,13 +47,3 @@ exports.getValidFormat = (format) => {
         throw new Error(`Please provide a valid platform i.e. ${formats}`);
     }
 };
-exports.printValidationMessages = (apiValidationSummary, warn, error) => {
-    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) => {
-        warn(utils_1.replaceHTML(warning));
-    });
-    if (apiValidationSummary && apiValidationSummary.errors.length > 0) {
-        error(utils_1.replaceHTML(errors));
-    }
-};

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

@@ -1,5 +1,3 @@
-import Command from "@oclif/command";
-import { APIValidationExternalApisController, ApiValidationSummary } from "@apimatic/sdk";
 import { GetValidationParams } from "../../types/api/validate";
+import { APIValidationExternalApisController, ApiValidationSummary } from "@apimatic/sdk";
 export declare const getValidation: ({ file, url }: GetValidationParams, apiValidationController: APIValidationExternalApisController) => Promise<ApiValidationSummary>;
-export declare const printValidationMessages: ({ warnings, errors }: ApiValidationSummary, warn: Command["warn"], error: Command["error"]) => void;

package/lib/controllers/api/validate.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printValidationMessages = exports.getValidation = void 0;
+exports.getValidation = void 0;
 const cli_ux_1 = require("cli-ux");
 const fs = require("fs-extra");
 const core_1 = require("@apimatic/core");
-const utils_1 = require("../../utils/utils");
 exports.getValidation = async ({ file, url }, apiValidationController) => {
     let validation;
     cli_ux_1.default.action.start("Validating specification file");
@@ -21,12 +20,3 @@ exports.getValidation = async ({ file, url }, apiValidationController) => {
     cli_ux_1.default.action.stop();
     return validation.result;
 };
-exports.printValidationMessages = ({ warnings, errors }, warn, error) => {
-    warnings.forEach((warning) => {
-        warn(`${utils_1.replaceHTML(warning)}`);
-    });
-    if (errors.length > 0) {
-        const singleLineError = errors.join("\n");
-        error(utils_1.replaceHTML(singleLineError));
-    }
-};

package/lib/controllers/portal/generate.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadDocsPortal = void 0;
+const cli_ux_1 = require("cli-ux");
 const fs = require("fs-extra");
 const FormData = require("form-data");
-const cli_ux_1 = require("cli-ux");
-const auth_manager_1 = require("../../client-utils/auth-manager");
 const env_1 = require("../../config/env");
 const utils_1 = require("../../utils/utils");
+const auth_manager_1 = require("../../client-utils/auth-manager");
 const axios_1 = require("axios");
 // TODO: Remove after SDK is patched
 const downloadPortalAxios = async (zippedBuildFilePath, overrideAuthKey, configDir) => {
@@ -14,7 +14,7 @@ const downloadPortalAxios = async (zippedBuildFilePath, overrideAuthKey, configD
     const authInfo = await auth_manager_1.getAuthInfo(configDir);
     formData.append("file", fs.createReadStream(zippedBuildFilePath));
     const config = {
-        headers: Object.assign({ Authorization: authInfo ? `X-Auth-Key ${overrideAuthKey || authInfo.authKey.trim()}` : "", "Content-Type": "multipart/form-data" }, formData.getHeaders()),
+        headers: Object.assign({ Authorization: authInfo || overrideAuthKey ? `X-Auth-Key ${(authInfo === null || authInfo === void 0 ? void 0 : authInfo.authKey.trim()) || overrideAuthKey}` : "" }, formData.getHeaders()),
         responseType: "arraybuffer"
     };
     const { data } = await axios_1.default.post(`${env_1.baseURL}/portal`, formData, config);

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

@@ -30,4 +30,5 @@ export declare const DestinationFormats: {
     RAML10: string;
     Postman10: string;
     Postman20: string;
+    GraphQlSchema: string;
 };

package/lib/types/api/transform.js

@@ -13,5 +13,6 @@ exports.DestinationFormats = {
     RAML: "yaml",
     RAML10: "yaml",
     Postman10: "json",
-    Postman20: "json"
+    Postman20: "json",
+    GraphQlSchema: "json"
 };

package/lib/types/utils.d.ts

@@ -0,0 +1,10 @@
+export declare type ValidationMessages = {
+    messages: string[];
+    warnings: string[];
+    errors: string[];
+};
+export declare type loggers = {
+    log: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+};

package/lib/types/utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/utils.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="mocha" />
+import { loggers, ValidationMessages } from "../types/utils";
 export declare const unzipFile: (stream: NodeJS.ReadableStream, destination: string) => Promise<unknown>;
 export declare const deleteFile: (filePath: string) => Promise<void>;
 export declare const writeFileUsingReadableStream: (stream: NodeJS.ReadableStream, destinationPath: string) => Promise<unknown>;
@@ -16,3 +17,4 @@ export declare const stopProgress: (isError?: boolean) => void | null;
 export declare const replaceHTML: (string: string) => string;
 export declare const isJSONParsable: (json: string) => boolean;
 export declare const getFileNameFromPath: (filePath: string) => string;
+export declare const printValidationMessages: ({ warnings, errors, messages }: ValidationMessages, { log, warn, error }: loggers) => void;

package/lib/utils/utils.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFileNameFromPath = exports.isJSONParsable = exports.replaceHTML = exports.stopProgress = exports.startProgress = exports.zipDirectory = exports.writeFileUsingReadableStream = exports.deleteFile = exports.unzipFile = void 0;
-const fs = require("fs-extra");
+exports.printValidationMessages = exports.getFileNameFromPath = exports.isJSONParsable = exports.replaceHTML = exports.stopProgress = exports.startProgress = exports.zipDirectory = exports.writeFileUsingReadableStream = exports.deleteFile = exports.unzipFile = void 0;
+const cli_ux_1 = require("cli-ux");
 const path = require("path");
+const fs = require("fs-extra");
 const archiver = require("archiver");
 const unzipper = require("unzipper");
 const stripTags = require("striptags");
-const cli_ux_1 = require("cli-ux");
 exports.unzipFile = (stream, destination) => {
     return new Promise((resolve, reject) => {
         stream.pipe(unzipper.Extract({ path: destination }));
@@ -105,3 +105,17 @@ exports.isJSONParsable = (json) => {
 exports.getFileNameFromPath = (filePath) => {
     return path.basename(filePath).split(".")[0];
 };
+exports.printValidationMessages = ({ warnings, errors, messages }, { log, warn, error }) => {
+    warnings = warnings || [];
+    messages = messages || [];
+    const singleError = errors.join("\n") || "";
+    messages.forEach((message) => {
+        log(`Info: ${exports.replaceHTML(message)}`);
+    });
+    warnings.forEach((warning) => {
+        warn(exports.replaceHTML(warning));
+    });
+    if (errors.length > 0) {
+        error(exports.replaceHTML(singleError));
+    }
+};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@apimatic/cli",
     "description": "The official CLI for APIMatic.",
-    "version": "1.0.1-alpha.6",
+    "version": "1.0.2-alpha.2",
     "author": "APIMatic",
     "bin": {
         "apimatic": "./bin/run"
@@ -36,16 +36,14 @@
         "build": "tsc -b",
         "postpack": "rimraf oclif.manifest.json",
         "posttest": "eslint . --ext .ts --config .eslintrc",
-        "prepack": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
         "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-        "version": "oclif-dev readme && git add README.md",
         "prettier": "prettier \"src/**/*.{js,ts}\"",
         "format": "prettier --write \"src/**/*.{js,ts}\"",
         "lint": "eslint \"src/**/*.{js,ts}\"",
         "lint:fix": "eslint --fix \"src/**/*.{js,ts}\" --quiet"
     },
     "dependencies": {
-        "@apimatic/sdk": "^0.0.1-alpha.1",
+        "@apimatic/sdk": "^0.0.1-alpha.8",
         "@oclif/command": "^1.8.0",
         "@oclif/config": "^1.17.0",
         "@oclif/plugin-autocomplete": "^0.3.0",

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

@@ -1,6 +0,0 @@
-import { Command } from "@oclif/command";
-export default class Api extends Command {
-    static description: string;
-    static examples: string[];
-    run(): Promise<void>;
-}

package/lib/commands/api/index.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-class Api extends command_1.Command {
-    async run() {
-        this.log(`Manage APIs
-
-USAGE
-  $ apimatic api
-
-EXAMPLE
-  $ apimatic api --help
-
-COMMANDS
-  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.
-  api:validate   Validate the syntactic and semantic correctness of an API specification`);
-    }
-}
-exports.default = Api;
-Api.description = "Manage APIs";
-Api.examples = ["$ apimatic api --help"];

package/lib/commands/auth/index.d.ts

@@ -1,6 +0,0 @@
-import { Command } from "@oclif/command";
-export default class Auth extends Command {
-    static description: string;
-    static examples: string[];
-    run: () => Promise<void>;
-}

package/lib/commands/auth/index.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-class Auth extends command_1.Command {
-    constructor() {
-        super(...arguments);
-        this.run = async () => {
-            this.log(`Manage this CLI's authentication state.
-
-USAGE
-  $ apimatic auth
-
-EXAMPLE
-  $ apimatic auth --help
-
-COMMANDS
-  auth:login   Login using your APIMatic credentials or an API Key
-  auth:logout  Clear local login credentials
-  auth:status  View current authentication state`);
-        };
-    }
-}
-exports.default = Auth;
-Auth.description = "Manage this CLI's authentication state.";
-Auth.examples = ["$ apimatic auth --help"];

package/lib/commands/portal/index.d.ts

@@ -1,6 +0,0 @@
-import { Command } from "@oclif/command";
-export default class SDK extends Command {
-    static description: string;
-    static examples: string[];
-    run(): Promise<void>;
-}

package/lib/commands/portal/index.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-class SDK extends command_1.Command {
-    async run() {
-        this.log(`Manage API documentation portals
-
-USAGE
-  $ apimatic portal
-
-EXAMPLE
-  $apimatic portal --help
-
-COMMANDS
-  portal:generate  Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)`);
-    }
-}
-exports.default = SDK;
-SDK.description = "Manage API documentation portals";
-SDK.examples = ["$apimatic portal --help"];

package/lib/commands/sdk/index.d.ts

@@ -1,6 +0,0 @@
-import { Command } from "@oclif/command";
-export default class SDK extends Command {
-    static description: string;
-    static examples: string[];
-    run(): Promise<void>;
-}

package/lib/commands/sdk/index.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-class SDK extends command_1.Command {
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    async run() {
-        this.log(`Generate and manage SDKs for APIs
-
-USAGE
-  $ apimatic sdk
-
-EXAMPLE
-  $apimatic sdk --help
-
-COMMANDS
-  sdk:generate  Generate SDK for your APIs`);
-    }
-}
-exports.default = SDK;
-SDK.description = "Generate and manage SDKs for APIs";
-SDK.examples = ["$apimatic sdk --help"];

package/oclif.manifest.json

@@ -1 +0,0 @@
-{"version":"1.0.1-alpha.6","commands":{"api":{"id":"api","description":"Manage APIs","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api --help"],"flags":{},"args":[]},"api:transform":{"id":"api: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.","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api:transform --format=\"OpenApi3Json\" --file=\"./specs/sample.json\" --destination=\"D:/\"\nSuccess! Your transformed file is located at D:/Transformed_OpenApi3Json.json\n","$ apimatic api:transform --format=RAML --url=\"https://petstore.swagger.io/v2/swagger.json\"  --destination=\"D:/\"\nSuccess! Your transformed file is located at D:/swagger_raml.yaml\n"],"flags":{"format":{"name":"format","type":"option","description":"specification format to transform API specification into\n(OpenApi3Json|OpenApi3Yaml|APIMATIC|WADL2009|WADL2006|WSDL|\nSwagger10|Swagger20|SwaggerYaml|RAML|RAML10|Postman10|Postman20)","required":true},"file":{"name":"file","type":"option","description":"path to the API specification file to transform","default":""},"url":{"name":"url","type":"option","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.","default":""},"destination":{"name":"destination","type":"option","description":"directory to download transformed file to","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli"},"force":{"name":"force","type":"boolean","char":"f","description":"overwrite if same file exist in the destination","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key"}},"args":[]},"api:validate":{"id":"api:validate","description":"Validate the syntactic and semantic correctness of an API specification","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api:validate --file=\"./specs/sample.json\"\nSpecification file provided is valid\n","$ apimatic api:validate --url=https://petstore.swagger.io/v2/swagger.json\nSpecification file provided is valid\n"],"flags":{"file":{"name":"file","type":"option","description":"Path to the API specification file to validate","default":""},"url":{"name":"url","type":"option","description":"URL to the specification file to validate. Can be used in place of the --file option if the API specification is publicly available.","default":""},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key"}},"args":[]},"auth":{"id":"auth","description":"Manage this CLI's authentication state.","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth --help"],"flags":{},"args":[]},"auth:login":{"id":"auth:login","description":"Login using your APIMatic credentials or an API Key","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:login\nPlease enter your registered email: apimatic-user@gmail.com\nPlease enter your password: *********\n\nYou have successfully logged into APIMatic\n","$ apimatic auth:login --auth-key=xxxxxx\nAuthentication key successfully set"],"flags":{"auth-key":{"name":"auth-key","type":"option","description":"Set authentication key for all commands","default":""}},"args":[]},"auth:logout":{"id":"auth:logout","description":"Clear local login credentials","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:logout\nLogged out\n"],"flags":{},"args":[]},"auth:status":{"id":"auth:status","description":"View current authentication state","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:status\nCurrently logged in as apimatic-client@gmail.com\n"],"flags":{},"args":[]},"portal:generate":{"id":"portal:generate","description":"Generate and download a static API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://portal-api-docs.apimatic.io/#/http/generating-api-portal/build-file)","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic portal:generate --folder=\"./portal/\" --destination=\"D:/\"\nYour portal has been generated at D:/\n"],"flags":{"folder":{"name":"folder","type":"option","description":"path to the input directory containing API specifications and config files","default":""},"destination":{"name":"destination","type":"option","description":"path to the downloaded portal","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli"},"force":{"name":"force","type":"boolean","char":"f","description":"overwrite if a portal exists in the destination","allowNo":false},"zip":{"name":"zip","type":"boolean","description":"download the generated portal as a .zip archive","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key","default":""}},"args":[]},"portal":{"id":"portal","description":"Manage API documentation portals","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$apimatic portal --help"],"flags":{},"args":[]},"sdk:generate":{"id":"sdk:generate","description":"Generate SDK for your APIs","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic sdk:generate --platform=\"CSHARP\" --file=\"./specs/sample.json\"\nGenerating SDK... done\nDownloading SDK... done\nSuccess! Your SDK is located at swagger_sdk_csharp","$ apimatic sdk:generate --platform=\"CSHARP\" --url=https://petstore.swagger.io/v2/swagger.json\nGenerating SDK... done\nDownloading SDK... done\nSuccess! Your SDK is located at swagger_sdk_csharp\n"],"flags":{"platform":{"name":"platform","type":"option","description":"language platform for sdk\nSimple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT\nLegacy: CS_NET_STANDARD_LIB|CS_PORTABLE_NET_LIB|CS_UNIVERSAL_WINDOWS_PLATFORM_LIB|\n        JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB|PYTHON_GENERIC_LIB|RUBY_GENERIC_LIB|\n        TS_GENERIC_LIB","required":true},"file":{"name":"file","type":"option","description":"path to the API specification to generate SDKs for","default":""},"url":{"name":"url","type":"option","description":"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.","default":""},"destination":{"name":"destination","type":"option","description":"directory to download the generated SDK to","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli"},"force":{"name":"force","type":"boolean","char":"f","description":"overwrite if an SDK already exists in the destination","allowNo":false},"zip":{"name":"zip","type":"boolean","description":"download the generated SDK as a .zip archive","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current authentication state with an authentication key","default":""}},"args":[]},"sdk":{"id":"sdk","description":"Generate and manage SDKs for APIs","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$apimatic sdk --help"],"flags":{},"args":[]}}}