@niivue/nv-ext-dcm2niix 1.0.0-rc.10

package/README.md

@@ -0,0 +1,69 @@
+# @niivue/nv-ext-dcm2niix
+
+Browser-side DICOM-to-NIfTI conversion for [NiiVue](https://github.com/niivue), wrapping the [`@niivue/dcm2niix`](https://www.npmjs.com/package/@niivue/dcm2niix) WebAssembly build of Chris Rorden's [`dcm2niix`](https://github.com/rordenlab/dcm2niix). No data leaves the browser.
+
+## Installation
+
+```bash
+bun add @niivue/nv-ext-dcm2niix
+```
+
+Requires `@niivue/niivue` as a peer dependency.
+
+## Usage
+
+### Folder picker
+
+```ts
+import NiiVue from '@niivue/niivue'
+import { runDcm2niix } from '@niivue/nv-ext-dcm2niix'
+
+const nv = new NiiVue()
+await nv.attachTo('gl1')
+
+const input = document.querySelector<HTMLInputElement>('#dicomFolder')!
+input.addEventListener('change', async () => {
+  const niftiFiles = await runDcm2niix(input.files)
+  await nv.loadVolumes([{ url: niftiFiles[0] }])
+})
+```
+
+The input should declare `webkitdirectory` so the browser exposes folder structure:
+
+```html
+<input id="dicomFolder" type="file" webkitdirectory multiple />
+```
+
+### Drag-and-drop folders
+
+```ts
+import { runDcm2niix, traverseDataTransferItems } from '@niivue/nv-ext-dcm2niix'
+
+dropTarget.addEventListener('drop', async (e) => {
+  e.preventDefault()
+  const files = await traverseDataTransferItems(e.dataTransfer!.items)
+  const niftiFiles = await runDcm2niix(files)
+  await nv.loadVolumes([{ url: niftiFiles[0] }])
+})
+```
+
+### Power users
+
+The underlying `Dcm2niix` class is re-exported for callers that need full control over dcm2niix command-line flags (compression level, BIDS sidecars, etc.):
+
+```ts
+import { Dcm2niix } from '@niivue/nv-ext-dcm2niix'
+
+const dcm2niix = new Dcm2niix()
+await dcm2niix.init()
+const result = await dcm2niix.input(files).compressionLevel(9).bids('n').run()
+```
+
+## Development
+
+```bash
+bunx nx build nv-ext-dcm2niix
+bunx nx typecheck nv-ext-dcm2niix
+```
+
+## Part of the [NiiVue](https://github.com/niivue) ecosystem

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+import { Dcm2niix } from '@niivue/dcm2niix';
+export { Dcm2niix };
+/** Options for {@link runDcm2niix}. */
+export interface RunDcm2niixOptions {
+    /**
+     * Filter the result list down to NIfTI outputs (`.nii` and `.nii.gz`).
+     * BIDS sidecars and other dcm2niix outputs are dropped. Default: `true`.
+     */
+    niftiOnly?: boolean;
+}
+/**
+ * Convert DICOM files to NIfTI by spinning up a fresh dcm2niix worker,
+ * feeding it the files, waiting for the result, then terminating the
+ * worker so the WASM heap is released.
+ *
+ * Each call boots its own worker — fine for one-off conversions; for
+ * batch workflows, instantiate `Dcm2niix` once and reuse it (and call
+ * `worker?.terminate()` yourself when finished).
+ *
+ * @param files       FileList from `<input webkitdirectory>` or File[]
+ *                    from a drop event (see {@link traverseDataTransferItems}).
+ * @param options     See {@link RunDcm2niixOptions}.
+ * @returns           Converted output files (NIfTI by default).
+ */
+export declare function runDcm2niix(files: FileList | File[] | null | undefined, options?: RunDcm2niixOptions): Promise<File[]>;
+/**
+ * Walk a drop event's `DataTransferItemList`, recurse into directories,
+ * and stamp `_webkitRelativePath` on each file so dcm2niix can group by
+ * series.
+ *
+ * The browser exposes folder structure on drop only via the
+ * `webkitGetAsEntry()` API; this helper runs that traversal for you.
+ *
+ * @example
+ * ```ts
+ * dropTarget.addEventListener('drop', async (e) => {
+ *   e.preventDefault()
+ *   const files = await traverseDataTransferItems(e.dataTransfer!.items)
+ *   const niftiFiles = await runDcm2niix(files)
+ * })
+ * ```
+ */
+export declare function traverseDataTransferItems(items: DataTransferItemList): Promise<File[]>;

package/dist/nv-ext-dcm2niix.js

@@ -0,0 +1,53 @@
+import { Dcm2niix as f } from "@niivue/dcm2niix";
+import { Dcm2niix as g } from "@niivue/dcm2niix";
+async function h(n, r = {}) {
+  var i;
+  const { niftiOnly: e = !0 } = r;
+  if (!n || n.length === 0) return [];
+  const t = new f();
+  try {
+    await t.init();
+    const a = await t.input(n).run();
+    return e ? a.filter((s) => /\.nii(\.gz)?$/i.test(s.name)) : a;
+  } finally {
+    (i = t.worker) == null || i.terminate();
+  }
+}
+async function w(n) {
+  const r = [], e = [];
+  for (let t = 0; t < n.length; t++) {
+    const i = n[t].webkitGetAsEntry();
+    i && e.push(i);
+  }
+  return await Promise.all(e.map((t) => m(t, "", r))), r;
+}
+function m(n, r, e) {
+  return new Promise((t, i) => {
+    if (n.isFile) {
+      n.file((a) => {
+        const s = a;
+        s._webkitRelativePath = r + a.name, e.push(s), t();
+      }, i);
+      return;
+    }
+    if (n.isDirectory) {
+      const a = n.createReader(), s = `${r}${n.name}/`, c = () => {
+        a.readEntries((o) => {
+          if (o.length === 0) {
+            t();
+            return;
+          }
+          Promise.all(o.map((u) => m(u, s, e))).then(c).catch(i);
+        }, i);
+      };
+      c();
+      return;
+    }
+    t();
+  });
+}
+export {
+  g as Dcm2niix,
+  h as runDcm2niix,
+  w as traverseDataTransferItems
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@niivue/nv-ext-dcm2niix",
+  "version": "1.0.0-rc.10",
+  "type": "module",
+  "description": "DICOM-to-NIfTI conversion in the browser via the dcm2niix WASM build, packaged for NiiVue",
+  "main": "./dist/nv-ext-dcm2niix.js",
+  "module": "./dist/nv-ext-dcm2niix.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/nv-ext-dcm2niix.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@niivue/niivue": "1.0.0-rc.12"
+  },
+  "dependencies": {
+    "@niivue/dcm2niix": "^1.2.0"
+  },
+  "devDependencies": {
+    "@niivue/niivue": "1.0.0-rc.12",
+    "typescript": "~5.8.3",
+    "vite": "^6.3.2",
+    "vite-plugin-dts": "^4.5.4"
+  },
+  "scripts": {
+    "build": "npx vite build",
+    "typecheck": "bunx tsc --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}