@ahmedrowaihi/pdf-forge-cli 1.0.0-canary.0

package/src/utils/preview/hot-reloading/get-imported-modules.ts

@@ -0,0 +1,49 @@
+import { parse } from '@babel/parser';
+
+import traverseModule from '@babel/traverse';
+
+const traverse =
+  // we keep this check here so that this still works with the dev:preview
+  // script's use of tsx
+  typeof traverseModule === 'function'
+    ? traverseModule
+    : traverseModule.default;
+
+export const getImportedModules = (contents: string) => {
+  const importedPaths: string[] = [];
+  const parsedContents = parse(contents, {
+    sourceType: 'unambiguous',
+    strictMode: false,
+    errorRecovery: true,
+    plugins: ['jsx', 'typescript', 'decorators'],
+  });
+
+  traverse(parsedContents, {
+    ImportDeclaration({ node }) {
+      importedPaths.push(node.source.value);
+    },
+    ExportAllDeclaration({ node }) {
+      importedPaths.push(node.source.value);
+    },
+    ExportNamedDeclaration({ node }) {
+      if (node.source) {
+        importedPaths.push(node.source.value);
+      }
+    },
+    TSExternalModuleReference({ node }) {
+      importedPaths.push(node.expression.value);
+    },
+    CallExpression({ node }) {
+      if ('name' in node.callee && node.callee.name === 'require') {
+        if (node.arguments.length === 1) {
+          const importPathNode = node.arguments[0]!;
+          if (importPathNode.type === 'StringLiteral') {
+            importedPaths.push(importPathNode.value);
+          }
+        }
+      }
+    },
+  });
+
+  return importedPaths;
+};

package/src/utils/preview/hot-reloading/resolve-path-aliases.ts

@@ -0,0 +1,32 @@
+import path from 'node:path';
+import { createMatchPath, loadConfig } from 'tsconfig-paths';
+
+export const resolvePathAliases = (
+  importPaths: string[],
+  projectPath: string,
+) => {
+  const configLoadResult = loadConfig(projectPath);
+
+  if (configLoadResult.resultType === 'success') {
+    const matchPath = createMatchPath(
+      configLoadResult.absoluteBaseUrl,
+      configLoadResult.paths,
+    );
+    return importPaths.map((importedPath) => {
+      const unaliasedPath = matchPath(importedPath, undefined, undefined, [
+        '.tsx',
+        '.ts',
+        '.js',
+        '.jsx',
+        '.cjs',
+        '.mjs',
+      ]);
+      if (unaliasedPath) {
+        return `./${path.relative(projectPath, unaliasedPath)}`;
+      }
+      return importedPath;
+    });
+  }
+
+  return importPaths;
+};

package/src/utils/preview/hot-reloading/setup-hot-reloading.ts

