@apimatic/cli 1.1.0-alpha.2 → 1.1.0-alpha.20

package/lib/utils/utils.js

@@ -1,34 +1,88 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.printValidationMessages = exports.getFileNameFromPath = exports.isJSONParsable = exports.replaceHTML = exports.stopProgress = exports.startProgress = exports.zipDirectory = exports.writeFileUsingReadableStream = exports.deleteFile = exports.unzipFile = void 0;
-const cli_ux_1 = require("cli-ux");
-const path = require("path");
-const fs = require("fs-extra");
-const archiver = require("archiver");
-const unzipper = require("unzipper");
-const stripTags = require("striptags");
-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");
-        });
+import { __asyncValues } from "tslib";
+import * as path from "path";
+import fs from "fs";
+import fsExtra from "fs-extra";
+import os from "os";
+import archiver from "archiver";
+import stripTags from "striptags";
+import colors from "picocolors";
+export const createTempDirectory = async () => {
+    return fs.mkdtempSync(path.join(os.tmpdir(), "apimatic-cli-"));
+};
+export const clearDirectory = async (folderPath) => {
+    if (!fs.existsSync(folderPath)) {
+        throw new Error(`Directory ${folderPath} does not exist`);
+    }
+    const files = await fsExtra.readdir(folderPath);
+    for (const file of files) {
+        const filePath = path.join(folderPath, file);
+        await deleteFile(filePath);
+    }
+    await deleteFile(folderPath);
+};
+// TODO: Move to portal:quickstart command.
+const descriptions = Object.entries({
+    "APIMATIC-BUILD.json": "# Defines all configurations for the API portal, including programming languages and themes",
+    spec: "# Contains all API definition files",
+    content: "# Includes custom documentation pages in Markdown",
+    "content/toc.yml": "# Controls the structure of the side navigation bar in the API portal",
+    static: "# Includes all static files, such as images, GIFs, and PDFs"
+}).reduce((acc, [key, value]) => {
+    acc[path.normalize(key)] = value;
+    return acc;
+}, {});
+// TODO: Move to portal:quickstart command.
+export const directoryToJson = (dirPath, parentPath = "") => {
+    const directoryStructure = {};
+    const items = fs.readdirSync(dirPath);
+    items.forEach((item) => {
+        if (item === ".git")
+            return; // Skip .git directory
+        const itemPath = path.join(dirPath, item);
+        const relativePath = path.join(parentPath, item);
+        const stats = fs.statSync(itemPath);
+        if (stats.isDirectory()) {
+            const subdirectoryStructure = directoryToJson(itemPath, relativePath);
+            const folderName = descriptions[path.normalize(relativePath)]
+                ? `${item} : ${descriptions[path.normalize(relativePath)]}`
+                : item;
+            directoryStructure[folderName] = subdirectoryStructure;
+        }
+        else {
+            directoryStructure[descriptions[path.normalize(relativePath)] ? `${item} : ${descriptions[path.normalize(relativePath)]}` : item] = null;
+        }
     });
+    return directoryStructure;
 };
