@apimatic/cli 1.0.1-alpha.1

package/lib/commands/sdk/generate.js

@@ -0,0 +1,178 @@
+"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 apimatic_sdk_for_js_1 = require("@apimatic/apimatic-sdk-for-js");
+const command_1 = require("@oclif/command");
+const sdk_client_1 = require("../../client-utils/sdk-client");
+const utils_1 = require("../../utils/utils");
+var SimplePlatforms;
+(function (SimplePlatforms) {
+    SimplePlatforms["CSHARP"] = "CS_NET_STANDARD_LIB";
+    SimplePlatforms["JAVA"] = "JAVA_ECLIPSE_JRE_LIB";
+    SimplePlatforms["PHP"] = "PHP_GENERIC_LIB";
+    SimplePlatforms["PYTHON"] = "PYTHON_GENERIC_LIB";
+    SimplePlatforms["RUBY"] = "RUBY_GENERIC_LIB";
+    SimplePlatforms["TYPESCRIPT"] = "TS_GENERIC_LIB";
+})(SimplePlatforms || (SimplePlatforms = {}));
+async function getSDKGenerationId({ file, url, platform }, sdkGenerationController) {
+    cli_ux_1.default.action.start("Generating SDK");
+    let generation;
+    const sdkPlatform = getSDKPlatform(platform);
+    if (file) {
+        const fileDescriptor = new apimatic_sdk_for_js_1.FileWrapper(fs.createReadStream(file));
+        generation = await sdkGenerationController.generateSDKViaFile(fileDescriptor, sdkPlatform);
+    }
+    else if (url) {
+        // If url to spec file is provided
+        const body = {
+            url: url,
+            template: sdkPlatform
+        };
+        generation = await sdkGenerationController.generateSDKViaURL(body);
+    }
+    else {
+        throw new Error("Please provide a specification file");
+    }
+    cli_ux_1.default.action.stop();
+    return generation.result.id;
+}
+// Get valid platform from user's input, convert simple platform to valid Platforms enum value
+function getSDKPlatform(platform) {
+    if (Object.keys(SimplePlatforms).includes(platform)) {
+        return SimplePlatforms[platform];
+    }
+    else if (Object.values(apimatic_sdk_for_js_1.Platforms).includes(platform)) {
+        return platform;
+    }
+    else {
+        const platforms = Object.keys(SimplePlatforms).concat(Object.values(apimatic_sdk_for_js_1.Platforms)).join("|");
+        throw new Error(`Please provide a valid platform i.e. ${platforms}`);
+    }
+}
+// Download Platform
+async function downloadGeneratedSDK({ codeGenId, zippedSDKPath, sdkFolderPath, zip }, sdkGenerationController) {
+    cli_ux_1.default.action.start("Downloading SDK");
+    const { result } = await sdkGenerationController.downloadSDK(codeGenId);
+    if (result.readable) {
+        if (!zip) {
+            await utils_1.unzipFile(result, sdkFolderPath);
+            cli_ux_1.default.action.stop();
+            return sdkFolderPath;
+        }
+        else {
+            await utils_1.writeFileUsingReadableStream(result, zippedSDKPath);
+            cli_ux_1.default.action.stop();
+            return zippedSDKPath;
+        }
+    }
+    else {
+        throw new Error("Couldn't download the SDK");
+    }
+}
+class SdkGenerate extends command_1.Command {
+    async run() {
+        const { flags } = this.parse(SdkGenerate);
+        const zip = flags.zip;
+        try {
+            if (!(await fs.pathExists(path.resolve(flags.destination)))) {
+                throw new Error(`Destination path ${flags.destination} does not exist`);
+            }
+            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 apimatic_sdk_for_js_1.CodeGenerationExternalApisController(client);
+            // Get generation id for the specification and platform
+            const codeGenId = await getSDKGenerationId(flags, sdkGenerationController);
+            // If user wanted to download the SDK as well
+            const sdkDownloadParams = {
+                codeGenId,
+                zippedSDKPath,
+                sdkFolderPath,
+                zip
+            };
+            const sdkPath = await downloadGeneratedSDK(sdkDownloadParams, sdkGenerationController);
+            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;
+                if (apiError.statusCode === 400 && utils_1.isJSONParsable(result.message)) {
+                    const errors = JSON.parse(result.message);
+                    if (Array.isArray(errors.Errors) && apiError.statusCode === 400) {
+                        this.error(utils_1.replaceHTML(`${JSON.parse(result.message).Errors[0]}`));
+                    }
+                }
+                else if (apiError.statusCode === 401 && apiError.body && typeof apiError.body === "string") {
+                    this.error(apiError.body);
+                }
+                else if (apiError.statusCode === 500 &&
+                    apiError.body &&
+                    typeof apiError.body === "string" &&
+                    utils_1.isJSONParsable(apiError.body)) {
+                    this.error(JSON.parse(apiError.body).message);
+                }
+                else if (apiError.statusCode === 422 &&
+                    apiError.body &&
+                    typeof apiError.body === "string" &&
+                    utils_1.isJSONParsable(apiError.body)) {
+                    this.error(JSON.parse(apiError.body)["dto.Url"][0]);
+                }
+                else {
+                    this.error(utils_1.replaceHTML(result.message));
+                }
+            }
+            else {
+                this.error(`${error.message}`);
+            }
+        }
+    }
+}
+exports.default = SdkGenerate;
+SdkGenerate.description = "Generate SDK for your APIs";
+SdkGenerate.flags = {
+    platform: command_1.flags.string({
+        parse: (input) => input.toUpperCase(),
+        required: true,
+        description: `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`
+    }),
+    file: command_1.flags.string({
+        parse: (input) => path.resolve(input),
+        default: "",
+        description: "path to the API specification to generate SDK"
+    }),
+    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)"
+    }),
+    zip: command_1.flags.boolean({ default: false, description: "zip the SDK (used with download flag)" }),
+    "auth-key": command_1.flags.string({
+        default: "",
+        description: "override current auth-key"
+    })
+};
+SdkGenerate.examples = [
+    `$ apimatic sdk:generate --platform="CSHARP" --file="./specs/sample.json"
+SDK generated successfully
+`
+];

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

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

