@docsalot/previewing 0.1.0-beta.3 → 0.1.0-beta.5

package/dist/constants.d.ts

@@ -1,5 +1,6 @@
 export declare const TARGET_CLIENT_VERSION = "v0.0.9";
 export declare const INSTALL_PATH: string;
+export declare const BUNDLED_CLIENT_TARBALL_PATH: string;
 export declare const HOME_DIR: string;
 export declare const DOT_DOCSALOT: string;
 export declare const VERSION_PATH: string;

package/dist/constants.js

@@ -7,6 +7,7 @@ import os from "os";
 export const TARGET_CLIENT_VERSION = "v0.0.9";
 // package installation location
 export const INSTALL_PATH = url.fileURLToPath(new URL(".", import.meta.url));
+export const BUNDLED_CLIENT_TARBALL_PATH = path.join(INSTALL_PATH, "assets", "client.tar.gz");
 export const HOME_DIR = os.homedir();
 // DOCSALOT_PATH can be overridden via environment variable.
 // Priority: DOCSALOT_PATH env var > ~/.docsalot

package/dist/local-preview/helper-commands/installDepsCommand.js

@@ -1,56 +1,53 @@
 import shell from "shelljs";
 import fse, { pathExists } from "fs-extra";
 import path from "path";
-import { Octokit } from "@octokit/rest";
-import { isInternetAvailable } from "is-internet-available";
-import { CLIENT_PATH, MINT_PATH, TARGET_CLIENT_VERSION, VERSION_PATH, } from "../../constants.js";
+import { BUNDLED_CLIENT_TARBALL_PATH, CLIENT_PATH, MINT_PATH, TARGET_CLIENT_VERSION, VERSION_PATH, } from "../../constants.js";
 import { buildLogger, ensureYarn } from "../../util.js";
