@orkestrel/worker 0.0.1

package/dist/src/server/index.js

@@ -0,0 +1,354 @@
+import { Worker, parentPort } from "node:worker_threads";
+import { isRecord } from "@orkestrel/contract";
+import { createWorker } from "../core/index.js";
+import { createJSONDriver } from "@orkestrel/database/server";
+import { createDatabaseQueueStore } from "@orkestrel/queue";
+//#region src/server/helpers.ts
+/**
+* Spawn one worker thread and resolve a live {@link NodeThread} once it comes online.
+*
+* @remarks
+* Constructs the thread with the `script` module and the cloned `workerData`, then
+* resolves on the thread's `online` event (rejecting on an early `error` OR an `exit`
+* that arrives before `online`, so the spawn promise is total — it can never dangle on a
+* thread that died without erroring). The wrapper attaches persistent `error` / `exit`
+* listeners that flip `alive` to `false` AND latch the first terminal event on
+* {@link NodeThread.death}: a crash is observable to an in-flight {@link dispatch} (via
+* its own listeners), to the pool's `validate` (via `alive`), and — crucially — to a
+* dispatch that attaches AFTER the death (via the latch). The latch closes a real race:
+* under event-loop pressure a dead thread's `online` + `error` + `exit` are delivered in
+* ONE synchronous exit-drain batch, so every death event fires before the microtask chain
+* resolving this spawn can hand the thread to `dispatch` — without the latch that job
+* would await events that already fired, forever. The pool's `create` hook calls this.
+*
+* @param script - The worker module each thread runs (must call `serveWorker`)
+* @param workerData - Opaque, structured-cloneable data handed to the thread at spawn
+* @returns A promise resolving the online {@link NodeThread}
+*/
+function spawnThread(script, workerData) {
+	const worker = new Worker(script, { workerData });
+	const thread = {
+		worker,
+		alive: true,
+		death: void 0
+	};
+	worker.on("error", (error) => {
+		thread.alive = false;
+		if (thread.death === void 0) thread.death = error;
+	});
+	worker.on("exit", (code) => {
+		thread.alive = false;
+		if (thread.death === void 0) thread.death = /* @__PURE__ */ new Error(`worker thread exited (code ${code})`);
+	});
+	return new Promise((resolve, reject) => {
+		const onOnline = () => {
+			worker.off("error", onError);
+			worker.off("exit", onExit);
+			resolve(thread);
+		};
+		const onError = (error) => {
+			worker.off("online", onOnline);
+			worker.off("exit", onExit);
+			reject(error);
+		};
+		const onExit = (code) => {
+			worker.off("online", onOnline);
+			worker.off("error", onError);
+			reject(/* @__PURE__ */ new Error(`worker thread exited before coming online (code ${code})`));
+		};
+		worker.once("online", onOnline);
+		worker.once("error", onError);
+		worker.once("exit", onExit);
+	});
+}
+/**
+* Narrow an inbound `message` to a {@link Reply} for a given job `id` — no assertion.
+*
+* @remarks
+* A total {@link Guard}-style predicate (never throws): a record whose `id` matches and
+* whose `ok` discriminant is well-formed (a `true` carries any `value`; a `false` carries a
+* string `error`). Anything else — another job's reply, a malformed payload — is `false`, so
+* a {@link dispatch} listener ignores it (a thread that chatters on the channel can't corrupt
+* a job).
+*
+* @param value - The inbound message to narrow
+* @param id - The job id a matching reply must carry
+* @returns `true` (narrowing `value` to {@link Reply}) when it is this job's well-formed reply
+*/
+function isReply(value, id) {
+	if (!isRecord(value)) return false;
+	if (value.id !== id) return false;
+	if (value.ok === true) return true;
+	return value.ok === false && typeof value.error === "string";
+}
+/**
+* Dispatch one job to a leased {@link NodeThread} and await its narrowed reply.
+*
+* @remarks
+* Mints a fresh `id`, posts a `run` envelope, and resolves when the thread replies for
+* that id: a success `value` is narrowed through `result` (a value that fails the guard
+* rejects — the zero-`as` type bridge), a failure rejects with the thread's error string.
+* A thread that ALREADY died rejects synchronously at entry from the latched
+* {@link NodeThread.death} — its death events fired before this dispatch existed (under
+* load they arrive in one batched exit drain) and will never fire again, so waiting on
+* the listeners below would dangle forever; the latch makes the death total across every
+* event ordering. If the thread `error`s / `exit`s mid-flight it is marked dead and the
+* job rejects. On `execution.signal` abort it posts an `abort` envelope (cooperative) AND
+* evicts the thread — `alive = false` + `terminate()` — because CPU-bound work cannot
+* honour the signal; the freed pool slot then gets a fresh thread. Every listener (the
+* thread's `message` / `error` / `exit` and the signal's `abort`) is removed on settle,
+* and a `settled` guard prevents a double-settle.
+*
+* @typeParam TResult - The reply type the `result` guard narrows to
+* @param thread - The leased thread to run the job on
+* @param input - The work payload (structured-cloned to the thread)
+* @param execution - The per-attempt handle; its `signal` aborts → terminate + evict
+* @param result - The {@link Guard} narrowing the reply value with no assertion
+* @returns A promise resolving the narrowed `TResult`, or rejecting on error / abort
+*/
+function dispatch(thread, input, execution, result) {
+	const id = crypto.randomUUID();
+	const worker = thread.worker;
+	return new Promise((resolve, reject) => {
+		if (thread.death !== void 0 || !thread.alive) {
+			reject(thread.death ?? /* @__PURE__ */ new Error("worker thread is dead"));
+			return;
+		}
+		let settled = false;
+		let detach = () => {};
+		const settle = (action) => {
+			if (settled) return;
+			settled = true;
+			detach();
+			action();
+		};
+		const onMessage = (value) => {
+			if (!isReply(value, id)) return;
+			if (value.ok) {
+				const reply = value.value;
+				if (result(reply)) settle(() => resolve(reply));
+				else settle(() => reject(/* @__PURE__ */ new Error("reply did not satisfy result guard")));
+				return;
+			}
+			const message = value.error;
+			settle(() => reject(new Error(message)));
+		};
+		const onError = (error) => {
+			thread.alive = false;
+			settle(() => reject(error));
+		};
+		const onExit = () => {
+			thread.alive = false;
+			settle(() => reject(/* @__PURE__ */ new Error("worker thread exited")));
+		};
+		const onAbort = () => {
+			worker.postMessage({
+				id,
+				command: "abort"
+			});
+			thread.alive = false;
+			worker.terminate();
+			settle(() => reject(/* @__PURE__ */ new Error("job aborted")));
+		};
+		detach = () => {
+			worker.off("message", onMessage);
+			worker.off("error", onError);
+			worker.off("exit", onExit);
+			execution.signal.removeEventListener("abort", onAbort);
+		};
+		worker.on("message", onMessage);
+		worker.on("error", onError);
+		worker.on("exit", onExit);
+		if (execution.signal.aborted) {
+			onAbort();
+			return;
+		}
+		execution.signal.addEventListener("abort", onAbort, { once: true });
+		try {
+			worker.postMessage({
+				id,
+				command: "run",
+				input
+			});
+		} catch (error) {
+			settle(() => reject(error instanceof Error ? error : new Error(String(error))));
+		}
+	});
+}
+//#endregion
+//#region src/server/serve.ts
+function isRecord$1(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isRun(value) {
+	return isRecord$1(value) && typeof value.id === "string" && value.command === "run" && "input" in value;
+}
+function isAbort(value) {
+	return isRecord$1(value) && typeof value.id === "string" && value.command === "abort";
+}
+/**
+* Register a worker-thread handler — the worker-side half of {@link createNodeWorker}.
+*
+* @remarks
+* Must be the spawned thread's module entry. It listens on the parent port for the
+* run/abort protocol: a `run` message narrows its `input` through `options.input` (an
+* invalid payload replies with an error envelope, never running the handler), then runs
+* `options.handler(input, { signal })` and replies `{ id, ok: true, value }` on success or
+* `{ id, ok: false, error }` on throw. Each in-flight job has its own `AbortController`,
+* so an `abort` message for that id fires the handler's `signal` (cooperative — the main
+* side ALSO terminates the thread, so a handler that ignores its signal is still stopped).
+* Every inbound message is narrowed with the inlined guards — no `as`. On the main thread
+* (`parentPort === null`) it is a no-op.
+*
+* @typeParam TInput - The work payload (inferred from `options.input`)
+* @typeParam TResult - The value the handler resolves (the reply payload)
+* @param options - The `input` guard and the `handler` (see {@link ServeWorkerOptions})
+*
+* @example
+* ```ts
+* // double.ts — a worker script
+* import { serveWorker } from '@src/server'
+*
+* serveWorker<number, number>({
+* 	input: (value): value is number => typeof value === 'number',
+* 	handler: (value) => value * 2,
+* })
+* ```
+*/
+function serveWorker(options) {
+	const port = parentPort;
+	if (port === null) return;
+	const controllers = /* @__PURE__ */ new Map();
+	port.on("message", (raw) => {
+		if (isAbort(raw)) {
+			controllers.get(raw.id)?.abort();
+			return;
+		}
+		if (!isRun(raw)) return;
+		const id = raw.id;
+		if (!options.input(raw.input)) {
+			port.postMessage({
+				id,
+				ok: false,
+				error: "input did not satisfy input guard"
+			});
+			return;
+		}
+		const input = raw.input;
+		const controller = new AbortController();
+		controllers.set(id, controller);
+		Promise.resolve().then(() => options.handler(input, { signal: controller.signal })).then((value) => {
+			controllers.delete(id);
+			port.postMessage({
+				id,
+				ok: true,
+				value
+			});
+		}, (error) => {
+			controllers.delete(id);
+			port.postMessage({
+				id,
+				ok: false,
+				error: error instanceof Error ? error.message : String(error)
+			});
+		});
+	});
+}
+//#endregion
+//#region src/server/factories.ts
+/**
+* Create a persistent JSON-file {@link QueueStoreInterface} — the core
+* `createDatabaseQueueStore` over a server {@link createJSONDriver}.
+*
+* @remarks
+* A queue's durable state is just a database table, so JSON persistence reuses the
+* existing JSON-file driver rather than a bespoke store: the entries are written to
+* (and reloaded from) the file at `path`, surviving a process restart. There is no new
+* class — the store engine ({@link createDatabaseQueueStore}) is shared, and only the
+* driver changes where the bytes live. The `input` shape must be JSON-serializable
+* (the JSON driver round-trips it as JSON). Build a second store over the SAME `path` to
+* resume the outstanding entries a prior store persisted.
+*
+* @typeParam TInput - The contract shape of each entry's `input` payload
+* @param path - The JSON file the entries are loaded from and flushed to
+* @param input - The {@link ContractShape} for the work payload (the `input` column)
+* @returns A JSON-file-backed {@link QueueStoreInterface}, typed by `input`
+*
+* @example
+* ```ts
+* import { stringShape } from '@src/core'
+* import { createJSONQueueStore } from '@src/server'
+*
+* const store = createJSONQueueStore('data/queue.json', stringShape())
+* await store.save({ id: 'job-1', input: 'https://example.com', attempts: 0 })
+* // A later process resumes the outstanding work:
+* const resumed = createJSONQueueStore('data/queue.json', stringShape())
+* const outstanding = await resumed.load()
+* ```
+*/
+function createJSONQueueStore(path, input) {
+	return createDatabaseQueueStore(input, createJSONDriver(path));
+}
+/**
+* Create a CPU-parallel worker over `node:worker_threads` — a thin specialization of the
+* core `createWorker` whose pooled resource is a worker THREAD.
+*
+* @remarks
+* Composition, not reimplementation: all concurrency, retries, per-attempt timeout,
+* lifecycle, and durability are the core `Worker`'s (a `Queue` ⨉ `Pool`). This factory
+* supplies only the thread pairing — the pool `create`s a thread (via `spawnThread`),
+* `destroy`s it with `terminate()`, and `validate`s it by `alive && threadId > 0` (so an
+* evicted / crashed thread is dropped and replaced) — and an internal handler that
+* narrows the input through `options.input` (fail-fast before the structured-clone
+* boundary) then `dispatch`es the job to the leased thread, narrowing the reply through
+* `options.result`. Both generics INFER from the `input` / `result` guards, so call sites
+* need no explicit type arguments. The boundary is crossed with ZERO `as`: the guards
+* reconstruct `TInput` / `TResult` by validation (AGENTS §14). An `abort` / `timeout`
+* TERMINATES the in-flight thread (CPU-bound work can't honour a signal) and evicts it; a
+* subsequent job spawns a fresh thread. The worker script's module must call
+* `serveWorker`. Returns the plain {@link WorkerInterface} — its methods are the Worker's.
+*
+* @typeParam TInput - The work payload each job carries (inferred from `input`)
+* @typeParam TResult - The value a thread resolves for a job (inferred from `result`)
+* @param options - The `script` plus the `input` / `result` guards and optional
+*   `workerData` / `concurrency` / `retries` / `timeout` / `store`
+*   (see {@link NodeWorkerOptions})
+* @returns A working {@link WorkerInterface} backed by a thread pool
+*
+* @example
+* ```ts
+* import { createNodeWorker } from '@src/server'
+*
+* const worker = createNodeWorker({
+* 	script: new URL('./double.js', import.meta.url),
+* 	input: (value): value is number => typeof value === 'number',
+* 	result: (value): value is number => typeof value === 'number',
+* 	concurrency: 4,
+* })
+*
+* const doubled = await worker.enqueue(21) // 42, computed on a worker thread
+* worker.destroy() // terminates every thread
+* ```
+*/
+function createNodeWorker(options) {
+	return createWorker({
+		pool: {
+			create: () => spawnThread(options.script, options.workerData),
+			destroy: (thread) => thread.worker.terminate().then(() => {}),
+			validate: (thread) => thread.alive && thread.worker.threadId > 0,
+			max: options.concurrency
+		},
+		handler: (input, thread, execution) => {
+			if (!options.input(input)) return Promise.reject(/* @__PURE__ */ new Error("input did not satisfy input guard"));
+			return dispatch(thread, input, execution, options.result);
+		},
+		concurrency: options.concurrency,
+		retries: options.retries,
+		timeout: options.timeout,
+		store: options.store
+	});
+}
+//#endregion
+export { createJSONQueueStore, createNodeWorker, dispatch, isReply, serveWorker, spawnThread };
+
+//# sourceMappingURL=index.js.map

package/dist/src/server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/server/helpers.ts","../../../src/server/serve.ts","../../../src/server/factories.ts"],"sourcesContent":["import type { QueueExecution } from '@orkestrel/queue'\nimport type { Guard, NodeThread, Reply } from './types.js'\nimport { Worker as ThreadWorker } from 'node:worker_threads'\nimport { isRecord } from '@orkestrel/contract'\n\n// === The wire protocol (main ↔ thread)\n//\n// The main-side half of the run/abort/reply protocol `serveWorker` answers — spawning a\n// pooled thread, narrowing its replies, and dispatching one job at a time. The envelope\n// types ({@link Reply}, {@link NodeThread}) live in `./types.js` (AGENTS §5); the public\n// bridge across the structured-clone boundary is the `input` / `result` `Guard`s, which\n// narrow the envelopes' opaque `unknown` payloads with no assertion (AGENTS §14).\n\n/**\n * Spawn one worker thread and resolve a live {@link NodeThread} once it comes online.\n *\n * @remarks\n * Constructs the thread with the `script` module and the cloned `workerData`, then\n * resolves on the thread's `online` event (rejecting on an early `error` OR an `exit`\n * that arrives before `online`, so the spawn promise is total — it can never dangle on a\n * thread that died without erroring). The wrapper attaches persistent `error` / `exit`\n * listeners that flip `alive` to `false` AND latch the first terminal event on\n * {@link NodeThread.death}: a crash is observable to an in-flight {@link dispatch} (via\n * its own listeners), to the pool's `validate` (via `alive`), and — crucially — to a\n * dispatch that attaches AFTER the death (via the latch). The latch closes a real race:\n * under event-loop pressure a dead thread's `online` + `error` + `exit` are delivered in\n * ONE synchronous exit-drain batch, so every death event fires before the microtask chain\n * resolving this spawn can hand the thread to `dispatch` — without the latch that job\n * would await events that already fired, forever. The pool's `create` hook calls this.\n *\n * @param script - The worker module each thread runs (must call `serveWorker`)\n * @param workerData - Opaque, structured-cloneable data handed to the thread at spawn\n * @returns A promise resolving the online {@link NodeThread}\n */\nexport function spawnThread(script: string | URL, workerData: unknown): Promise<NodeThread> {\n\tconst worker = new ThreadWorker(script, { workerData })\n\tconst thread: NodeThread = { worker, alive: true, death: undefined }\n\t// The persistent death latch — attached BEFORE any once-listener, so the first terminal\n\t// event records its cause on the record even when it fires inside a batched exit drain.\n\tworker.on('error', (error: Error) => {\n\t\tthread.alive = false\n\t\tif (thread.death === undefined) thread.death = error\n\t})\n\tworker.on('exit', (code: number) => {\n\t\tthread.alive = false\n\t\tif (thread.death === undefined) thread.death = new Error(`worker thread exited (code ${code})`)\n\t})\n\treturn new Promise<NodeThread>((resolve, reject) => {\n\t\tconst onOnline = (): void => {\n\t\t\tworker.off('error', onError)\n\t\t\tworker.off('exit', onExit)\n\t\t\tresolve(thread)\n\t\t}\n\t\tconst onError = (error: Error): void => {\n\t\t\tworker.off('online', onOnline)\n\t\t\tworker.off('exit', onExit)\n\t\t\treject(error)\n\t\t}\n\t\tconst onExit = (code: number): void => {\n\t\t\tworker.off('online', onOnline)\n\t\t\tworker.off('error', onError)\n\t\t\treject(new Error(`worker thread exited before coming online (code ${code})`))\n\t\t}\n\t\tworker.once('online', onOnline)\n\t\tworker.once('error', onError)\n\t\tworker.once('exit', onExit)\n\t})\n}\n\n/**\n * Narrow an inbound `message` to a {@link Reply} for a given job `id` — no assertion.\n *\n * @remarks\n * A total {@link Guard}-style predicate (never throws): a record whose `id` matches and\n * whose `ok` discriminant is well-formed (a `true` carries any `value`; a `false` carries a\n * string `error`). Anything else — another job's reply, a malformed payload — is `false`, so\n * a {@link dispatch} listener ignores it (a thread that chatters on the channel can't corrupt\n * a job).\n *\n * @param value - The inbound message to narrow\n * @param id - The job id a matching reply must carry\n * @returns `true` (narrowing `value` to {@link Reply}) when it is this job's well-formed reply\n */\nexport function isReply(value: unknown, id: string): value is Reply {\n\tif (!isRecord(value)) return false\n\tif (value.id !== id) return false\n\tif (value.ok === true) return true\n\treturn value.ok === false && typeof value.error === 'string'\n}\n\n/**\n * Dispatch one job to a leased {@link NodeThread} and await its narrowed reply.\n *\n * @remarks\n * Mints a fresh `id`, posts a `run` envelope, and resolves when the thread replies for\n * that id: a success `value` is narrowed through `result` (a value that fails the guard\n * rejects — the zero-`as` type bridge), a failure rejects with the thread's error string.\n * A thread that ALREADY died rejects synchronously at entry from the latched\n * {@link NodeThread.death} — its death events fired before this dispatch existed (under\n * load they arrive in one batched exit drain) and will never fire again, so waiting on\n * the listeners below would dangle forever; the latch makes the death total across every\n * event ordering. If the thread `error`s / `exit`s mid-flight it is marked dead and the\n * job rejects. On `execution.signal` abort it posts an `abort` envelope (cooperative) AND\n * evicts the thread — `alive = false` + `terminate()` — because CPU-bound work cannot\n * honour the signal; the freed pool slot then gets a fresh thread. Every listener (the\n * thread's `message` / `error` / `exit` and the signal's `abort`) is removed on settle,\n * and a `settled` guard prevents a double-settle.\n *\n * @typeParam TResult - The reply type the `result` guard narrows to\n * @param thread - The leased thread to run the job on\n * @param input - The work payload (structured-cloned to the thread)\n * @param execution - The per-attempt handle; its `signal` aborts → terminate + evict\n * @param result - The {@link Guard} narrowing the reply value with no assertion\n * @returns A promise resolving the narrowed `TResult`, or rejecting on error / abort\n */\nexport function dispatch<TResult>(\n\tthread: NodeThread,\n\tinput: unknown,\n\texecution: QueueExecution,\n\tresult: Guard<TResult>,\n): Promise<TResult> {\n\tconst id = crypto.randomUUID()\n\tconst worker = thread.worker\n\treturn new Promise<TResult>((resolve, reject) => {\n\t\t// The latched-death entry check: a thread that died BEFORE this dispatch attached has\n\t\t// already emitted its `error` / `exit` (a batched exit drain delivers them before this\n\t\t// microtask runs) — no listener below will ever fire, and a `postMessage` to it is a\n\t\t// silent no-op. Reject NOW from the latch; this check + the attaches are synchronous,\n\t\t// so there is no gap a death can slip through.\n\t\tif (thread.death !== undefined || !thread.alive) {\n\t\t\treject(thread.death ?? new Error('worker thread is dead'))\n\t\t\treturn\n\t\t}\n\t\tlet settled = false\n\t\tlet detach = (): void => {}\n\t\tconst settle = (action: () => void): void => {\n\t\t\tif (settled) return\n\t\t\tsettled = true\n\t\t\tdetach()\n\t\t\taction()\n\t\t}\n\t\tconst onMessage = (value: unknown): void => {\n\t\t\tif (!isReply(value, id)) return\n\t\t\tif (value.ok) {\n\t\t\t\tconst reply = value.value\n\t\t\t\tif (result(reply)) settle(() => resolve(reply))\n\t\t\t\telse settle(() => reject(new Error('reply did not satisfy result guard')))\n\t\t\t\treturn\n\t\t\t}\n\t\t\tconst message = value.error\n\t\t\tsettle(() => reject(new Error(message)))\n\t\t}\n\t\tconst onError = (error: Error): void => {\n\t\t\tthread.alive = false\n\t\t\tsettle(() => reject(error))\n\t\t}\n\t\tconst onExit = (): void => {\n\t\t\tthread.alive = false\n\t\t\tsettle(() => reject(new Error('worker thread exited')))\n\t\t}\n\t\t// Cooperative abort first, then EVICT: CPU-bound work won't honour the signal, so\n\t\t// terminate the thread and mark it dead — the pool replaces it on the next acquire.\n\t\t// NOTE: this `terminate()` may run TWICE — once here, and again when the pool's\n\t\t// `destroy` hook (`thread.worker.terminate()`) tears down the now-dead thread its\n\t\t// `validate` evicts. A second `terminate()` on an already-terminated Node thread is a\n\t\t// safe, idempotent no-op (it resolves with the prior exit code), so do NOT \"dedupe\" it\n\t\t// by gating on `alive` — that would skip the pool's eviction and reuse a tainted thread.\n\t\tconst onAbort = (): void => {\n\t\t\tworker.postMessage({ id, command: 'abort' })\n\t\t\tthread.alive = false\n\t\t\tvoid worker.terminate()\n\t\t\tsettle(() => reject(new Error('job aborted')))\n\t\t}\n\t\tdetach = (): void => {\n\t\t\tworker.off('message', onMessage)\n\t\t\tworker.off('error', onError)\n\t\t\tworker.off('exit', onExit)\n\t\t\texecution.signal.removeEventListener('abort', onAbort)\n\t\t}\n\t\tworker.on('message', onMessage)\n\t\tworker.on('error', onError)\n\t\tworker.on('exit', onExit)\n\t\tif (execution.signal.aborted) {\n\t\t\tonAbort()\n\t\t\treturn\n\t\t}\n\t\texecution.signal.addEventListener('abort', onAbort, { once: true })\n\t\t// `postMessage` structured-clones `input`; a non-cloneable payload throws here —\n\t\t// settle-reject so the listeners detach (no leak) rather than escaping the executor.\n\t\ttry {\n\t\t\tworker.postMessage({ id, command: 'run', input })\n\t\t} catch (error: unknown) {\n\t\t\tsettle(() => reject(error instanceof Error ? error : new Error(String(error))))\n\t\t}\n\t})\n}\n","import type { ServeWorkerOptions } from './types.js'\nimport { parentPort } from 'node:worker_threads'\n\n// The worker-side entry. SELF-CONTAINED by necessity: this module loads as RAW `.ts`\n// inside a spawned thread (Node ≥ 23.6 type-stripping), so it imports ONLY\n// `node:worker_threads` at runtime — no `@src/*`, no `.js`-relative value imports (the\n// only non-node import is the type-only `ServeWorkerOptions`, fully erased at runtime).\n// Its guards are inlined for the same reason. A worker script that needs the cloned\n// `workerData` reads it directly from `node:worker_threads` (it is in a thread already).\n\n// Inlined record guard (do NOT import `isRecord` from `@src/core` — see above). Total:\n// adversarial input returns `false`, never throws (AGENTS §14).\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n\treturn typeof value === 'object' && value !== null && !Array.isArray(value)\n}\n\n// Narrow an inbound message to a `run` envelope (a string `id` + a `'run'` command + an\n// `input` payload) — no assertion.\nfunction isRun(value: unknown): value is { readonly id: string; readonly input: unknown } {\n\treturn (\n\t\tisRecord(value) && typeof value.id === 'string' && value.command === 'run' && 'input' in value\n\t)\n}\n\n// Narrow an inbound message to an `abort` envelope (a string `id` + an `'abort'` command).\nfunction isAbort(value: unknown): value is { readonly id: string } {\n\treturn isRecord(value) && typeof value.id === 'string' && value.command === 'abort'\n}\n\n/**\n * Register a worker-thread handler — the worker-side half of {@link createNodeWorker}.\n *\n * @remarks\n * Must be the spawned thread's module entry. It listens on the parent port for the\n * run/abort protocol: a `run` message narrows its `input` through `options.input` (an\n * invalid payload replies with an error envelope, never running the handler), then runs\n * `options.handler(input, { signal })` and replies `{ id, ok: true, value }` on success or\n * `{ id, ok: false, error }` on throw. Each in-flight job has its own `AbortController`,\n * so an `abort` message for that id fires the handler's `signal` (cooperative — the main\n * side ALSO terminates the thread, so a handler that ignores its signal is still stopped).\n * Every inbound message is narrowed with the inlined guards — no `as`. On the main thread\n * (`parentPort === null`) it is a no-op.\n *\n * @typeParam TInput - The work payload (inferred from `options.input`)\n * @typeParam TResult - The value the handler resolves (the reply payload)\n * @param options - The `input` guard and the `handler` (see {@link ServeWorkerOptions})\n *\n * @example\n * ```ts\n * // double.ts — a worker script\n * import { serveWorker } from '@src/server'\n *\n * serveWorker<number, number>({\n * \tinput: (value): value is number => typeof value === 'number',\n * \thandler: (value) => value * 2,\n * })\n * ```\n */\nexport function serveWorker<TInput, TResult>(options: ServeWorkerOptions<TInput, TResult>): void {\n\tconst port = parentPort\n\tif (port === null) return\n\tconst controllers = new Map<string, AbortController>()\n\tport.on('message', (raw: unknown) => {\n\t\tif (isAbort(raw)) {\n\t\t\tcontrollers.get(raw.id)?.abort()\n\t\t\treturn\n\t\t}\n\t\tif (!isRun(raw)) return\n\t\tconst id = raw.id\n\t\tif (!options.input(raw.input)) {\n\t\t\tport.postMessage({ id, ok: false, error: 'input did not satisfy input guard' })\n\t\t\treturn\n\t\t}\n\t\tconst input = raw.input\n\t\tconst controller = new AbortController()\n\t\tcontrollers.set(id, controller)\n\t\t// Defer the handler call into the `then` so a SYNCHRONOUS throw becomes a rejection\n\t\t// (not an uncaught thread exception) and is reported as an error reply.\n\t\tPromise.resolve()\n\t\t\t.then(() => options.handler(input, { signal: controller.signal }))\n\t\t\t.then(\n\t\t\t\t(value) => {\n\t\t\t\t\tcontrollers.delete(id)\n\t\t\t\t\tport.postMessage({ id, ok: true, value })\n\t\t\t\t},\n\t\t\t\t(error: unknown) => {\n\t\t\t\t\tcontrollers.delete(id)\n\t\t\t\t\tport.postMessage({\n\t\t\t\t\t\tid,\n\t\t\t\t\t\tok: false,\n\t\t\t\t\t\terror: error instanceof Error ? error.message : String(error),\n\t\t\t\t\t})\n\t\t\t\t},\n\t\t\t)\n\t})\n}\n","import type { WorkerInterface } from '@src/core'\nimport type { ContractShape, Infer } from '@orkestrel/contract'\nimport type { QueueStoreInterface } from '@orkestrel/queue'\nimport type { NodeThread, NodeWorkerOptions } from './types.js'\nimport { createWorker } from '@src/core'\nimport { createJSONDriver } from '@orkestrel/database/server'\nimport { createDatabaseQueueStore } from '@orkestrel/queue'\nimport { dispatch, spawnThread } from './helpers.js'\n\n/**\n * Create a persistent JSON-file {@link QueueStoreInterface} — the core\n * `createDatabaseQueueStore` over a server {@link createJSONDriver}.\n *\n * @remarks\n * A queue's durable state is just a database table, so JSON persistence reuses the\n * existing JSON-file driver rather than a bespoke store: the entries are written to\n * (and reloaded from) the file at `path`, surviving a process restart. There is no new\n * class — the store engine ({@link createDatabaseQueueStore}) is shared, and only the\n * driver changes where the bytes live. The `input` shape must be JSON-serializable\n * (the JSON driver round-trips it as JSON). Build a second store over the SAME `path` to\n * resume the outstanding entries a prior store persisted.\n *\n * @typeParam TInput - The contract shape of each entry's `input` payload\n * @param path - The JSON file the entries are loaded from and flushed to\n * @param input - The {@link ContractShape} for the work payload (the `input` column)\n * @returns A JSON-file-backed {@link QueueStoreInterface}, typed by `input`\n *\n * @example\n * ```ts\n * import { stringShape } from '@src/core'\n * import { createJSONQueueStore } from '@src/server'\n *\n * const store = createJSONQueueStore('data/queue.json', stringShape())\n * await store.save({ id: 'job-1', input: 'https://example.com', attempts: 0 })\n * // A later process resumes the outstanding work:\n * const resumed = createJSONQueueStore('data/queue.json', stringShape())\n * const outstanding = await resumed.load()\n * ```\n */\nexport function createJSONQueueStore<TInput extends ContractShape>(\n\tpath: string,\n\tinput: TInput,\n): QueueStoreInterface<Infer<TInput>> {\n\treturn createDatabaseQueueStore(input, createJSONDriver(path))\n}\n\n/**\n * Create a CPU-parallel worker over `node:worker_threads` — a thin specialization of the\n * core `createWorker` whose pooled resource is a worker THREAD.\n *\n * @remarks\n * Composition, not reimplementation: all concurrency, retries, per-attempt timeout,\n * lifecycle, and durability are the core `Worker`'s (a `Queue` ⨉ `Pool`). This factory\n * supplies only the thread pairing — the pool `create`s a thread (via `spawnThread`),\n * `destroy`s it with `terminate()`, and `validate`s it by `alive && threadId > 0` (so an\n * evicted / crashed thread is dropped and replaced) — and an internal handler that\n * narrows the input through `options.input` (fail-fast before the structured-clone\n * boundary) then `dispatch`es the job to the leased thread, narrowing the reply through\n * `options.result`. Both generics INFER from the `input` / `result` guards, so call sites\n * need no explicit type arguments. The boundary is crossed with ZERO `as`: the guards\n * reconstruct `TInput` / `TResult` by validation (AGENTS §14). An `abort` / `timeout`\n * TERMINATES the in-flight thread (CPU-bound work can't honour a signal) and evicts it; a\n * subsequent job spawns a fresh thread. The worker script's module must call\n * `serveWorker`. Returns the plain {@link WorkerInterface} — its methods are the Worker's.\n *\n * @typeParam TInput - The work payload each job carries (inferred from `input`)\n * @typeParam TResult - The value a thread resolves for a job (inferred from `result`)\n * @param options - The `script` plus the `input` / `result` guards and optional\n *   `workerData` / `concurrency` / `retries` / `timeout` / `store`\n *   (see {@link NodeWorkerOptions})\n * @returns A working {@link WorkerInterface} backed by a thread pool\n *\n * @example\n * ```ts\n * import { createNodeWorker } from '@src/server'\n *\n * const worker = createNodeWorker({\n * \tscript: new URL('./double.js', import.meta.url),\n * \tinput: (value): value is number => typeof value === 'number',\n * \tresult: (value): value is number => typeof value === 'number',\n * \tconcurrency: 4,\n * })\n *\n * const doubled = await worker.enqueue(21) // 42, computed on a worker thread\n * worker.destroy() // terminates every thread\n * ```\n */\nexport function createNodeWorker<TInput, TResult>(\n\toptions: NodeWorkerOptions<TInput, TResult>,\n): WorkerInterface<TInput, TResult> {\n\treturn createWorker<TInput, NodeThread, TResult>({\n\t\tpool: {\n\t\t\tcreate: () => spawnThread(options.script, options.workerData),\n\t\t\tdestroy: (thread) => thread.worker.terminate().then(() => {}),\n\t\t\tvalidate: (thread) => thread.alive && thread.worker.threadId > 0,\n\t\t\tmax: options.concurrency,\n\t\t},\n\t\thandler: (input, thread, execution) => {\n\t\t\tif (!options.input(input)) {\n\t\t\t\treturn Promise.reject(new Error('input did not satisfy input guard'))\n\t\t\t}\n\t\t\treturn dispatch(thread, input, execution, options.result)\n\t\t},\n\t\tconcurrency: options.concurrency,\n\t\tretries: options.retries,\n\t\ttimeout: options.timeout,\n\t\tstore: options.store,\n\t})\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,SAAgB,YAAY,QAAsB,YAA0C;CAC3F,MAAM,SAAS,IAAI,OAAa,QAAQ,EAAE,WAAW,CAAC;CACtD,MAAM,SAAqB;EAAE;EAAQ,OAAO;EAAM,OAAO,KAAA;CAAU;CAGnE,OAAO,GAAG,UAAU,UAAiB;EACpC,OAAO,QAAQ;EACf,IAAI,OAAO,UAAU,KAAA,GAAW,OAAO,QAAQ;CAChD,CAAC;CACD,OAAO,GAAG,SAAS,SAAiB;EACnC,OAAO,QAAQ;EACf,IAAI,OAAO,UAAU,KAAA,GAAW,OAAO,wBAAQ,IAAI,MAAM,8BAA8B,KAAK,EAAE;CAC/F,CAAC;CACD,OAAO,IAAI,SAAqB,SAAS,WAAW;EACnD,MAAM,iBAAuB;GAC5B,OAAO,IAAI,SAAS,OAAO;GAC3B,OAAO,IAAI,QAAQ,MAAM;GACzB,QAAQ,MAAM;EACf;EACA,MAAM,WAAW,UAAuB;GACvC,OAAO,IAAI,UAAU,QAAQ;GAC7B,OAAO,IAAI,QAAQ,MAAM;GACzB,OAAO,KAAK;EACb;EACA,MAAM,UAAU,SAAuB;GACtC,OAAO,IAAI,UAAU,QAAQ;GAC7B,OAAO,IAAI,SAAS,OAAO;GAC3B,uBAAO,IAAI,MAAM,mDAAmD,KAAK,EAAE,CAAC;EAC7E;EACA,OAAO,KAAK,UAAU,QAAQ;EAC9B,OAAO,KAAK,SAAS,OAAO;EAC5B,OAAO,KAAK,QAAQ,MAAM;CAC3B,CAAC;AACF;;;;;;;;;;;;;;;AAgBA,SAAgB,QAAQ,OAAgB,IAA4B;CACnE,IAAI,CAAC,SAAS,KAAK,GAAG,OAAO;CAC7B,IAAI,MAAM,OAAO,IAAI,OAAO;CAC5B,IAAI,MAAM,OAAO,MAAM,OAAO;CAC9B,OAAO,MAAM,OAAO,SAAS,OAAO,MAAM,UAAU;AACrD;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,SAAgB,SACf,QACA,OACA,WACA,QACmB;CACnB,MAAM,KAAK,OAAO,WAAW;CAC7B,MAAM,SAAS,OAAO;CACtB,OAAO,IAAI,SAAkB,SAAS,WAAW;EAMhD,IAAI,OAAO,UAAU,KAAA,KAAa,CAAC,OAAO,OAAO;GAChD,OAAO,OAAO,yBAAS,IAAI,MAAM,uBAAuB,CAAC;GACzD;EACD;EACA,IAAI,UAAU;EACd,IAAI,eAAqB,CAAC;EAC1B,MAAM,UAAU,WAA6B;GAC5C,IAAI,SAAS;GACb,UAAU;GACV,OAAO;GACP,OAAO;EACR;EACA,MAAM,aAAa,UAAyB;GAC3C,IAAI,CAAC,QAAQ,OAAO,EAAE,GAAG;GACzB,IAAI,MAAM,IAAI;IACb,MAAM,QAAQ,MAAM;IACpB,IAAI,OAAO,KAAK,GAAG,aAAa,QAAQ,KAAK,CAAC;SACzC,aAAa,uBAAO,IAAI,MAAM,oCAAoC,CAAC,CAAC;IACzE;GACD;GACA,MAAM,UAAU,MAAM;GACtB,aAAa,OAAO,IAAI,MAAM,OAAO,CAAC,CAAC;EACxC;EACA,MAAM,WAAW,UAAuB;GACvC,OAAO,QAAQ;GACf,aAAa,OAAO,KAAK,CAAC;EAC3B;EACA,MAAM,eAAqB;GAC1B,OAAO,QAAQ;GACf,aAAa,uBAAO,IAAI,MAAM,sBAAsB,CAAC,CAAC;EACvD;EAQA,MAAM,gBAAsB;GAC3B,OAAO,YAAY;IAAE;IAAI,SAAS;GAAQ,CAAC;GAC3C,OAAO,QAAQ;GACf,OAAY,UAAU;GACtB,aAAa,uBAAO,IAAI,MAAM,aAAa,CAAC,CAAC;EAC9C;EACA,eAAqB;GACpB,OAAO,IAAI,WAAW,SAAS;GAC/B,OAAO,IAAI,SAAS,OAAO;GAC3B,OAAO,IAAI,QAAQ,MAAM;GACzB,UAAU,OAAO,oBAAoB,SAAS,OAAO;EACtD;EACA,OAAO,GAAG,WAAW,SAAS;EAC9B,OAAO,GAAG,SAAS,OAAO;EAC1B,OAAO,GAAG,QAAQ,MAAM;EACxB,IAAI,UAAU,OAAO,SAAS;GAC7B,QAAQ;GACR;EACD;EACA,UAAU,OAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EAGlE,IAAI;GACH,OAAO,YAAY;IAAE;IAAI,SAAS;IAAO;GAAM,CAAC;EACjD,SAAS,OAAgB;GACxB,aAAa,OAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC,CAAC,CAAC;EAC/E;CACD,CAAC;AACF;;;ACvLA,SAAS,WAAS,OAAkD;CACnE,OAAO,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC3E;AAIA,SAAS,MAAM,OAA2E;CACzF,OACC,WAAS,KAAK,KAAK,OAAO,MAAM,OAAO,YAAY,MAAM,YAAY,SAAS,WAAW;AAE3F;AAGA,SAAS,QAAQ,OAAkD;CAClE,OAAO,WAAS,KAAK,KAAK,OAAO,MAAM,OAAO,YAAY,MAAM,YAAY;AAC7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,SAAgB,YAA6B,SAAoD;CAChG,MAAM,OAAO;CACb,IAAI,SAAS,MAAM;CACnB,MAAM,8BAAc,IAAI,IAA6B;CACrD,KAAK,GAAG,YAAY,QAAiB;EACpC,IAAI,QAAQ,GAAG,GAAG;GACjB,YAAY,IAAI,IAAI,EAAE,CAAC,EAAE,MAAM;GAC/B;EACD;EACA,IAAI,CAAC,MAAM,GAAG,GAAG;EACjB,MAAM,KAAK,IAAI;EACf,IAAI,CAAC,QAAQ,MAAM,IAAI,KAAK,GAAG;GAC9B,KAAK,YAAY;IAAE;IAAI,IAAI;IAAO,OAAO;GAAoC,CAAC;GAC9E;EACD;EACA,MAAM,QAAQ,IAAI;EAClB,MAAM,aAAa,IAAI,gBAAgB;EACvC,YAAY,IAAI,IAAI,UAAU;EAG9B,QAAQ,QAAQ,CAAC,CACf,WAAW,QAAQ,QAAQ,OAAO,EAAE,QAAQ,WAAW,OAAO,CAAC,CAAC,CAAC,CACjE,MACC,UAAU;GACV,YAAY,OAAO,EAAE;GACrB,KAAK,YAAY;IAAE;IAAI,IAAI;IAAM;GAAM,CAAC;EACzC,IACC,UAAmB;GACnB,YAAY,OAAO,EAAE;GACrB,KAAK,YAAY;IAChB;IACA,IAAI;IACJ,OAAO,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;GAC7D,CAAC;EACF,CACD;CACF,CAAC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACxDA,SAAgB,qBACf,MACA,OACqC;CACrC,OAAO,yBAAyB,OAAO,iBAAiB,IAAI,CAAC;AAC9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAAgB,iBACf,SACmC;CACnC,OAAO,aAA0C;EAChD,MAAM;GACL,cAAc,YAAY,QAAQ,QAAQ,QAAQ,UAAU;GAC5D,UAAU,WAAW,OAAO,OAAO,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC;GAC5D,WAAW,WAAW,OAAO,SAAS,OAAO,OAAO,WAAW;GAC/D,KAAK,QAAQ;EACd;EACA,UAAU,OAAO,QAAQ,cAAc;GACtC,IAAI,CAAC,QAAQ,MAAM,KAAK,GACvB,OAAO,QAAQ,uBAAO,IAAI,MAAM,mCAAmC,CAAC;GAErE,OAAO,SAAS,QAAQ,OAAO,WAAW,QAAQ,MAAM;EACzD;EACA,aAAa,QAAQ;EACrB,SAAS,QAAQ;EACjB,SAAS,QAAQ;EACjB,OAAO,QAAQ;CAChB,CAAC;AACF"}

package/package.json

@@ -0,0 +1,99 @@
+{
+	"name": "@orkestrel/worker",
+	"version": "0.0.1",
+	"description": "A typed, resource-backed job worker for the @orkestrel line — a Queue paired with a Pool over an execution seam, plus a node:worker_threads server surface for CPU-parallel jobs. Part of the @orkestrel line.",
+	"keywords": [
+		"async",
+		"concurrency",
+		"job-queue",
+		"pool",
+		"typescript",
+		"worker",
+		"worker-threads"
+	],
+	"homepage": "https://github.com/orkestrel/worker#readme",
+	"bugs": "https://github.com/orkestrel/worker/issues",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/orkestrel/worker.git"
+	},
+	"files": [
+		"dist",
+		"README.md"
+	],
+	"type": "module",
+	"sideEffects": false,
+	"main": "./dist/src/core/index.cjs",
+	"module": "./dist/src/core/index.js",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/src/core/index.d.ts",
+				"default": "./dist/src/core/index.js"
+			},
+			"require": {
+				"types": "./dist/src/core/index.d.cts",
+				"default": "./dist/src/core/index.cjs"
+			}
+		},
+		"./server": {
+			"import": {
+				"types": "./dist/src/server/index.d.ts",
+				"default": "./dist/src/server/index.js"
+			},
+			"require": {
+				"types": "./dist/src/server/index.d.cts",
+				"default": "./dist/src/server/index.cjs"
+			}
+		},
+		"./package.json": "./package.json"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"clean": "node -e \"try{require('node:fs').rmSync('dist',{recursive:true,force:true})}catch{}\"",
+		"copy": "node -e \"const fs=require('node:fs'),p=require('node:path'),a=process.argv[1],b=process.argv[2];fs.mkdirSync(p.dirname(b),{recursive:true});fs.cpSync(a,b,{force:true});console.log('Copied: '+a+' to '+b)\"",
+		"tmp:txt": "node -e \"const fs=require('node:fs'),p=require('node:path');function walk(d){for(const e of fs.readdirSync(d,{withFileTypes:true})){const f=p.join(d,e.name);if(e.isDirectory()){walk(f)}else if(!e.name.endsWith('.md')&&!e.name.endsWith('.txt')){const t=f+'.txt';if(!fs.existsSync(t)){fs.renameSync(f,t)}else{console.warn('Skipping '+f+' — target exists: '+t)}}}}try{walk('tmp')}catch(e){if(e.code!=='ENOENT')throw e}\"",
+		"lint": "oxlint --config .oxlintrc.json --fix .",
+		"check": "tsc --noEmit --project tsconfig.json",
+		"check:src": "npm run check:src:core && npm run check:src:server",
+		"check:src:core": "tsc --noEmit -p configs/src/tsconfig.core.json",
+		"check:src:server": "tsc --noEmit -p configs/src/tsconfig.server.json",
+		"format": "oxfmt --config .oxfmtrc.json --write .",
+		"format:check": "oxfmt --config .oxfmtrc.json --check .",
+		"lint:check": "oxlint --config .oxlintrc.json .",
+		"test": "npm run test:src && npm run test:guides",
+		"test:src": "vitest run --config vite.config.ts --no-cache --reporter=dot --project src:core --project src:server",
+		"test:src:core": "vitest run --config vite.config.ts --no-cache --reporter=dot --project src:core",
+		"test:src:server": "vitest run --config vite.config.ts --no-cache --reporter=dot --project src:server",
+		"test:guides": "vitest run --config vite.config.ts --reporter=dot --project guides",
+		"build": "npm run clean && npm run build:src",
+		"build:src": "npm run build:src:core && npm run build:src:server",
+		"build:src:core": "vite build --config configs/src/vite.core.config.ts && npm run copy dist/src/core/index.d.ts dist/src/core/index.d.cts",
+		"build:src:server": "vite build --config configs/src/vite.server.config.ts && npm run copy dist/src/server/index.d.ts dist/src/server/index.d.cts",
+		"prepublishOnly": "npm run format:check && npm run lint:check && npm run check && npm run check:src && npm run build && npm test"
+	},
+	"dependencies": {
+		"@orkestrel/contract": "^0.0.1",
+		"@orkestrel/database": "^0.0.2",
+		"@orkestrel/emitter": "^0.0.1",
+		"@orkestrel/pool": "^0.0.1",
+		"@orkestrel/queue": "^0.0.1"
+	},
+	"devDependencies": {
+		"@microsoft/api-extractor": "^7.58.9",
+		"@orkestrel/guide": "^0.0.1",
+		"@types/node": "^26.1.1",
+		"oxfmt": "^0.58.0",
+		"oxlint": "^1.73.0",
+		"typescript": "^6.0.3",
+		"vite": "^8.1.4",
+		"vite-plugin-dts": "^5.0.3",
+		"vitest": "^4.1.10"
+	},
+	"engines": {
+		"node": ">=24"
+	}
+}