@danielsimonjr/sciengjs 0.0.0-stage → 0.1.0

package/dist/worker/run.js

@@ -0,0 +1,90 @@
+import { Worker } from "node:worker_threads";
+import { extname } from "node:path";
+import { fileURLToPath } from "node:url";
+import { RenderError } from "../errors.js";
+/** The default longest wait for a worker to stop. It is the only place where this value is set. */
+const DEFAULT_TERMINATE_WAIT_MS = 5000;
+function createDefaultWorker(entry, data, maxMemoryMb) {
+    return new Worker(entry, {
+        workerData: data,
+        resourceLimits: { maxOldGenerationSizeMb: maxMemoryMb },
+    });
+}
+/** Terminates the worker. It rejects when terminate throws, rejects or does not resolve within the wait. */
+function stopWorker(worker, waitMs) {
+    let timer;
+    const bound = new Promise((_, reject) => {
+        timer = setTimeout(() => reject(new Error(`the worker did not stop within ${waitMs} ms`)), waitMs);
+    });
+    const stop = new Promise((resolve) => resolve(worker.terminate()));
+    return Promise.race([stop, bound]).finally(() => clearTimeout(timer));
+}
+function messageOf(err) {
+    return err instanceof Error ? err.message : String(err);
+}
+/**
+ * The entry file sits next to this module. Its extension follows this module:
+ * `.ts` under Bun tests, `.js` in the built package.
+ */
+function entryUrl() {
+    const here = fileURLToPath(import.meta.url);
+    return new URL(`./entry${extname(here)}`, import.meta.url);
+}
+/**
+ * Runs one render in a fresh worker. The worker ends at the first of: its message, its error,
+ * its exit, or the time limit. The promise settles only after the worker has exited.
+ *
+ * A heap exhaustion (`ERR_WORKER_OUT_OF_MEMORY`) maps to `E_LIMIT`. The design lists the heap
+ * limit as a resource limit of a source. A crash of any other kind maps to `E_INTERNAL`.
+ */
+export function runInWorker(job, limits) {
+    return new Promise((resolve, reject) => {
+        const create = limits.createWorker ?? createDefaultWorker;
+        const worker = create(entryUrl(), job, limits.maxMemoryMb);
+        const terminateWaitMs = limits.terminateWaitMs ?? DEFAULT_TERMINATE_WAIT_MS;
+        let settled = false;
+        let timer;
+        const settle = (action) => {
+            if (settled)
+                return;
+            settled = true;
+            if (timer !== undefined)
+                clearTimeout(timer);
+            stopWorker(worker, terminateWaitMs)
+                .then((exitCode) => {
+                limits.onWorkerExit?.({ exitCode });
+            })
+                .then(action, (err) => {
+                reject(new RenderError("E_INTERNAL", `render worker did not stop cleanly: ${messageOf(err)}`));
+            });
+        };
+        timer = setTimeout(() => {
+            settle(() => reject(new RenderError("E_TIMEOUT", `render did not finish within ${limits.timeoutMs} ms`)));
+        }, limits.timeoutMs);
+        worker.once("message", (msg) => {
+            settle(() => {
+                if (msg.ok) {
+                    resolve({ bytes: msg.bytes, warnings: msg.warnings });
+                }
+                else {
+                    const code = msg.code;
+                    reject(new RenderError(code, msg.message, { line: msg.line, column: msg.column }));
+                }
+            });
+        });
+        worker.once("error", (err) => {
+            settle(() => {
+                if (err.code === "ERR_WORKER_OUT_OF_MEMORY") {
+                    reject(new RenderError("E_LIMIT", `render exceeded the heap limit of ${limits.maxMemoryMb} MB`));
+                }
+                else {
+                    reject(new RenderError("E_INTERNAL", `render worker failed: ${err.message}`));
+                }
+            });
+        });
+        worker.once("exit", (code) => {
+            settle(() => reject(new RenderError("E_INTERNAL", `render worker exited with code ${code} before it returned`)));
+        });
+    });
+}
+//# sourceMappingURL=run.js.map