-const downloadTargetClient = async (logger) => {
-    fse.emptyDirSync(MINT_PATH);
-    logger.text = "Downloading DocsALot framework...";
-    const octokit = new Octokit();
-    const downloadRes = await octokit.repos.downloadTarballArchive({
-        owner: "slashml",
-        repo: "docsalot",
-        ref: TARGET_CLIENT_VERSION,
-    });
-    logger.text = "Extracting DocsALot framework...";
-    const tarPath = path.join(MINT_PATH, "mint.tar.gz");
-    const tmpPath = path.join(MINT_PATH, "mint-tmp");
-    fse.writeFileSync(tarPath, Buffer.from(downloadRes.data));
-    fse.mkdirSync(tmpPath, { recursive: true });
-    const untarResult = shell.exec(`tar -xzf "${tarPath}" -C "${tmpPath}" --strip-components 1`, {
-        silent: true,
-    });
+const bootstrapBundledClient = async (logger) => {
+    if (!(await pathExists(BUNDLED_CLIENT_TARBALL_PATH))) {
+        logger.fail(`Bundled client tarball is missing at: ${BUNDLED_CLIENT_TARBALL_PATH}`);
+        process.exit(1);
+    }
+    await fse.ensureDir(CLIENT_PATH);
+    logger.text = "Extracting bundled DocsALot client...";
+    const untarResult = shell.exec(`tar -xzf "${BUNDLED_CLIENT_TARBALL_PATH}" -C "${CLIENT_PATH}" --strip-components 1`, { silent: true });
     if (untarResult.code !== 0) {
-        logger.fail("Failed to extract DocsALot framework.");
+        logger.fail("Failed to extract bundled DocsALot client.");
         process.exit(1);
     }
-    fse.removeSync(tarPath);
-    fse.moveSync(path.join(tmpPath, "client"), CLIENT_PATH);
     fse.writeFileSync(VERSION_PATH, TARGET_CLIENT_VERSION);
-    fse.removeSync(tmpPath);
+};
+const shouldBootstrapClient = async () => {
+    const clientExists = await pathExists(CLIENT_PATH);
+    if (!clientExists)
+        return true;
+    if (!(await pathExists(VERSION_PATH)))
+        return true;
+    const installedVersion = fse.readFileSync(VERSION_PATH, "utf8").trim();
+    return installedVersion !== TARGET_CLIENT_VERSION;
 };
 const installDeps = async () => {
     const logger = buildLogger("Preparing local DocsALot client...");
     ensureYarn(logger);
     await fse.ensureDir(MINT_PATH);
-    const clientExists = await pathExists(CLIENT_PATH);
-    if (!clientExists) {
-        const internet = await isInternetAvailable();
-        if (!internet) {
-            logger.fail("First-time setup requires internet to download the local DocsALot framework.");
+    const needsBootstrap = await shouldBootstrapClient();
+    if (needsBootstrap) {
+        await fse.remove(CLIENT_PATH);
+        await bootstrapBundledClient(logger);
+    }
+    const nodeModulesPath = path.join(CLIENT_PATH, "node_modules");
+    const dependenciesInstalled = await pathExists(nodeModulesPath);
+    if (!dependenciesInstalled || needsBootstrap) {
+        logger.text = "Installing local DocsALot dependencies...";
+        shell.cd(CLIENT_PATH);
+        const installResult = shell.exec("yarn");
+        if (installResult.code !== 0) {
+            logger.fail("Failed to install dependencies.");
             process.exit(1);
         }
-        await downloadTargetClient(logger);
-    }
-    logger.text = "Installing local DocsALot dependencies...";
-    shell.cd(CLIENT_PATH);
-    const installResult = shell.exec("yarn");
-    if (installResult.code !== 0) {
-        logger.fail("Failed to install dependencies.");
-        process.exit(1);
+        logger.succeed("Dependencies installed.");
+        return;
     }
-    logger.succeed("Dependencies installed.");
+    logger.succeed("Dependencies already installed.");
 };
 export default installDeps;

package/dist/local-preview/index.js

@@ -7,11 +7,11 @@ import inquirer from "inquirer";
 import { isInternetAvailable } from "is-internet-available";
 import path from "path";
 import shell from "shelljs";
-import { Octokit } from "@octokit/rest";
-import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, TARGET_CLIENT_VERSION, VERSION_PATH, MINT_PATH, } from "../constants.js";
-import { buildLogger, ensureYarn } from "../util.js";
+import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, MINT_PATH, } from "../constants.js";
+import { buildLogger } from "../util.js";
 import listener from "./listener/index.js";
 import { getConfigPath } from "./listener/utils/mintConfigFile.js";
+import installDepsCommand from "./helper-commands/installDepsCommand.js";
 const nodeModulesExists = async () => {
     return pathExists(path.join(DOT_DOCSALOT, "client", "node_modules"));
 };
@@ -37,34 +37,6 @@ const promptForYarn = async () => {
         });
     }
 };
