@ubercode/dcmtk 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -11
- package/dist/{DicomInstance-CQEIuF_x.d.ts → DicomInstance-D9plqHp5.d.ts} +1 -1
- package/dist/{DicomInstance-By9zd7GM.d.cts → DicomInstance-DNHPkkzl.d.cts} +1 -1
- package/dist/dicom.cjs.map +1 -1
- package/dist/dicom.d.cts +2 -2
- package/dist/dicom.d.ts +2 -2
- package/dist/dicom.js.map +1 -1
- package/dist/index.cjs +533 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +319 -6
- package/dist/index.d.ts +319 -6
- package/dist/index.js +531 -5
- package/dist/index.js.map +1 -1
- package/dist/servers.cjs +1 -1
- package/dist/servers.cjs.map +1 -1
- package/dist/servers.d.cts +1 -1
- package/dist/servers.d.ts +1 -1
- package/dist/servers.js +1 -1
- package/dist/servers.js.map +1 -1
- package/dist/tools.cjs +1 -1
- package/dist/tools.cjs.map +1 -1
- package/dist/tools.js +1 -1
- package/dist/tools.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
[](https://nodejs.org/)
|
|
10
10
|
[](https://opensource.org/licenses/MIT)
|
|
11
11
|
|
|
12
|
-
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,
|
|
12
|
+
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, a pooled DicomReceiver with auto-scaling workers, and a high-throughput DicomSender with queuing and backpressure — all with a modern async/await API, branded types, and the Result pattern for safe error handling.
|
|
13
13
|
|
|
14
14
|
## Features
|
|
15
15
|
|
|
16
16
|
- **51 tool wrappers** — async functions for every DCMTK command-line binary (data conversion, network, image processing, structured reports, presentation state)
|
|
17
|
-
- **6 server classes + DicomReceiver** — long-lived DICOM listeners with typed EventEmitter APIs,
|
|
17
|
+
- **6 server classes + DicomReceiver + DicomSender** — long-lived DICOM listeners with typed EventEmitter APIs, a pooled receiver with auto-scaling workers, and a high-throughput sender with queuing, bucketing, and backpressure
|
|
18
18
|
- **PacsClient** — high-level PACS client with Echo, Query, Retrieve, and Store operations
|
|
19
19
|
- **DICOM data layer** — immutable `DicomDataset`, explicit `ChangeSet` builder, and `DicomInstance` unified file I/O
|
|
20
20
|
- **Result pattern** — all fallible operations return `Result<T>` instead of throwing
|
|
@@ -103,6 +103,7 @@ if (result.ok) {
|
|
|
103
103
|
| [PACS Client](docs/pacs-client.md) | High-level Echo, Query, Retrieve, Store API |
|
|
104
104
|
| [DICOM Data Layer](docs/dicom-data-layer.md) | DicomDataset, ChangeSet, DicomInstance |
|
|
105
105
|
| [Servers](docs/servers.md) | 6 server classes + DicomReceiver pooled receiver |
|
|
106
|
+
| [Senders](docs/senders.md) | DicomSender high-throughput sender with backpressure |
|
|
106
107
|
| [Utilities](docs/utilities.md) | batch processing, retry with backoff |
|
|
107
108
|
|
|
108
109
|
## Tool Reference
|
|
@@ -121,15 +122,16 @@ if (result.ok) {
|
|
|
121
122
|
|
|
122
123
|
## Server Reference
|
|
123
124
|
|
|
124
|
-
| Class | Binary
|
|
125
|
-
| --------------- |
|
|
126
|
-
| `Dcmrecv` | dcmrecv
|
|
127
|
-
| `StoreSCP` | storescp
|
|
128
|
-
| `DcmQRSCP` | dcmqrscp
|
|
129
|
-
| `Wlmscpfs` | wlmscpfs
|
|
130
|
-
| `DcmprsCP` | dcmprscp
|
|
131
|
-
| `Dcmpsrcv` | dcmpsrcv
|
|
132
|
-
| `DicomReceiver` | dcmrecv (pool)
|
|
125
|
+
| Class | Binary | Description | Docs |
|
|
126
|
+
| --------------- | --------------- | ------------------------------------------ | ------------------------------------------- |
|
|
127
|
+
| `Dcmrecv` | dcmrecv | DICOM receiver (C-STORE SCP) | [servers.md](docs/servers.md#dcmrecv) |
|
|
128
|
+
| `StoreSCP` | storescp | Storage SCP with advanced options | [servers.md](docs/servers.md#storescp) |
|
|
129
|
+
| `DcmQRSCP` | dcmqrscp | Query/Retrieve SCP (C-FIND, C-MOVE, C-GET) | [servers.md](docs/servers.md#dcmqrscp) |
|
|
130
|
+
| `Wlmscpfs` | wlmscpfs | Worklist Management SCP | [servers.md](docs/servers.md#wlmscpfs) |
|
|
131
|
+
| `DcmprsCP` | dcmprscp | Print Management SCP | [servers.md](docs/servers.md#dcmprscp) |
|
|
132
|
+
| `Dcmpsrcv` | dcmpsrcv | Viewer network receiver | [servers.md](docs/servers.md#dcmpsrcv) |
|
|
133
|
+
| `DicomReceiver` | dcmrecv (pool) | Pooled receiver with auto-scaling workers | [servers.md](docs/servers.md#dicomreceiver) |
|
|
134
|
+
| `DicomSender` | storescu (pool) | High-throughput sender with backpressure | [senders.md](docs/senders.md) |
|
|
133
135
|
|
|
134
136
|
## License
|
|
135
137
|
|
|
@@ -90,7 +90,7 @@ declare function createDicomTag(input: string): Result<DicomTag>;
|
|
|
90
90
|
/**
|
|
91
91
|
* Creates a validated AETitle from a raw string.
|
|
92
92
|
*
|
|
93
|
-
* @param input - A string expected to be 1-16
|
|
93
|
+
* @param input - A string expected to be 1-16 printable ASCII chars (no backslash)
|
|
94
94
|
* @returns A Result containing the branded AETitle or an error
|
|
95
95
|
*/
|
|
96
96
|
declare function createAETitle(input: string): Result<AETitle>;
|
|
@@ -90,7 +90,7 @@ declare function createDicomTag(input: string): Result<DicomTag>;
|
|
|
90
90
|
/**
|
|
91
91
|
* Creates a validated AETitle from a raw string.
|
|
92
92
|
*
|
|
93
|
-
* @param input - A string expected to be 1-16
|
|
93
|
+
* @param input - A string expected to be 1-16 printable ASCII chars (no backslash)
|
|
94
94
|
* @returns A Result containing the branded AETitle or an error
|
|
95
95
|
*/
|
|
96
96
|
declare function createAETitle(input: string): Result<AETitle>;
|