@apimatic/cli 1.0.1-alpha.3 → 1.0.1-alpha.7

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.3 linux-x64 node-v14.18.1
+@apimatic/cli/1.0.1-alpha.7 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.3/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)
+                             (OpenApi3Json|OpenApi3Yaml|APIMATIC|WADL2009|WSDL|Swagger10|
+                             Swagger20|SwaggerYaml|RAML|RAML10|Postman10|Postman20)
 
-  --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.3/src/commands/api/transform.ts)_
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/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.3/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.3/src/commands/auth/index.ts)_
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/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.3/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/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.3/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/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.3/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/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.9/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.3/src/commands/portal/index.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.10/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.3/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.3/src/commands/sdk/index.ts)_
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/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,21 @@ 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.3/src/commands/sdk/generate.ts)_
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.7/src/commands/sdk/generate.ts)_
 <!-- commandsstop -->

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

@@ -1,4 +1,4 @@
-import { Client } from "@apimatic/js-sdk";
+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 js_sdk_1 = require("@apimatic/js-sdk");
+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 js_sdk_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 js_sdk_1.Client({
+            return new sdk_1.Client({
                 timeout: 0,
                 authorization: `X-Auth-Key ${storedAuthInfo.authKey}`
             });

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

@@ -7,6 +7,7 @@ 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>;
     };
     run(): Promise<void>;

package/lib/commands/api/transform.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
 const path = require("path");
 const cli_ux_1 = require("cli-ux");
-const js_sdk_1 = require("@apimatic/js-sdk");
+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");
@@ -15,10 +15,12 @@ class Transform extends command_1.Command {
         const fileName = flags.file ? utils_1.getFileNameFromPath(flags.file) : utils_1.getFileNameFromPath(flags.url);
         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`);
             }
@@ -27,7 +29,7 @@ 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 js_sdk_1.TransformationController(client);
+            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({
@@ -69,10 +71,13 @@ 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 = {
@@ -80,11 +85,23 @@ 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)`
+(OpenApi3Json|OpenApi3Yaml|APIMATIC|WADL2009|WSDL|Swagger10|
+Swagger20|SwaggerYaml|RAML|RAML10|Postman10|Postman20)`
     }),
-    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" })
+    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"
+    }),
+    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.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
-const js_sdk_1 = require("@apimatic/js-sdk");
+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");
@@ -16,7 +16,7 @@ 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 js_sdk_1.APIValidationExternalApisController(client);
+            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
@@ -44,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

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

@@ -4,6 +4,7 @@ export default class PortalGenerate extends Command {
     static flags: {
         folder: flags.IOptionFlag<string>;
         destination: flags.IOptionFlag<string>;
+        force: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         zip: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         "auth-key": flags.IOptionFlag<string>;
     };

package/lib/commands/portal/generate.js

@@ -2,9 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
 const path = require("path");
-const cli_ux_1 = require("cli-ux");
 const command_1 = require("@oclif/command");
-const js_sdk_1 = require("@apimatic/js-sdk");
+const sdk_1 = require("@apimatic/sdk");
 const sdk_client_1 = require("../../client-utils/sdk-client");
 const generate_1 = require("../../controllers/portal/generate");
 const utils_1 = require("../../utils/utils");
@@ -12,9 +11,17 @@ class PortalGenerate extends command_1.Command {
     async run() {
         const { flags } = this.parse(PortalGenerate);
         const zip = flags.zip;
-        const portalFolderPath = flags.folder;
-        const generatedPortalFolderPath = flags.destination;
+        const sourceFolderPath = flags.folder;
+        const portalFolderPath = path.join(flags.destination, "generated_portal");
+        const zippedPortalPath = path.join(flags.destination, "generated_portal.zip");
         const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
+        // Check if at destination, portal already exists and throw error if force flag is not set for both zip and extracted
+        if (fs.existsSync(portalFolderPath) && !flags.force && !zip) {
+            throw new Error(`Can't download portal to path ${portalFolderPath}, because it already exists`);
+        }
+        else if (fs.existsSync(zippedPortalPath) && !flags.force && zip) {
+            throw new Error(`Can't download portal to path ${zippedPortalPath}, because it already exists`);
+        }
         try {
             if (!(await fs.pathExists(flags.destination))) {
                 throw new Error(`Destination path ${flags.destination} does not exist`);
@@ -23,11 +30,12 @@ class PortalGenerate extends command_1.Command {
                 throw new Error(`Portal build folder ${flags.folder} does not exist`);
             }
             const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
-            const docsPortalController = new js_sdk_1.DocsPortalManagementController(client);
-            const zippedBuildFilePath = await utils_1.zipDirectory(portalFolderPath, generatedPortalFolderPath);
+            const docsPortalController = new sdk_1.DocsPortalManagementController(client);
+            const zippedBuildFilePath = await utils_1.zipDirectory(sourceFolderPath, flags.destination);
             const generatePortalParams = {
                 zippedBuildFilePath,
-                generatedPortalFolderPath,
+                portalFolderPath,
+                zippedPortalPath,
                 docsPortalController,
                 overrideAuthKey,
                 zip
@@ -36,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;
@@ -51,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) {
@@ -69,22 +76,23 @@ class PortalGenerate extends command_1.Command {
     }
 }
 exports.default = PortalGenerate;
-PortalGenerate.description = "Generate static docs portal on premise";
+PortalGenerate.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)";
 PortalGenerate.flags = {
     folder: command_1.flags.string({
         parse: (input) => path.resolve(input),
-        default: "",
-        description: "folder to generate the portal with"
+        default: "./",
+        description: "path to the input directory containing API specifications and config files"
     }),
     destination: command_1.flags.string({
         parse: (input) => path.resolve(input),
-        default: "./",
+        default: path.resolve("./"),
         description: "path to the downloaded portal"
     }),
-    zip: command_1.flags.boolean({ default: false, description: "zip the portal" }),
+    force: command_1.flags.boolean({ char: "f", default: false, description: "overwrite if a portal exists in the destination" }),
+    zip: command_1.flags.boolean({ default: false, description: "download the generated portal as a .zip archive" }),
     "auth-key": command_1.flags.string({
         default: "",
-        description: "override current auth-key"
+        description: "override current authentication state with an authentication key"
     })
 };
 PortalGenerate.examples = [

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

@@ -6,6 +6,7 @@ export default class SdkGenerate extends Command {
         file: flags.IOptionFlag<string>;
         url: flags.IOptionFlag<string>;
         destination: flags.IOptionFlag<string>;
+        force: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         zip: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
         "auth-key": flags.IOptionFlag<string>;
     };

package/lib/commands/sdk/generate.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
 const path = require("path");
 const cli_ux_1 = require("cli-ux");
-const js_sdk_1 = require("@apimatic/js-sdk");
+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");
@@ -12,6 +12,16 @@ class SdkGenerate extends command_1.Command {
     async run() {
         const { flags } = this.parse(SdkGenerate);
         const zip = flags.zip;
+        const fileName = flags.file ? utils_1.getFileNameFromPath(flags.file) : utils_1.getFileNameFromPath(flags.url);
+        const sdkFolderPath = path.join(flags.destination, `${fileName}_sdk_${flags.platform}`.toLowerCase());
+        const zippedSDKPath = path.join(flags.destination, `${fileName}_sdk_${flags.platform}.zip`.toLowerCase());
+        // Check if at destination, SDK already exists and throw error if force flag is not set for both zip and extracted
+        if (fs.existsSync(sdkFolderPath) && !flags.force && !zip) {
+            throw new Error(`Can't download SDK to path ${sdkFolderPath}, because it already exists`);
+        }
+        else if (fs.existsSync(zippedSDKPath) && !flags.force && zip) {
+            throw new Error(`Can't download SDK to path ${zippedSDKPath}, because it already exists`);
+        }
         try {
             if (!(await fs.pathExists(path.resolve(flags.destination)))) {
                 throw new Error(`Destination path ${flags.destination} does not exist`);
@@ -19,18 +29,9 @@ class SdkGenerate extends command_1.Command {
             else if (!(await fs.pathExists(path.resolve(flags.file)))) {
                 throw new Error(`Specification file ${flags.file} does not exist`);
             }
-            const fileName = flags.file ? utils_1.getFileNameFromPath(flags.file) : utils_1.getFileNameFromPath(flags.url);
-            const sdkFolderPath = path.join(flags.destination, `${fileName}_sdk_${flags.platform}`.toLowerCase());
-            const zippedSDKPath = path.join(flags.destination, `${fileName}_sdk_${flags.platform}.zip`.toLowerCase());
-            if (fs.existsSync(zippedSDKPath) && zip) {
-                throw new Error(`Can't generate SDK to path ${zippedSDKPath}, because it already exists`);
-            }
-            else if (fs.existsSync(sdkFolderPath) && !zip) {
-                throw new Error(`Can't generate SDK to path ${sdkFolderPath}, because it already exists`);
-            }
             const overrideAuthKey = flags["auth-key"] ? flags["auth-key"] : null;
             const client = await sdk_client_1.SDKClient.getInstance().getClient(overrideAuthKey, this.config.configDir);
-            const sdkGenerationController = new js_sdk_1.CodeGenerationExternalApisController(client);
+            const sdkGenerationController = new sdk_1.CodeGenerationExternalApisController(client);
             // Get generation id for the specification and platform
             const codeGenId = await generate_1.getSDKGenerationId(flags, sdkGenerationController);
             // If user wanted to download the SDK as well
@@ -94,22 +95,36 @@ Legacy: CS_NET_STANDARD_LIB|CS_PORTABLE_NET_LIB|CS_UNIVERSAL_WINDOWS_PLATFORM_LI
     file: command_1.flags.string({
         parse: (input) => path.resolve(input),
         default: "",
-        description: "path to the API specification to generate SDK"
+        description: "path to the API specification to generate SDKs for"
+    }),
+    url: command_1.flags.string({
+        default: "",
+        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."
     }),
-    url: command_1.flags.string({ default: "", description: "URL to the API specification to generate SDK" }),
     destination: command_1.flags.string({
         parse: (input) => path.resolve(input),
-        default: "./",
-        description: "path to downloaded SDK (used with download flag)"
+        default: path.resolve("./"),
+        description: "directory to download the generated SDK to"
+    }),
+    force: command_1.flags.boolean({
+        char: "f",
+        default: false,
+        description: "overwrite if an SDK already exists in the destination"
     }),
-    zip: command_1.flags.boolean({ default: false, description: "zip the SDK (used with download flag)" }),
+    zip: command_1.flags.boolean({ default: false, description: "download the generated SDK as a .zip archive" }),
     "auth-key": command_1.flags.string({
         default: "",
-        description: "override current auth-key"
+        description: "override current authentication state with an authentication key"
     })
 };
 SdkGenerate.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
 `
 ];

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

@@ -1,5 +1,5 @@
 import Command from "@oclif/command";
-import { ApiValidationSummary, ExportFormats, Transformation, TransformationController } from "@apimatic/js-sdk";
+import { ApiValidationSummary, ExportFormats, Transformation, TransformationController } from "@apimatic/sdk";
 import { DownloadTransformationParams, TransformationIdParams } from "../../types/api/transform";
 export declare const getTransformationId: ({ file, url, format }: TransformationIdParams, transformationController: TransformationController) => Promise<Transformation>;
 export declare const downloadTransformationFile: ({ id, destinationFilePath, transformationController }: DownloadTransformationParams) => Promise<string>;

package/lib/controllers/api/transform.js

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.printValidationMessages = exports.getValidFormat = exports.downloadTransformationFile = exports.getTransformationId = void 0;
 const cli_ux_1 = require("cli-ux");
 const fs = require("fs-extra");
-const js_sdk_1 = require("@apimatic/js-sdk");
+const sdk_1 = require("@apimatic/sdk");
 const utils_1 = require("../../utils/utils");
 exports.getTransformationId = async ({ file, url, format }, transformationController) => {
     cli_ux_1.default.action.start("Transforming API specification");
     let generation;
     if (file) {
-        const fileDescriptor = new js_sdk_1.FileWrapper(fs.createReadStream(file));
+        const fileDescriptor = new sdk_1.FileWrapper(fs.createReadStream(file));
         generation = await transformationController.transformViaFile(fileDescriptor, format);
     }
     else if (url) {
@@ -39,11 +39,11 @@ exports.downloadTransformationFile = async ({ id, destinationFilePath, transform
 };
 // Get valid platform from user's input, convert simple platform to valid Platforms enum value
 exports.getValidFormat = (format) => {
-    if (Object.keys(js_sdk_1.ExportFormats).find((exportFormat) => exportFormat === format)) {
-        return js_sdk_1.ExportFormats[format];
+    if (Object.keys(sdk_1.ExportFormats).find((exportFormat) => exportFormat === format)) {
+        return sdk_1.ExportFormats[format];
     }
     else {
-        const formats = Object.keys(js_sdk_1.ExportFormats).join("|");
+        const formats = Object.keys(sdk_1.ExportFormats).join("|");
         throw new Error(`Please provide a valid platform i.e. ${formats}`);
     }
 };

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

@@ -1,5 +1,5 @@
 import Command from "@oclif/command";
-import { APIValidationExternalApisController, ApiValidationSummary } from "@apimatic/js-sdk";
+import { APIValidationExternalApisController, ApiValidationSummary } from "@apimatic/sdk";
 import { GetValidationParams } from "../../types/api/validate";
 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/portal/generate.d.ts

@@ -1,2 +1,2 @@
 import { GeneratePortalParams } from "../../types/portal/generate";
-export declare const downloadDocsPortal: ({ zippedBuildFilePath, generatedPortalFolderPath, overrideAuthKey, zip }: GeneratePortalParams, configDir: string) => Promise<string>;
+export declare const downloadDocsPortal: ({ zippedBuildFilePath, portalFolderPath, zippedPortalPath, overrideAuthKey, zip }: GeneratePortalParams, configDir: string) => Promise<string>;

package/lib/controllers/portal/generate.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadDocsPortal = void 0;
 const fs = require("fs-extra");
 const FormData = require("form-data");
-const path = require("path");
 const cli_ux_1 = require("cli-ux");
 const auth_manager_1 = require("../../client-utils/auth-manager");
 const env_1 = require("../../config/env");
@@ -22,9 +21,7 @@ const downloadPortalAxios = async (zippedBuildFilePath, overrideAuthKey, configD
     return data;
 };
 // Download Docs Portal
-exports.downloadDocsPortal = async ({ zippedBuildFilePath, generatedPortalFolderPath, overrideAuthKey, zip }, configDir) => {
-    const zippedPortalPath = path.join(generatedPortalFolderPath, "generated_portal.zip");
-    const portalPath = path.join(generatedPortalFolderPath, "generated_portal");
+exports.downloadDocsPortal = async ({ zippedBuildFilePath, portalFolderPath, zippedPortalPath, overrideAuthKey, zip }, configDir) => {
     cli_ux_1.default.action.start("Downloading portal");
     // Check if the build file exists for the user or not
     if (!(await fs.pathExists(zippedBuildFilePath))) {
@@ -41,11 +38,11 @@ exports.downloadDocsPortal = async ({ zippedBuildFilePath, generatedPortalFolder
     // if ((data as NodeJS.ReadableStream).readable) {
     //   await writeFileUsingReadableStream(data as NodeJS.ReadableStream, zippedPortalPath);
     if (!zip) {
-        await utils_1.unzipFile(fs.createReadStream(zippedPortalPath), portalPath);
+        await utils_1.unzipFile(fs.createReadStream(zippedPortalPath), portalFolderPath);
         await utils_1.deleteFile(zippedPortalPath);
     }
     cli_ux_1.default.action.stop();
-    return zip ? zippedPortalPath : portalPath;
+    return zip ? zippedPortalPath : portalFolderPath;
     // } else {
     //   throw new Error("Couldn't download the portal");
     // }

package/lib/controllers/sdk/generate.d.ts

@@ -1,4 +1,4 @@
-import { CodeGenerationExternalApisController } from "@apimatic/js-sdk";
+import { CodeGenerationExternalApisController } from "@apimatic/sdk";
 import { GenerationIdParams, DownloadSDKParams } from "../../types/sdk/generate";
 export declare const getSDKGenerationId: ({ file, url, platform }: GenerationIdParams, sdkGenerationController: CodeGenerationExternalApisController) => Promise<string>;
 export declare const downloadGeneratedSDK: ({ codeGenId, zippedSDKPath, sdkFolderPath, zip }: DownloadSDKParams, sdkGenerationController: CodeGenerationExternalApisController) => Promise<string>;

package/lib/controllers/sdk/generate.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadGeneratedSDK = exports.getSDKGenerationId = void 0;
 const fs = require("fs-extra");
 const cli_ux_1 = require("cli-ux");
-const js_sdk_1 = require("@apimatic/js-sdk");
+const sdk_1 = require("@apimatic/sdk");
 const core_1 = require("@apimatic/core");
 const generate_1 = require("../../types/sdk/generate");
 const utils_1 = require("../../utils/utils");
@@ -34,11 +34,11 @@ const getSDKPlatform = (platform) => {
     if (Object.keys(generate_1.SimplePlatforms).includes(platform)) {
         return generate_1.SimplePlatforms[platform];
     }
-    else if (Object.values(js_sdk_1.Platforms).includes(platform)) {
+    else if (Object.values(sdk_1.Platforms).includes(platform)) {
         return platform;
     }
     else {
-        const platforms = Object.keys(generate_1.SimplePlatforms).concat(Object.values(js_sdk_1.Platforms)).join("|");
+        const platforms = Object.keys(generate_1.SimplePlatforms).concat(Object.values(sdk_1.Platforms)).join("|");
         throw new Error(`Please provide a valid platform i.e. ${platforms}`);
     }
 };

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { TransformationController } from "@apimatic/js-sdk";
+import { TransformationController } from "@apimatic/sdk";
 export declare type AuthenticationError = {
     statusCode: number;
     body: string;

package/lib/types/portal/generate.d.ts

@@ -1,7 +1,8 @@
-import { DocsPortalManagementController } from "@apimatic/js-sdk";
+import { DocsPortalManagementController } from "@apimatic/sdk";
 export declare type GeneratePortalParams = {
     zippedBuildFilePath: string;
-    generatedPortalFolderPath: string;
+    portalFolderPath: string;
+    zippedPortalPath: string;
     docsPortalController: DocsPortalManagementController;
     overrideAuthKey: string | null;
     zip: boolean;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.1-alpha.3","commands":{"api":{"id":"api","description":"lists all commands related to the APIMatic API.","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api --help"],"flags":{},"args":[]},"api:transform":{"id":"api: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).","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"],"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","default":""},"destination":{"name":"destination","type":"option","description":"path to transformed file","default":"/home/runner/work/apimatic-cli/apimatic-cli/cli/src/commands/api"},"auth-key":{"name":"auth-key","type":"option","description":"override current auth-key"}},"args":[]},"api:validate":{"id":"api:validate","description":"Validates the provided API specification file for any syntactical and semantic errors","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic api:validate --file=\"./specs/sample.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","default":""},"auth-key":{"name":"auth-key","type":"option","description":"override current auth-key"}},"args":[]},"auth":{"id":"auth","description":"invokes subcommands related to authentication.","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth --help"],"flags":{},"args":[]},"auth:login":{"id":"auth:login","description":"login to your APIMatic account","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"],"flags":{"auth-key":{"name":"auth-key","type":"option","description":"Set authentication key for all commands","default":""}},"args":[]},"auth:logout":{"id":"auth:logout","description":"logout of APIMatic","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$ apimatic auth:logout\nLogged out\n"],"flags":{},"args":[]},"auth:status":{"id":"auth:status","description":"checks current logged-in account","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 static docs portal on premise","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":"folder to generate the portal with","default":""},"destination":{"name":"destination","type":"option","description":"path to the downloaded portal","default":"./"},"zip":{"name":"zip","type":"boolean","description":"zip the portal","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current auth-key","default":""}},"args":[]},"portal":{"id":"portal","description":"invokes subcommands related to the API Portal.","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\"\nSDK generated successfully\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 SDK","default":""},"url":{"name":"url","type":"option","description":"URL to the API specification to generate SDK","default":""},"destination":{"name":"destination","type":"option","description":"path to downloaded SDK (used with download flag)","default":"./"},"zip":{"name":"zip","type":"boolean","description":"zip the SDK (used with download flag)","allowNo":false},"auth-key":{"name":"auth-key","type":"option","description":"override current auth-key","default":""}},"args":[]},"sdk":{"id":"sdk","description":"invokes subcommands related to your SDKs.","pluginName":"@apimatic/cli","pluginType":"core","aliases":[],"examples":["$apimatic sdk --help"],"flags":{},"args":[]}}}
+{"version":"1.0.1-alpha.7","commands":{"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|WSDL|Swagger10|\nSwagger20|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: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":[]},"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":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@apimatic/cli",
     "description": "The official CLI for APIMatic.",
-    "version": "1.0.1-alpha.3",
+    "version": "1.0.1-alpha.7",
     "author": "APIMatic",
     "bin": {
         "apimatic": "./bin/run"
@@ -45,7 +45,7 @@
         "lint:fix": "eslint --fix \"src/**/*.{js,ts}\" --quiet"
     },
     "dependencies": {
-        "@apimatic/js-sdk": "^0.0.3-alpha.1",
+        "@apimatic/sdk": "^0.0.1-alpha.1",
         "@oclif/command": "^1.8.0",
         "@oclif/config": "^1.17.0",
         "@oclif/plugin-autocomplete": "^0.3.0",

package/CHANGELOG.md

@@ -1,20 +0,0 @@
-## [1.0.1-alpha.3](https://github.com/apimatic/apimatic-cli/compare/v1.0.1-alpha.2...v1.0.1-alpha.3) (2021-12-01)
-
-
-### Bug Fixes
-
-* **sdk package:** get sdk package from npm ([4c8e178](https://github.com/apimatic/apimatic-cli/commit/4c8e1787eb21f04d81cab95b5a58e3133a61f7af))
-
-## [1.0.1-alpha.2](https://github.com/apimatic/apimatic-cli/compare/v1.0.1-alpha.1...v1.0.1-alpha.2) (2021-11-30)
-
-
-### Bug Fixes
-
-* **refactor:** refactor code ([d7cb486](https://github.com/apimatic/apimatic-cli/commit/d7cb4863bcfd44f297f0525e0c7eae7ecef12695))
-
-## [1.0.1-alpha.1](https://github.com/apimatic/apimatic-cli/compare/v1.0.0...v1.0.1-alpha.1) (2021-11-26)
-
-
-### Bug Fixes
-
-* **release:** add lock file to gitignore restore check_build workflow ([2eb959a](https://github.com/apimatic/apimatic-cli/commit/2eb959afc2a7ee2317959fc8525930acde2989dc))

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,22 +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(`lists all commands related to the APIMatic API.
-
-USAGE
-  $ apimatic api
-
-EXAMPLE
-  $ apimatic api --help
-
-COMMANDS
-  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).
-  api:validate   Validates the provided API specification file for any syntactical and semantic errors`);
-    }
-}
-exports.default = Api;
-Api.description = "lists all commands related to the APIMatic API.";
-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(`invokes subcommands related to authentication.
-
-USAGE
-  $ apimatic auth
-
-EXAMPLE
-  $ apimatic auth --help
-
-COMMANDS
-  auth:login   login to your APIMatic account
-  auth:logout  logout of APIMatic
-  auth:status  checks current logged-in account`);
-        };
-    }
-}
-exports.default = Auth;
-Auth.description = "invokes subcommands related to authentication.";
-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(`invokes subcommands related to the API Portal.
-
-USAGE
-  $ apimatic portal
-
-EXAMPLE
-  $apimatic portal --help
-
-COMMANDS
-  portal:generate  Generate static docs portal on premise`);
-    }
-}
-exports.default = SDK;
-SDK.description = "invokes subcommands related to the API Portal.";
-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(`invokes subcommands related to your SDKs.
-
-USAGE
-  $ apimatic sdk
-
-EXAMPLE
-  $apimatic sdk --help
-
-COMMANDS
-  sdk:generate  Generate SDK for your APIs`);
-    }
-}
-exports.default = SDK;
-SDK.description = "invokes subcommands related to your SDKs.";
-SDK.examples = ["$apimatic sdk --help"];