@ubercode/dcmtk 0.1.4 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # @ubercode/dcmtk
 
-> **ALPHA PREVIEW RELEASE** — This library has not been thoroughly tested by humans. Use in production at your own risk.
+> **ALPHA PREVIEW** — API may have breaking changes before 1.0. Use in production at your own risk.
 
 [![npm version](https://img.shields.io/npm/v/@ubercode/dcmtk.svg)](https://www.npmjs.com/package/@ubercode/dcmtk)
 [![npm downloads](https://img.shields.io/npm/dm/@ubercode/dcmtk.svg)](https://www.npmjs.com/package/@ubercode/dcmtk)
@@ -9,14 +9,14 @@
 [![Node.js](https://img.shields.io/badge/Node.js-%3E%3D20-green.svg)](https://nodejs.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-Type-safe Node.js bindings for the [DCMTK](https://dicom.offis.de/dcmtk.php.en) (DICOM Toolkit) command-line utilities. Wraps 51 DCMTK binaries and 6 long-lived server processes with a modern async/await API, branded types, and the Result pattern for safe error handling.
+Type-safe Node.js bindings for the [DCMTK](https://dicom.offis.de/dcmtk.php.en) (DICOM Toolkit) command-line utilities. Wraps 51 DCMTK binaries, 6 long-lived server processes, and a pooled DicomReceiver with auto-scaling workers, all with a modern async/await API, branded types, and the Result pattern for safe error handling.
 
 ## Features
 
 - **51 tool wrappers** — async functions for every DCMTK command-line binary (data conversion, network, image processing, structured reports, presentation state)
-- **6 server classes** — long-lived DICOM listeners with typed EventEmitter APIs and graceful shutdown
+- **6 server classes + DicomReceiver** — long-lived DICOM listeners with typed EventEmitter APIs, plus a pooled receiver with auto-scaling workers
 - **PacsClient** — high-level PACS client with Echo, Query, Retrieve, and Store operations
-- **DICOM data layer** — immutable `DicomDataset`, explicit `ChangeSet` builder, and `DicomFile` I/O
+- **DICOM data layer** — immutable `DicomDataset`, explicit `ChangeSet` builder, and `DicomInstance` unified file I/O
 - **Result pattern** — all fallible operations return `Result<T>` instead of throwing
 - **Branded types** — `DicomTag`, `AETitle`, `Port`, and more prevent primitive-type mix-ups at compile time
 - **Full TypeScript** — strict mode, dual CJS/ESM build, complete `.d.ts` declarations
@@ -26,7 +26,7 @@ Type-safe Node.js bindings for the [DCMTK](https://dicom.offis.de/dcmtk.php.en)
 ## Prerequisites
 
 - **Node.js** >= 20
-- **DCMTK** installed on the system — set the `DCMTK_PATH` environment variable or install to a standard location (`/usr/bin`, `/usr/local/bin`, `C:\Program Files\DCMTK`)
+- **DCMTK** installed on the system — set the `DCMTK_PATH` environment variable or install to a standard location (`/usr/bin`, `/usr/local/bin`, `C:\Program Files\DCMTK`). Pre-built Docker images with Node.js + DCMTK are available: [`michaelleehobbs/nodejs-dcmtk`](https://hub.docker.com/r/michaelleehobbs/nodejs-dcmtk)
 
 ## Installation
 
@@ -92,6 +92,8 @@ if (result.ok) {
 }
 ```
 
+> For production workloads with concurrent connections, use [`DicomReceiver`](docs/servers.md#dicomreceiver) — a pooled receiver that manages multiple `Dcmrecv` workers behind a TCP proxy with auto-scaling.
+
 ## Documentation
 
 | Guide                                        | Description                                              |
@@ -99,8 +101,8 @@ if (result.ok) {
 | [Getting Started](docs/GETTING_STARTED.md)   | Installation, DICOM glossary, tutorials, troubleshooting |
 | [Core Concepts](docs/core-concepts.md)       | Result pattern, branded types, timeouts, AbortSignal     |
 | [PACS Client](docs/pacs-client.md)           | High-level Echo, Query, Retrieve, Store API              |
-| [DICOM Data Layer](docs/dicom-data-layer.md) | DicomDataset, ChangeSet, DicomFile                       |
-| [Servers](docs/servers.md)                   | 6 long-lived server classes with typed events            |
+| [DICOM Data Layer](docs/dicom-data-layer.md) | DicomDataset, ChangeSet, DicomInstance                   |
+| [Servers](docs/servers.md)                   | 6 server classes + DicomReceiver pooled receiver         |
 | [Utilities](docs/utilities.md)               | batch processing, retry with backoff                     |
 
 ## Tool Reference
@@ -119,14 +121,15 @@ if (result.ok) {
 
 ## Server Reference
 
-| Class      | Binary   | Description                                | Docs                                   |
-| ---------- | -------- | ------------------------------------------ | -------------------------------------- |
-| `Dcmrecv`  | dcmrecv  | DICOM receiver (C-STORE SCP)               | [servers.md](docs/servers.md#dcmrecv)  |
-| `StoreSCP` | storescp | Storage SCP with advanced options          | [servers.md](docs/servers.md#storescp) |
-| `DcmQRSCP` | dcmqrscp | Query/Retrieve SCP (C-FIND, C-MOVE, C-GET) | [servers.md](docs/servers.md#dcmqrscp) |
-| `Wlmscpfs` | wlmscpfs | Worklist Management SCP                    | [servers.md](docs/servers.md#wlmscpfs) |
-| `DcmprsCP` | dcmprscp | Print Management SCP                       | [servers.md](docs/servers.md#dcmprscp) |
-| `Dcmpsrcv` | dcmpsrcv | Viewer network receiver                    | [servers.md](docs/servers.md#dcmpsrcv) |
+| Class           | Binary         | Description                                | Docs                                        |
+| --------------- | -------------- | ------------------------------------------ | ------------------------------------------- |
+| `Dcmrecv`       | dcmrecv        | DICOM receiver (C-STORE SCP)               | [servers.md](docs/servers.md#dcmrecv)       |
+| `StoreSCP`      | storescp       | Storage SCP with advanced options          | [servers.md](docs/servers.md#storescp)      |
+| `DcmQRSCP`      | dcmqrscp       | Query/Retrieve SCP (C-FIND, C-MOVE, C-GET) | [servers.md](docs/servers.md#dcmqrscp)      |
+| `Wlmscpfs`      | wlmscpfs       | Worklist Management SCP                    | [servers.md](docs/servers.md#wlmscpfs)      |
+| `DcmprsCP`      | dcmprscp       | Print Management SCP                       | [servers.md](docs/servers.md#dcmprscp)      |
+| `Dcmpsrcv`      | dcmpsrcv       | Viewer network receiver                    | [servers.md](docs/servers.md#dcmpsrcv)      |
+| `DicomReceiver` | dcmrecv (pool) | Pooled receiver with auto-scaling workers  | [servers.md](docs/servers.md#dicomreceiver) |
 
 ## License