@niivue/nv-ohif 0.1.0-rc.0

package/dist/types/wsiThumbnail.d.ts

@@ -0,0 +1,40 @@
+interface WsiThumbInstance extends Record<string, unknown> {
+    imageId?: unknown;
+    ImageType?: unknown;
+    NumberOfFrames?: unknown;
+    Rows?: unknown;
+    Columns?: unknown;
+    SamplesPerPixel?: unknown;
+    PhotometricInterpretation?: unknown;
+}
+/**
+ * Choose the best ready-made preview image in the pyramid: prefer an OVERVIEW,
+ * then a THUMBNAIL, then any non-LABEL side image, then a LABEL; tie-break on the
+ * fewest frames (the side images are single-frame). Only instances with an
+ * imageId are eligible. Returns undefined when the series has no usable instance.
+ */
+export declare function pickThumbnailInstance(instances: ReadonlyArray<Record<string, unknown>>): WsiThumbInstance | undefined;
+/** Encoded-image signature of a frame's bytes, or 'raw' for uncompressed pixels. */
+export declare function frameEncoding(bytes: Uint8Array): 'jpeg' | 'png' | 'raw';
+export declare const MAX_THUMBNAIL_FETCH_BYTES: number;
+export declare const MAX_THUMBNAIL_DECODE_PIXELS: number;
+interface RawImageInfo {
+    width: number;
+    height: number;
+    channels: number;
+}
+/**
+ * The dimensions for decoding a raw (uncompressed) frame, when the instance
+ * describes an 8-bit RGB or grayscale image whose pixel count matches the byte
+ * length. Returns null for anything else (leave those to the encoded path or the
+ * panel's default tile) so a mismatched buffer never paints garbage.
+ */
+export declare function rawImageInfo(inst: WsiThumbInstance, byteLength: number): RawImageInfo | null;
+/**
+ * Fetch a WSI series' preview image and return an image URL for the study panel
+ * (a Blob URL for an encoded frame, a data URL for a decoded raw frame), or null
+ * if there is no usable instance or the fetch/decode fails. The caller treats the
+ * result as an `<img src>`.
+ */
+export declare function fetchWsiThumbnailObjectUrl(instances: ReadonlyArray<Record<string, unknown>>, headers?: Record<string, string>, signal?: AbortSignal): Promise<string | null>;
+export {};

package/dist/types/wsiTileSource.d.ts