@@ -0,0 +1,125 @@
+import type http from 'node:http';
+import path from 'node:path';
+import { watch } from 'chokidar';
+import debounce from 'debounce';
+import { type Socket, Server as SocketServer } from 'socket.io';
+import type { HotReloadChange } from '../../types/hot-reload-change.js';
+import { createDependencyGraph } from './create-dependency-graph.js';
+
+export const setupHotreloading = async (
+  devServer: http.Server,
+  templatesDirRelativePath: string,
+) => {
+  let clients: Socket[] = [];
+  const io = new SocketServer(devServer);
+
+  io.on('connection', (client) => {
+    clients.push(client);
+
+    client.on('disconnect', () => {
+      clients = clients.filter((item) => item !== client);
+    });
+  });
+
+  // used to keep track of all changes
+  // and send them at once to the preview app through the web socket
+  let changes = [] as HotReloadChange[];
+
+  const reload = debounce(() => {
+    // we detect these using the useHotreload hook on the Next app
+    clients.forEach((client) => {
+      client.emit(
+        'reload',
+        changes.filter((change) =>
+          // Ensures only changes inside the templates directory are emitted
+          path
+            .resolve(absolutePathToTemplatesDirectory, change.filename)
+            .startsWith(absolutePathToTemplatesDirectory),
+        ),
+      );
+    });
+
+    changes = [];
+  }, 150);
+
+  const absolutePathToTemplatesDirectory = path.resolve(
+    process.cwd(),
+    templatesDirRelativePath,
+  );
+
+  const [dependencyGraph, updateDependencyGraph, { resolveDependentsOf }] =
+    await createDependencyGraph(absolutePathToTemplatesDirectory);
+
+  const watcher = watch('', {
+    ignoreInitial: true,
+    cwd: absolutePathToTemplatesDirectory,
+  });
+
+  const getFilesOutsideTemplatesDirectory = () =>
+    Object.keys(dependencyGraph).filter((p) =>
+      path.relative(absolutePathToTemplatesDirectory, p).startsWith('..'),
+    );
+  let filesOutsideTemplatesDirectory = getFilesOutsideTemplatesDirectory();
+  // adds in to be watched separately all of the files that are outside of
+  // the user's templates directory
+  for (const p of filesOutsideTemplatesDirectory) {
+    watcher.add(p);
+  }
+
+  const exit = async () => {
+    await watcher.close();
+  };
+  process.on('SIGINT', exit);
+  process.on('uncaughtException', exit);
+
+  watcher.on('all', async (event, relativePathToChangeTarget) => {
+    const file = relativePathToChangeTarget.split(path.sep);
+    if (file.length === 0) {
+      return;
+    }
+    const pathToChangeTarget = path.resolve(
+      absolutePathToTemplatesDirectory,
+      relativePathToChangeTarget,
+    );
+
+    await updateDependencyGraph(event, pathToChangeTarget);
+
+    const newFilesOutsideTemplatesDirectory =
+      getFilesOutsideTemplatesDirectory();
+    // updates the files outside of the user's templates directory by unwatching
+    // the inexistent ones and watching the new ones
+    //
+    // Update watched files outside templates directory to handle dependency changes
+    for (const p of filesOutsideTemplatesDirectory) {
+      if (!newFilesOutsideTemplatesDirectory.includes(p)) {
+        watcher.unwatch(p);
+      }
+    }
+    for (const p of newFilesOutsideTemplatesDirectory) {
+      if (!filesOutsideTemplatesDirectory.includes(p)) {
+        watcher.add(p);
+      }
+    }
+    filesOutsideTemplatesDirectory = newFilesOutsideTemplatesDirectory;
+
+    changes.push({
+      event,
+      filename: relativePathToChangeTarget,
+    });
+
+    // These dependents are dependents resolved recursively, so even dependents of dependents
+    // will be notified of this change so that we ensure that things are updated in the preview.
+    for (const dependentPath of resolveDependentsOf(pathToChangeTarget)) {
+      changes.push({
+        event: 'change' as const,
+        filename: path.relative(
+          absolutePathToTemplatesDirectory,
+          dependentPath,
+        ),
+      });
+    }
+    reload();
+  });
+
+  return watcher;
+};

package/src/utils/preview/serve-static-file.ts

