@repdf/preview 0.4.0 → 0.5.0

package/dist/index.mjs

@@ -0,0 +1,381 @@
+#!/usr/bin/env node
+import { program } from "commander";
+import fs from "node:fs";
+import pino from "pino";
+import { parse } from "node:url";
+import path from "path";
+import { fileURLToPath } from "url";
+import next from "next";
+import http from "node:http";
+import { Server } from "socket.io";
+import * as chokidar from "chokidar";
+import path$1 from "node:path";
+import dependencyTree from "dependency-tree";
+import { glob } from "glob";
+//#region package.json
+var version = "0.4.0";
+//#endregion
+//#region src/logger.ts
+const logger = pino({
+	transport: { target: "pino-pretty" },
+	level: "info"
+});
+function enableDebugLogging() {
+	logger.level = "debug";
+}
+//#endregion
+//#region src/utils/files/dependencyTree.ts
+function getDependencyTree({ relViewerPath, outputType }) {
+	const options = {
+		filename: relViewerPath,
+		directory: ".",
+		tsConfig: "tsconfig.json",
+		filter: (path) => path.indexOf("node_modules") === -1,
+		noTypeDefinitions: false
+	};
+	if (outputType === "list") return dependencyTree.toList(options);
+	return dependencyTree(options);
+}
+//#endregion
+//#region src/constants.ts
+const RELATIVE_PATH_TO_PDF_FOLDER = () => {
+	if (!process.env.RELATIVE_PATH_TO_PDF_FOLDER) throw new Error("RELATIVE_PATH_TO_PDF_FOLDER is not set");
+	return process.env.RELATIVE_PATH_TO_PDF_FOLDER;
+};
+const ABSOLUTE_PATH_TO_PDF_FOLDER = () => {
+	const absoluteFromEnv = process.env.ABSOLUTE_PATH_TO_PDF_FOLDER;
+	if (absoluteFromEnv && fs.existsSync(absoluteFromEnv)) return absoluteFromEnv;
+	const resolvedFromRelative = path$1.resolve(process.cwd(), RELATIVE_PATH_TO_PDF_FOLDER());
+	if (fs.existsSync(resolvedFromRelative)) return resolvedFromRelative;
+	if (absoluteFromEnv) return absoluteFromEnv;
+	throw new Error("ABSOLUTE_PATH_TO_PDF_FOLDER is not set");
+};
+//#endregion
+//#region src/utils/files/getPdfTemplates.ts
+/**
+* checks if a file could be a pdf template
+* @param relativeFilePath
+* @returns
+*/
+function isPotentialPdfTemplate(relViewerPath) {
+	if (fs.statSync(relViewerPath).isDirectory()) return false;
+	if (path$1.basename(relViewerPath).startsWith("_")) return false;
+	const extension = path$1.extname(relViewerPath);
+	if (![
+		".tsx",
+		".ts",
+		".jsx",
+		".js"
+	].includes(extension)) return false;
+	const absoluteFilePath = path$1.resolve(relViewerPath);
+	if (!fs.existsSync(absoluteFilePath)) return false;
+	return fs.readFileSync(absoluteFilePath, "utf8").includes("export default");
+}
+/**
+* returns a list of all potential pdf templates and relevant metadata for display
+*/
+function getPdfTemplates() {
+	return glob.sync(`${RELATIVE_PATH_TO_PDF_FOLDER()}/**/*.{tsx,jsx,js}`, { nodir: true }).filter(isPotentialPdfTemplate).map((file) => {
+		const relTemplatePath = file.replace(`${RELATIVE_PATH_TO_PDF_FOLDER()}/`, "");
+		const pathParts = relTemplatePath.split("/");
+		let topParentFolder = null;
+		if (pathParts.length > 1 && pathParts[0]) topParentFolder = pathParts[0];
+		return {
+			fileName: path$1.basename(file),
+			relTemplatePath,
+			relViewerPath: file,
+			absolutePath: path$1.resolve(file),
+			topParentFolder
+		};
+	});
+}
+//#endregion
+//#region src/utils/files/pdfTemplateWatcher.ts
+function pdfTemplateWatcher() {
+	try {
+		const absolutePathToPdfFolder = ABSOLUTE_PATH_TO_PDF_FOLDER();
+		const watcher = chokidar.watch(absolutePathToPdfFolder, {
+			persistent: true,
+			ignoreInitial: true,
+			ignored: /(^|[\/\\])\../
+		});
+		logger.info(`watching ${absolutePathToPdfFolder} for changes`);
+		const getExternalDependencyFiles = () => {
+			const externalDeps = /* @__PURE__ */ new Set();
+			const templates = getPdfTemplates();
+			for (const template of templates) {
+				let dependencies = [];
+				try {
+					dependencies = getDependencyTree({
+						relViewerPath: template.relViewerPath,
+						outputType: "list"
+					});
+				} catch (error) {
+					logger.debug({
+						err: error,
+						template: template.relViewerPath
+					}, "failed to resolve dependency tree for template");
+					continue;
+				}
+				for (const dependency of dependencies) {
+					const absoluteDependencyPath = path$1.resolve(dependency);
+					if (absoluteDependencyPath.startsWith(absolutePathToPdfFolder) || !path$1.isAbsolute(absoluteDependencyPath)) continue;
+					externalDeps.add(absoluteDependencyPath);
+				}
+			}
+			return [...externalDeps];
+		};
+		let watchedExternalDependencies = getExternalDependencyFiles();
+		if (watchedExternalDependencies.length > 0) watcher.add(watchedExternalDependencies);
+		const syncExternalDependencyWatches = () => {
+			const nextExternalDependencies = getExternalDependencyFiles();
+			for (const filePath of watchedExternalDependencies) if (!nextExternalDependencies.includes(filePath)) watcher.unwatch(filePath);
+			for (const filePath of nextExternalDependencies) if (!watchedExternalDependencies.includes(filePath)) watcher.add(filePath);
+			watchedExternalDependencies = nextExternalDependencies;
+		};
+		watcher.on("add", (filePath) => {
+			logger.info(`file added: ${filePath}`);
+			syncExternalDependencyWatches();
+		}).on("change", (filePath) => {
+			logger.info(`file changed: ${filePath}`);
+			syncExternalDependencyWatches();
+		}).on("unlink", (filePath) => {
+			logger.info(`file removed: ${filePath}`);
+			syncExternalDependencyWatches();
+		}).on("error", (error) => {
+			logger.error({ err: error }, "watcher error");
+		});
+		return watcher;
+	} catch (error) {
+		logger.error({ err: error }, "watcher failed to start");
+		throw error;
+	}
+}
+//#endregion
+//#region src/cli/commands/server.ts
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const resolvePreviewServerLocation = () => {
+	const candidates = [
+		path.resolve(__dirname, "preview"),
+		path.resolve(__dirname, "../preview"),
+		path.resolve(__dirname, "../../preview"),
+		path.resolve(__dirname, "../../..")
+	];
+	for (const candidate of candidates) if (fs.existsSync(path.join(candidate, ".next"))) return candidate;
+	return path.resolve(__dirname, "../../..");
+};
+const previewServerLocation = resolvePreviewServerLocation();
+logger.debug({ previewServerLocation }, "resolved preview server location");
+const getEnvVariablesForPreviewApp = (relativePathToPdfsDirectory, cwd) => {
+	return {
+		RELATIVE_PATH_TO_PDF_FOLDER: relativePathToPdfsDirectory,
+		ABSOLUTE_PATH_TO_PDF_FOLDER: path.resolve(cwd, relativePathToPdfsDirectory),
+		USER_PROJECT_LOCATION: cwd
+	};
+};
+let previewServer;
+const activeSockets = /* @__PURE__ */ new Set();
+let nextAppInstance = null;
+let hotReloadSocketServer = null;
+let templateWatcher = null;
+let hotReloadDebounce = null;
+const safeAsyncServerListen = (server, port) => {
+	return new Promise((resolve, reject) => {
+		const onListening = () => {
+			server.off("error", onError);
+			resolve({ portAlreadyInUse: false });
+		};
+		const onError = (error) => {
+			server.off("listening", onListening);
+			if (error.code === "EADDRINUSE") {
+				resolve({ portAlreadyInUse: true });
+				return;
+			}
+			reject(error);
+		};
+		server.once("listening", onListening);
+		server.once("error", onError);
+		server.listen(port);
+	});
+};
+const startPreviewServer = async (pdfsDirRelativePath, port) => {
+	if (port > 65535) throw new Error("No available ports found (checked through 65535)");
+	const normalizedPdfsDirPath = path.normalize(pdfsDirRelativePath);
+	const absolutePathToPdfsDir = path.resolve(process.cwd(), normalizedPdfsDirPath);
+	let nextReadyPromise = Promise.resolve();
+	let isNextReady = false;
+	let nextRequestHandler = null;
+	previewServer = http.createServer((req, res) => {
+		if (!req.url) {
+			res.writeHead(404);
+			res.end();
+			return;
+		}
+		const parsedUrl = parse(req.url, true);
+		res.setHeader("Cache-Control", "no-cache, max-age=0, must-revalidate, no-store");
+		res.setHeader("Pragma", "no-cache");
+		res.setHeader("Expires", "-1");
+		if (!isNextReady) {
+			nextReadyPromise.then(() => nextRequestHandler?.(req, res, parsedUrl));
+			return;
+		}
+		nextRequestHandler?.(req, res, parsedUrl);
+	});
+	previewServer.on("connection", (socket) => {
+		activeSockets.add(socket);
+		socket.on("close", () => {
+			activeSockets.delete(socket);
+		});
+	});
+	const { portAlreadyInUse } = await safeAsyncServerListen(previewServer, port);
+	if (portAlreadyInUse) {
+		logger.info(`port ${port} in use, trying ${port + 1}`);
+		return startPreviewServer(pdfsDirRelativePath, port + 1);
+	}
+	process.env = {
+		NODE_ENV: "development",
+		...process.env,
+		PORT: String(port),
+		...getEnvVariablesForPreviewApp(normalizedPdfsDirPath, process.cwd())
+	};
+	const nextApp = next({
+		dev: false,
+		conf: { images: { unoptimized: true } },
+		hostname: "localhost",
+		port,
+		dir: previewServerLocation
+	});
+	nextAppInstance = nextApp;
+	logger.info("preparing next app");
+	nextReadyPromise = nextApp.prepare();
+	await nextReadyPromise;
+	nextRequestHandler = nextApp.getRequestHandler();
+	isNextReady = true;
+	hotReloadSocketServer = new Server(previewServer, { path: "/socket.io/" });
+	const pendingChanges = [];
+	const flushReloadEvents = () => {
+		if (!hotReloadSocketServer || pendingChanges.length === 0) return;
+		hotReloadSocketServer.emit("reload", pendingChanges.splice(0));
+	};
+	templateWatcher = pdfTemplateWatcher();
+	templateWatcher.on("all", (event, filePath) => {
+		const absolutePath = path.isAbsolute(filePath) ? filePath : path.resolve(absolutePathToPdfsDir, filePath);
+		const relPath = path.relative(absolutePathToPdfsDir, absolutePath);
+		pendingChanges.push({
+			event: event === "add" || event === "addDir" || event === "change" || event === "unlink" || event === "unlinkDir" ? event : "change",
+			filename: relPath
+		});
+		if (hotReloadDebounce) clearTimeout(hotReloadDebounce);
+		hotReloadDebounce = setTimeout(flushReloadEvents, 150);
+	});
+	previewServer.on("close", async () => {
+		if (hotReloadDebounce) {
+			clearTimeout(hotReloadDebounce);
+			hotReloadDebounce = null;
+		}
+		if (templateWatcher) {
+			templateWatcher.removeAllListeners();
+			await templateWatcher.close();
+			templateWatcher = null;
+		}
+		if (hotReloadSocketServer) {
+			hotReloadSocketServer.close();
+			hotReloadSocketServer = null;
+		}
+		if (!nextAppInstance || !("close" in nextAppInstance)) return;
+		await nextAppInstance.close();
+		nextAppInstance = null;
+	});
+	const url = `http://localhost:${port}`;
+	const clickableUrl = `\u001B]8;;${url}\u0007${url}\u001B]8;;\u0007`;
+	console.log(clickableUrl);
+	return previewServer;
+};
+const stopPreviewServer = async () => {
+	if (!previewServer) return;
+	for (const socket of activeSockets) socket.destroy();
+	activeSockets.clear();
+	await new Promise((resolve, reject) => {
+		previewServer.close((error) => {
+			if (error) {
+				reject(error);
+				return;
+			}
+			resolve();
+		});
+	});
+};
+//#endregion
+//#region src/cli/commands/dev.ts
+const dev = async ({ dir: relativePathToPdfFolder, port, debug }) => {
+	if (debug || process.env.DEBUG === "true" || process.env.DEBUG === "1") {
+		process.env.DEBUG = "true";
+		enableDebugLogging();
+		logger.debug("debug logging enabled");
+	}
+	try {
+		if (!fs.existsSync(relativePathToPdfFolder)) throw new Error(`Missing ${relativePathToPdfFolder} folder`);
+		await startPreviewServer(relativePathToPdfFolder, parseInt(port));
+		let isShuttingDown = false;
+		const shutdown = async (signal) => {
+			if (isShuttingDown) return;
+			isShuttingDown = true;
+			if (signal) logger.info({ signal }, "Shutting down preview server...");
+			else logger.info("Shutting down preview server...");
+			process.off("SIGINT", onSigInt);
+			process.off("SIGTERM", onSigTerm);
+			process.off("SIGHUP", onSigHup);
+			process.off("SIGQUIT", onSigQuit);
+			process.stdin.off("end", onStdinEnd);
+			const forceExitTimer = setTimeout(() => {
+				logger.warn("Shutdown timed out after 5s; forcing process exit to release terminal control.");
+				process.exit(1);
+			}, 5e3);
+			try {
+				await stopPreviewServer();
+				clearTimeout(forceExitTimer);
+				process.exit(0);
+			} catch (error) {
+				clearTimeout(forceExitTimer);
+				logger.error({ err: error }, "Failed during preview server shutdown");
+				process.exit(1);
+			}
+		};
+		const onSigInt = () => {
+			shutdown("SIGINT");
+		};
+		const onSigTerm = () => {
+			shutdown("SIGTERM");
+		};
+		const onSigHup = () => {
+			shutdown("SIGHUP");
+		};
+		const onSigQuit = () => {
+			shutdown("SIGQUIT");
+		};
+		const onStdinEnd = () => {
+			shutdown("STDIN_END");
+		};
+		process.on("SIGINT", onSigInt);
+		process.on("SIGTERM", onSigTerm);
+		process.on("SIGHUP", onSigHup);
+		process.on("SIGQUIT", onSigQuit);
+		process.stdin.on("end", onStdinEnd);
+		if (!process.stdin.isTTY) process.stdin.resume();
+	} catch (error) {
+		logger.error(error);
+		process.exit(1);
+	}
+};
+//#endregion
+//#region src/cli/index.ts
+program.name("repdf").description("A live preview of your pdf templates").version(version);
+program.command("dev").description("Starts the preview pdf development app").option("-d --dir <path>", "Directory containing pdf templates", "./src/pdfs").option("-p --port <port>", "Port to run dev server on", "3000").option("--debug", "Enable debug logging").action(dev);
+if (!process.argv.slice(2).length) {
+	program.outputHelp();
+	process.exit(0);
+}
+program.parse();
+//#endregion
+export {};