@@ -0,0 +1,21 @@
+"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"];

package/lib/config/env.d.ts

@@ -0,0 +1 @@
+export declare const baseURL = "https://apimaticio-test.azurewebsites.net/api";

package/lib/config/env.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.baseURL = void 0;
+exports.baseURL = "https://apimaticio-test.azurewebsites.net/api";

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { run } from "@oclif/command";

package/lib/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var command_1 = require("@oclif/command");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });

package/lib/utils/utils.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+/// <reference types="mocha" />
+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>;
+/**
+ * Packages local files into a ZIP archive
+ *
+ * @param {docsPortalFolderPath} path to portal directory.
+ * @param {destinationZipPath} path to generated zip
+ * return {string}
+ */
+export declare const zipDirectory: (sourcePath: string, destinationPath: string) => Promise<string>;
+export declare const startProgress: (title: string) => void;
+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;

package/lib/utils/utils.js

@@ -0,0 +1,107 @@
+"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");
+const path = require("path");
+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 }));
+        stream.on("close", (error) => {
+            if (error) {
+                reject(new Error("Couldn't extract the zip"));
+            }
+            resolve("Extracted");
+        });
+    });
+};
+exports.deleteFile = async (filePath) => {
+    return await fs.remove(filePath);
+};
+exports.writeFileUsingReadableStream = (stream, destinationPath) => {
+    return new Promise((resolve, reject) => {
+        const writeStream = fs.createWriteStream(destinationPath);
+        stream.pipe(writeStream);
+        writeStream.on("close", (error) => {
+            if (error) {
+                return reject(new Error("Couldn't zip the stream"));
+            }
+            resolve("Zipped");
+        });
+    });
+};
+/**
+ * Packages local files into a ZIP archive
+ *
+ * @param {docsPortalFolderPath} path to portal directory.
+ * @param {destinationZipPath} path to generated zip
+ * return {string}
+ */
+exports.zipDirectory = async (sourcePath, destinationPath) => {
+    // Check if the directory exists for the user or not
+    await fs.ensureDir(sourcePath);
+    const zipPath = path.join(destinationPath, "target.zip");
+    const output = fs.createWriteStream(zipPath);
+    const archive = archiver("zip");
+    archive.on("error", (err) => {
+        throw err;
+    });
+    archive.pipe(output);
+    // append files from a sub-directory, putting its contents at the root of archive
+    archive.directory(sourcePath, false);
+    await archive.finalize();
+    return zipPath;
+};
+// TODO: Instead of making progressBar a static, you should have "startProgress"
+// return the instance of the progress bar created, the same way "cli.progress"
+// method does.
+let progressBar;
+// TODO: I didn't mean to say that we should create a fake progress bar when we
+// set the requirements to include progress bar. You should get the download or
+// upload progress by tracking how much of the steam has been read/written and
+// compare that with the remaining size of the stream (in case of upload, you
+// get size from the file size and in case of download, you get it from the
+// content-type header). In case the progress can not be calculated, show a
+// spinner.
+exports.startProgress = (title) => {
+    progressBar = cli_ux_1.default.progress({
+        format: `${title} | {bar}`,
+        barCompleteChar: "\u2588",
+        barIncompleteChar: "\u2591"
+    });
+    progressBar.start();
+    const total = 100;
+    let count = 0;
+    const iv = setInterval(() => {
+        count++;
+        progressBar.update(count);
+        if (count === total - 1) {
+            clearInterval(iv);
+        }
+    }, 50);
+};
+exports.stopProgress = (isError = false) => {
+    if (isError) {
+        return progressBar ? progressBar.stop() : null;
+    }
+    progressBar.update(100);
+    return progressBar.stop();
+};
+exports.replaceHTML = (string) => {
+    return stripTags(string);
+};
+exports.isJSONParsable = (json) => {
+    try {
+        JSON.parse(json);
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+};
+exports.getFileNameFromPath = (filePath) => {
+    return path.basename(filePath).split(".")[0];
+};

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"1.0.1-alpha.1","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":[]}}}

