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

package/dist/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const TARGET_CLIENT_VERSION = "v0.0.9";
+export declare const TARGET_CLIENT_VERSION = "v0.1.0-runtime.1";
 export declare const INSTALL_PATH: string;
 export declare const BUNDLED_CLIENT_TARBALL_PATH: string;
 export declare const HOME_DIR: string;

package/dist/constants.js

@@ -4,7 +4,7 @@ import path from "path";
 import * as url from "url";
 import os from "os";
 // Change this to bump to a newer version of the bundled client.
-export const TARGET_CLIENT_VERSION = "v0.0.9";
+export const TARGET_CLIENT_VERSION = "v0.1.0-runtime.1";
 // 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");

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

@@ -1,8 +1,7 @@
 import shell from "shelljs";
 import fse, { pathExists } from "fs-extra";
-import path from "path";
 import { BUNDLED_CLIENT_TARBALL_PATH, CLIENT_PATH, MINT_PATH, TARGET_CLIENT_VERSION, VERSION_PATH, } from "../../constants.js";
-import { buildLogger, ensureYarn } from "../../util.js";
+import { buildLogger } from "../../util.js";
 const bootstrapBundledClient = async (logger) => {
     if (!(await pathExists(BUNDLED_CLIENT_TARBALL_PATH))) {
         logger.fail(`Bundled client tarball is missing at: ${BUNDLED_CLIENT_TARBALL_PATH}`);
@@ -27,27 +26,15 @@ const shouldBootstrapClient = async () => {
     return installedVersion !== TARGET_CLIENT_VERSION;
 };
 const installDeps = async () => {
-    const logger = buildLogger("Preparing local DocsALot client...");
-    ensureYarn(logger);
+    const logger = buildLogger("Preparing local DocsALot runtime...");
     await fse.ensureDir(MINT_PATH);
     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);
-        }
-        logger.succeed("Dependencies installed.");
+        logger.succeed("DocsALot runtime installed.");
         return;
     }
-    logger.succeed("Dependencies already installed.");
+    logger.succeed("DocsALot runtime already installed.");
 };
 export default installDeps;

package/dist/local-preview/helper-commands/syncLocalContentCommand.d.ts

@@ -0,0 +1,2 @@
+declare const syncLocalContentCommand: () => Promise<void>;
+export default syncLocalContentCommand;

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

