@apimatic/cli 1.0.1-alpha.1 → 1.0.1-alpha.10

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

@@ -1,23 +1,13 @@
-import { DocsPortalManagementController } from "@apimatic/apimatic-sdk-for-js";
 import { Command, flags } from "@oclif/command";
-declare type GeneratePortalParams = {
-    zippedBuildFilePath: string;
-    generatedPortalFolderPath: string;
-    docsPortalController: DocsPortalManagementController;
-    overrideAuthKey: string | null;
-    zip: boolean;
-};
 export default class PortalGenerate extends Command {
     static description: string;
     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>;
     };
     static examples: string[];
-    downloadPortalAxios: (zippedBuildFilePath: string, overrideAuthKey: string | null) => Promise<any>;
-    downloadDocsPortal: ({ zippedBuildFilePath, generatedPortalFolderPath, overrideAuthKey, zip }: GeneratePortalParams) => Promise<string>;
     run(): Promise<undefined>;
 }
-export {};

package/lib/commands/portal/generate.js

@@ -1,67 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs-extra");
-const FormData = require("form-data");
 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_1 = require("@apimatic/sdk");
 const sdk_client_1 = require("../../client-utils/sdk-client");
-const env_1 = require("../../config/env");
+const generate_1 = require("../../controllers/portal/generate");
 const utils_1 = require("../../utils/utils");
-const auth_manager_1 = require("../../client-utils/auth-manager");
-const axios_1 = require("axios");
 class PortalGenerate extends command_1.Command {
-    constructor() {
-        super(...arguments);
-        // TODO: Remove after SDK is patched
-        this.downloadPortalAxios = async (zippedBuildFilePath, overrideAuthKey) => {
-            const formData = new FormData();
-            const authInfo = await auth_manager_1.getAuthInfo(this.config.configDir);
-            formData.append("file", fs.createReadStream(zippedBuildFilePath));
-            const config = {
-                headers: Object.assign({ Authorization: authInfo ? `X-Auth-Key ${overrideAuthKey || authInfo.authKey.trim()}` : "", "Content-Type": "multipart/form-data" }, formData.getHeaders()),
-                responseType: "arraybuffer"
-            };
-            const { data } = await axios_1.default.post(`${env_1.baseURL}/portal`, formData, config);
-            return data;
-        };
-        // Download Docs Portal
-        this.downloadDocsPortal = async ({ zippedBuildFilePath, generatedPortalFolderPath, overrideAuthKey, zip }) => {
-            const zippedPortalPath = path.join(generatedPortalFolderPath, "generated_portal.zip");
-            const portalPath = path.join(generatedPortalFolderPath, "generated_portal");
-            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 this.downloadPortalAxios(zippedBuildFilePath, overrideAuthKey);
-            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), portalPath);
-                await utils_1.deleteFile(zippedPortalPath);
-            }
-            cli_ux_1.default.action.stop();
-            return portalPath;
-            // } else {
-            //   throw new Error("Couldn't download the portal");
-            // }
-        };
-    }
     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`);
@@ -70,20 +30,20 @@ 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 apimatic_sdk_for_js_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
             };
-            const generatedPortalPath = await this.downloadDocsPortal(generatePortalParams);
-            this.log(`Your portal has been generated at ${generatedPortalPath}${flags.zip ? ".zip" : ""}`);
+            const generatedPortalPath = await generate_1.downloadDocsPortal(generatePortalParams, this.config.configDir);
+            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;
@@ -98,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) {
@@ -116,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

@@ -2,79 +2,25 @@
 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 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");
-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");
-    }
-}
+const generate_1 = require("../../controllers/sdk/generate");
 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`);
@@ -82,20 +28,11 @@ 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 apimatic_sdk_for_js_1.CodeGenerationExternalApisController(client);
+            const sdkGenerationController = new sdk_1.CodeGenerationExternalApisController(client);
             // Get generation id for the specification and platform
