@pretextbook/import 0.6.0 → 0.8.0

package/dist/worker/convert-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/worker/protocol.d.ts

@@ -0,0 +1,30 @@
+import { ImportProjectOptions } from '../lib/upload';
+import { ImportedProjectResult } from '../lib/types';
+/** Sent to the worker to start a conversion. */
+export interface ConvertRequest {
+    type: "convert";
+    /** Correlates the reply, so a stale run's messages can be ignored. */
+    requestId: string;
+    files: Record<string, string>;
+    /**
+     * Binary assets, sent as transferables. Carried here rather than inside
+     * `options` so the buffers can be listed in the `postMessage` transfer list
+     * instead of being structured-cloned.
+     */
+    assets: Record<string, Uint8Array>;
+    /** Everything except `assets`, which travels in its own field above. */
+    options: Omit<ImportProjectOptions, "assets">;
+}
+export type WorkerRequest = ConvertRequest;
+export interface ResultResponse {
+    type: "result";
+    requestId: string;
+    result: ImportedProjectResult;
+}
+/** A throw that escaped the pipeline — distinct from a `pretextError` result. */
+export interface ErrorResponse {
+    type: "error";
+    requestId: string;
+    message: string;
+}
+export type WorkerResponse = ResultResponse | ErrorResponse;

package/dist/worker/worker-engine.d.ts

@@ -0,0 +1,52 @@
+import { ImportProjectOptions } from '../lib/upload';
+import { ImportEngine } from '../react/import-wizard';
+import { ImportedProjectResult } from '../lib/types';
+import { WorkerRequest, WorkerResponse } from './protocol';
+/** The minimum of the `Worker` API this engine uses. */
+export interface ConversionWorker {
+    postMessage(message: WorkerRequest, transfer?: Transferable[]): void;
+    terminate(): void;
+    addEventListener(type: "message", listener: (event: MessageEvent<WorkerResponse>) => void): void;
+    addEventListener(type: "error", listener: (event: unknown) => void): void;
+}
+export interface WorkerEngineOptions {
+    /** Builds a fresh worker. Called once per conversion. */
+    createWorker: () => ConversionWorker;
+    id?: string;
+    label?: string;
+    description?: string;
+    acceptExtensions?: string[];
+}
+/**
+ * One conversion in flight. `cancel` terminates the worker outright — the
+ * pipeline has no yield points, so a cooperative cancellation flag would never
+ * be read; killing the thread is the only way to stop it mid-grind.
+ */
+export interface RunningConversion {
+    result: Promise<ImportedProjectResult>;
+    cancel: () => void;
+}
+/** Raised on the `result` promise when `cancel()` is called. */
+export declare class ConversionCancelledError extends Error {
+    constructor();
+}
+/**
+ * Run one conversion on a freshly spawned worker.
+ *
+ * A worker per conversion rather than a long-lived pooled one: cancellation is
+ * `terminate()`, which destroys the thread, and the pipeline holds no state
+ * worth keeping warm between runs. Spawn cost is milliseconds against a
+ * multi-second conversion.
+ */
+export declare function runConversionInWorker(createWorker: () => ConversionWorker, files: Record<string, string>, options?: ImportProjectOptions): RunningConversion;
+/**
+ * Build an `ImportEngine` that converts on a worker.
+ *
+ * `prepare` stays on the main thread: unpacking is real async I/O that already
+ * yields, and it is cheap next to the conversion. Only `convertPrepared` and
+ * `convertFile` — the multi-second synchronous grind — go off-thread.
+ *
+ * The returned engine is stateful: it remembers the run in flight so `cancel`
+ * can terminate it. One engine instance therefore drives one wizard.
+ */
+export declare function createWorkerEngine(options: WorkerEngineOptions): ImportEngine;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/import",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Shared import helpers for converting LaTeX/Markdown/PreTeXt into PreTeXt for VS Code and web apps",
   "author": "Oscar Levin",
   "license": "MIT",
@@ -30,7 +30,12 @@
       "require": "./dist/react.cjs",
       "default": "./dist/react.js"
     },
-    "./react.css": "./dist/import.css"
+    "./react.css": "./dist/import.css",
+    "./worker": {
+      "types": "./dist/worker/convert-worker.d.ts",
+      "import": "./dist/convert-worker.js",
+      "default": "./dist/convert-worker.js"
+    }
   },
   "sideEffects": [
     "*.css",