@apimatic/cli 0.0.0-alpha.3 → 1.0.0-beta.1

package/lib/controllers/portal/generate.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadDocsPortal = void 0;
-const cli_ux_1 = require("cli-ux");
-const fs = require("fs-extra");
-const FormData = require("form-data");
-const env_1 = require("../../config/env");
-const utils_1 = require("../../utils/utils");
-const auth_manager_1 = require("../../client-utils/auth-manager");
-const axios_1 = require("axios");
-// TODO: Remove after SDK is patched
-const downloadPortalAxios = async (zippedBuildFilePath, overrideAuthKey, configDir) => {
-    const formData = new FormData();
-    const authInfo = await auth_manager_1.getAuthInfo(configDir);
-    formData.append("file", fs.createReadStream(zippedBuildFilePath));
-    const config = {
-        headers: Object.assign({ Authorization: authInfo ? `X-Auth-Key ${overrideAuthKey || authInfo.authKey.trim()}` : "" }, formData.getHeaders()),
-        responseType: "arraybuffer"
-    };
-    const { data } = await axios_1.default.post(`${env_1.baseURL}/portal`, formData, config);
-    return data;
-};
-// Download Docs 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))) {
-        throw new Error("Build file doesn't exist");
-    }
-    // TODO: ***CRITICAL*** Remove this call once the SDK is patched
-    const data = await downloadPortalAxios(zippedBuildFilePath, overrideAuthKey, configDir);
-    await utils_1.deleteFile(zippedBuildFilePath);
-    await fs.writeFile(zippedPortalPath, data);
-    // TODO: Uncomment this code block when the SDK is patched
-    // const file: FileWrapper = new FileWrapper(fs.createReadStream(zippedBuildFilePath));
-    // const { result }: ApiResponse<NodeJS.ReadableStream | Blob> =
-    //   await docsPortalController.generateOnPremPortalViaBuildInput(file);
-    // if ((data as NodeJS.ReadableStream).readable) {
-    //   await writeFileUsingReadableStream(data as NodeJS.ReadableStream, zippedPortalPath);
-    if (!zip) {
-        await utils_1.unzipFile(fs.createReadStream(zippedPortalPath), portalFolderPath);
-        await utils_1.deleteFile(zippedPortalPath);
-    }
-    cli_ux_1.default.action.stop();
-    return zip ? zippedPortalPath : portalFolderPath;
-    // } else {
-    //   throw new Error("Couldn't download the portal");
-    // }
-};

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

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

@@ -1,64 +0,0 @@
-"use strict";
-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 sdk_1 = require("@apimatic/sdk");
-const core_1 = require("@apimatic/core");
-const generate_1 = require("../../types/sdk/generate");
-const utils_1 = require("../../utils/utils");
-exports.getSDKGenerationId = async ({ file, url, platform }, sdkGenerationController) => {
-    cli_ux_1.default.action.start("Generating SDK");
-    let generation;
-    const sdkPlatform = getSDKPlatform(platform);
-    if (file) {
-        const fileDescriptor = new core_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
-const getSDKPlatform = (platform) => {
-    if (Object.keys(generate_1.SimplePlatforms).includes(platform)) {
-        return generate_1.SimplePlatforms[platform];
-    }
-    else if (Object.values(sdk_1.Platforms).includes(platform)) {
-        return platform;
-    }
-    else {
-        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}`);
-    }
-};
-// Download Platform
-exports.downloadGeneratedSDK = async ({ 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");
-    }
-};

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

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

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

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

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

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

package/oclif.manifest.json

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