-            const codeGenId = await getSDKGenerationId(flags, sdkGenerationController);
+            const codeGenId = await generate_1.getSDKGenerationId(flags, sdkGenerationController);
             // If user wanted to download the SDK as well
             const sdkDownloadParams = {
                 codeGenId,
@@ -103,11 +40,10 @@ class SdkGenerate extends command_1.Command {
                 sdkFolderPath,
                 zip
             };
-            const sdkPath = await downloadGeneratedSDK(sdkDownloadParams, sdkGenerationController);
+            const sdkPath = await generate_1.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;
@@ -157,22 +93,37 @@ 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

@@ -0,0 +1,7 @@
+import Command from "@oclif/command";
+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>;
+export declare const getValidFormat: (format: string) => ExportFormats;
+export declare const printValidationMessages: (apiValidationSummary: ApiValidationSummary | undefined, warn: Command["warn"], error: Command["error"]) => void;

package/lib/controllers/api/transform.js

@@ -0,0 +1,59 @@
+"use strict";
+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 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 sdk_1.FileWrapper(fs.createReadStream(file));
+        generation = await transformationController.transformViaFile(fileDescriptor, format);
+    }
+    else if (url) {
+        const body = {
+            url: url,
+            exportFormat: format
+        };
+        generation = await transformationController.transformViaURL(body);
+    }
+    else {
+        throw new Error("Please provide a specification file");
+    }
+    cli_ux_1.default.action.stop();
+    return generation.result;
+};
+exports.downloadTransformationFile = async ({ id, destinationFilePath, transformationController }) => {
+    cli_ux_1.default.action.start("Downloading Transformed file");
+    const { result } = await transformationController.downloadTransformedFile(id);
+    if (result.readable) {
+        await utils_1.writeFileUsingReadableStream(result, destinationFilePath);
+    }
+    else {
+        throw new Error("Couldn't save transformation file");
+    }
+    cli_ux_1.default.action.stop();
+    return destinationFilePath;
+};
+// Get valid platform from user's input, convert simple platform to valid Platforms enum value
+exports.getValidFormat = (format) => {
+    if (Object.keys(sdk_1.ExportFormats).find((exportFormat) => exportFormat === format)) {
+        return sdk_1.ExportFormats[format];
+    }
+    else {
+        const formats = Object.keys(sdk_1.ExportFormats).join("|");
+        throw new Error(`Please provide a valid platform i.e. ${formats}`);
+    }
+};
+exports.printValidationMessages = (apiValidationSummary, warn, error) => {
+    const warnings = (apiValidationSummary === null || apiValidationSummary === void 0 ? void 0 : apiValidationSummary.warnings) || [];
+    const errors = (apiValidationSummary === null || apiValidationSummary === void 0 ? void 0 : apiValidationSummary.errors.join("\n")) || "";
+    warnings.forEach((warning) => {
+        warn(utils_1.replaceHTML(warning));
+    });
+    if (apiValidationSummary && apiValidationSummary.errors.length > 0) {
+        error(utils_1.replaceHTML(errors));
+    }
+};

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

@@ -0,0 +1,5 @@
+import Command from "@oclif/command";
+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/api/validate.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printValidationMessages = exports.getValidation = void 0;
+const cli_ux_1 = require("cli-ux");
+const fs = require("fs-extra");
+const core_1 = require("@apimatic/core");
+const utils_1 = require("../../utils/utils");
+exports.getValidation = async ({ file, url }, apiValidationController) => {
+    let validation;
+    cli_ux_1.default.action.start("Validating specification file");
+    if (file) {
+        const fileDescriptor = new core_1.FileWrapper(fs.createReadStream(file));
+        validation = await apiValidationController.validateAPIViaFile(fileDescriptor);
+    }
+    else if (url) {
+        validation = await apiValidationController.validateAPIViaURL(url);
+    }
+    else {
+        throw new Error("Please provide a specification file");
+    }
+    cli_ux_1.default.action.stop();
+    return validation.result;
+};
+exports.printValidationMessages = ({ warnings, errors }, warn, error) => {
+    warnings.forEach((warning) => {
+        warn(`${utils_1.replaceHTML(warning)}`);
+    });
+    if (errors.length > 0) {
+        const singleLineError = errors.join("\n");
+        error(utils_1.replaceHTML(singleLineError));
+    }
+};

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

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

package/lib/controllers/portal/generate.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadDocsPortal = void 0;
+const fs = require("fs-extra");
+const FormData = require("form-data");
+const cli_ux_1 = require("cli-ux");
+const auth_manager_1 = require("../../client-utils/auth-manager");
+const env_1 = require("../../config/env");
+const utils_1 = require("../../utils/utils");
+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()}` : "", "Content-Type": "multipart/form-data" }, 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

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

@@ -0,0 +1,64 @@
+"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/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;
+};