@@ -0,0 +1,134 @@
+import { existsSync, promises as fs } from 'node:fs';
+import type http from 'node:http';
+import path from 'node:path';
+import type url from 'node:url';
+import { lookup } from 'mime-types';
+
+/**
+ * Extracts the template directory path from the referer URL.
+ * @param referer - The referer header value
+ * @returns The template directory path, or null if not found
+ */
+const extractTemplatePathFromReferer = (referer: string): string | null => {
+  try {
+    const refererUrl = new URL(referer);
+    const previewMatch = refererUrl.pathname.match(/\/preview\/(.+)$/);
+    if (!previewMatch?.[1]) {
+      return null;
+    }
+
+    const templateSlug = previewMatch[1];
+    return templateSlug.replace(/\.(tsx|jsx|ts|js)$/, '');
+  } catch {
+    return null;
+  }
+};
+
+/**
+ * Recursively searches for a static file starting from the template directory
+ * and traversing up to the templates root directory.
+ * @param templateFullPath - Full path to the template directory
+ * @param templatesDirResolved - Resolved path to the templates root directory
+ * @param relativeFilePath - Relative path to the file within the static folder
+ * @returns Absolute path to the found file, or null if not found
+ */
+const findStaticFileRecursively = (
+  templateFullPath: string,
+  templatesDirResolved: string,
+  relativeFilePath: string,
+): string | null => {
+  let currentDir = templateFullPath;
+
+  while (currentDir.startsWith(templatesDirResolved)) {
+    const staticPath = path.join(currentDir, 'static', relativeFilePath);
+    if (existsSync(staticPath)) {
+      return staticPath;
+    }
+
+    // Move up one directory level
+    const parentDir = path.dirname(currentDir);
+    if (parentDir === currentDir) {
+      // Reached filesystem root
+      break;
+    }
+    currentDir = parentDir;
+  }
+
+  return null;
+};
+
+export const serveStaticFile = async (
+  res: http.ServerResponse,
+  parsedUrl: url.UrlWithParsedQuery,
+  staticDirRelativePath: string,
+  templatesDirRelativePath?: string,
+  req?: http.IncomingMessage,
+) => {
+  const originalPath = parsedUrl.pathname!;
+  const pathname = originalPath.startsWith('/static')
+    ? originalPath.replace('/static', './static')
+    : `./static${originalPath}`;
+  const ext = path.parse(pathname).ext;
+
+  const staticBaseDir = path.resolve(process.cwd(), staticDirRelativePath);
+  let fileAbsolutePath: string | null = null;
+
+  if (templatesDirRelativePath && req?.headers.referer) {
+    const templateDirPath = extractTemplatePathFromReferer(req.headers.referer);
+
+    if (templateDirPath) {
+      const templatesDir = path.resolve(
+        process.cwd(),
+        templatesDirRelativePath,
+      );
+      const templateFullPath = path.join(templatesDir, templateDirPath);
+      const relativeFilePath = pathname.replace('./static/', '');
+      const templatesDirResolved = path.resolve(templatesDir);
+
+      fileAbsolutePath = findStaticFileRecursively(
+        templateFullPath,
+        templatesDirResolved,
+        relativeFilePath,
+      );
+    }
+  }
+
+  // Fallback to root static directory
+  if (!fileAbsolutePath) {
+    fileAbsolutePath = path.resolve(staticBaseDir, pathname);
+    if (!fileAbsolutePath.startsWith(staticBaseDir)) {
+      res.statusCode = 403;
+      res.end();
+      return;
+    }
+  }
+
+  try {
+    const fileHandle = await fs.open(fileAbsolutePath, 'r');
+
+    const fileData = await fs.readFile(fileHandle);
+
+    // if the file is found, set Content-type and send data
+    res.setHeader('Content-type', lookup(ext) || 'text/plain');
+    res.end(fileData);
+
+    void fileHandle.close();
+  } catch (exception) {
+    if (!existsSync(fileAbsolutePath)) {
+      res.statusCode = 404;
+      res.end();
+    } else {
+      const sanitizedFilePath = fileAbsolutePath.replace(/\n|\r/g, '');
+      console.error(
+        `Could not read file at %s to be served, here's the exception:`,
+        sanitizedFilePath,
+        exception,
+      );
+
+      res.statusCode = 500;
+      res.end(
+        'Could not read file to be served! Check your terminal for more information.',
+      );
+    }
+  }
+};

package/src/utils/preview/start-dev-server.ts