package/dist/worker/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/worker/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAyB3C,mGAAmG;AACnG,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAEvC,SAAS,mBAAmB,CAAC,KAAU,EAAE,IAAe,EAAE,WAAmB;IAC3E,OAAO,IAAI,MAAM,CAAC,KAAK,EAAE;QACvB,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,EAAE,sBAAsB,EAAE,WAAW,EAAE;KACxD,CAAC,CAAC;AACL,CAAC;AAED,4GAA4G;AAC5G,SAAS,UAAU,CAAC,MAAc,EAAE,MAAc;IAChD,IAAI,KAAgD,CAAC;IACrD,MAAM,KAAK,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC7C,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,kCAAkC,MAAM,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACrG,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAC3E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,SAAS,CAAC,GAAY;IAC7B,OAAO,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,SAAS,QAAQ;IACf,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,IAAI,GAAG,CAAC,UAAU,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,GAAc,EAAE,MAAoB;IAC9D,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,IAAI,mBAAmB,CAAC;QAC1D,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3D,MAAM,eAAe,GAAG,MAAM,CAAC,eAAe,IAAI,yBAAyB,CAAC;QAC5E,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,KAAgD,CAAC;QAErD,MAAM,MAAM,GAAG,CAAC,MAAkB,EAAQ,EAAE;YAC1C,IAAI,OAAO;gBAAE,OAAO;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,IAAI,KAAK,KAAK,SAAS;gBAAE,YAAY,CAAC,KAAK,CAAC,CAAC;YAC7C,UAAU,CAAC,MAAM,EAAE,eAAe,CAAC;iBAChC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,MAAM,CAAC,YAAY,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC;iBACD,IAAI,CAAC,MAAM,EAAE,CAAC,GAAY,EAAE,EAAE;gBAC7B,MAAM,CAAC,IAAI,WAAW,CAAC,YAAY,EAAE,uCAAuC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;YACjG,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YACtB,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,WAAW,EAAE,gCAAgC,MAAM,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5G,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAErB,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAkB,EAAE,EAAE;YAC5C,MAAM,CAAC,GAAG,EAAE;gBACV,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;oBACX,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACxD,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,GAAG,GAAG,CAAC,IAA2B,CAAC;oBAC7C,MAAM,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBACrF,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAA8B,EAAE,EAAE;YACtD,MAAM,CAAC,GAAG,EAAE;gBACV,IAAI,GAAG,CAAC,IAAI,KAAK,0BAA0B,EAAE,CAAC;oBAC5C,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,EAAE,qCAAqC,MAAM,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC;gBACnG,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,WAAW,CAAC,YAAY,EAAE,yBAAyB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAChF,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACnC,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,YAAY,EAAE,kCAAkC,IAAI,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,71 @@
-{
-  "name": "@danielsimonjr/sciengjs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@danielsimonjr/sciengjs",
+  "version": "0.1.0",
+  "private": false,
+  "description": "A local rendering engine for science and engineering diagrams, documents and models",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./graph": {
+      "types": "./dist/graph/index.d.ts",
+      "default": "./dist/graph/index.js"
+    },
+    "./raster": {
+      "types": "./dist/raster/index.d.ts",
+      "default": "./dist/raster/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "assets",
+    "THIRD_PARTY_NOTICES.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "bun test",
+    "smoke": "node test/smoke/smoke.mjs",
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "test:node": "node --test test/node/worker.node.mjs"
+  },
+  "keywords": [
+    "graphviz",
+    "mermaid",
+    "latex",
+    "tikz",
+    "svg",
+    "diagram",
+    "rendering"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/danielsimonjr/sciengjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/danielsimonjr/sciengjs/issues"
+  },
+  "homepage": "https://github.com/danielsimonjr/sciengjs#readme",
+  "engines": {
+    "node": ">=22"
+  },
+  "packageManager": "bun@1.4.4",
+  "devDependencies": {
+    "@types/bun": "^1.4.4",
+    "@types/node": "^22",
+    "typescript": "^7.0.2"
+  },
+  "dependencies": {
+    "@resvg/resvg-wasm": "2.6.2",
+    "@viz-js/viz": "3.31.0"
+  }
+}