@apimatic/cli 1.0.1-alpha.1

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [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/README.md

@@ -0,0 +1,292 @@
+@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)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @apimatic/cli
+$ apimatic COMMAND
+running command...
+$ apimatic (-v|--version|version)
+@apimatic/cli/1.0.1-alpha.1 linux-x64 node-v14.18.1
+$ apimatic --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`
+
+lists all commands related to the APIMatic API.
+
+```
+USAGE
+  $ apimatic api
+
+EXAMPLE
+  $ apimatic api --help
+```
+
+_See code: [src/commands/api/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/api/index.ts)_
+
+## `apimatic api:transform`
+
+Transforms your API specification to any supported format of your choice from amongst[10+ different formats](https://www.apimatic.io/transformer/#supported-formats).
+
+```
+USAGE
+  $ apimatic api:transform
+
+OPTIONS
+  --auth-key=auth-key        override current auth-key
+
+  --destination=destination  [default: /home/runner/work/apimatic-cli/apimatic-cli/cli/src/commands/api] path to
+                             transformed file
+
+  --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)
+
+  --url=url                  URL to the API specification file to transform
+
+EXAMPLE
+  $ apimatic api:transform --format="OpenApi3Json" --file="./specs/sample.json" --destination="D:/"
+  Success! Your transformed file is located at D:/Transformed_OpenApi3Json.json
+```
+
+_See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/api/transform.ts)_
+
+## `apimatic api:validate`
+
+Validates the provided API specification file for any syntactical and semantic errors
+
+```
+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
+
+EXAMPLE
+  $ apimatic api:validate --file="./specs/sample.json"
+  Specification file provided is valid
+```
+
+_See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/api/validate.ts)_
+
+## `apimatic auth`
+
+invokes subcommands related to authentication.
+
+```
+USAGE
+  $ apimatic auth
+
+EXAMPLE
+  $ apimatic auth --help
+```
+
+_See code: [src/commands/auth/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/index.ts)_
+
+## `apimatic auth:login`
+
+login to your APIMatic account
+
+```
+USAGE
+  $ apimatic auth:login
+
+OPTIONS
+  --auth-key=auth-key  Set authentication key for all commands
+
+EXAMPLE
+  $ apimatic auth:login
+  Please enter your registered email: apimatic-user@gmail.com
+  Please enter your password: *********
+
+  You have successfully logged into APIMatic
+```
+
+_See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/login.ts)_
+
+## `apimatic auth:logout`
+
+logout of APIMatic
+
+```
+USAGE
+  $ apimatic auth:logout
+
+EXAMPLE
+  $ apimatic auth:logout
+  Logged out
+```
+
+_See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/logout.ts)_
+
+## `apimatic auth:status`
+
+checks current logged-in account
+
+```
+USAGE
+  $ apimatic auth:status
+
+EXAMPLE
+  $ apimatic auth:status
+  Currently logged in as apimatic-client@gmail.com
+```
+
+_See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/auth/status.ts)_
+
+## `apimatic autocomplete [SHELL]`
+
+display autocomplete installation instructions
+
+```
+USAGE
+  $ apimatic autocomplete [SHELL]
+
+ARGUMENTS
+  SHELL  shell type
+
+OPTIONS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+EXAMPLES
+  $ apimatic autocomplete
+  $ apimatic autocomplete bash
+  $ apimatic autocomplete zsh
+  $ apimatic autocomplete --refresh-cache
+```
+
+_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_
+
+## `apimatic help [COMMAND]`
+
+display help for apimatic
+
+```
+USAGE
+  $ apimatic help [COMMAND]
+
+ARGUMENTS
+  COMMAND  command to show help for
+
+OPTIONS
+  --all  see all commands in CLI
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.7/src/commands/help.ts)_
+
+## `apimatic portal`
+
+invokes subcommands related to the API Portal.
+
+```
+USAGE
+  $ apimatic portal
+
+EXAMPLE
+  $apimatic portal --help
+```
+
+_See code: [src/commands/portal/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/portal/index.ts)_
+
+## `apimatic portal:generate`
+
+Generate static docs portal on premise
+
+```
+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
+
+EXAMPLE
+  $ apimatic portal:generate --folder="./portal/" --destination="D:/"
+  Your portal has been generated at D:/
+```
+
+_See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/portal/generate.ts)_
+
+## `apimatic sdk`
+
+invokes subcommands related to your SDKs.
+
+```
+USAGE
+  $ apimatic sdk
+
+EXAMPLE
+  $apimatic sdk --help
+```
+
+_See code: [src/commands/sdk/index.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/sdk/index.ts)_
+
+## `apimatic sdk:generate`
+
+Generate SDK for your APIs
+
+```
+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
+
+  --platform=platform        (required) language platform for sdk
+                             Simple: CSHARP|JAVA|PYTHON|RUBY|PHP|TYPESCRIPT
+                             Legacy: CS_NET_STANDARD_LIB|CS_PORTABLE_NET_LIB|CS_UNIVERSAL_WINDOWS_PLATFORM_LIB|
+                             JAVA_ECLIPSE_JRE_LIB|PHP_GENERIC_LIB|PYTHON_GENERIC_LIB|RUBY_GENERIC_LIB|
+                             TS_GENERIC_LIB
+
+  --url=url                  URL to the API specification to generate SDK
+
+  --zip                      zip the SDK (used with download flag)
+
+EXAMPLE
+  $ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
+  SDK generated successfully
+```
+
+_See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.0.1-alpha.1/src/commands/sdk/generate.ts)_
+<!-- commandsstop -->

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+require('@oclif/command').run()
+.then(require('@oclif/command/flush'))
+.catch(require('@oclif/errors/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/lib/client-utils/auth-manager.d.ts

@@ -0,0 +1,17 @@
+export declare type AuthInfo = {
+    email: string;
+    authKey: string;
+};
+/**
+ *
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to get credentials
+ */
+export declare function getAuthInfo(configDir: string): Promise<AuthInfo | null>;
+/**
+ *
+ * @param {AuthInfo} credentials
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to set credentials.
+ */
+export declare function setAuthInfo(credentials: AuthInfo, configDir: string): Promise<void>;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setAuthInfo = exports.getAuthInfo = void 0;
+const fs = require("fs-extra");
+const path = require("path");
+/**
+ *
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to get credentials
+ */
+async function getAuthInfo(configDir) {
+    try {
+        const data = JSON.parse(await fs.readFile(path.join(configDir, "config.json"), "utf8"));
+        return data;
+    }
+    catch (e) {
+        return null;
+    }
+}
+exports.getAuthInfo = getAuthInfo;
+/**
+ *
+ * @param {AuthInfo} credentials
+ * @param {string} configDir <- Directory with user configuration
+ * //Function to set credentials.
+ */
+async function setAuthInfo(credentials, configDir) {
+    const configFilePath = path.join(configDir, "config.json");
+    if (!fs.existsSync(configFilePath))
+        fs.createFileSync(configFilePath);
+    return await fs.writeFile(configFilePath, JSON.stringify(credentials));
+}
+exports.setAuthInfo = setAuthInfo;

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

@@ -0,0 +1,23 @@
+import { Client } from "@apimatic/apimatic-sdk-for-js";
+export declare class SDKClient {
+    private static instance;
+    private static authAPI;
+    static client: Client;
+    /**
+     * The static method that controls the access to the SDKClient instance.
+     *
+     * This implementation let you subclass the SDKClient class while keeping
+     * just one instance of each subclass around.
+     */
+    static getInstance(): SDKClient;
+    /**
+     * Finally, any SDKClient should define some business logic, which can be
+     * executed on its instance.
+     */
+    login(email: string, password: string, configDir: string): Promise<string>;
+    logout(configDir: string): Promise<string>;
+    status(configDir: string): Promise<string>;
+    getClient(overrideAuthKey: string | null, configDir: string): Promise<Client>;
+    private getAuthKey;
+    setAuthKey: (authKey: string, configDir: string) => string;
+}

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

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKClient = void 0;
+const base64 = require("base-64");
+const axios_1 = require("axios");
+const apimatic_sdk_for_js_1 = require("@apimatic/apimatic-sdk-for-js");
+const auth_manager_1 = require("./auth-manager");
+const env_1 = require("../config/env");
+class SDKClient {
+    constructor() {
+        this.setAuthKey = (authKey, configDir) => {
+            auth_manager_1.setAuthInfo({
+                email: "",
+                authKey
+            }, configDir);
+            return "Authentication key successfully set";
+        };
+    }
+    /**
+     * The static method that controls the access to the SDKClient instance.
+     *
+     * This implementation let you subclass the SDKClient class while keeping
+     * just one instance of each subclass around.
+     */
+    static getInstance() {
+        if (!SDKClient.instance) {
+            SDKClient.instance = new SDKClient();
+        }
+        return SDKClient.instance;
+    }
+    /**
+     * Finally, any SDKClient should define some business logic, which can be
+     * executed on its instance.
+     */
+    async login(email, password, configDir) {
+        let storedAuthInfo = await auth_manager_1.getAuthInfo(configDir);
+        // If no config file or no credentials exist in the config file
+        if (!storedAuthInfo) {
+            storedAuthInfo = { email: "", authKey: "" };
+        }
+        const credentials = { email, password };
+        const authKey = await this.getAuthKey(credentials);
+        if (storedAuthInfo.email !== email) {
+            auth_manager_1.setAuthInfo({
+                email,
+                authKey
+            }, configDir);
+            return "Logged in";
+        }
+        else if (authKey === storedAuthInfo.authKey) {
+            return "Already logged in";
+        }
+        else {
+            auth_manager_1.setAuthInfo({
+                email,
+                authKey
+            }, configDir);
+            return "Logged in";
+        }
+    }
+    async logout(configDir) {
+        auth_manager_1.setAuthInfo({
+            email: "",
+            authKey: ""
+        }, configDir);
+        return "Logged out";
+    }
+    async status(configDir) {
+        try {
+            let storedAuthInfo = await auth_manager_1.getAuthInfo(configDir);
+            if (!storedAuthInfo) {
+                // If no config file or no credentials exist in the config file
+                storedAuthInfo = { email: "", authKey: "" };
+            }
+            return storedAuthInfo.email === "" && storedAuthInfo.authKey === ""
+                ? "Not logged in"
+                : storedAuthInfo.email === "" && storedAuthInfo.authKey !== ""
+                    ? "Logged in with authentication key"
+                    : `Currently logged in as ${storedAuthInfo.email}`;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    async getClient(overrideAuthKey, configDir) {
+        if (overrideAuthKey) {
+            return new apimatic_sdk_for_js_1.Client({
+                timeout: 0,
+                authorization: `X-Auth-Key ${overrideAuthKey}`
+            });
+        }
+        let storedAuthInfo = await auth_manager_1.getAuthInfo(configDir);
+        if (!storedAuthInfo) {
+            // If no config file or no credentials exist in the config file
+            storedAuthInfo = { email: "", authKey: "" };
+        }
+        if (storedAuthInfo.authKey !== "") {
+            return new apimatic_sdk_for_js_1.Client({
+                timeout: 0,
+                authorization: `X-Auth-Key ${storedAuthInfo.authKey}`
+            });
+        }
+        else {
+            throw new Error("Please login first or provide an authKey");
+        }
+    }
+    async getAuthKey(credentials) {
+        const config = {
+            headers: {
+                Authorization: `Basic ${base64.encode(`${credentials.email}:${credentials.password}`)}`
+            }
+        };
+        const response = await axios_1.default.get(SDKClient.authAPI, config);
+        const authKey = response.data.EncryptedValue;
+        return authKey;
+    }
+}
+exports.SDKClient = SDKClient;
+SDKClient.authAPI = `${env_1.baseURL}/account/authkey`;

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,22 @@
+"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/api/transform.d.ts

@@ -0,0 +1,15 @@
+import { ApiValidationSummary } from "@apimatic/apimatic-sdk-for-js";
+import { flags, Command } from "@oclif/command";
+export default class Transform extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        format: flags.IOptionFlag<string>;
+        file: flags.IOptionFlag<string>;
+        url: flags.IOptionFlag<string>;
+        destination: flags.IOptionFlag<string>;
+        "auth-key": flags.IOptionFlag<string | undefined>;
+    };
+    printValidationMessages: (apiValidationSummary: ApiValidationSummary | undefined) => void;
+    run(): Promise<void>;
+}