@@ -0,0 +1,242 @@
+import http from 'node:http';
+import path from 'node:path';
+import url from 'node:url';
+import { createJiti } from 'jiti';
+import logSymbols from 'log-symbols';
+import ora from 'ora';
+import { getPreviewServerLocation } from '../get-preview-server-location.js';
+import { packageJson } from '../packageJson.js';
+import { registerSpinnerAutostopping } from '../register-spinner-autostopping.js';
+import { styleText } from '../style-text.js';
+import { getEnvVariablesForPreviewApp } from './get-env-variables-for-preview-app.js';
+import { serveStaticFile } from './serve-static-file.js';
+
+let devServer: http.Server | undefined;
+
+const safeAsyncServerListen = (server: http.Server, port: number) => {
+  return new Promise<{ portAlreadyInUse: boolean }>((resolve) => {
+    server.listen(port, () => {
+      resolve({ portAlreadyInUse: false });
+    });
+
+    server.on('error', (e: NodeJS.ErrnoException) => {
+      if (e.code === 'EADDRINUSE') {
+        resolve({ portAlreadyInUse: true });
+      }
+    });
+  });
+};
+
+export const startDevServer = async (
+  templatesDirRelativePath: string,
+  staticBaseDirRelativePath: string,
+  port: number,
+): Promise<http.Server> => {
+  const [majorNodeVersion] = process.versions.node.split('.');
+  if (majorNodeVersion && Number.parseInt(majorNodeVersion, 10) < 20) {
+    console.error(
+      ` ${logSymbols.error}  Node ${majorNodeVersion} is not supported. Please upgrade to Node 20 or higher.`,
+    );
+    process.exit(1);
+  }
+
+  const previewServerLocation = await getPreviewServerLocation();
+  const previewServer = createJiti(previewServerLocation);
+
+  devServer = http.createServer((req, res) => {
+    if (!req.url) {
+      res.end(404);
+      return;
+    }
+
+    const parsedUrl = url.parse(req.url, true);
+
+    // Never cache anything to avoid
+    res.setHeader(
+      'Cache-Control',
+      'no-cache, max-age=0, must-revalidate, no-store',
+    );
+    res.setHeader('Pragma', 'no-cache');
+    res.setHeader('Expires', '-1');
+
+    try {
+      if (
+        parsedUrl.path &&
+        !parsedUrl.path.startsWith('/preview/') &&
+        !parsedUrl.path.startsWith('/api/') &&
+        !parsedUrl.path.includes('_next/')
+      ) {
+        void serveStaticFile(
+          res,
+          parsedUrl,
+          staticBaseDirRelativePath,
+          templatesDirRelativePath,
+          req,
+        );
+      } else if (!isNextReady) {
+        void nextReadyPromise.then(() =>
+          nextHandleRequest?.(req, res, parsedUrl),
+        );
+      } else {
+        void nextHandleRequest?.(req, res, parsedUrl);
+      }
+    } catch (e) {
+      console.error('caught error', e);
+
+      res.writeHead(500);
+      res.end();
+    }
+  });
+
+  const { portAlreadyInUse } = await safeAsyncServerListen(devServer, port);
+
+  if (!portAlreadyInUse) {
+    console.log(
+      styleText('greenBright', `    React PDF ${packageJson.version}`),
+    );
+    console.log(`    Running preview at:          http://localhost:${port}\n`);
+  } else {
+    const nextPortToTry = port + 1;
+    console.warn(
+      ` ${logSymbols.warning} Port ${port} is already in use, trying ${nextPortToTry}`,
+    );
+    return startDevServer(
+      templatesDirRelativePath,
+      staticBaseDirRelativePath,
+      nextPortToTry,
+    );
+  }
+
+  devServer.on('close', () => {
+    void app.close();
+  });
+
+  devServer.on('error', (e: NodeJS.ErrnoException) => {
+    spinner.stopAndPersist({
+      symbol: logSymbols.error,
+      text: `Preview Server had an error: ${e.message}`,
+    });
+    process.exit(1);
+  });
+
+  const spinner = ora({
+    text: 'Getting react-pdf preview server ready...\n',
+    prefixText: ' ',
+  }).start();
+
+  registerSpinnerAutostopping(spinner);
+  const timeBeforeNextReady = performance.now();
+
+  // these environment variables are used on the next app
+  // this is the most reliable way of communicating these paths through
+  process.env = {
+    NODE_ENV: 'development',
+    ...(process.env as Omit<NodeJS.ProcessEnv, 'NODE_ENV'> & {
+      NODE_ENV?: NodeJS.ProcessEnv['NODE_ENV'];
+    }),
+    ...getEnvVariablesForPreviewApp(
+      // Normalize paths to avoid issues with path resolution
+      path.normalize(templatesDirRelativePath),
+      previewServerLocation,
+      process.cwd(),
+    ),
+  };
+
+  const next = await previewServer.import<typeof import('next')['default']>(
+    'next',
+    {
+      default: true,
+    },
+  );
+
+  const app = next({
+    // passing in env here does not get the environment variables there
+    dev: false,
+    conf: {
+      images: {
+        // This is to avoid the warning with sharp
+        unoptimized: true,
+      },
+    },
+    hostname: 'localhost',
+    port,
+    dir: previewServerLocation,
+  });
+
+  let isNextReady = false;
+  const nextReadyPromise = app.prepare();
+  try {
+    await nextReadyPromise;
+  } catch (exception) {
+    spinner.stopAndPersist({
+      symbol: logSymbols.error,
+      text: ` Preview Server had an error: ${exception}`,
+    });
+    process.exit(1);
+  }
+  isNextReady = true;
+
+  const nextHandleRequest:
+    | ReturnType<typeof app.getRequestHandler>
+    | undefined = app.getRequestHandler();
+
+  const secondsToNextReady = (
+    (performance.now() - timeBeforeNextReady) /
+    1000
+  ).toFixed(1);
+
+  spinner.stopAndPersist({
+    text: `Ready in ${secondsToNextReady}s\n`,
+    symbol: logSymbols.success,
+  });
+
+  return devServer;
+};
+
+// based on https://stackoverflow.com/a/14032965
+const makeExitHandler =
+  (
+    options?:
+      | { shouldKillProcess: false }
+      | { shouldKillProcess: true; killWithErrorCode: boolean },
+  ) =>
+  (codeSignalOrError: number | NodeJS.Signals | Error) => {
+    if (typeof devServer !== 'undefined') {
+      console.log('\nshutting down dev server');
+      devServer.close();
+      devServer = undefined;
+    }
+
+    if (codeSignalOrError instanceof Error) {
+      console.error(codeSignalOrError);
+    }
+
+    if (options?.shouldKillProcess) {
+      process.exit(options.killWithErrorCode ? 1 : 0);
+    }
+  };
+
+// do something when app is closing
+process.on('exit', makeExitHandler());
+
+// catches ctrl+c event
+process.on(
+  'SIGINT',
+  makeExitHandler({ shouldKillProcess: true, killWithErrorCode: false }),
+);
+
+//  catches "kill pid" (for example: nodemon restart)
+process.on(
+  'SIGUSR1',
+  makeExitHandler({ shouldKillProcess: true, killWithErrorCode: false }),
+);
+process.on(
+  'SIGUSR2',
+  makeExitHandler({ shouldKillProcess: true, killWithErrorCode: false }),
+);
+
+// catches uncaught exceptions
+process.on(
+  'uncaughtException',
+  makeExitHandler({ shouldKillProcess: true, killWithErrorCode: true }),
+);

