Version 2.0 Discussion

[yagni]

There are a couple of issues in the backlog that require a major version bump and could be beneficial, so I thought I'd get that process started. I created a milestone and added the issues there.

This issue is for discussion around 2.0 itself. Please discuss issue-specific details in the issues themselves.

@chafey @swederik @dannyrb @galelis (and anyone else) want to weigh in on what should/shouldn't be included in 2.0?

[Ragnar-Oock]

I'm biased but maybe making the types more explicit (either by rewriting the lib in TS or by updating the type declaration like I proposed in #258 last year) would help when using the lib for advanced usage (i.e. not just throwing the file into cornerstone (legacy or 3d) for it to display the images on screen). The biggest pain point is the Element interface that has every possible element kinds merge into a single interface instead of the 4 different kinds that are actually returned by the parser (sequence elements, encapsulated PixelData element, FileMetaInformation element and the "basic" elements).
For an actual example use case I had to create a wrapper around dicom-parser to edit DICOM files (for anonymization mostly).

[sedghi]

The most important feature in Version 2.0 should be ES Modules, in my opinion.

We have to patch the modern bundlers because of dicomParser right now

import { viteCommonjs } from "@originjs/vite-plugin-commonjs"


export default defineConfig({
  plugins: [viteCommonjs()],
  optimizeDeps: {
    include: ["dicom-parser"],
  },
})

[Ragnar-Oock]

I don't remember having encountered bundling issues when using dicon-parser, but I never had it on its own so it's possible that I fixed it alongside cornerstone legacy when I ussed it.
And I do agree the migration to ESM is more important than typing (at least assuming it doesn't degrade the existing types)