package/package.json

@@ -0,0 +1,107 @@
+{
+    "name": "@apimatic/cli",
+    "description": "The official CLI for APIMatic.",
+    "version": "1.0.1-alpha.1",
+    "author": "APIMatic",
+    "bin": {
+        "apimatic": "./bin/run"
+    },
+    "bugs": "https://github.com/apimatic/apimatic-cli/issues",
+    "publishConfig": {
+        "access": "public"
+    },
+    "engines": {
+        "node": ">=12.0.0"
+    },
+    "files": [
+        "/bin",
+        "/lib",
+        "/npm-shrinkwrap.json",
+        "/oclif.manifest.json"
+    ],
+    "repository": "git://github.com/apimatic/apimatic-cli.git",
+    "homepage": "https://github.com/apimatic/apimatic-cli",
+    "keywords": [
+        "apimatic",
+        "cli",
+        "sdk generation",
+        "openapi",
+        "api",
+        "automation"
+    ],
+    "license": "MIT",
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "scripts": {
+        "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/apimatic-sdk-for-js": "git+https://github.com/apimatic/apimatic-sdk-for-js.git",
+        "@oclif/command": "^1.8.0",
+        "@oclif/config": "^1.17.0",
+        "@oclif/plugin-autocomplete": "^0.3.0",
+        "@oclif/plugin-help": "^3.2.3",
+        "@oclif/plugin-not-found": "^1.2.4",
+        "archiver": "^5.3.0",
+        "axios": "^0.24.0",
+        "base-64": "^1.0.0",
+        "form-data": "^4.0.0",
+        "fs-extra": "^10.0.0",
+        "striptags": "^3.2.0",
+        "tslib": "^1.14.1",
+        "unzipper": "^0.10.11"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "^15.0.0",
+        "@commitlint/config-conventional": "^15.0.0",
+        "@oclif/dev-cli": "^1.26.0",
+        "@oclif/test": "^1.2.8",
+        "@semantic-release/changelog": "^6.0.1",
+        "@semantic-release/git": "^10.0.1",
+        "@types/archiver": "^5.1.1",
+        "@types/axios": "^0.14.0",
+        "@types/base-64": "^1.0.0",
+        "@types/chai": "^4.2.22",
+        "@types/fs-extra": "^9.0.13",
+        "@types/mocha": "^5.2.7",
+        "@types/node": "^10.17.60",
+        "@types/unzipper": "^0.10.4",
+        "@typescript-eslint/eslint-plugin": "^5.0.0",
+        "@typescript-eslint/parser": "^5.0.0",
+        "chai": "^4.3.4",
+        "eslint": "^7.32.0",
+        "eslint-config-prettier": "^8.3.0",
+        "eslint-plugin-import": "^2.25.2",
+        "globby": "^10.0.2",
+        "husky": "^7.0.4",
+        "lint-staged": "^11.2.6",
+        "mocha": "^5.2.0",
+        "nyc": "^14.1.1",
+        "prettier": "^2.4.1",
+        "rimraf": "^3.0.2",
+        "ts-node": "^8.10.2",
+        "typescript": "^3.9.10"
+    },
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "apimatic",
+        "plugins": [
+            "@oclif/plugin-autocomplete",
+            "@oclif/plugin-help",
+            "@oclif/plugin-not-found"
+        ]
+    },
+    "lint-staged": {
+        "*.js": "eslint --cache --fix",
+        "*.{js,ts}": "prettier --write"
+    }
+}