-const downloadTargetClient = async (logger) => {
-    fse.emptyDirSync(MINT_PATH);
-    logger.text = "Downloading DocsALot framework...";
-    const octokit = new Octokit();
-    const downloadRes = await octokit.repos.downloadTarballArchive({
-        owner: "slashml",
-        repo: "docsalot",
-        ref: TARGET_CLIENT_VERSION,
-    });
-    logger.text = "Extracting DocsALot framework...";
-    const TAR_PATH = path.join(MINT_PATH, "mint.tar.gz");
-    fse.writeFileSync(TAR_PATH, Buffer.from(downloadRes.data));
-    // strip-components 1 removes the top level directory from the unzipped content
-    // which is a folder with the release sha
-    fse.mkdirSync(path.join(MINT_PATH, "mint-tmp"));
-    shell.exec("tar -xzf mint.tar.gz -C mint-tmp --strip-components 1", {
-        silent: true,
-    });
-    fse.removeSync(TAR_PATH);
-    fse.moveSync(path.join(MINT_PATH, "mint-tmp", "client"), path.join(CLIENT_PATH));
-    fse.writeFileSync(VERSION_PATH, TARGET_CLIENT_VERSION);
-    // Delete unnecessary content downloaded from GitHub
-    fse.removeSync(path.join(MINT_PATH, "mint-tmp"));
-    logger.text = "Installing dependencies...";
-    ensureYarn(logger);
-    shell.cd(CLIENT_PATH);
-    shell.exec("yarn", { silent: true });
-};
 const checkForLayoutJson = async (logger) => {
     const configPath = await getConfigPath(CMD_EXEC_PATH);
     if (configPath == null) {
@@ -81,23 +53,6 @@ const dev = async (argv) => {
     await fse.ensureDir(MINT_PATH);
     shell.cd(MINT_PATH);
     const internet = await isInternetAvailable();
-    if (!internet && !(await pathExists(CLIENT_PATH))) {
-        logger.fail("Running docsalot dev for the first time requires an internet connection.");
-        process.exit(1);
-    }
-    // if (internet) {
-    //   const mintVersionExists = await pathExists(VERSION_PATH);
-    //   let needToDownloadTargetClient = !mintVersionExists;
-    //   if (mintVersionExists) {
-    //     const currVersion = fse.readFileSync(VERSION_PATH, "utf8");
-    //     if (currVersion !== TARGET_CLIENT_VERSION) {
-    //       needToDownloadTargetClient = true;
-    //     }
-    //   }
-    //   if (needToDownloadTargetClient) {
-    //     await downloadTargetClient(logger);
-    //   }
-    // }
     if (!(await nodeModulesExists())) {
         if (!internet) {
             logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
@@ -105,15 +60,10 @@ const dev = async (argv) => {
       docsalot install
       
       `);
+            process.exit(1);
         }
-        else {
-            logger.fail(`Dependencies were not installed correctly, run
-  
-      docsalot install
-      
-      `);
-        }
-        process.exit(1);
+        logger.info("Dependencies missing; running first-time bootstrap...");
+        await installDepsCommand();
     }
     await checkForLayoutJson(logger);
     shell.cd(CLIENT_PATH);

package/dist/local-preview/prod.js

@@ -10,6 +10,7 @@ import shell from "shelljs";
 import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, MINT_PATH, } from "../constants.js";
 import { buildLogger } from "../util.js";
 import { getConfigPath } from "./listener/utils/mintConfigFile.js";
+import installDepsCommand from "./helper-commands/installDepsCommand.js";
 const nodeModulesExists = async () => {
     return pathExists(path.join(DOT_DOCSALOT, "client", "node_modules"));
 };
@@ -50,10 +51,6 @@ const prod = async (argv) => {
     await fse.ensureDir(MINT_PATH);
     shell.cd(MINT_PATH);
     const internet = await isInternetAvailable();
-    if (!internet && !(await pathExists(CLIENT_PATH))) {
-        logger.fail("Running docsalot prod for the first time requires an internet connection.");
-        process.exit(1);
-    }
     if (!(await nodeModulesExists())) {
         if (!internet) {
             logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
@@ -61,15 +58,10 @@ const prod = async (argv) => {
       docsalot install
 
       `);
+            process.exit(1);
         }
-        else {
-            logger.fail(`Dependencies were not installed correctly, run
-
-      docsalot install
-
-      `);
-        }
-        process.exit(1);
+        logger.info("Dependencies missing; running first-time bootstrap...");
+        await installDepsCommand();
     }
     await checkForLayoutJson(logger);
     shell.cd(CLIENT_PATH);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsalot/previewing",
-  "version": "0.1.0-beta.3",
+  "version": "0.1.0-beta.5",
   "description": "Preview DocsALot docs locally",
   "engines": {
     "node": ">=18.0.0"
@@ -29,8 +29,8 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@docsalot/prebuild": "^0.1.0-beta.3",
-    "@docsalot/validation": "^0.1.0-beta.3",
+    "@docsalot/prebuild": "^0.1.0-beta.5",
+    "@docsalot/validation": "^0.1.0-beta.5",
     "@octokit/rest": "^19.0.5",
     "axios": "^1.2.2",
     "chalk": "^5.1.0",