@procedures/pdf 0.54.0 → 0.54.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @procedures/pdf
 
+## 0.54.1
+
+### Patch Changes
+
+- a3efa7e: The new package `@procedures/browser` is the home of the renders of a page with a Chromium browser that is already installed. It has `findBrowser`, one headless run for each render, `renderPdf` and the new `renderScreenshot`.
+  
+  - `renderScreenshot` loads an address, an HTML text or an HTML file in a window of a given size. It writes a PNG, JPEG or WebP picture of the window. The extension of the output sets the format.
+  - It accepts only an `http:`, `https:` or `file:` address, so a flag cannot get into the argv of the browser.
+  - The headless run is written one time. The two renders give only their flags and the check of their file.
+  
+  `@procedures/pdf` gives the same names again from `@procedures/browser`, so no caller breaks. Its procedure `pdf.render` does not change.
+  
+  PATCH: before 1.0.0, a new package and a new feature raise PATCH. The exports and the behavior of `@procedures/pdf` do not change.
+- Updated dependencies [a3efa7e]
+- Updated dependencies [13c3a8b]
+  - @procedures/browser@0.54.1
+  - @procedures/client@0.54.1
+
 ## 0.54.0
 
 ### Patch Changes

package/README.md

@@ -33,7 +33,7 @@ const { path, bytes } = await client.call(["pdf", "render"], {
 
 ## The functions
 
-The package root also gives the functions without a registry:
+The package root also gives the functions without a registry. Their home is [`@procedures/browser`](../browser), and this package gives them again, so no caller breaks. New code imports them from `@procedures/browser`, which also takes screenshots.
 
 - `renderPdf(options)` prints the page and gives `{ path, bytes, browser }`. The options are the input of `pdf.render`, and `signal`, `env`, `platform` and `runner`.
 - `findBrowser(options)` gives the path of the browser program, or `undefined`.

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 export * from "./module.js";
 export * from "./types.js";
-export * from "./browser.js";
-export * from "./render.js";
+export { BROWSER_ENV, BROWSER_NAMES, CHROME_PATH_ENV, DEFAULT_TIMEOUT_MS, WINDOWS_BROWSER_NAMES, browserCandidates, findBrowser, isPdfFile, pdfArgs, renderPdf, type CommandRunner, type FindBrowserOptions, type RenderPdfOptions, type RenderPdfResult, } from "@procedures/browser";
 export { pdfRender } from "./procedures/pdf/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAE3B,OAAO,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,eAAe,GACrB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -1,7 +1,7 @@
 // The root registers nothing: import "<package>/register", or give the module to createRegistry()
 export * from "./module.js";
 export * from "./types.js";
-export * from "./browser.js";
-export * from "./render.js";
+// The search and the render moved to @procedures/browser. The names stay here, so no caller breaks.
+export { BROWSER_ENV, BROWSER_NAMES, CHROME_PATH_ENV, DEFAULT_TIMEOUT_MS, WINDOWS_BROWSER_NAMES, browserCandidates, findBrowser, isPdfFile, pdfArgs, renderPdf, } from "@procedures/browser";
 export { pdfRender } from "./procedures/pdf/index.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,oGAAoG;AACpG,OAAO,EACL,WAAW,EACX,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,SAAS,GAKV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/procedures/pdf/render.d.ts

@@ -4,7 +4,7 @@
  * This procedure prints an HTML page to a PDF file with a headless Chromium browser that is
  * already installed.
  */
-import { type CommandRunner } from "../../render.js";
+import { type CommandRunner } from "@procedures/browser";
 import type { PdfRenderInput, PdfRenderOutput } from "../../types.js";
 /**
  * This function prints the HTML text or the HTML file of the input to a PDF file. It gives the

package/dist/procedures/pdf/render.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../../src/procedures/pdf/render.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAa,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtE;;;GAGG;AACH,wBAAsB,SAAS,CAC7B,KAAK,EAAE,cAAc,EACrB,GAAG,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;CAAE,EAC1C,MAAM,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,eAAe,CAAC,CAY1B"}
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../../src/procedures/pdf/render.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAa,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtE;;;GAGG;AACH,wBAAsB,SAAS,CAC7B,KAAK,EAAE,cAAc,EACrB,GAAG,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;CAAE,EAC1C,MAAM,CAAC,EAAE,aAAa,GACrB,OAAO,CAAC,eAAe,CAAC,CAY1B"}

package/dist/procedures/pdf/render.js

@@ -4,7 +4,7 @@
  * This procedure prints an HTML page to a PDF file with a headless Chromium browser that is
  * already installed.
  */
-import { renderPdf } from "../../render.js";
+import { renderPdf } from "@procedures/browser";
 /**
  * This function prints the HTML text or the HTML file of the input to a PDF file. It gives the
  * path and the size of the file.

package/dist/procedures/pdf/render.js.map

@@ -1 +1 @@
-{"version":3,"file":"render.js","sourceRoot":"","sources":["../../../src/procedures/pdf/render.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAsB,MAAM,iBAAiB,CAAC;AAGhE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,KAAqB,EACrB,GAA0C,EAC1C,MAAsB;IAEtB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC;QAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,MAAM,EAAE,GAAG,EAAE,MAAM;QACnB,MAAM;KACP,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;AAC7E,CAAC"}
+{"version":3,"file":"render.js","sourceRoot":"","sources":["../../../src/procedures/pdf/render.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAsB,MAAM,qBAAqB,CAAC;AAGpE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,KAAqB,EACrB,GAA0C,EAC1C,MAAsB;IAEtB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC;QAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,MAAM,EAAE,GAAG,EAAE,MAAM;QACnB,MAAM;KACP,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;AAC7E,CAAC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@procedures/pdf",
-  "version": "0.54.0",
-  "description": "HTML to PDF with a headless Chromium browser that is already installed (Edge, Chrome or Chromium), with no browser download.",
+  "version": "0.54.1",
+  "description": "HTML to PDF with a headless Chromium browser that is already installed (Edge, Chrome or Chromium), as the procedure pdf.render. The render is in @procedures/browser.",
   "keywords": [
     "pdf",
     "html",
@@ -59,15 +59,16 @@
     "provenance": true
   },
   "dependencies": {
-    "@procedures/client": "0.54.0",
-    "@procedures/shell": "0.54.0",
+    "@procedures/browser": "0.54.1",
+    "@procedures/client": "0.54.1",
     "zod": "^4.6.5"
   },
   "devDependencies": {
     "typescript": "^7.0.2",
     "@types/node": "^22.0.0",
     "@mark1russell7/cue": "^2.1.1",
-    "vitest": "^5.0.3"
+    "vitest": "^5.0.3",
+    "@procedures/shell": "0.54.1"
   },
   "client": {
     "procedures": "./dist/register.js"

package/src/index.ts

@@ -1,6 +1,21 @@
 // The root registers nothing: import "<package>/register", or give the module to createRegistry()
 export * from "./module.js";
 export * from "./types.js";
-export * from "./browser.js";
-export * from "./render.js";
+// The search and the render moved to @procedures/browser. The names stay here, so no caller breaks.
+export {
+  BROWSER_ENV,
+  BROWSER_NAMES,
+  CHROME_PATH_ENV,
+  DEFAULT_TIMEOUT_MS,
+  WINDOWS_BROWSER_NAMES,
+  browserCandidates,
+  findBrowser,
+  isPdfFile,
+  pdfArgs,
+  renderPdf,
+  type CommandRunner,
+  type FindBrowserOptions,
+  type RenderPdfOptions,
+  type RenderPdfResult,
+} from "@procedures/browser";
 export { pdfRender } from "./procedures/pdf/index.js";

package/src/procedures/pdf/render.ts

@@ -5,7 +5,7 @@
  * already installed.
  */
 
-import { renderPdf, type CommandRunner } from "../../render.js";
+import { renderPdf, type CommandRunner } from "@procedures/browser";
 import type { PdfRenderInput, PdfRenderOutput } from "../../types.js";
 
 /**

package/dist/browser.d.ts

@@ -1,34 +0,0 @@
-/**
- * Find a Chromium browser that is already installed: Microsoft Edge, Google Chrome or Chromium.
- * The package does not download a browser.
- */
-/** The environment variable that names the browser program. It comes before the search. */
-export declare const BROWSER_ENV = "PDF_BROWSER";
-/** The second environment variable for the browser program. Other tools use this name too. */
-export declare const CHROME_PATH_ENV = "CHROME_PATH";
-/** The program names that the search looks for on the `PATH`, in order. */
-export declare const BROWSER_NAMES: readonly string[];
-/** The program names on the `PATH` of Windows, in order. */
-export declare const WINDOWS_BROWSER_NAMES: readonly string[];
-/** The options of `findBrowser`. Each one has a default from the host. */
-export interface FindBrowserOptions {
-    /** The browser program. When it is set, the search does not occur. */
-    readonly executable?: string | undefined;
-    /** The environment (default: `process.env`). */
-    readonly env?: Readonly<Record<string, string | undefined>> | undefined;
-    /** The operating system (default: `process.platform`). */
-    readonly platform?: NodeJS.Platform | undefined;
-    /** The function that tells if a file exists (default: `existsSync`). */
-    readonly exists?: ((path: string) => boolean) | undefined;
-}
-/**
- * This function gives the paths that the search examines on an operating system, in order. The
- * install folders come first, then the folders of the `PATH`.
- */
-export declare function browserCandidates(platform: NodeJS.Platform, env: Readonly<Record<string, string | undefined>>): string[];
-/**
- * This function finds the browser program. The order is `executable`, then `PDF_BROWSER`, then
- * `CHROME_PATH`, then the install folders and the `PATH`. It gives `undefined` when it finds none.
- */
-export declare function findBrowser(options?: FindBrowserOptions): string | undefined;
-//# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,2FAA2F;AAC3F,eAAO,MAAM,WAAW,gBAAgB,CAAC;AAEzC,8FAA8F;AAC9F,eAAO,MAAM,eAAe,gBAAgB,CAAC;AAE7C,2EAA2E;AAC3E,eAAO,MAAM,aAAa,EAAE,SAAS,MAAM,EAO1C,CAAC;AAEF,4DAA4D;AAC5D,eAAO,MAAM,qBAAqB,EAAE,SAAS,MAAM,EAAiC,CAAC;AAErF,0EAA0E;AAC1E,MAAM,WAAW,kBAAkB;IACjC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,gDAAgD;IAChD,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAC;IACxE,0DAA0D;IAC1D,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,SAAS,CAAC;IAChD,wEAAwE;IACxE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;CAC3D;AASD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,GAAG,MAAM,EAAE,CA8BxH;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,MAAM,GAAG,SAAS,CAShF"}

package/dist/browser.js

@@ -1,81 +0,0 @@
-/**
- * Find a Chromium browser that is already installed: Microsoft Edge, Google Chrome or Chromium.
- * The package does not download a browser.
- */
-import { existsSync } from "node:fs";
-import { posix, win32 } from "node:path";
-/** The environment variable that names the browser program. It comes before the search. */
-export const BROWSER_ENV = "PDF_BROWSER";
-/** The second environment variable for the browser program. Other tools use this name too. */
-export const CHROME_PATH_ENV = "CHROME_PATH";
-/** The program names that the search looks for on the `PATH`, in order. */
-export const BROWSER_NAMES = [
-    "google-chrome",
-    "google-chrome-stable",
-    "chromium",
-    "chromium-browser",
-    "microsoft-edge",
-    "microsoft-edge-stable",
-];
-/** The program names on the `PATH` of Windows, in order. */
-export const WINDOWS_BROWSER_NAMES = ["msedge.exe", "chrome.exe"];
-/** This function gives the folders of the `PATH`, in order. */
-function pathFolders(env, windows) {
-    const value = windows ? (env["Path"] ?? env["PATH"]) : env["PATH"];
-    if (value === undefined)
-        return [];
-    return value.split(windows ? ";" : ":").filter((folder) => folder.length > 0);
-}
-/**
- * This function gives the paths that the search examines on an operating system, in order. The
- * install folders come first, then the folders of the `PATH`.
- */
-export function browserCandidates(platform, env) {
-    if (platform === "win32") {
-        const programFiles = env["ProgramFiles"] ?? env["PROGRAMFILES"] ?? "C:\\Program Files";
-        const programFilesX86 = env["ProgramFiles(x86)"] ?? env["PROGRAMFILES(X86)"] ?? "C:\\Program Files (x86)";
-        const localAppData = env["LOCALAPPDATA"];
-        const installed = [
-            win32.join(programFilesX86, "Microsoft", "Edge", "Application", "msedge.exe"),
-            win32.join(programFiles, "Microsoft", "Edge", "Application", "msedge.exe"),
-            win32.join(programFiles, "Google", "Chrome", "Application", "chrome.exe"),
-            win32.join(programFilesX86, "Google", "Chrome", "Application", "chrome.exe"),
-            ...(localAppData !== undefined
-                ? [win32.join(localAppData, "Google", "Chrome", "Application", "chrome.exe"), win32.join(localAppData, "Chromium", "Application", "chrome.exe")]
-                : []),
-        ];
-        const onPath = pathFolders(env, true).flatMap((folder) => WINDOWS_BROWSER_NAMES.map((name) => win32.join(folder, name)));
-        return [...installed, ...onPath];
-    }
-    const installed = [];
-    if (platform === "darwin") {
-        const bundles = [
-            "Google Chrome.app/Contents/MacOS/Google Chrome",
-            "Microsoft Edge.app/Contents/MacOS/Microsoft Edge",
-            "Chromium.app/Contents/MacOS/Chromium",
-        ];
-        const home = env["HOME"];
-        installed.push(...bundles.map((bundle) => posix.join("/Applications", bundle)));
-        if (home !== undefined)
-            installed.push(...bundles.map((bundle) => posix.join(home, "Applications", bundle)));
-    }
-    const onPath = pathFolders(env, false).flatMap((folder) => BROWSER_NAMES.map((name) => posix.join(folder, name)));
-    return [...installed, ...onPath];
-}
-/**
- * This function finds the browser program. The order is `executable`, then `PDF_BROWSER`, then
- * `CHROME_PATH`, then the install folders and the `PATH`. It gives `undefined` when it finds none.
- */
-export function findBrowser(options = {}) {
-    if (options.executable !== undefined && options.executable.length > 0)
-        return options.executable;
-    const env = options.env ?? process.env;
-    for (const name of [BROWSER_ENV, CHROME_PATH_ENV]) {
-        const value = env[name];
-        if (value !== undefined && value.length > 0)
-            return value;
-    }
-    const exists = options.exists ?? existsSync;
-    return browserCandidates(options.platform ?? process.platform, env).find((candidate) => exists(candidate));
-}
-//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAEzC,2FAA2F;AAC3F,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC;AAEzC,8FAA8F;AAC9F,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAC;AAE7C,2EAA2E;AAC3E,MAAM,CAAC,MAAM,aAAa,GAAsB;IAC9C,eAAe;IACf,sBAAsB;IACtB,UAAU;IACV,kBAAkB;IAClB,gBAAgB;IAChB,uBAAuB;CACxB,CAAC;AAEF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,qBAAqB,GAAsB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;AAcrF,+DAA+D;AAC/D,SAAS,WAAW,CAAC,GAAiD,EAAE,OAAgB;IACtF,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACnE,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAChF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAyB,EAAE,GAAiD;IAC5G,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QACzB,MAAM,YAAY,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,IAAI,mBAAmB,CAAC;QACvF,MAAM,eAAe,GAAG,GAAG,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,mBAAmB,CAAC,IAAI,yBAAyB,CAAC;QAC1G,MAAM,YAAY,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG;YAChB,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC;YAC7E,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,CAAC;YAC1E,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,CAAC;YACzE,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,CAAC;YAC5E,GAAG,CAAC,YAAY,KAAK,SAAS;gBAC5B,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;gBAChJ,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACzH,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG;YACd,gDAAgD;YAChD,kDAAkD;YAClD,sCAAsC;SACvC,CAAC;QACF,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;QACzB,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAChF,IAAI,IAAI,KAAK,SAAS;YAAE,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/G,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAClH,OAAO,CAAC,GAAG,SAAS,EAAE,GAAG,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,OAAO,GAAuB,EAAE;IAC1D,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC,UAAU,CAAC;IACjG,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IACvC,KAAK,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;IAC5D,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC;IAC5C,OAAO,iBAAiB,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;AAC7G,CAAC"}

package/dist/render.d.ts

@@ -1,52 +0,0 @@
-/**
- * HTML to PDF with a headless Chromium browser that is already installed.
- *
- * The browser starts with argv, not through a shell, through `runCommand` of
- * `@procedures/shell`. A time limit and the signal of the call stop its process tree.
- */
-import { type CommandOptions, type CommandResult } from "@procedures/shell/command";
-import { type FindBrowserOptions } from "./browser.js";
-/** The default time limit of one render, in milliseconds. */
-export declare const DEFAULT_TIMEOUT_MS = 60000;
-/** The function that runs a program. The default is `runCommand` of `@procedures/shell`. */
-export type CommandRunner = (command: string, options: CommandOptions) => Promise<CommandResult>;
-/** The options of `renderPdf`. Give `html` or `file`, not the two. */
-export interface RenderPdfOptions extends FindBrowserOptions {
-    /** The HTML text. The function writes it to a temporary file. */
-    readonly html?: string | undefined;
-    /** The path of an HTML file. */
-    readonly file?: string | undefined;
-    /** The path of the PDF file. The default is a file in a new temporary folder. */
-    readonly output?: string | undefined;
-    /** More flags for the browser, after the default flags. */
-    readonly args?: readonly string[] | undefined;
-    /** The time limit, in milliseconds (default: 60000). */
-    readonly timeout?: number | undefined;
-    /** When the signal aborts, the browser stops. */
-    readonly signal?: AbortSignal | undefined;
-    /** The function that runs the browser (default: `runCommand`). The tests give their own. */
-    readonly runner?: CommandRunner | undefined;
-}
-/** The result of `renderPdf`. */
-export interface RenderPdfResult {
-    /** The absolute path of the PDF file. */
-    readonly path: string;
-    /** The size of the PDF file, in bytes. */
-    readonly bytes: number;
-    /** The browser program that made the file. */
-    readonly browser: string;
-}
-/**
- * This function gives the argv of the browser. The argv has the flags of a headless print, the
- * profile folder, the extra flags and the address of the page.
- */
-export declare function pdfArgs(page: string, output: string, profile: string, extra?: readonly string[]): string[];
-/** This function tells if a file starts with the signature of a PDF file (`%PDF`). */
-export declare function isPdfFile(path: string): boolean;
-/**
- * This function prints an HTML page to a PDF file with a headless browser. It gives the path and
- * the size of the file. It throws when it finds no browser, at the time limit, and when the file
- * is not a PDF file.
- */
-export declare function renderPdf(options: RenderPdfOptions): Promise<RenderPdfResult>;
-//# sourceMappingURL=render.d.ts.map

package/dist/render.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,EAAc,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAChG,OAAO,EAA4B,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEjF,6DAA6D;AAC7D,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAEzC,4FAA4F;AAC5F,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;AAEjG,sEAAsE;AACtE,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D,iEAAiE;IACjE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,gCAAgC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,iFAAiF;IACjF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9C,wDAAwD;IACxD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iDAAiD;IACjD,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC1C,4FAA4F;IAC5F,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CAC7C;AAED,iCAAiC;AACjC,MAAM,WAAW,eAAe;IAC9B,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,SAAS,MAAM,EAAO,GAAG,MAAM,EAAE,CAW9G;AAED,sFAAsF;AACtF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAS/C;AAcD;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,CA2DnF"}

package/dist/render.js

@@ -1,125 +0,0 @@
-/**
- * HTML to PDF with a headless Chromium browser that is already installed.
- *
- * The browser starts with argv, not through a shell, through `runCommand` of
- * `@procedures/shell`. A time limit and the signal of the call stop its process tree.
- */
-import { closeSync, copyFileSync, mkdirSync, mkdtempSync, openSync, readSync, rmSync, statSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
-import { pathToFileURL } from "node:url";
-import { runCommand } from "@procedures/shell/command";
-import { BROWSER_ENV, findBrowser } from "./browser.js";
-/** The default time limit of one render, in milliseconds. */
-export const DEFAULT_TIMEOUT_MS = 60_000;
-/**
- * This function gives the argv of the browser. The argv has the flags of a headless print, the
- * profile folder, the extra flags and the address of the page.
- */
-export function pdfArgs(page, output, profile, extra = []) {
-    return [
-        "--headless",
-        "--disable-gpu",
-        "--no-pdf-header-footer",
-        // A separate profile keeps the print apart from a browser that the user has open
-        `--user-data-dir=${profile}`,
-        `--print-to-pdf=${output}`,
-        ...extra,
-        page,
-    ];
-}
-/** This function tells if a file starts with the signature of a PDF file (`%PDF`). */
-export function isPdfFile(path) {
-    const fd = openSync(path, "r");
-    try {
-        const head = Buffer.alloc(4);
-        const read = readSync(fd, head, 0, 4, 0);
-        return read === 4 && head.toString("latin1") === "%PDF";
-    }
-    finally {
-        closeSync(fd);
-    }
-}
-function fileSize(path) {
-    try {
-        return statSync(path).size;
-    }
-    catch {
-        return undefined;
-    }
-}
-function lastLines(text, count = 5) {
-    return text.trim().split(/\r?\n/).slice(-count).join("\n");
-}
-/**
- * This function prints an HTML page to a PDF file with a headless browser. It gives the path and
- * the size of the file. It throws when it finds no browser, at the time limit, and when the file
- * is not a PDF file.
- */
-export async function renderPdf(options) {
-    const hasHtml = options.html !== undefined;
-    const hasFile = options.file !== undefined;
-    if (hasHtml === hasFile)
-        throw new Error("renderPdf needs html or file, and not the two");
-    const browser = findBrowser(options);
-    if (browser === undefined) {
-        throw new Error(`No browser found. Install Microsoft Edge, Google Chrome or Chromium, or set ${BROWSER_ENV} to the browser program.`);
-    }
-    const work = mkdtempSync(join(tmpdir(), "procedures-pdf-"));
-    const profile = join(work, "profile");
-    const output = resolve(options.output ?? join(work, "page.pdf"));
-    // The browser prints into the temporary folder. The file replaces the output only after its
-    // check, so a failed render keeps an old output file (before, it was deleted: audit pass 2).
-    const printed = join(work, "page.pdf");
-    let made = false;
-    try {
-        let page;
-        if (options.html !== undefined) {
-            const htmlFile = join(work, "page.html");
-            writeFileSync(htmlFile, options.html, "utf8");
-            page = pathToFileURL(htmlFile).href;
-        }
-        else {
-            page = pathToFileURL(resolve(options.file)).href;
-        }
-        mkdirSync(dirname(output), { recursive: true });
-        const run = options.runner ?? runCommand;
-        const timeout = options.timeout ?? DEFAULT_TIMEOUT_MS;
-        const result = await run(browser, {
-            args: pdfArgs(page, printed, profile, options.args),
-            timeout,
-            signal: options.signal,
-            maxOutputBytes: 64 * 1024,
-            keep: "tail",
-        });
-        if (result.error !== undefined)
-            throw new Error(`The browser did not start: ${result.error}`);
-        if (result.timedOut === true)
-            throw new Error(`The browser did not finish in ${timeout} ms`);
-        if (result.aborted === true)
-            throw new Error("The render was cancelled");
-        const bytes = fileSize(printed);
-        if (bytes === undefined || bytes === 0) {
-            const detail = lastLines(result.stderr || result.stdout);
-            throw new Error(`The browser made no PDF file (exit code ${result.exitCode})${detail ? `: ${detail}` : ""}`);
-        }
-        if (!isPdfFile(printed))
-            throw new Error(`The file ${output} is not a PDF file`);
-        // The temporary folder goes in `finally`, so a copy is enough, also across two drives
-        if (printed !== output)
-            copyFileSync(printed, output);
-        made = true;
-        return { path: output, bytes, browser };
-    }
-    finally {
-        // The temporary page and profile go. A default output stays in its folder after a success.
-        if (made && options.output === undefined) {
-            rmSync(profile, { recursive: true, force: true, maxRetries: 3, retryDelay: 100 });
-            rmSync(join(work, "page.html"), { force: true });
-        }
-        else {
-            rmSync(work, { recursive: true, force: true, maxRetries: 3, retryDelay: 100 });
-        }
-    }
-}
-//# sourceMappingURL=render.js.map

package/dist/render.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"render.js","sourceRoot":"","sources":["../src/render.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC/H,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,UAAU,EAA2C,MAAM,2BAA2B,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,WAAW,EAA2B,MAAM,cAAc,CAAC;AAEjF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAiCzC;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,IAAY,EAAE,MAAc,EAAE,OAAe,EAAE,KAAK,GAAsB,EAAE;IAClG,OAAO;QACL,YAAY;QACZ,eAAe;QACf,wBAAwB;QACxB,iFAAiF;QACjF,mBAAmB,OAAO,EAAE;QAC5B,kBAAkB,MAAM,EAAE;QAC1B,GAAG,KAAK;QACR,IAAI;KACL,CAAC;AACJ,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC/B,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACzC,OAAO,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC;IAC1D,CAAC;YAAS,CAAC;QACT,SAAS,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC;QACH,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;IACxC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAyB;IACvD,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;IAC3C,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC;IAC3C,IAAI,OAAO,KAAK,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC1F,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,+EAA+E,WAAW,0BAA0B,CAAC,CAAC;IACxI,CAAC;IAED,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IACjE,4FAA4F;IAC5F,6FAA6F;IAC7F,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACvC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,IAAY,CAAC;QACjB,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACzC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9C,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACpD,CAAC;QACD,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEhD,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,EAAE;YAChC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC;YACnD,OAAO;YACP,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,EAAE,GAAG,IAAI;YACzB,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QACH,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAC9F,IAAI,MAAM,CAAC,QAAQ,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,OAAO,KAAK,CAAC,CAAC;QAC7F,IAAI,MAAM,CAAC,OAAO,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAEzE,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,IAAI,KAAK,CAAC,2CAA2C,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/G,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,YAAY,MAAM,oBAAoB,CAAC,CAAC;QACjF,sFAAsF;QACtF,IAAI,OAAO,KAAK,MAAM;YAAE,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtD,IAAI,GAAG,IAAI,CAAC;QACZ,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IAC1C,CAAC;YAAS,CAAC;QACT,2FAA2F;QAC3F,IAAI,IAAI,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;YAClF,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;AACH,CAAC"}

package/src/browser.ts

@@ -1,96 +0,0 @@
-/**
- * Find a Chromium browser that is already installed: Microsoft Edge, Google Chrome or Chromium.
- * The package does not download a browser.
- */
-
-import { existsSync } from "node:fs";
-import { posix, win32 } from "node:path";
-
-/** The environment variable that names the browser program. It comes before the search. */
-export const BROWSER_ENV = "PDF_BROWSER";
-
-/** The second environment variable for the browser program. Other tools use this name too. */
-export const CHROME_PATH_ENV = "CHROME_PATH";
-
-/** The program names that the search looks for on the `PATH`, in order. */
-export const BROWSER_NAMES: readonly string[] = [
-  "google-chrome",
-  "google-chrome-stable",
-  "chromium",
-  "chromium-browser",
-  "microsoft-edge",
-  "microsoft-edge-stable",
-];
-
-/** The program names on the `PATH` of Windows, in order. */
-export const WINDOWS_BROWSER_NAMES: readonly string[] = ["msedge.exe", "chrome.exe"];
-
-/** The options of `findBrowser`. Each one has a default from the host. */
-export interface FindBrowserOptions {
-  /** The browser program. When it is set, the search does not occur. */
-  readonly executable?: string | undefined;
-  /** The environment (default: `process.env`). */
-  readonly env?: Readonly<Record<string, string | undefined>> | undefined;
-  /** The operating system (default: `process.platform`). */
-  readonly platform?: NodeJS.Platform | undefined;
-  /** The function that tells if a file exists (default: `existsSync`). */
-  readonly exists?: ((path: string) => boolean) | undefined;
-}
-
-/** This function gives the folders of the `PATH`, in order. */
-function pathFolders(env: Readonly<Record<string, string | undefined>>, windows: boolean): string[] {
-  const value = windows ? (env["Path"] ?? env["PATH"]) : env["PATH"];
-  if (value === undefined) return [];
-  return value.split(windows ? ";" : ":").filter((folder) => folder.length > 0);
-}
-
-/**
- * This function gives the paths that the search examines on an operating system, in order. The
- * install folders come first, then the folders of the `PATH`.
- */
-export function browserCandidates(platform: NodeJS.Platform, env: Readonly<Record<string, string | undefined>>): string[] {
-  if (platform === "win32") {
-    const programFiles = env["ProgramFiles"] ?? env["PROGRAMFILES"] ?? "C:\\Program Files";
-    const programFilesX86 = env["ProgramFiles(x86)"] ?? env["PROGRAMFILES(X86)"] ?? "C:\\Program Files (x86)";
-    const localAppData = env["LOCALAPPDATA"];
-    const installed = [
-      win32.join(programFilesX86, "Microsoft", "Edge", "Application", "msedge.exe"),
-      win32.join(programFiles, "Microsoft", "Edge", "Application", "msedge.exe"),
-      win32.join(programFiles, "Google", "Chrome", "Application", "chrome.exe"),
-      win32.join(programFilesX86, "Google", "Chrome", "Application", "chrome.exe"),
-      ...(localAppData !== undefined
-        ? [win32.join(localAppData, "Google", "Chrome", "Application", "chrome.exe"), win32.join(localAppData, "Chromium", "Application", "chrome.exe")]
-        : []),
-    ];
-    const onPath = pathFolders(env, true).flatMap((folder) => WINDOWS_BROWSER_NAMES.map((name) => win32.join(folder, name)));
-    return [...installed, ...onPath];
-  }
-  const installed: string[] = [];
-  if (platform === "darwin") {
-    const bundles = [
-      "Google Chrome.app/Contents/MacOS/Google Chrome",
-      "Microsoft Edge.app/Contents/MacOS/Microsoft Edge",
-      "Chromium.app/Contents/MacOS/Chromium",
-    ];
-    const home = env["HOME"];
-    installed.push(...bundles.map((bundle) => posix.join("/Applications", bundle)));
-    if (home !== undefined) installed.push(...bundles.map((bundle) => posix.join(home, "Applications", bundle)));
-  }
-  const onPath = pathFolders(env, false).flatMap((folder) => BROWSER_NAMES.map((name) => posix.join(folder, name)));
-  return [...installed, ...onPath];
-}
-
-/**
- * This function finds the browser program. The order is `executable`, then `PDF_BROWSER`, then
- * `CHROME_PATH`, then the install folders and the `PATH`. It gives `undefined` when it finds none.
- */
-export function findBrowser(options: FindBrowserOptions = {}): string | undefined {
-  if (options.executable !== undefined && options.executable.length > 0) return options.executable;
-  const env = options.env ?? process.env;
-  for (const name of [BROWSER_ENV, CHROME_PATH_ENV]) {
-    const value = env[name];
-    if (value !== undefined && value.length > 0) return value;
-  }
-  const exists = options.exists ?? existsSync;
-  return browserCandidates(options.platform ?? process.platform, env).find((candidate) => exists(candidate));
-}

package/src/render.ts

@@ -1,154 +0,0 @@
-/**
- * HTML to PDF with a headless Chromium browser that is already installed.
- *
- * The browser starts with argv, not through a shell, through `runCommand` of
- * `@procedures/shell`. A time limit and the signal of the call stop its process tree.
- */
-
-import { closeSync, copyFileSync, mkdirSync, mkdtempSync, openSync, readSync, rmSync, statSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
-import { pathToFileURL } from "node:url";
-import { runCommand, type CommandOptions, type CommandResult } from "@procedures/shell/command";
-import { BROWSER_ENV, findBrowser, type FindBrowserOptions } from "./browser.js";
-
-/** The default time limit of one render, in milliseconds. */
-export const DEFAULT_TIMEOUT_MS = 60_000;
-
-/** The function that runs a program. The default is `runCommand` of `@procedures/shell`. */
-export type CommandRunner = (command: string, options: CommandOptions) => Promise<CommandResult>;
-
-/** The options of `renderPdf`. Give `html` or `file`, not the two. */
-export interface RenderPdfOptions extends FindBrowserOptions {
-  /** The HTML text. The function writes it to a temporary file. */
-  readonly html?: string | undefined;
-  /** The path of an HTML file. */
-  readonly file?: string | undefined;
-  /** The path of the PDF file. The default is a file in a new temporary folder. */
-  readonly output?: string | undefined;
-  /** More flags for the browser, after the default flags. */
-  readonly args?: readonly string[] | undefined;
-  /** The time limit, in milliseconds (default: 60000). */
-  readonly timeout?: number | undefined;
-  /** When the signal aborts, the browser stops. */
-  readonly signal?: AbortSignal | undefined;
-  /** The function that runs the browser (default: `runCommand`). The tests give their own. */
-  readonly runner?: CommandRunner | undefined;
-}
-
-/** The result of `renderPdf`. */
-export interface RenderPdfResult {
-  /** The absolute path of the PDF file. */
-  readonly path: string;
-  /** The size of the PDF file, in bytes. */
-  readonly bytes: number;
-  /** The browser program that made the file. */
-  readonly browser: string;
-}
-
-/**
- * This function gives the argv of the browser. The argv has the flags of a headless print, the
- * profile folder, the extra flags and the address of the page.
- */
-export function pdfArgs(page: string, output: string, profile: string, extra: readonly string[] = []): string[] {
-  return [
-    "--headless",
-    "--disable-gpu",
-    "--no-pdf-header-footer",
-    // A separate profile keeps the print apart from a browser that the user has open
-    `--user-data-dir=${profile}`,
-    `--print-to-pdf=${output}`,
-    ...extra,
-    page,
-  ];
-}
-
-/** This function tells if a file starts with the signature of a PDF file (`%PDF`). */
-export function isPdfFile(path: string): boolean {
-  const fd = openSync(path, "r");
-  try {
-    const head = Buffer.alloc(4);
-    const read = readSync(fd, head, 0, 4, 0);
-    return read === 4 && head.toString("latin1") === "%PDF";
-  } finally {
-    closeSync(fd);
-  }
-}
-
-function fileSize(path: string): number | undefined {
-  try {
-    return statSync(path).size;
-  } catch {
-    return undefined;
-  }
-}
-
-function lastLines(text: string, count = 5): string {
-  return text.trim().split(/\r?\n/).slice(-count).join("\n");
-}
-
-/**
- * This function prints an HTML page to a PDF file with a headless browser. It gives the path and
- * the size of the file. It throws when it finds no browser, at the time limit, and when the file
- * is not a PDF file.
- */
-export async function renderPdf(options: RenderPdfOptions): Promise<RenderPdfResult> {
-  const hasHtml = options.html !== undefined;
-  const hasFile = options.file !== undefined;
-  if (hasHtml === hasFile) throw new Error("renderPdf needs html or file, and not the two");
-  const browser = findBrowser(options);
-  if (browser === undefined) {
-    throw new Error(`No browser found. Install Microsoft Edge, Google Chrome or Chromium, or set ${BROWSER_ENV} to the browser program.`);
-  }
-
-  const work = mkdtempSync(join(tmpdir(), "procedures-pdf-"));
-  const profile = join(work, "profile");
-  const output = resolve(options.output ?? join(work, "page.pdf"));
-  // The browser prints into the temporary folder. The file replaces the output only after its
-  // check, so a failed render keeps an old output file (before, it was deleted: audit pass 2).
-  const printed = join(work, "page.pdf");
-  let made = false;
-  try {
-    let page: string;
-    if (options.html !== undefined) {
-      const htmlFile = join(work, "page.html");
-      writeFileSync(htmlFile, options.html, "utf8");
-      page = pathToFileURL(htmlFile).href;
-    } else {
-      page = pathToFileURL(resolve(options.file!)).href;
-    }
-    mkdirSync(dirname(output), { recursive: true });
-
-    const run = options.runner ?? runCommand;
-    const timeout = options.timeout ?? DEFAULT_TIMEOUT_MS;
-    const result = await run(browser, {
-      args: pdfArgs(page, printed, profile, options.args),
-      timeout,
-      signal: options.signal,
-      maxOutputBytes: 64 * 1024,
-      keep: "tail",
-    });
-    if (result.error !== undefined) throw new Error(`The browser did not start: ${result.error}`);
-    if (result.timedOut === true) throw new Error(`The browser did not finish in ${timeout} ms`);
-    if (result.aborted === true) throw new Error("The render was cancelled");
-
-    const bytes = fileSize(printed);
-    if (bytes === undefined || bytes === 0) {
-      const detail = lastLines(result.stderr || result.stdout);
-      throw new Error(`The browser made no PDF file (exit code ${result.exitCode})${detail ? `: ${detail}` : ""}`);
-    }
-    if (!isPdfFile(printed)) throw new Error(`The file ${output} is not a PDF file`);
-    // The temporary folder goes in `finally`, so a copy is enough, also across two drives
-    if (printed !== output) copyFileSync(printed, output);
-    made = true;
-    return { path: output, bytes, browser };
-  } finally {
-    // The temporary page and profile go. A default output stays in its folder after a success.
-    if (made && options.output === undefined) {
-      rmSync(profile, { recursive: true, force: true, maxRetries: 3, retryDelay: 100 });
-      rmSync(join(work, "page.html"), { force: true });
-    } else {
-      rmSync(work, { recursive: true, force: true, maxRetries: 3, retryDelay: 100 });
-    }
-  }
-}