@apimatic/cli 0.0.0-alpha.2

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

@@ -0,0 +1,34 @@
+/// <reference types="node" />
+import { TransformationController } from "@apimatic/sdk";
+export declare type AuthenticationError = {
+    statusCode: number;
+    body: string;
+};
+export declare type TransformationIdParams = {
+    file: string;
+    url: string;
+    format: string;
+};
+export declare type DownloadTransformationParams = {
+    id: string;
+    destinationFilePath: string;
+    transformationController: TransformationController;
+};
+export declare type TransformationData = {
+    result: NodeJS.ReadableStream | Blob;
+};
+export declare const DestinationFormats: {
+    OpenApi3Json: string;
+    OpenApi3Yaml: string;
+    APIMATIC: string;
+    WADL2009: string;
+    WSDL: string;
+    Swagger10: string;
+    Swagger20: string;
+    SwaggerYaml: string;
+    RAML: string;
+    RAML10: string;
+    Postman10: string;
+    Postman20: string;
+    GraphQlSchema: string;
+};

package/lib/types/api/transform.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DestinationFormats = void 0;
+exports.DestinationFormats = {
+    OpenApi3Json: "json",
+    OpenApi3Yaml: "yaml",
+    APIMATIC: "json",
+    WADL2009: "xml",
+    WSDL: "xml",
+    Swagger10: "json",
+    Swagger20: "json",
+    SwaggerYaml: "yaml",
+    RAML: "yaml",
+    RAML10: "yaml",
+    Postman10: "json",
+    Postman20: "json",
+    GraphQlSchema: "json"
+};

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

@@ -0,0 +1,12 @@
+export declare type GetValidationParams = {
+    file: string;
+    url: string;
+};
+export declare type APIValidateError = {
+    modelState: {
+        "exception Error": string[];
+    };
+};
+export declare type AuthorizationError = {
+    body: string;
+};

package/lib/types/api/validate.js

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

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

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

package/lib/types/portal/generate.js

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

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

@@ -0,0 +1,22 @@
+export declare type GenerationIdParams = {
+    file: string;
+    url: string;
+    platform: string;
+};
+export declare type DownloadSDKParams = {
+    codeGenId: string;
+    zip: boolean;
+    zippedSDKPath: string;
+    sdkFolderPath: string;
+};
+export declare type SDKGenerateUnprocessableError = {
+    message: string;
+};
+export declare enum SimplePlatforms {
+    CSHARP = "CS_NET_STANDARD_LIB",
+    JAVA = "JAVA_ECLIPSE_JRE_LIB",
+    PHP = "PHP_GENERIC_LIB",
+    PYTHON = "PYTHON_GENERIC_LIB",
+    RUBY = "RUBY_GENERIC_LIB",
+    TYPESCRIPT = "TS_GENERIC_LIB"
+}

package/lib/types/sdk/generate.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimplePlatforms = void 0;
+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 = exports.SimplePlatforms || (exports.SimplePlatforms = {}));

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":"0.0.0-alpha.2","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\nAPIMATIC|WADL2009|WSDL|SWAGGER10|SWAGGER20|SWAGGERYAML|OAS3|OPENAPI3YAML|APIBLUEPRINT|RAML|RAML10|POSTMAN10|POSTMAN20|GRAPHQLSCHEMA","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","\n$ 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

@@ -0,0 +1,107 @@
+{
+    "name": "@apimatic/cli",
+    "description": "The official CLI for APIMatic.",
+    "version": "0.0.0-alpha.2",
+    "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/sdk": "^0.0.1-alpha.6",
+        "@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"
+    }
+}