fix(dependencies): Update dcmjs library and improve documentation links (#4741)

This commit is contained in:
Alireza 2025-01-28 14:59:59 -05:00 committed by GitHub
parent ff6dd3a152
commit d554f02f7c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
29 changed files with 1162 additions and 606 deletions

View File

@ -38,7 +38,7 @@
"resolutions": {
"**/@babel/runtime": "^7.20.13",
"commander": "8.3.0",
"dcmjs": ">=0.33.0",
"dcmjs": "0.38.0",
"dicomweb-client": ">=0.10.4",
"nth-check": "^2.1.1",
"trim-newlines": "^5.0.0",

BIN
bun.lockb

Binary file not shown.

View File

@ -45,6 +45,10 @@ export default function areAllImagePositionsEqual(instances: Array<any>): boolea
const firstImagePositionPatient = toNumber(instances[0].ImagePositionPatient);
const lastIpp = toNumber(instances[instances.length - 1].ImagePositionPatient);
if (!firstImagePositionPatient || !lastIpp) {
return false;
}
const averageSpacingBetweenFrames =
_getPerpendicularDistance(firstImagePositionPatient, lastIpp) / (instances.length - 1);

View File

@ -32,7 +32,7 @@
"peerDependencies": {
"@ohif/core": "3.10.0-beta.78",
"@ohif/ui": "3.10.0-beta.78",
"dcmjs": "0.29.11",
"dcmjs": "0.38.0",
"dicom-parser": "^1.8.9",
"hammerjs": "^2.0.8",
"prop-types": "^15.6.2",

View File

@ -75,7 +75,7 @@
"optionalDependencies": {
"@percy/cypress": "^3.1.1",
"@playwright/test": "^1.48.0",
"cypress": "^13.16.1",
"cypress": "^14.0.0",
"cypress-file-upload": "^5.0.8"
},
"devDependencies": {
@ -108,7 +108,7 @@
},
"resolutions": {
"commander": "8.3.0",
"dcmjs": ">=0.33.0",
"dcmjs": "0.38.0",
"dicomweb-client": ">=0.10.4",
"nth-check": "^2.1.1",
"trim-newlines": "^5.0.0",

View File

@ -1,3 +0,0 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};

View File

@ -117,7 +117,7 @@ with the labels returned from `getItemLabels`.
## Creation via Customization Module
The generic UI (i.e. `DataSourceConfigurationComponent`) uses the
[OHIF UI customization service](../../platform/services/ui/customization-service.md) to
[OHIF UI customization service](../../platform/services/customization-service/customizationService.md) to
instantiate the `BaseDataSourceConfigurationAPI` instance to configure a data source.
A UI configurable data source should have a `configurationAPI` field as part of

View File

@ -95,7 +95,7 @@ yarn run dev:orthanc
#### Configuration: Learn More
> For more configuration fun, check out the
> [Essentials Configuration](../index.md) guide.
> [Essentials Configuration](../configurationFiles.md) guide.
Let's take a look at what's going on under the hood here. `yarn run dev:orthanc`
is running the `dev:orthanc` script in our project's `package.json` (inside
@ -183,7 +183,7 @@ A comma delimited string specifying which payloads the data source responds with
For DICOM video and PDF it has been found that Orthanc delivers multipart, while DCM4CHEE delivers single part. Consult the DICOM conformance statement for your particular data source to determine which payload types it delivers.
To learn more about how you can configure the OHIF Viewer, check out our
[Configuration Guide](../index.md).
[Configuration Guide](../configurationFiles.md).
### DICOM PDF

View File

@ -43,7 +43,7 @@ The best alternative is to host OHIF over HTTPS.
OHIF can be served over HTTPS in a variety of ways (these are just some examples).
- Website hosting services that offer HTTPS deployment (e.g,. Netlify) or offer HTTPS load balancers (AWS, Google Cloud etc.)
- Setting up a reverse proxy (e.g. `nginx`) with a self-signed certificate that forwards requests to the OHIF server
- [An OHIF Docker image can be set up this way](./docker.md#ssl).
- [An OHIF Docker image can be set up this way](./docker/docker.md#ssl).
:::
## Origin Definition

View File

@ -35,7 +35,7 @@ Building a Docker image comes in handy when OHIF has been customized (e.g. with
### Prerequisites
The machine on which to build and run the Docker container must have:
1. All of the [requirements](./build-for-production.md#build-for-production) for building a production version of OHIF.
1. All of the [requirements](../build-for-production.md#build-for-production) for building a production version of OHIF.
2. A checked out branch of the OHIF Viewer.
3. [Docker](https://docs.docker.com/get-docker/) installed.

View File

@ -198,7 +198,7 @@ new mode as well.
[viewers-project]: https://github.com/OHIF/Viewers
[viewer-npm]: https://www.npmjs.com/package/@ohif/app
[pwa]: https://developers.google.com/web/progressive-web-apps/
[configuration]: ../configuration/index.md
[configuration]: ../configuration/configurationFiles.md
[extensions]: ../platform/extensions/index.md
[core-github]: https://github.com/OHIF/viewers/platform/core
[ui-github]: https://github.com/OHIF/Viewers/tree/master/platform/ui

View File

@ -152,5 +152,5 @@ addressed and a Stable version is released.
[ohif-prod]: https://viewer.ohif.org
[gh-board]: https://github.com/OHIF/Viewers/projects/4
[label-grabs]: https://github.com/OHIF/Viewers/issues?q=is%3Aissue+is%3Aopen+label%3A%22Up+For+Grabs+%3Araising_hand_woman%3A%22
[contributing-docs]: ./development/contributing.md
[contributing-docs]: ./contributing.md
<!-- prettier-ignore-end -->

View File

@ -66,7 +66,7 @@ are configuration objects that will be used by the viewer to load the modules. T
- cornerstone-core and cornerstone-tools are removed and OHIF v3 is using the new Cornerstone3D rendering library and tools. Moving to Cornerstone3D has enabled us to provide a more robust and stable foundation
for 3D rendering and 3D annotations and measurements. In addition, Cornerstone3D provides APIs to load
and stream data into a volume which has huge performance benefits.
- A new CLI tool to help you create extensions and modes (more [here]((./development/ohif-cli.md)))
- A new CLI tool to help you create extensions and modes (more [here](../development/ohif-cli.md))
- redux store has been removed and replaced with a simpler state management system via React Context API.
New significant additions that might be useful for you that weren't available in OHIF v2:
@ -104,7 +104,7 @@ far more capable than servers. Read more about dataSources [here](../platform/ex
- `StudyPrefetcher` is only available in OHIF v3.9 beta and will be available in the next stable 3.9 release.
- The `servers` object has been replaced with a `dataSources` array containing objects representing different data sources.
- The cornerstoneExtensionConfig property has been removed, you should use `customizationService` instead (you can read more [here](../platform/services/ui/customization-service.md))
- The cornerstoneExtensionConfig property has been removed, you should use `customizationService` instead (you can read more [here](../platform/services/customization-service/customizationService.md))
- The maxConcurrentMetadataRequests property has been removed in favor of `maxNumRequests`
- The hotkeys array has been updated with different command names and options, and some keys have been removed.
- New properties have been added, including `maxNumberOfWebWorkers`, `omitQuotationForMultipartRequest`, `showWarningMessageForCrossOrigin`, `showCPUFallbackMessage`, `showLoadingIndicator`, `strictZSpacingForVolumeViewport`.
@ -222,7 +222,7 @@ Can I register a custom route to OHIF v3?
</summary>
Yes, you can take advantage of the customizationService and register your own routes.
see [custom routes](../platform/services/ui/customization-service.md#customroutes)
see [custom routes](../platform/services/customization-service/customRoutes.md)
</details>

View File

@ -95,7 +95,7 @@ Therefore, navigating to
`http://localhost:3000/viewer/?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1`
will run the app with the layout and functionalities of the `viewer` mode using
the `defaultDataSourceName` which is defined in the
[App Config](../../configuration/index.md)
[App Config](../../configuration/configurationFiles.md)
You can use the same exact mode using a different registered data source (e.g.,
`dicomjson`) by navigating to

View File

@ -39,7 +39,7 @@ many data sources. The OHIF Viewer's scope **DOES** include configuration and
support for services that are protected with OpenID-Connect.
In an effort to aid our users and contributors, we attempt to provide several
[deployment and hosting recipes](./deployment/index.md) as potential starting
[deployment and hosting recipes](../deployment/index.md) as potential starting
points. These are not meant to be rock solid, production ready, solutions; like
most recipes, they should be augmented to best fit you and your organization's
taste, preferences, etc.

View File

@ -19,8 +19,8 @@ We maintain the following non-ui Services:
- [Hanging Protocol Service](../data/HangingProtocolService.md)
- [Toolbar Service](./ToolbarService.md)
- [Measurement Service](../data/MeasurementService.md)
- [Customization Service](./../ui/customization-service.md)
- [State Sync Service](../data/StateSyncService.md)
- [Customization Service](./../customization-service/customizationService.md)
- [State Sync Service](../../../../versioned_docs/version-3.9/migration-guide/3p8-to-3p9/5-StateSyncService.md)
- [Panel Service](../data/PanelService.md)
## Service Architecture

View File

@ -47,8 +47,8 @@ module.exports = {
defaultLocale: 'en',
locales: ['en'],
},
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: 'img/favicon.ico',
themes: ['@docusaurus/theme-live-codeblock'],
plugins: [

View File

@ -30,17 +30,17 @@
]
},
"dependencies": {
"@docusaurus/core": "3.6.1",
"@docusaurus/faster": "3.6.1",
"@docusaurus/module-type-aliases": "3.0.0",
"@docusaurus/plugin-client-redirects": "3.6.1",
"@docusaurus/plugin-google-gtag": "3.6.1",
"@docusaurus/plugin-ideal-image": "3.6.1",
"@docusaurus/plugin-pwa": "3.6.1",
"@docusaurus/preset-classic": "3.6.1",
"@docusaurus/remark-plugin-npm2yarn": "3.6.1",
"@docusaurus/theme-classic": "3.6.1",
"@docusaurus/theme-live-codeblock": "3.6.1",
"@docusaurus/core": "3.7.0",
"@docusaurus/faster": "3.7.0",
"@docusaurus/module-type-aliases": "3.7.0",
"@docusaurus/plugin-client-redirects": "3.7.0",
"@docusaurus/plugin-google-gtag": "3.7.0",
"@docusaurus/plugin-ideal-image": "3.7.0",
"@docusaurus/plugin-pwa": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
"@docusaurus/remark-plugin-npm2yarn": "3.7.0",
"@docusaurus/theme-classic": "3.7.0",
"@docusaurus/theme-live-codeblock": "3.7.0",
"@docusaurus/tsconfig": "3.0.0",
"@docusaurus/types": "3.0.0",
"@mdx-js/react": "3.0.1",

View File

@ -51,12 +51,6 @@ export default function Versions() {
</li>
))}
</ul>
<p>
You can read more about the differences between the versions in the{' '}
<Link to="/docs/development/getting-started#branches">development section</Link> of the
documentation to understand which version is more suitable for your use case.
</p>
</div>
</Layout>
);

View File

@ -95,7 +95,7 @@ yarn run dev:orthanc
#### Configuration: Learn More
> For more configuration fun, check out the
> [Essentials Configuration](../index.md) guide.
> [Essentials Configuration](../configurationFiles.md) guide.
Let's take a look at what's going on under the hood here. `yarn run dev:orthanc`
is running the `dev:orthanc` script in our project's `package.json` (inside
@ -183,7 +183,7 @@ A comma delimited string specifying which payloads the data source responds with
For DICOM video and PDF it has been found that Orthanc delivers multipart, while DCM4CHEE delivers single part. Consult the DICOM conformance statement for your particular data source to determine which payload types it delivers.
To learn more about how you can configure the OHIF Viewer, check out our
[Configuration Guide](../index.md).
[Configuration Guide](../configurationFiles.md).
### DICOM PDF

View File

@ -198,7 +198,7 @@ new mode as well.
[viewers-project]: https://github.com/OHIF/Viewers
[viewer-npm]: https://www.npmjs.com/package/@ohif/app
[pwa]: https://developers.google.com/web/progressive-web-apps/
[configuration]: ../configuration/index.md
[configuration]: ../configuration/configurationFiles.md
[extensions]: ../platform/extensions/index.md
[core-github]: https://github.com/OHIF/viewers/platform/core
[ui-github]: https://github.com/OHIF/Viewers/tree/master/platform/ui

View File

@ -39,7 +39,7 @@ Below we demonstrate how to link Cornerstone3D to OHIF Viewer. This is useful fo
<iframe src="https://player.vimeo.com/video/849096279?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameBorder="0" allow="autoplay; fullscreen; picture-in-picture" allowFullScreen style= {{ position:"absolute",top:0,left:0,width:"100%",height:"100%"}} title="measurement-report"></iframe>
</div>
::tip
:::tip
Since `@cornerstonejs/tools` depends on `@cornerstonejs/core`, if you need the changes
you made in `@cornerstonejs/core` to be reflected in `@cornerstonejs/tools`, you need to
also link `@cornerstonejs/core` to `@cornerstonejs/tools`.
@ -60,3 +60,4 @@ cd /path/to/OHIFViewer
yarn link "@cornerstonejs/core"
yarn link "@cornerstonejs/tools"
```
:::

View File

@ -152,5 +152,5 @@ addressed and a Stable version is released.
[ohif-prod]: https://viewer.ohif.org
[gh-board]: https://github.com/OHIF/Viewers/projects/4
[label-grabs]: https://github.com/OHIF/Viewers/issues?q=is%3Aissue+is%3Aopen+label%3A%22Up+For+Grabs+%3Araising_hand_woman%3A%22
[contributing-docs]: ./development/contributing.md
[contributing-docs]: ./contributing.md
<!-- prettier-ignore-end -->

View File

@ -66,7 +66,7 @@ are configuration objects that will be used by the viewer to load the modules. T
- cornerstone-core and cornerstone-tools are removed and OHIF v3 is using the new Cornerstone3D rendering library and tools. Moving to Cornerstone3D has enabled us to provide a more robust and stable foundation
for 3D rendering and 3D annotations and measurements. In addition, Cornerstone3D provides APIs to load
and stream data into a volume which has huge performance benefits.
- A new CLI tool to help you create extensions and modes (more [here]((./development/ohif-cli.md)))
- A new CLI tool to help you create extensions and modes (more [here](../development/ohif-cli.md))
- redux store has been removed and replaced with a simpler state management system via React Context API.
New significant additions that might be useful for you that weren't available in OHIF v2:

View File

@ -95,7 +95,7 @@ Therefore, navigating to
`http://localhost:3000/viewer/?StudyInstanceUIDs=1.3.6.1.4.1.25403.345050719074.3824.20170125113417.1`
will run the app with the layout and functionalities of the `viewer` mode using
the `defaultDataSourceName` which is defined in the
[App Config](../../configuration/index.md)
[App Config](../../configuration/configurationFiles.md)
You can use the same exact mode using a different registered data source (e.g.,
`dicomjson`) by navigating to

View File

@ -39,7 +39,7 @@ many data sources. The OHIF Viewer's scope **DOES** include configuration and
support for services that are protected with OpenID-Connect.
In an effort to aid our users and contributors, we attempt to provide several
[deployment and hosting recipes](./deployment/index.md) as potential starting
[deployment and hosting recipes](../deployment/index.md) as potential starting
points. These are not meant to be rock solid, production ready, solutions; like
most recipes, they should be augmented to best fit you and your organization's
taste, preferences, etc.

View File

@ -20,7 +20,7 @@ We maintain the following non-ui Services:
- [Toolbar Service](./ToolbarService.md)
- [Measurement Service](../data/MeasurementService.md)
- [Customization Service](./../ui/customization-service.md)
- [State Sync Service](../data/StateSyncService.md)
- [State Sync Service](../../../migration-guide/3p8-to-3p9/5-StateSyncService.md)
- [Panel Service](../data/PanelService.md)
## Service Architecture

File diff suppressed because it is too large Load Diff

View File

@ -8265,10 +8265,10 @@ cypress-file-upload@^5.0.8:
resolved "https://registry.yarnpkg.com/cypress-file-upload/-/cypress-file-upload-5.0.8.tgz#d8824cbeaab798e44be8009769f9a6c9daa1b4a1"
integrity sha512-+8VzNabRk3zG6x8f8BWArF/xA/W0VK4IZNx3MV0jFWrJS/qKn8eHfa5nU73P9fOQAgwHFJx7zjg4lwOnljMO8g==
cypress@^13.16.1:
version "13.16.1"
resolved "https://registry.yarnpkg.com/cypress/-/cypress-13.16.1.tgz#82e776f6ad2037ccce6b6feabed768615c476258"
integrity sha512-17FtCaz0cx7ssWYKXzGB0Vub8xHwpVPr+iPt2fHhLMDhVAPVrplD+rTQsZUsfb19LVBn5iwkEUFjQ1yVVJXsLA==
cypress@^14.0.0:
version "14.0.0"
resolved "https://registry.yarnpkg.com/cypress/-/cypress-14.0.0.tgz#a71cb0a243a0bfeb97b6973ab9c5291ca5288e93"
integrity sha512-kEGqQr23so5IpKeg/dp6GVi7RlHx1NmW66o2a2Q4wk9gRaAblLZQSiZJuDI8UMC4LlG5OJ7Q6joAiqTrfRNbTw==
dependencies:
"@cypress/request" "^3.0.6"
"@cypress/xvfb" "^1.2.4"
@ -8516,10 +8516,10 @@ dayjs@^1.10.4:
resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.11.13.tgz#92430b0139055c3ebb60150aa13e860a4b5a366c"
integrity sha512-oaMBel6gjolK862uaPQOVTA7q3TZhuSvuMQAAglQDOWYO9A91IrAOUJEyKVlqJlHE0vq5p5UXxzdPfMH/x6xNg==
dcmjs@*, dcmjs@>=0.33.0, dcmjs@^0.29.8:
version "0.34.5"
resolved "https://registry.yarnpkg.com/dcmjs/-/dcmjs-0.34.5.tgz#13fe2b4ff34145ea6efeb62e53967e76d867b8f8"
integrity sha512-a2m9lnvdQuKA0YllwymDiOOv7LEv43Vno9QyIP78QWKRc0azoMKxFpti9ynFy2zf2bcapEwaD9OzYes39FukVQ==
dcmjs@*, dcmjs@0.38.0, dcmjs@^0.29.8:
version "0.38.0"
resolved "https://registry.yarnpkg.com/dcmjs/-/dcmjs-0.38.0.tgz#34cb1b08b5a8159801fc647537d6f8e903cc78cf"
integrity sha512-fsVASGco1aDaq9g683/masbhc7jeGRT1breGsMuiCgCWtOGe7oJFeDDzPcmLTxM1fFt6daHPCk0FnQZTxpr8Ew==
dependencies:
"@babel/runtime-corejs3" "^7.22.5"
adm-zip "^0.5.10"