@@ -0,0 +1,75 @@
+import Chalk from "chalk";
+import mintValidation from "@docsalot/validation";
+import fse from "fs-extra";
+import path from "path";
+import { promises as _promises } from "fs";
+import { CLIENT_PATH, CMD_EXEC_PATH } from "../../constants.js";
+import { categorizeFiles } from "../listener/categorize.js";
+import { generateNav } from "../listener/generate.js";
+import { isFileSizeValid } from "../listener/utils.js";
+import createPage from "../listener/utils/createPage.js";
+import { getConfigPath } from "../listener/utils/mintConfigFile.js";
+const { readFile } = _promises;
+const PROPS_PATH = path.join(CLIENT_PATH, "src", "_props");
+const PUBLIC_PATH = path.join(CLIENT_PATH, "public");
+const writePages = async (contentFilenames, openApiFiles) => {
+    const writes = contentFilenames.map(async (filename) => {
+        const sourcePath = path.join(CMD_EXEC_PATH, filename);
+        const targetPath = path.join(PROPS_PATH, filename);
+        const contentStr = (await readFile(sourcePath)).toString();
+        const { pageContent } = await createPage(filename, contentStr, CMD_EXEC_PATH, openApiFiles);
+        await fse.outputFile(targetPath, pageContent, { flag: "w" });
+    });
+    await Promise.all(writes);
+};
+const writeSnippets = async (snippets) => {
+    const writes = snippets.map(async (filename) => {
+        const sourcePath = path.join(CMD_EXEC_PATH, filename);
+        const targetPath = path.join(PROPS_PATH, filename);
+        await fse.copy(sourcePath, targetPath);
+    });
+    await Promise.all(writes);
+};
+const writeStaticFiles = async (staticFilenames) => {
+    for (const filename of staticFilenames) {
+        const sourcePath = path.join(CMD_EXEC_PATH, filename);
+        if (!(await isFileSizeValid(sourcePath, 5))) {
+            console.error(Chalk.red(`🚨 The file at ${filename} is too big. The maximum file size is 5 mb.`));
+            continue;
+        }
+        const targetPath = path.join(PUBLIC_PATH, filename);
+        await fse.copy(sourcePath, targetPath);
+    }
+};
+const copyAndValidateLayout = async () => {
+    const configPath = await getConfigPath(CMD_EXEC_PATH);
+    if (configPath == null) {
+        throw new Error("Could not find layout.json in the docs directory.");
+    }
+    const rawConfig = (await readFile(configPath)).toString();
+    const config = JSON.parse(rawConfig);
+    const { status, errors, warnings } = mintValidation.validateMintConfig(config);
+    errors.forEach((error) => {
+        console.error(`🚨 ${Chalk.red(error)}`);
+    });
+    warnings.forEach((warning) => {
+        console.warn(`⚠️ ${Chalk.yellow(warning)}`);
+    });
+    if (status !== "success") {
+        throw new Error("layout.json is invalid. Fix validation errors and try again.");
+    }
+    await fse.copy(configPath, path.join(PROPS_PATH, "layout.json"));
+};
+const syncLocalContentCommand = async () => {
+    await fse.ensureDir(PROPS_PATH);
+    await fse.ensureDir(PUBLIC_PATH);
+    const { contentFilenames, staticFilenames, openApiFiles, snippets } = await categorizeFiles(CMD_EXEC_PATH);
+    await copyAndValidateLayout();
+    await writePages(contentFilenames, openApiFiles);
+    await writeSnippets(snippets);
+    await writeStaticFiles(staticFilenames);
+    await fse.outputFile(path.join(PROPS_PATH, "openApiFiles.json"), JSON.stringify(openApiFiles, null, 2), { flag: "w" });
+    const generatedNav = await generateNav();
+    await fse.outputFile(path.join(PROPS_PATH, "generatedNav.json"), JSON.stringify(generatedNav, null, 2), { flag: "w" });
+};
+export default syncLocalContentCommand;

package/dist/local-preview/index.js

@@ -2,43 +2,16 @@
 import Chalk from "chalk";
 import child_process from "child_process";
 import open from "open";
-import fse, { pathExists } from "fs-extra";
-import inquirer from "inquirer";
-import { isInternetAvailable } from "is-internet-available";
-import path from "path";
+import fse from "fs-extra";
 import shell from "shelljs";