-exports.deleteFile = async (filePath) => {
-    return await fs.remove(filePath);
+export const isValidUrl = (input) => {
+    if (!input) {
+        return false;
+    }
+    try {
+        const url = new URL(input);
+        if (!["http:", "https:"].includes(url.protocol)) {
+            return false;
+        }
+        if (url.protocol === "file:" || fs.existsSync(input)) {
+            return false;
+        }
+        if (!url.host) {
+            return false;
+        }
+        return true;
+    }
+    catch (_) {
+        return false;
+    }
 };
-exports.writeFileUsingReadableStream = (stream, destinationPath) => {
-    return new Promise((resolve, reject) => {
+export const deleteFile = async (filePath) => {
+    return await fsExtra.remove(filePath);
+};
+export const writeFileUsingReadableStream = (stream, destinationPath) => {
+    return new Promise((resolve) => {
         const writeStream = fs.createWriteStream(destinationPath);
         stream.pipe(writeStream);
-        writeStream.on("close", (error) => {
-            if (error) {
-                return reject(new Error("Couldn't zip the stream"));
-            }
+        writeStream.on("close", () => {
             resolve("Zipped");
         });
     });
@@ -40,82 +94,84 @@ exports.writeFileUsingReadableStream = (stream, destinationPath) => {
  * @param {destinationZipPath} path to generated zip
  * return {string}
  */
-exports.zipDirectory = async (sourcePath, destinationPath) => {
+export const 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");
+    await fsExtra.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"
+    return new Promise((resolve, reject) => {
+        archive.on("error", (err) => {
+            reject(new Error(err.message));
+        });
+        output.on("error", (err) => {
+            reject(new Error(err.message));
+        });
+        output.on("close", () => {
+            resolve(zipPath);
+        });
+        archive.pipe(output);
+        archive.directory(sourcePath, false);
+        archive.finalize().catch(reject);
     });
-    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) => {
+export const replaceHTML = (string) => {
     return stripTags(string);
 };
-exports.isJSONParsable = (json) => {
-    try {
-        JSON.parse(json);
-        return true;
-    }
-    catch (e) {
-        return false;
-    }
-};
-exports.getFileNameFromPath = (filePath) => {
+export const getFileNameFromPath = (filePath) => {
     return path.basename(filePath).split(".")[0];
 };
-exports.printValidationMessages = ({ warnings, errors, messages }, { log, warn, error }) => {
+export const printValidationMessages = ({ warnings, errors, messages }, { log, warn, error }) => {
     warnings = warnings || [];
     messages = messages || [];
     const singleError = errors.join("\n") || "";
     messages.forEach((message) => {
-        log(`Info: ${exports.replaceHTML(message)}`);
+        log(`Info: ${replaceHTML(message)}`);
     });
     warnings.forEach((warning) => {
-        warn(exports.replaceHTML(warning));
+        warn(replaceHTML(warning));
     });
     if (errors.length > 0) {
-        error(exports.replaceHTML(singleError));
+        error(replaceHTML(singleError));
     }
 };
+export async function parseStreamBodyToJson(body) {
+    var _a, e_1, _b, _c;
+    const chunks = [];
+    try {
+        for (var _d = true, body_1 = __asyncValues(body), body_1_1; body_1_1 = await body_1.next(), _a = body_1_1.done, !_a; _d = true) {
+            _c = body_1_1.value;
+            _d = false;
+            const chunk = _c;
+            chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (!_d && !_a && (_b = body_1.return)) await _b.call(body_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    const text = Buffer.concat(chunks).toString("utf-8");
+    return JSON.parse(text);
+}
+export const getMessageInOrangeColor = (message) => {
+    return colors.yellow(message);
+};
+export const getMessageInBlueColor = (message) => {
+    return colors.blueBright(message);
+};
+export const getMessageInCyanColor = (message) => {
+    return colors.cyan(message);
+};
+export const getMessageInGreenColor = (message) => {
+    return colors.greenBright(message);
+};
+export const getMessageInMagentaColor = (message) => {
+    return colors.magentaBright(message);
+};
+export const getMessageInRedColor = (message) => {
+    return colors.redBright(message);
+};
+//# sourceMappingURL=utils.js.map

package/lib/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,MAAM,MAAM,YAAY,CAAC;AAIhC,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,IAAI,EAAE;IAC5C,OAAO,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,UAAkB,EAAE,EAAE;IACzD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,aAAa,UAAU,iBAAiB,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAEhD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7C,MAAM,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC,CAAC;AAOF,2CAA2C;AAC3C,MAAM,YAAY,GAA8B,MAAM,CAAC,OAAO,CAAC;IAC7D,qBAAqB,EAAE,6FAA6F;IACpH,IAAI,EAAE,qCAAqC;IAC3C,OAAO,EAAE,mDAAmD;IAC5D,iBAAiB,EAAE,uEAAuE;IAC1F,MAAM,EAAE,6DAA6D;CACtE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;IAC9B,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;IACjC,OAAO,GAAG,CAAC;AACb,CAAC,EAAE,EAA+B,CAAC,CAAC;AAEpC,2CAA2C;AAC3C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,UAAU,GAAG,EAAE,EAAiB,EAAE;IACjF,MAAM,kBAAkB,GAAkB,EAAE,CAAC;IAE7C,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACtC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,IAAI,KAAK,MAAM;YAAE,OAAO,CAAC,sBAAsB;QAEnD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEpC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,MAAM,qBAAqB,GAAG,eAAe,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;YAEtE,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;gBAC3D,CAAC,CAAC,GAAG,IAAI,MAAM,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,EAAE;gBAC3D,CAAC,CAAC,IAAI,CAAC;YAET,kBAAkB,CAAC,UAAU,CAAC,GAAG,qBAAqB,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,kBAAkB,CAChB,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAC9G,GAAG,IAAI,CAAC;QACX,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAW,EAAE;IACnD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3B,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,QAAgB,EAAE,EAAE;IACnD,OAAO,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,MAA6B,EAAE,eAAuB,EAAE,EAAE;IACrG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,WAAW,GAAG,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,UAAkB,EAAE,eAAuB,EAAmB,EAAE;IACjG,oDAAoD;IACpD,MAAM,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAEpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAEhC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1B,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,OAAO,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAErB,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAErC,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,EAAE;IAC5C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACtD,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAsB,EAClD,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAW,EAC7B,EAAE;IACF,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAC;IAC1B,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAC;IAC1B,MAAM,WAAW,GAAW,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAEpD,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,GAAG,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;IAClC,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,IAA2B;;IACrE,MAAM,MAAM,GAAa,EAAE,CAAC;;QAC5B,KAA0B,eAAA,SAAA,cAAA,IAAI,CAAA,UAAA,sEAAE,CAAC;YAAP,oBAAI;YAAJ,WAAI;YAAnB,MAAM,KAAK,KAAA,CAAA;YACpB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACnE,CAAC;;;;;;;;;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,OAAe,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,EAAE;IACvD,OAAO,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,EAAE;IACvD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,OAAe,EAAE,EAAE;IACxD,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAAe,EAAE,EAAE;IAC1D,OAAO,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,OAAe,EAAE,EAAE;IACtD,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC"}

package/lib/validators/common/directoryValidator.d.ts

@@ -0,0 +1,5 @@
+import { Result } from "../../types/common/result.js";
+export declare class DirectoryValidator {
+    validateSourceDirectory(sourceDir: string): Result<string, string>;
+    private getDirectoryItems;
+}

package/lib/validators/common/directoryValidator.js

@@ -0,0 +1,22 @@
+import fsExtra from "fs-extra";
+import { readdirSync } from "fs";
+import { Result } from "../../types/common/result.js";
+export class DirectoryValidator {
+    validateSourceDirectory(sourceDir) {
+        if (!fsExtra.pathExistsSync(sourceDir)) {
+            return Result.failure(`The specified source directory does not exist: ${sourceDir}. Please provide a valid source directory to continue.`);
+        }
+        const sourceDirItems = this.getDirectoryItems(sourceDir);
+        if (sourceDirItems.length == 0) {
+            return Result.failure("The source directory is empty. Please ensure that the directory contains a valid build input.");
+        }
+        if (!sourceDirItems.some((item) => item.endsWith("APIMATIC-BUILD.json"))) {
+            return Result.failure("The source directory is missing the 'APIMATIC-BUILD.json' file. Please add a valid build config file to continue.");
+        }
+        return Result.success(`Source directory ${sourceDir} is valid.`);
+    }
+    getDirectoryItems(directoryPath) {
+        return readdirSync(directoryPath).filter((item) => !item.startsWith("."));
+    }
+}
+//# sourceMappingURL=directoryValidator.js.map

package/lib/validators/common/directoryValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directoryValidator.js","sourceRoot":"","sources":["../../../src/validators/common/directoryValidator.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAEtD,MAAM,OAAO,kBAAkB;IACtB,uBAAuB,CAAC,SAAiB;QAC9C,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,OAAO,CACnB,kDAAkD,SAAS,wDAAwD,CACpH,CAAC;QACJ,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,cAAc,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC/B,OAAO,MAAM,CAAC,OAAO,CACnB,+FAA+F,CAChG,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;YACzE,OAAO,MAAM,CAAC,OAAO,CACnB,mHAAmH,CACpH,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,oBAAoB,SAAS,YAAY,CAAC,CAAC;IACnE,CAAC;IAEO,iBAAiB,CAAC,aAAqB;QAC7C,OAAO,WAAW,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/lib/validators/portal/serve-validator.d.ts

@@ -0,0 +1,6 @@
+import { Result } from "../../types/common/result.js";
+export declare class PortalServeValidator {
+    private readonly directoryValidator;
+    constructor();
+    validateSourceDirectory(sourceDirectoryPath: string): Promise<Result<string, string>>;
+}

package/lib/validators/portal/serve-validator.js

@@ -0,0 +1,15 @@
+import { Result } from "../../types/common/result.js";
+import { DirectoryValidator } from "../common/directoryValidator.js";
+export class PortalServeValidator {
+    constructor() {
+        this.directoryValidator = new DirectoryValidator();
+    }
+    async validateSourceDirectory(sourceDirectoryPath) {
+        const sourceDirectoryValidationResult = this.directoryValidator.validateSourceDirectory(sourceDirectoryPath);
+        if (sourceDirectoryValidationResult.isFailed()) {
+            return Result.failure(sourceDirectoryValidationResult.error);
+        }
+        return Result.success("Serve flags validated successfully.");
+    }
+}
+//# sourceMappingURL=serve-validator.js.map

package/lib/validators/portal/serve-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve-validator.js","sourceRoot":"","sources":["../../../src/validators/portal/serve-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,OAAO,oBAAoB;IAG/B;QACE,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,mBAA2B;QAC9D,MAAM,+BAA+B,GAAG,IAAI,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;QAC7G,IAAI,+BAA+B,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC/C,OAAO,MAAM,CAAC,OAAO,CAAC,+BAA+B,CAAC,KAAM,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,MAAM,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;IAC/D,CAAC;CACF"}

package/package.json

@@ -1,26 +1,29 @@
 {
     "name": "@apimatic/cli",
     "description": "The official CLI for APIMatic.",
-    "version": "1.1.0-alpha.2",
+    "version": "1.1.0-alpha.20",
     "author": "APIMatic",
     "bin": {
-        "apimatic": "./bin/run"
+        "apimatic": "./bin/run.js"
+    },
+    "bugs": {
+        "url": "https://github.com/apimatic/apimatic-cli/issues",
+        "email": "support@apimatic.io"
     },
-    "bugs": "https://github.com/apimatic/apimatic-cli/issues",
     "publishConfig": {
         "access": "public"
     },
     "engines": {
-        "node": ">=12.0.0"
+        "node": ">=20.0.0"
     },
     "files": [
-        "/bin",
-        "/lib",
+        "./bin",
+        "./lib",
         "/npm-shrinkwrap.json",
         "/oclif.manifest.json"
     ],
     "repository": "git://github.com/apimatic/apimatic-cli.git",
-    "homepage": "https://github.com/apimatic/apimatic-cli",
+    "homepage": "https://docs.apimatic.io/apimatic-cli/intro-and-install/",
     "keywords": [
         "apimatic",
         "cli",
@@ -30,76 +33,129 @@
         "automation"
     ],
     "license": "MIT",
+    "type": "module",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
     "scripts": {
         "build": "tsc -b",
         "postpack": "rimraf oclif.manifest.json",
-        "posttest": "eslint . --ext .ts --config .eslintrc",
-        "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+        "posttest": "eslint . --ext .ts",
         "prettier": "prettier \"src/**/*.{js,ts}\"",
         "format": "prettier --write \"src/**/*.{js,ts}\"",
         "lint": "eslint \"src/**/*.{js,ts}\"",
-        "lint:fix": "eslint --fix \"src/**/*.{js,ts}\" --quiet"
+        "lint:fix": "eslint --fix \"src/**/*.{js,ts}\" --quiet",
+        "test": "tsx node_modules/mocha/bin/_mocha --forbid-only \"test/**/*.test.ts\" --timeout 99999"
     },
     "dependencies": {
-        "@apimatic/sdk": "^0.0.1-alpha.10",
-        "@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",
+        "@apimatic/sdk": "^0.2.0-alpha.3",
+        "@clack/prompts": "1.0.0-alpha.1",
+        "@oclif/core": "^4.2.8",
+        "@oclif/plugin-autocomplete": "^3.2.24",
+        "@oclif/plugin-help": "^6.2.26",
+        "@oclif/plugin-not-found": "^3.2.44",
+        "archiver": "^7.0.1",
+        "async-mutex": "^0.5.0",
+        "axios": "^1.8.1",
         "base-64": "^1.0.0",
-        "form-data": "^4.0.0",
-        "fs-extra": "^10.0.0",
+        "chokidar": "^3.6.0",
+        "connect-livereload": "^0.6.1",
+        "execa": "^9.6.0",
+        "express": "^4.17.1",
+        "extract-zip": "^2.0.1",
+        "file-type": "^15.0.0",
+        "form-data": "^4.0.2",
+        "fs-extra": "^11.3.0",
+        "get-port": "^7.1.0",
+        "livereload": "^0.9.3",
+        "neverthrow": "^8.2.0",
+        "open": "^8.4.0",
+        "prettier": "^2.8.8",
         "striptags": "^3.2.0",
-        "tslib": "^1.14.1",
-        "unzipper": "^0.10.11"
+        "tmp-promise": "^3.0.3",
+        "treeify": "^1.1.0",
+        "tslib": "^2.8.1",
+        "uuid": "^11.1.0",
+        "yaml": "^2.8.0"
     },
     "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",
+        "@oclif/test": "^4.1.13",
+        "@semantic-release/changelog": "^6.0.3",
         "@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/chai": "^4.3.20",
+        "@types/connect-livereload": "^0.5.32",
+        "@types/express": "^4.17.23",
         "@types/fs-extra": "^9.0.13",
+        "@types/livereload": "^0.9.5",
         "@types/mocha": "^5.2.7",
-        "@types/node": "^10.17.60",
+        "@types/mock-fs": "^4.13.4",
+        "@types/node": "^20.17.50",
+        "@types/prettier": "^2.7.3",
+        "@types/sinon": "^17.0.4",
+        "@types/treeify": "^1.0.3",
         "@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",
+        "@typescript-eslint/eslint-plugin": "^8.0.0",
+        "@typescript-eslint/parser": "^8.0.0",
+        "chai": "^4.5.0",
+        "eslint": "^9.21.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"
+        "mocha": "^11.7.1",
+        "mock-fs": "^5.5.0",
+        "nock": "^14.0.4",
+        "nyc": "^17.1.0",
+        "oclif": "^4.17.34",
+        "rimraf": "^6.0.1",
+        "sinon": "^21.0.0",
+        "tmp-promise": "^3.0.3",
+        "ts-node": "^10.9.2",
+        "tsx": "^4.20.3",
+        "typescript": "^5.2.2"
     },
     "oclif": {
         "commands": "./lib/commands",
+        "dirname": "apimatic",
         "bin": "apimatic",
+        "description": "The official CLI for APIMatic. \nTo get started with APIMatic's CLI using a step by step wizard, run 'apimatic portal:quickstart'.",
         "plugins": [
             "@oclif/plugin-autocomplete",
             "@oclif/plugin-help",
             "@oclif/plugin-not-found"
-        ]
+        ],
+        "topics": {
+            "api": {
+                "description": "Transform & Validate your API specifications."
+            },
+            "auth": {
+                "description": "Login using your APIMatic credentials, or view your authentication status."
+            },
+            "portal": {
+                "description": "Generate, download and serve an API Documentation portal for your APIs."
+            },
+            "sdk": {
+                "description": "Generate SDKs for your APIs in multiple languages."
+            },
+            "portal:toc": {
+                "description": "Generate a Table of Contents (TOC) file for your API documentation portal."
+            }
+        },
+        "state": "Alpha"
     },
     "lint-staged": {
         "*.js": "eslint --cache --fix",
         "*.{js,ts}": "prettier --write"
+    },
+    "overrides": {
+        "inflight": "npm:lru-cache@^7.14.1",
+        "lodash.get": "npm:lodash@^4.17.21",
+        "@humanwhocodes/config-array": "npm:@eslint/config-array@latest",
+        "rimraf": "^6.0.1",
+        "glob": "^10.4.5",
+        "q": "npm:promise@^8.3.0"
     }
 }

package/bin/run

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable no-undef */
-/* eslint-disable @typescript-eslint/no-var-requires */
-
-require("@oclif/command").run().then(require("@oclif/command/flush")).catch(require("@oclif/errors/handle"));

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

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

@@ -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 || overrideAuthKey ? `X-Auth-Key ${(authInfo === null || authInfo === void 0 ? void 0 : authInfo.authKey.trim()) || overrideAuthKey}` : "" }, 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>;