@ubercode/dcmtk 0.16.1 → 1.0.0-rc.2

package/README.md

@@ -1,6 +1,7 @@
 # @ubercode/dcmtk
 
-> **ALPHA PREVIEW** — API may have breaking changes before 1.0. Use in production at your own risk.
+> **RELEASE CANDIDATE** — the public API is frozen for 1.0. In production use. Breaking changes before
+> 1.0 final would require a compelling reason and will be called out in the [changelog](CHANGELOG.md).
 
 [![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)

package/dist/{DicomInstance-DGWB2mfD.d.ts → DicomInstance-BFFzieOp.d.ts}

@@ -460,10 +460,16 @@ interface FileIOOptions {
 }
 /** Options for opening a DICOM file. Extends FileIOOptions with read-specific settings. */
 interface DicomOpenOptions extends FileIOOptions {
-    /** Assume the specified character set when SpecificCharacterSet (0008,0005) is absent. Maps to dcm2xml `+Ca`. */
+    /** Assume the specified character set when SpecificCharacterSet (0008,0005) is absent. Accepts DICOM defined terms ('ISO_IR 100') or DCMTK-style aliases ('latin-1'). */
     readonly charsetAssume?: string | undefined;
-    /** Fallback charset to retry with when UTF-8 conversion fails due to illegal byte sequences. Maps to dcm2xml `+Ca`. When set, a charset conversion failure triggers an automatic retry with this charset assumed. `'Latin1'` is recommended — it maps every byte 0x00-0xFF to a valid character, so conversion never fails. */
+    /** Fallback charset to decode with when the file's character set is unsupported or conversion fails. `'latin-1'` is recommended — it maps every byte 0x00-0xFF to a valid character, so decoding never fails. */
     readonly charsetFallback?: string | undefined;
+    /**
+     * Parse engine. `'js'` (default) parses in-process via {@link dicom2json}
+     * and automatically falls back to the DCMTK binaries when the JS parser
+     * fails; `'dcmtk'` uses the deprecated dcm2json binary path exclusively.
+     */
+    readonly engine?: 'js' | 'dcmtk' | undefined;
 }
 
 /**

package/dist/{DicomInstance-BGXtON9T.d.cts → DicomInstance-C0ntZyxC.d.cts}

@@ -460,10 +460,16 @@ interface FileIOOptions {
 }
 /** Options for opening a DICOM file. Extends FileIOOptions with read-specific settings. */
 interface DicomOpenOptions extends FileIOOptions {
-    /** Assume the specified character set when SpecificCharacterSet (0008,0005) is absent. Maps to dcm2xml `+Ca`. */
+    /** Assume the specified character set when SpecificCharacterSet (0008,0005) is absent. Accepts DICOM defined terms ('ISO_IR 100') or DCMTK-style aliases ('latin-1'). */
     readonly charsetAssume?: string | undefined;
-    /** Fallback charset to retry with when UTF-8 conversion fails due to illegal byte sequences. Maps to dcm2xml `+Ca`. When set, a charset conversion failure triggers an automatic retry with this charset assumed. `'Latin1'` is recommended — it maps every byte 0x00-0xFF to a valid character, so conversion never fails. */
+    /** Fallback charset to decode with when the file's character set is unsupported or conversion fails. `'latin-1'` is recommended — it maps every byte 0x00-0xFF to a valid character, so decoding never fails. */
     readonly charsetFallback?: string | undefined;
+    /**
+     * Parse engine. `'js'` (default) parses in-process via {@link dicom2json}
+     * and automatically falls back to the DCMTK binaries when the JS parser
+     * fails; `'dcmtk'` uses the deprecated dcm2json binary path exclusively.
+     */
+    readonly engine?: 'js' | 'dcmtk' | undefined;
 }
 
 /**