-import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, MINT_PATH, } from "../constants.js";
+import { HOME_DIR, CLIENT_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"));
-};
-const promptForYarn = async () => {
-    const yarnInstalled = shell.which("yarn");
-    if (!yarnInstalled) {
-        await inquirer
-            .prompt([
-            {
-                type: "confirm",
-                name: "confirm",
-                message: "yarn must be globally installed. Install yarn?",
-                default: true,
-            },
-        ])
-            .then(({ confirm }) => {
-            if (confirm) {
-                shell.exec("npm install --global yarn");
-            }
-            else {
-                console.log("Installation cancelled.");
-            }
-        });
-    }
-};
+import syncLocalContentCommand from "./helper-commands/syncLocalContentCommand.js";
 const checkForLayoutJson = async (logger) => {
-    const configPath = await getConfigPath(CMD_EXEC_PATH);
+    const configPath = await getConfigPath(process.cwd());
     if (configPath == null) {
         logger.fail("Must be ran in a directory where a layout.json file exists.");
         process.exit(1);
@@ -46,43 +19,26 @@ const checkForLayoutJson = async (logger) => {
     return;
 };
 const dev = async (argv) => {
-    buildLogger("DEVS");
     shell.cd(HOME_DIR);
-    await promptForYarn();
     const logger = buildLogger("Preparing local Docsalot instance...");
     await fse.ensureDir(MINT_PATH);
-    shell.cd(MINT_PATH);
-    const internet = await isInternetAvailable();
-    if (!(await nodeModulesExists())) {
-        if (!internet) {
-            logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
-  
-      docsalot install
-      
-      `);
-            process.exit(1);
-        }
-        logger.info("Dependencies missing; running first-time bootstrap...");
-        await installDepsCommand();
-    }
+    await installDepsCommand();
     await checkForLayoutJson(logger);
-    shell.cd(CLIENT_PATH);
-    const relativePath = path.relative(CLIENT_PATH, CMD_EXEC_PATH);
-    child_process.spawnSync("yarn preconfigure", [relativePath], { shell: true });
+    logger.text = "Syncing docs content into local runtime...";
+    await syncLocalContentCommand();
     logger.succeed("Local instance is ready. Launching your site...");
     run(argv.port || "3000");
 };
 const run = (port) => {
     shell.cd(CLIENT_PATH);
-    console.log("CLIENT PATH", CLIENT_PATH);
-    // For Cloud Run/Docker, use dev-host (binds to 0.0.0.0, no file watching)
-    // For local development, use dev-watch (binds to localhost, with file watching)
-    const isProduction = process.env.BIND_ALL_INTERFACES === "true";
-    const devScript = isProduction ? "npm run dev-host" : "npm run dev-watch";
-    const docsalotDevProcess = child_process.spawn(devScript, {
+    const host = process.env.BIND_ALL_INTERFACES === "true" ? "0.0.0.0" : "127.0.0.1";
+    let browserOpened = false;
+    const docsalotDevProcess = child_process.spawn("node server.js", {
         env: {
             ...process.env,
             PORT: port,
+            HOSTNAME: host,
+            NODE_ENV: "production",
         },
         cwd: CLIENT_PATH,
         stdio: "pipe",
@@ -91,7 +47,11 @@ const run = (port) => {
     docsalotDevProcess.stdout.on("data", (data) => {
         const output = data.toString();
         console.log(output);
-        if (output.startsWith("> Ready on http://localhost:")) {
+        if (!browserOpened &&
+            (output.includes("Ready in") ||
+                output.includes("started server") ||
+                output.includes("http://localhost:"))) {
+            browserOpened = true;
             console.log(`🌿 ${Chalk.green(`Your local preview is available at http://localhost:${port}`)}`);
             console.log(`🌿 ${Chalk.green("Press Ctrl+C any time to stop the local preview.")}`);
             open(`http://localhost:${port}`);

package/dist/local-preview/prod.js

@@ -2,42 +2,15 @@
 import Chalk from "chalk";
 import child_process from "child_process";
 import open from "open";
-import fse, { pathExists } from "fs-extra";
-import inquirer from "inquirer";
-import { isInternetAvailable } from "is-internet-available";
-import path from "path";
+import fse from "fs-extra";
 import shell from "shelljs";
-import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, MINT_PATH, } from "../constants.js";
+import { HOME_DIR, CLIENT_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"));
-};
-const promptForYarn = async () => {
-    const yarnInstalled = shell.which("yarn");
-    if (!yarnInstalled) {
-        await inquirer
-            .prompt([
-            {
-                type: "confirm",
-                name: "confirm",
-                message: "yarn must be globally installed. Install yarn?",
-                default: true,
-            },
-        ])
-            .then(({ confirm }) => {
-            if (confirm) {
-                shell.exec("npm install --global yarn");
-            }
-            else {
-                console.log("Installation cancelled.");
-            }
-        });
-    }
-};
+import syncLocalContentCommand from "./helper-commands/syncLocalContentCommand.js";
 const checkForLayoutJson = async (logger) => {
-    const configPath = await getConfigPath(CMD_EXEC_PATH);
+    const configPath = await getConfigPath(process.cwd());
     if (configPath == null) {
         logger.fail("Must be ran in a directory where a layout.json file exists.");
         process.exit(1);
@@ -46,51 +19,23 @@ const checkForLayoutJson = async (logger) => {
 };
 const prod = async (argv) => {
     shell.cd(HOME_DIR);
-    await promptForYarn();
     const logger = buildLogger("Preparing production DocsALot instance...");
     await fse.ensureDir(MINT_PATH);
-    shell.cd(MINT_PATH);
-    const internet = await isInternetAvailable();
-    if (!(await nodeModulesExists())) {
-        if (!internet) {
-            logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
-
-      docsalot install
-
-      `);
-            process.exit(1);
-        }
-        logger.info("Dependencies missing; running first-time bootstrap...");
-        await installDepsCommand();
-    }
+    await installDepsCommand();
     await checkForLayoutJson(logger);
-    shell.cd(CLIENT_PATH);
-    const relativePath = path.relative(CLIENT_PATH, CMD_EXEC_PATH);
-    child_process.spawnSync("yarn preconfigure", [relativePath], { shell: true });
+    logger.text = "Syncing docs content into local runtime...";
+    await syncLocalContentCommand();
     logger.succeed("Production instance is ready. Launching your site...");
     run(argv.port || "3000");
 };
 const run = (port) => {
     shell.cd(CLIENT_PATH);
-    console.log("CLIENT PATH", CLIENT_PATH);
-    // Build the production bundle
-    console.log(`🔨 ${Chalk.cyan("Building production bundle...")}`);
-    const buildResult = child_process.spawnSync("npm run build", {
-        cwd: CLIENT_PATH,
-        stdio: "inherit",
-        shell: true,
-    });
-    if (buildResult.status !== 0) {
-        console.error(`${Chalk.red("Build failed. Please fix the errors and try again.")}`);
-        process.exit(1);
-    }
-    console.log(`✅ ${Chalk.green("Build complete! Starting production server...")}`);
-    console.log("");
-    // Start the production server (no file watching)
-    const docsalotProdProcess = child_process.spawn("npm run start", {
+    const host = process.env.BIND_ALL_INTERFACES === "true" ? "0.0.0.0" : "127.0.0.1";
+    const docsalotProdProcess = child_process.spawn("node server.js", {
         env: {
             ...process.env,
             PORT: port,
+            HOSTNAME: host,
             NODE_ENV: "production",
         },
         cwd: CLIENT_PATH,
@@ -101,8 +46,11 @@ const run = (port) => {
     docsalotProdProcess.stdout.on("data", (data) => {
         const output = data.toString();
         console.log(output);
-        // Next.js production server outputs "ready" or "started server"
-        if (!serverStarted && (output.includes("started server") || output.includes("ready"))) {
+        if (!serverStarted &&
+            (output.includes("started server") ||
+                output.includes("ready") ||
+                output.includes("Ready in") ||
+                output.includes("http://localhost:"))) {
             serverStarted = true;
             console.log(`🌿 ${Chalk.green(`Your production preview is available at http://localhost:${port}`)}`);
             console.log(`🌿 ${Chalk.green("Press Ctrl+C any time to stop the production preview.")}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsalot/previewing",
-  "version": "0.1.0-beta.5",
+  "version": "0.1.0-beta.7",
   "description": "Preview DocsALot docs locally",
   "engines": {
     "node": ">=18.0.0"
@@ -23,14 +23,15 @@
     "dist"
   ],
   "scripts": {
+    "prepare": "npm run build",
     "build": "tsc",
     "watch": "tsc --watch",
     "lint": "eslint . --cache"
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@docsalot/prebuild": "^0.1.0-beta.5",
-    "@docsalot/validation": "^0.1.0-beta.5",
+    "@docsalot/prebuild": "^0.1.0-beta.7",
+    "@docsalot/validation": "^0.1.0-beta.7",
     "@octokit/rest": "^19.0.5",
     "axios": "^1.2.2",
     "chalk": "^5.1.0",