package/src/utils/register-spinner-autostopping.ts

@@ -0,0 +1,29 @@
+import logSymbols from 'log-symbols';
+import type { Ora } from 'ora';
+
+const spinners = new Set<Ora>();
+
+process.on('SIGINT', () => {
+  spinners.forEach((spinner) => {
+    if (spinner.isSpinning) {
+      spinner.stop();
+    }
+  });
+});
+
+process.on('exit', (code) => {
+  if (code !== 0) {
+    spinners.forEach((spinner) => {
+      if (spinner.isSpinning) {
+        spinner.stopAndPersist({
+          symbol: logSymbols.error,
+          text: 'Process exited with error',
+        });
+      }
+    });
+  }
+});
+
+export const registerSpinnerAutostopping = (spinner: Ora) => {
+  spinners.add(spinner);
+};

package/src/utils/style-text.ts

@@ -0,0 +1,11 @@
+/**
+ * Centralized fallback for Node versions (<20.12.0) without util.styleText.
+ * Returns the original text when styleText is unavailable.
+ */
+import * as nodeUtil from 'node:util';
+
+type StyleTextFunction = typeof nodeUtil.styleText;
+
+export const styleText: StyleTextFunction = (nodeUtil as any).styleText
+  ? (nodeUtil as any).styleText
+  : (_: string, text: string) => text;

package/src/utils/tree.ts

@@ -0,0 +1,76 @@
+import { promises as fs } from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+
+const SYMBOLS = {
+  BRANCH: '├── ',
+  EMPTY: '',
+  INDENT: '    ',
+  LAST_BRANCH: '└── ',
+  VERTICAL: '│   ',
+};
+
+const getTreeLines = async (
+  dirPath: string,
+  depth: number,
+  currentDepth = 0,
+) => {
+  const base = process.cwd();
+  const dirFullpath = path.resolve(base, dirPath);
+  const dirname = path.basename(dirFullpath);
+  let lines = [dirname];
+
+  const dirStat = await fs.stat(dirFullpath);
+  if (dirStat.isDirectory() && currentDepth < depth) {
+    const childDirents = await fs.readdir(dirFullpath, { withFileTypes: true });
+
+    childDirents.sort((a, b) => {
+      // orders directories before files
+      if (a.isDirectory() && b.isFile()) {
+        return -1;
+      }
+
+      if (a.isFile() && b.isDirectory()) {
+        return 1;
+      }
+
+      // orders by name because they are the same type
+      // either directory & directory
+      // or file & file
+      return b.name > a.name ? -1 : 1;
+    });
+
+    for (let i = 0; i < childDirents.length; i++) {
+      const dirent = childDirents[i]!;
+      const isLast = i === childDirents.length - 1;
+
+      const branchingSymbol = isLast ? SYMBOLS.LAST_BRANCH : SYMBOLS.BRANCH;
+      const verticalSymbol = isLast ? SYMBOLS.INDENT : SYMBOLS.VERTICAL;
+
+      if (dirent.isFile()) {
+        lines.push(`${branchingSymbol}${dirent.name}`);
+      } else {
+        const pathToDirectory = path.join(dirFullpath, dirent.name);
+        const treeLinesForSubDirectory = await getTreeLines(
+          pathToDirectory,
+          depth,
+          currentDepth + 1,
+        );
+        lines = lines.concat(
+          treeLinesForSubDirectory.map((line, index) =>
+            index === 0
+              ? `${branchingSymbol}${line}`
+              : `${verticalSymbol}${line}`,
+          ),
+        );
+      }
+    }
+  }
+
+  return lines;
+};
+
+export const tree = async (dirPath: string, depth: number) => {
+  const lines = await getTreeLines(dirPath, depth);
+  return lines.join(os.EOL);
+};