feat: Add customization URL parameter (#5992)

* Add customization URL parameter * fix: Preserve should be customizeable * Update customizations docs * fix: Overlay items on patient name * Add customization test * Fix resolve to absolute path * fix: Warn on no data in load * Remove unused customization stuff * fix: PR comments * Update stored parameters to only use an array for mulitples * Remove requires ohif.* special call out * Remove strict mode * PR comments * Document segmentation examples * Add three examples as requested * PR comments * lock * Remove old customizatoin export * fix: Ordering issues on customization loads * fix: Use correct default for dev builds app config * Fixes for conflicts * chore: restore pnpm-lock.yaml to match master The lockfile diff was incidental peer-descriptor churn and carried no functional dependency change. It tripped the CircleCI security-audit gate (which only runs when pnpm-lock.yaml is in the PR diff), surfacing a pre-existing critical `decompress` transitive vuln that also exists on master. Restoring master's lockfile removes the audit trigger. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * fix(ci): restore json5 lockfile entry; ignore unfixable decompress GHSA The previous commit restored pnpm-lock.yaml from master, which dropped the json5@2.2.3 entry that platform/core legitimately depends on (JSONC parsing for the customization feature). That broke `--frozen-lockfile` install (ERR_PNPM_OUTDATED_LOCKFILE). This restores the correct lockfile. Because the lockfile must change (json5), the CircleCI security-audit gate runs and previously failed on a critical `decompress` <=4.2.1 zip-slip advisory. This is a pre-existing transitive vuln (present on master too) with no published patch — decompress's latest release is 4.2.1, so no version bump/override can resolve it. It reaches the tree only via @itk-wasm/dam, a build/data-asset extraction tool under @cornerstonejs/labelmap-interpolation. Add GHSA-mp2f-45pm-3cg9 to the existing pnpm-workspace.yaml auditConfig ignoreGhsas accepted-risk list, matching how the repo already exempts other build-tooling advisories. `pnpm audit --audit-level high` now passes locally (1 critical ignored, 0 high). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(e2e): fix visitStudy URL encoding that broke mpr2 study load The visitStudy rewrite (added for the ?customization= option) built the URL with new URLSearchParams({ StudyInstanceUIDs: studyInstanceUID }), which percent-encodes the value. mpr2.spec.ts embeds an extra param in the UID string ('<uid>&hangingprotocolid=mpr'), so the & and = were encoded and the whole thing collapsed into one invalid StudyInstanceUIDs value -> the study could not be found ('studies are not available'), the viewer never rendered, and the side-panel-header-right click timed out. Restore master's raw concatenation for StudyInstanceUIDs (so embedded params survive as separate query params) while still appending the customization option separately. Only mpr2 embeds & in the UID, matching the single failure. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * PR comments --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-07 15:30:27 -04:00
1 parent 3d9a17bc0c
commit 3dd5c70cb2
@@ -0,0 +1,21 @@
+// Example URL-loaded customization: ctPresets
+//
+// Replaces the CT window/level presets offered in the window-level menu with a
+// site-specific set (key: `cornerstone.windowLevelPresets`). Other modalities
+// keep their defaults because only the `CT` entry is overridden.
+//
+// Load it with `?customization=ctPresets`.
+{
+  "global": {
+    "cornerstone.windowLevelPresets": {
+      "$merge": {
+        "CT": [
+          { "id": "ct-soft-tissue", "description": "Soft tissue", "window": "400", "level": "40" },
+          { "id": "ct-lung", "description": "Lung", "window": "1500", "level": "-600" },
+          { "id": "ct-angio", "description": "Angio", "window": "600", "level": "300" },
+          { "id": "ct-bone", "description": "Bone", "window": "2500", "level": "480" }
+        ]
+      }
+    }
+  }
+}
@@ -0,0 +1,23 @@
+// Example URL-loaded customization: measurementLabels
+//
+// Makes the viewer prompt for a label from a fixed list whenever a measurement
+// is created (key: `measurementLabels`). `labelOnMeasure` triggers the prompt on
+// creation and `exclusive` restricts entries to the provided items.
+//
+// Load it with `?customization=measurementLabels`.
+{
+  "global": {
+    "measurementLabels": {
+      "$set": {
+        "labelOnMeasure": true,
+        "exclusive": true,
+        "items": [
+          { "value": "Head", "label": "Head" },
+          { "value": "Shoulder", "label": "Shoulder" },
+          { "value": "Knee", "label": "Knee" },
+          { "value": "Toe", "label": "Toe" }
+        ]
+      }
+    }
+  }
+}
@@ -0,0 +1,34 @@
+// Example URL-loaded customization: patientBirthDate
+//
+// Adds a "Birth Date" column to the WorkList study list, right after the
+// Patient column. Because a URL customization file is DATA (never executed), it
+// cannot carry a render function — it inserts a plain, serializable column spec
+// (`id` + `meta`) and WorkList expands it into a display-only text column that
+// reads `row.patientBirthDate` (surfaced by the DICOMweb data source from DICOM
+// tag 00100030).
+//
+// This applies in the `global` phase, so it is in place before the WorkList
+// renders. Load it with `?customization=patientBirthDate`, or pull it in from
+// `appConfig.customizationService.requires`.
+{
+  "global": {
+    "workList.columns": {
+      // Insert at index 1 (immediately after the Patient column). Using a
+      // fixed index keeps the trailing `actions` column last.
+      "$splice": [
+        [
+          1,
+          0,
+          {
+            "id": "patientBirthDate",
+            "meta": {
+              "label": "Birth Date",
+              "minWidth": 130,
+              "priority": 40
+            }
+          }
+        ]
+      ]
+    }
+  }
+}
@@ -0,0 +1,42 @@
+// Example URL-loaded customization: smoothRotate
+//
+// Adds a "Smooth Rotate" tool button to the More Tools menu of the basic and
+// longitudinal viewers. It activates the cornerstone `PlanarRotate` tool, which
+// rotates the image freely as you drag (unlike the fixed 90° "Rotate Right").
+//
+// It extends the default toolbar customizations registered by the cornerstone
+// extension (`cornerstone.toolbarButtons` / `cornerstone.toolbarSections`) using
+// immutability-helper `$push` commands, so the built-in buttons are preserved.
+//
+// Load it with `?customization=smoothRotate`.
+{
+  "global": {
+    "cornerstone.toolbarButtons": {
+      "$push": [
+        {
+          "id": "SmoothRotate",
+          "uiType": "ohif.toolButton",
+          "props": {
+            "type": "tool",
+            // Re-use the existing rotate icon.
+            "icon": "tool-rotate-right",
+            "label": "Smooth Rotate",
+            "tooltip": "Smooth Rotate (drag to rotate the image freely)",
+            "commands": {
+              "commandName": "setToolActiveToolbar",
+              "commandOptions": {
+                "toolName": "PlanarRotate"
+              }
+            },
+            "evaluate": "evaluate.cornerstoneTool"
+          }
+        }
+      ]
+    },
+    "cornerstone.toolbarSections": {
+      "MoreTools": {
+        "$push": ["SmoothRotate"]
+      }
+    }
+  }
+}
@@ -0,0 +1,5 @@
+// Example chaining module: ensures `veterinaryOverlay` is loaded and applied
+// first when using `?customization=veterinary` alone.
+{
+  "requires": ["veterinaryOverlay"]
+}
@@ -0,0 +1,56 @@
+// Example URL-loaded customization: veterinaryOverlay
+//
+// Demonstrates a runtime-loaded customization that overrides the default
+// viewport overlay with a veterinary-style demographics layout. Loaded via
+// `?customization=veterinaryOverlay` (see CustomizationService URL handling).
+//
+// Uses the same `global`-at-top-level shape as the cornerstone overlay samples
+// and `inheritsFrom: 'ohif.overlayItem'` on each row, matching
+// extensions/cornerstone/.../viewportOverlayCustomization.tsx.
+{
+  "global": {
+    "viewportOverlay.topLeft": {
+      "$set": [
+        {
+          "id": "PatientName",
+          "inheritsFrom": "ohif.overlayItem",
+          "attribute": "PatientName",
+          "label": "Patient",
+          "title": "Patient name"
+        },
+        {
+          "id": "PatientID",
+          "inheritsFrom": "ohif.overlayItem",
+          "attribute": "PatientID",
+          "label": "ID",
+          "title": "Patient ID"
+        },
+        {
+          "id": "StudyDate",
+          "inheritsFrom": "ohif.overlayItem",
+          "attribute": "StudyDate",
+          "label": "Date",
+          "title": "Study date"
+        }
+      ]
+    },
+    "viewportOverlay.topRight": {
+      "$set": [
+        {
+          "id": "PatientSpecies",
+          "inheritsFrom": "ohif.overlayItem",
+          "attribute": "PatientSpecies",
+          "label": "Species",
+          "title": "Patient species"
+        },
+        {
+          "id": "PatientBreed",
+          "inheritsFrom": "ohif.overlayItem",
+          "attribute": "PatientBreed",
+          "label": "Breed",
+          "title": "Patient breed"
+        }
+      ]
+    }
+  }
+}