package/dist/preview/.next/BUILD_ID

@@ -1 +1 @@
-KcxCEfbjkQZ7a2n1JJAmW
+uQjdkl4yTW6Zpf-3uNg2P

package/dist/preview/.next/build-manifest.json

@@ -3,47 +3,45 @@
     "static/chunks/polyfills-42372ed130431b0a.js"
   ],
   "devFiles": [],
-  "ampDevFiles": [],
   "lowPriorityFiles": [
-    "static/KcxCEfbjkQZ7a2n1JJAmW/_buildManifest.js",
-    "static/KcxCEfbjkQZ7a2n1JJAmW/_ssgManifest.js"
+    "static/uQjdkl4yTW6Zpf-3uNg2P/_buildManifest.js",
+    "static/uQjdkl4yTW6Zpf-3uNg2P/_ssgManifest.js"
   ],
   "rootMainFiles": [],
+  "rootMainFilesTree": {},
   "pages": {
     "/": [
-      "static/chunks/webpack-0b5d8249fb15f5f3.js",
-      "static/chunks/framework-e0f347a11a70369e.js",
-      "static/chunks/main-32f0addb06a02100.js",
-      "static/chunks/64-33135d2a0b032c99.js",
-      "static/chunks/pages/index-0ad3d9cfeac8a6ab.js"
+      "static/chunks/webpack-6f363cd1990801ba.js",
+      "static/chunks/framework-c1a985c867714b4b.js",
+      "static/chunks/main-3c8a75f1bd6d0687.js",
+      "static/chunks/440-7f86160d543d19eb.js",
+      "static/chunks/pages/index-303e0eb1a2330d43.js"
     ],
     "/_app": [
-      "static/chunks/webpack-0b5d8249fb15f5f3.js",
-      "static/chunks/framework-e0f347a11a70369e.js",
-      "static/chunks/main-32f0addb06a02100.js",
-      "static/css/2f58a14ea86bceaa.css",
-      "static/chunks/pages/_app-7fa4f80c08ce0ec4.js"
+      "static/chunks/webpack-6f363cd1990801ba.js",
+      "static/chunks/framework-c1a985c867714b4b.js",
+      "static/chunks/main-3c8a75f1bd6d0687.js",
+      "static/css/a1c9c82f00c72350.css",
+      "static/chunks/pages/_app-6411e6a26996cdef.js"
     ],
     "/_error": [
-      "static/chunks/webpack-0b5d8249fb15f5f3.js",
-      "static/chunks/framework-e0f347a11a70369e.js",
-      "static/chunks/main-32f0addb06a02100.js",
-      "static/chunks/pages/_error-0577f827b4afb66a.js"
+      "static/chunks/webpack-6f363cd1990801ba.js",
+      "static/chunks/framework-c1a985c867714b4b.js",
+      "static/chunks/main-3c8a75f1bd6d0687.js",
+      "static/chunks/pages/_error-4911830c68e733ed.js"
     ],
     "/preview/[...relTemplatePath]": [
-      "static/chunks/webpack-0b5d8249fb15f5f3.js",
-      "static/chunks/framework-e0f347a11a70369e.js",
-      "static/chunks/main-32f0addb06a02100.js",
-      "static/chunks/64-33135d2a0b032c99.js",
-      "static/chunks/837-9d4cc2d57e81e85c.js",
-      "static/chunks/pages/preview/[...relTemplatePath]-e0152b67b748423c.js"
+      "static/chunks/webpack-6f363cd1990801ba.js",
+      "static/chunks/framework-c1a985c867714b4b.js",
+      "static/chunks/main-3c8a75f1bd6d0687.js",
+      "static/chunks/440-7f86160d543d19eb.js",
+      "static/chunks/pages/preview/[...relTemplatePath]-9bf0ebcb9e9f9c65.js"
     ],
     "/test": [
-      "static/chunks/webpack-0b5d8249fb15f5f3.js",
-      "static/chunks/framework-e0f347a11a70369e.js",
-      "static/chunks/main-32f0addb06a02100.js",
-      "static/chunks/pages/test-1b0ec700afcdd64b.js"
+      "static/chunks/webpack-6f363cd1990801ba.js",
+      "static/chunks/framework-c1a985c867714b4b.js",
+      "static/chunks/main-3c8a75f1bd6d0687.js",
+      "static/chunks/pages/test-787280cd6c1cdb85.js"
     ]
-  },
-  "ampFirstPages": []
+  }
 }

package/dist/preview/.next/cache/.previewinfo

@@ -0,0 +1 @@
+{"previewModeId":"5f739dd66df2bf0113e6397704146612","previewModeSigningKey":"3e30d460d9841ae936dac02de5699520f6320e828e4abd538d486f9690129811","previewModeEncryptionKey":"72ee6230aaed11e742c6358be39da1f9ca4c55d1ddf746837e23a6e493d02856","expireAt":1774379152992}

package/dist/preview/.next/cache/.rscinfo

@@ -0,0 +1 @@
+{"encryption.key":"y8rBNN9f5CqnZkTMrMg2bW1z7Z+WN1OTeLAibgr6Wpg=","encryption.expire_at":1774379152987}