@@ -0,0 +1,68 @@
+import type { NVSlideLevelManifest, NVSlideManifest, NVSlideTileManifest, SlideSourceHost, SlideTileSource } from '@niivue/niivue';
+import type { OhifDisplaySet } from './ohif-types';
+/**
+ * A multi-valued DICOM attribute (e.g. ImageType) as a backslash-joined string.
+ * Depending on the data source the value arrives either already joined
+ * ('DERIVED\\PRIMARY\\VOLUME\\NONE') or as a string array (OHIF's
+ * dcmjs-naturalized instances deliver ['DERIVED', 'PRIMARY', 'VOLUME', 'NONE']);
+ * normalize both to the joined form so flavor matching sees every value.
+ */
+export declare function imageTypeString(value: unknown): string | undefined;
+interface WsiLevel {
+    matrixColumns: number;
+    matrixRows: number;
+    tileColumns: number;
+    tileRows: number;
+    /** Frame base URL (`.../instances/{sop}/frames`); a tile fetch appends `/{n}`. */
+    frameBaseUrl: string;
+    /** Query string (with leading `?`) to re-append after the frame index, or ''. */
+    frameQuery: string;
+    isJpeg: boolean;
+    /** Physical spacing `[dx, dy]` in mm for this tier, when the SM metadata carries it. */
+    spacingMM?: readonly [number, number];
+    /**
+     * True when the frames are (or default to) TILED_FULL row-major order — the
+     * only layout levelTiles maps correctly (frame = row*cols + col + 1). False
+     * only when DimensionOrganizationType is explicitly a non-full value
+     * (e.g. TILED_SPARSE), where frame positions come from PlanePositionSlide.
+     */
+    tiledFull: boolean;
+}
+/** Extract the VOLUME pyramid levels from an SM display set, finest first. */
+export declare function wsiVolumeLevels(ds: OhifDisplaySet): WsiLevel[];
+export interface BuiltWsiManifest {
+    manifest: NVSlideManifest;
+    /** Frame base URL by level.index (aligned with manifest.levels). */
+    levelBaseUrls: string[];
+    /** Query string (with leading `?`, or '') by level.index, re-appended per tile. */
+    levelQueries: string[];
+    /** True when every kept level is JPEG (v1-renderable). */
+    allJpeg: boolean;
+    /**
+     * True when every kept level is TILED_FULL (row-major) — the only frame layout
+     * the row-major tile grid maps correctly. False for a TILED_SPARSE slide, which
+     * would otherwise render scrambled.
+     */
+    tiledFull: boolean;
+}
+/**
+ * Build an {@link NVSlideManifest} (+ per-level frame base URLs) from an OHIF
+ * DICOM-WSI (SM) display set, or null when it has no VOLUME pyramid levels.
+ */
+export declare function buildWsiManifest(ds: OhifDisplaySet): BuiltWsiManifest | null;
+/**
+ * A live DICOM-WSI tile source: fetches encoded JPEG tiles on demand from a
+ * DICOMweb server via WADO-RS `/frames/{n}`, one HTTP request per tile. NVSlide
+ * owns the pyramid manifest, LOD, decoding and caching; this only supplies the
+ * per-level frame base URLs + the encoded bytes.
+ */
+export declare class DicomWsiTileSource implements SlideTileSource {
+    readonly manifest: NVSlideManifest;
+    private readonly levelBaseUrls;
+    private readonly levelQueries;
+    private readonly headers;
+    constructor(built: BuiltWsiManifest, headers?: Record<string, string>);
+    bind(_host: SlideSourceHost): void;
+    fetchTileBytes(level: NVSlideLevelManifest, tile: NVSlideTileManifest): Promise<Uint8Array>;
+}
+export {};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@niivue/nv-ohif",
+  "version": "0.1.0-rc.0",
+  "private": false,
+  "type": "module",
+  "description": "NiiVue viewport extension for the OHIF Viewer (render series with NiiVue: 3D volume rendering, meshes, overlays, multiplanar, drawing).",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build:lib": "NODE_ENV=production bun build ./src/index.ts --outdir=dist --target=browser --format=esm --external react --external react-dom --external @niivue/niivue --external @niivue/uikit --external @niivue/dcm2niix --external dcmjs",
+    "build:types": "tsc -p tsconfig.build.json",
+    "build:package": "bun run build:lib && bun run build:types",
+    "test": "bun test"
+  },
+  "comment:peers": "The host OHIF app (>= 3.12, React 18) provides @ohif/core, @ohif/extension-default and react-dom. They are intentionally NOT peerDependencies here: bun would install the whole OHIF tree (pinned to react-dom 18) into this monorepo, colliding with @niivue/nvreact (React 19). This package builds against local OHIF typings (src/ohif-types.ts) and externalizes react. The react peer allows 18 or 19 so bun reuses the monorepo's React 19 for dev; the component's simple hook usage is compatible with both, and the OHIF host supplies React 18 at runtime.",
+  "peerDependencies": {
+    "@niivue/niivue": "1.0.0-rc.13",
+    "react": "^18.3.1 || ^19"
+  },
+  "comment:dcm2niix-pin": "The dcm2niix Web-Worker exit fix (wrap callMain in try/catch, read err.status) is PUBLISHED: @niivue/dcm2niix 1.3.20260724 (calendar-versioned, now npm 'latest') contains it (verified in the published dist/worker.js + worker.jpeg.js). The pin requires that fixed release or newer, so DICOM conversion now works for npm-install consumers. The dev-rig local-patched dcm2niix override can be dropped in favor of the published package. See README '## DICOM support'.",
+  "comment:uikit-dep": "@niivue/uikit is externalized in build:lib and is a runtime dependency (its ruler/line/text overlays, loadDefaultFont, and the inlined MSDF font are imported at runtime, not bundled). It is published from this monorepo in the same Nx release group, so `npm install @niivue/nv-ohif` resolves it. The workspace range is rewritten to the published version on pack/release. Its only @niivue/niivue import is type-only, so no niivue runtime is duplicated.",
+  "dependencies": {
+    "@niivue/dcm2niix": "^1.3.20260724",
+    "@niivue/uikit": "0.1.0-rc.0",
+    "dcmjs": "^0.49.0"
+  },
+  "devDependencies": {
+    "@niivue/niivue": "1.0.0-rc.13",
+    "@types/bun": "^1.3.12",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@vitejs/plugin-react": "^6.0.1",
+    "react": "^19",
+    "react-dom": "^19",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.9"
+  }
+}