@niivue/nv-ext-save-html 1.0.0-rc.3 → 1.0.0-rc.31

package/README.md

@@ -13,10 +13,10 @@ Requires `@niivue/niivue` as a peer dependency.
 ## Usage
 
 ```ts
-import NiiVueGPU from '@niivue/niivue'
+import NiiVue from '@niivue/niivue'
 import { saveHTML } from '@niivue/nv-ext-save-html'
 
-const nv = new NiiVueGPU()
+const nv = new NiiVue()
 await nv.attachTo('gl1')
 await nv.loadVolumes([{ url: 'brain.nii.gz' }])
 

package/dist/gzip.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Gzip helpers built on the Web Streams API (available in all modern browsers).
+ *
+ * Split out of `index.ts` so it can be unit tested: `index.ts` imports
+ * `@niivue/niivue`, whose module graph uses Vite's `import.meta.glob` and cannot
+ * be loaded by the Bun test runner.
+ */
+/**
+ * Gzip-compress a Uint8Array.
+ *
+ * Start consuming `readable` BEFORE awaiting the write/close. A CompressionStream
+ * is a TransformStream whose readable side applies backpressure once its queue
+ * fills; if nothing is reading, `writer.write()` / `writer.close()` never settle
+ * and this hangs forever. In Chromium that happens for inputs as small as ~1 MB —
+ * i.e. every real document — so the read must already be in flight. (This is the
+ * same shape niivue's own `codecs/NVGz.ts` compress() uses.)
+ *
+ * `chunk` is a copy: a view backed by a SharedArrayBuffer (see the extension
+ * context's `acquireSharedBuffer`) cannot be enqueued directly.
+ */
+export declare function gzipCompress(data: Uint8Array): Promise<Uint8Array>;

package/dist/gzip.test.d.ts

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

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-import { default as NiiVueGPU } from '@niivue/niivue';
+import { default as NiiVue } from '@niivue/niivue';
 export interface SaveHTMLOptions {
     /**
      * Fully self-contained niivue ESM bundle as a source code string.
      *
-     * The bundle must export `NiiVueGPU` as its **default export** and must
+     * The bundle must export `NiiVue` as its **default export** and must
      * have all dependencies (cbor-x, gl-matrix, nifti-reader-js, etc.) inlined.
      *
      * Build one with e.g. `vite build` using `rollupOptions.external: []`.
@@ -25,7 +25,7 @@ export interface SaveHTMLOptions {
  * @param options - See {@link SaveHTMLOptions}.
  * @returns A complete HTML document as a string.
  */
-export declare function generateHTML(nv: NiiVueGPU, options: SaveHTMLOptions): Promise<string>;
+export declare function generateHTML(nv: NiiVue, options: SaveHTMLOptions): Promise<string>;
 /**
  * Download the current NiiVue scene as a self-contained HTML file.
  *
@@ -36,4 +36,4 @@ export declare function generateHTML(nv: NiiVueGPU, options: SaveHTMLOptions): P
  * @param filename - Name of the downloaded file (default: `"scene.html"`).
  * @param options  - See {@link SaveHTMLOptions}.
  */
-export declare function saveHTML(nv: NiiVueGPU, filename: string | undefined, options: SaveHTMLOptions): Promise<void>;
+export declare function saveHTML(nv: NiiVue, filename: string | undefined, options: SaveHTMLOptions): Promise<void>;

package/dist/nv-ext-save-html.js

@@ -1,6 +1,8 @@
 async function l(e) {
-  const a = new CompressionStream("gzip"), t = a.writable.getWriter();
-  return t.write(e), t.close(), new Uint8Array(await new Response(a.readable).arrayBuffer());
+  const a = new CompressionStream("gzip"), t = new Uint8Array(e.byteLength);
+  t.set(e);
+  const n = new Response(a.readable).arrayBuffer(), o = a.writable.getWriter();
+  return await o.write(t), await o.close(), new Uint8Array(await n);
 }
 function d(e) {
   const t = [];
@@ -71,7 +73,7 @@ ${a}
     const blobUrl = URL.createObjectURL(blob);
     const niivueModule = await import(blobUrl);
     URL.revokeObjectURL(blobUrl);
-    const NiiVueGPU = niivueModule.default ?? niivueModule.NiiVueGPU;
+    const NiiVue = niivueModule.default ?? niivueModule.NiiVue;
 
     // 2. Decode base-64, gzip-decompress, and wrap as a File
     const base64 = document.getElementById("__nvd_data__").textContent.trim();
@@ -86,7 +88,7 @@ ${a}
     const file = new File([bytes], "scene.nvd");
 
     // 3. Create NiiVue, attach to canvas, and load the document
-    const nv = new NiiVueGPU();
+    const nv = new NiiVue();
     await nv.attachTo("${t}");
     await nv.loadDocument(file);
     // The serialized document has an empty matcap to avoid baking in
@@ -103,22 +105,22 @@ async function b(e, a) {
   const {
     niivueBundleSource: t,
     canvasId: n = "gl1",
-    title: r = "NiiVue Scene"
+    title: o = "NiiVue Scene"
   } = a;
   if (!t)
     throw new Error(
       "nv-ext-save-html: niivueBundleSource is required. Provide the full source of a self-contained niivue ESM bundle."
     );
-  const o = e.volumeMatcap;
+  const r = e.volumeMatcap;
   e.model.volume.matcap = "";
   const i = e.serializeDocument();
-  e.model.volume.matcap = o;
+  e.model.volume.matcap = r;
   const c = await l(i), s = d(c);
-  return m(t, s, n, r);
+  return m(t, s, n, o);
 }
 async function h(e, a = "scene.html", t) {
-  const n = await b(e, t), r = new Blob([n], { type: "text/html" }), o = URL.createObjectURL(r), i = document.createElement("a");
-  i.href = o, i.download = a, document.body.appendChild(i), i.click(), document.body.removeChild(i), URL.revokeObjectURL(o);
+  const n = await b(e, t), o = new Blob([n], { type: "text/html" }), r = URL.createObjectURL(o), i = document.createElement("a");
+  i.href = r, i.download = a, document.body.appendChild(i), i.click(), document.body.removeChild(i), URL.revokeObjectURL(r);
 }
 export {
   b as generateHTML,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@niivue/nv-ext-save-html",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0-rc.31",
   "type": "module",
   "description": "Export a NiiVue scene as a self-contained HTML file",
   "main": "./dist/nv-ext-save-html.js",
@@ -16,10 +16,10 @@
     "dist"
   ],
   "peerDependencies": {
-    "@niivue/niivue": "workspace:*"
+    "@niivue/niivue": "1.0.0-rc.31"
   },
   "devDependencies": {
-    "@niivue/niivue": "workspace:*",
+    "@niivue/niivue": "1.0.0-rc.31",
     "typescript": "~5.8.3",
     "vite": "^6.3.2",
     "vite-plugin-dts": "^4.5.4"
@@ -27,5 +27,8 @@
   "scripts": {
     "build": "npx vite build",
     "typecheck": "bunx tsc --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }