@3cr/viewer-browser 0.0.200 → 0.0.220

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.
Files changed (370) hide show
  1. package/.circleci/config.yml +46 -22
  2. package/.prettierrc +6 -0
  3. package/components.d.ts +23 -10
  4. package/dist/Viewer3CR.js +37 -46
  5. package/dist/Viewer3CR.mjs +22625 -20892
  6. package/dist/Viewer3CR.umd.js +37 -46
  7. package/dist/android-chrome-192x192.png +0 -0
  8. package/dist/android-chrome-512x512.png +0 -0
  9. package/dist/apple-touch-icon.png +0 -0
  10. package/dist/browserconfig.xml +9 -0
  11. package/dist/favicon-16x16.png +0 -0
  12. package/dist/favicon-32x32.png +0 -0
  13. package/dist/favicon.ico +0 -0
  14. package/dist/mstile-144x144.png +0 -0
  15. package/dist/mstile-150x150.png +0 -0
  16. package/dist/mstile-310x150.png +0 -0
  17. package/dist/mstile-310x310.png +0 -0
  18. package/dist/mstile-70x70.png +0 -0
  19. package/dist/safari-pinned-tab.svg +50 -0
  20. package/dist/site.webmanifest +19 -0
  21. package/index.html +34 -41
  22. package/package.json +23 -20
  23. package/playground/android-chrome-192x192.png +0 -0
  24. package/playground/android-chrome-512x512.png +0 -0
  25. package/playground/apple-touch-icon.png +0 -0
  26. package/playground/browserconfig.xml +9 -0
  27. package/playground/favicon-16x16.png +0 -0
  28. package/playground/favicon-32x32.png +0 -0
  29. package/playground/favicon.ico +0 -0
  30. package/playground/index.html +26 -29
  31. package/playground/mstile-144x144.png +0 -0
  32. package/playground/mstile-150x150.png +0 -0
  33. package/playground/mstile-310x150.png +0 -0
  34. package/playground/mstile-310x310.png +0 -0
  35. package/playground/mstile-70x70.png +0 -0
  36. package/playground/safari-pinned-tab.svg +50 -0
  37. package/playground/site.webmanifest +19 -0
  38. package/playground/sw.js +15 -1
  39. package/public/android-chrome-192x192.png +0 -0
  40. package/public/android-chrome-512x512.png +0 -0
  41. package/public/apple-touch-icon.png +0 -0
  42. package/public/browserconfig.xml +9 -0
  43. package/public/favicon-16x16.png +0 -0
  44. package/public/favicon-32x32.png +0 -0
  45. package/public/favicon.ico +0 -0
  46. package/public/mstile-144x144.png +0 -0
  47. package/public/mstile-150x150.png +0 -0
  48. package/public/mstile-310x150.png +0 -0
  49. package/public/mstile-310x310.png +0 -0
  50. package/public/mstile-70x70.png +0 -0
  51. package/public/safari-pinned-tab.svg +50 -0
  52. package/public/site.webmanifest +19 -0
  53. package/src/App.vue +35 -45
  54. package/src/__tests__/app.spec.ts +7 -8
  55. package/{__tests__/index.spec.ts → src/__tests__/main.spec.ts} +5 -6
  56. package/src/assets/logos/3dicom/white-mini.svg +20 -0
  57. package/src/assets/logos/3dicom/white.svg +30 -0
  58. package/src/assets/styles.scss +14 -4
  59. package/src/components/demo/__tests__/DemoModal.spec.ts +9 -8
  60. package/src/components/demo/__tests__/DemoPatientModal.spec.ts +11 -10
  61. package/src/components/demo/__tests__/options.spec.ts +1 -1
  62. package/src/components/demo/licence/__tests__/DemoLicenceEnableCloudStorageModal.spec.ts +11 -10
  63. package/src/components/demo/licence/__tests__/DemoLicenceInfoModal.spec.ts +21 -11
  64. package/src/components/demo/licence/__tests__/DemoLicenceSendToPartyModal.spec.ts +10 -10
  65. package/src/components/demo/licence/__tests__/DemoLicenceShareToMobileModal.spec.ts +14 -13
  66. package/src/components/demo/options.ts +54 -59
  67. package/src/components/demo/patient/__tests__/DemoPatientEnableCloudStorageModal.spec.ts +11 -10
  68. package/src/components/demo/patient/__tests__/DemoPatientInfoModal.spec.ts +12 -11
  69. package/src/components/demo/patient/__tests__/DemoPatientSendToPartyModal.spec.ts +10 -10
  70. package/src/components/demo/patient/__tests__/DemoPatientShareToMobileModal.spec.ts +14 -13
  71. package/src/components/modal/ActionRail.vue +7 -11
  72. package/src/components/modal/AskAI.vue +35 -50
  73. package/src/components/modal/CloseViewerModal.vue +22 -57
  74. package/src/components/modal/MftpWebGL3DRModal.vue +152 -570
  75. package/src/components/modal/ViewerActionRail.vue +50 -39
  76. package/src/components/modal/ViewerNavigationDrawer.vue +10 -8
  77. package/src/components/modal/ViewerNavigationDrawerContent.vue +82 -49
  78. package/src/components/modal/ViewerNavigationDrawerFooter.vue +57 -60
  79. package/src/components/modal/ViewerNavigationDrawerHeader.vue +13 -48
  80. package/src/components/modal/ViewerScanView.vue +114 -0
  81. package/src/components/modal/WebGL3DR.vue +84 -0
  82. package/src/components/modal/__tests__/ActionRail.spec.ts +10 -0
  83. package/src/components/modal/__tests__/AskAI.spec.ts +33 -0
  84. package/src/components/modal/__tests__/CloseViewerModal.spec.ts +24 -14
  85. package/src/components/modal/__tests__/MftpWebGL3DRModal.spec.ts +147 -176
  86. package/src/components/modal/__tests__/ViewerActionRail.spec.ts +11 -0
  87. package/src/components/modal/__tests__/ViewerNavigationDrawer.spec.ts +10 -12
  88. package/src/components/modal/__tests__/ViewerNavigationDrawerContent.spec.ts +4 -22
  89. package/src/components/modal/__tests__/ViewerNavigationDrawerFooter.spec.ts +35 -32
  90. package/src/components/modal/__tests__/ViewerNavigationDrawerHeader.spec.ts +11 -9
  91. package/src/components/modal/__tests__/ViewerScanView.spec.ts +60 -0
  92. package/src/components/modal/__tests__/WebGL3DR.spec.ts +57 -0
  93. package/src/components/modal/actions/Flip3dAction.vue +1 -1
  94. package/src/components/modal/actions/FlipHorizontalAction.vue +5 -10
  95. package/src/components/modal/actions/FlipVerticalAction.vue +5 -10
  96. package/src/components/modal/actions/FullscreenAction.vue +6 -11
  97. package/src/components/modal/actions/HideViewAction.vue +38 -0
  98. package/src/components/modal/actions/NavigationCubeAction.vue +7 -14
  99. package/src/components/modal/actions/PanAction.vue +4 -4
  100. package/src/components/modal/actions/ResetViewAction.vue +1 -1
  101. package/src/components/modal/actions/Rotate2dAction.vue +8 -20
  102. package/src/components/modal/actions/Slice3dAction.vue +10 -32
  103. package/src/components/modal/actions/ZoomAction.vue +1 -1
  104. package/src/components/modal/actions/__tests__/Action.spec.ts +8 -9
  105. package/src/components/modal/actions/__tests__/Flip3dAction.spec.ts +6 -8
  106. package/src/components/modal/actions/__tests__/FlipHorizontalAction.spec.ts +6 -7
  107. package/src/components/modal/actions/__tests__/FlipVerticalAction.spec.ts +6 -7
  108. package/src/components/modal/actions/__tests__/FullscreenAction.spec.ts +9 -10
  109. package/src/components/modal/actions/__tests__/NavigationCubeAction.spec.ts +11 -11
  110. package/src/components/modal/actions/__tests__/PanAction.spec.ts +9 -10
  111. package/src/components/modal/actions/__tests__/ResetViewAction.spec.ts +7 -7
  112. package/src/components/modal/actions/__tests__/Rotate2dAction.spec.ts +6 -8
  113. package/src/components/modal/actions/__tests__/Slice3dAction.spec.ts +23 -5
  114. package/src/components/modal/actions/__tests__/ZoomAction.spec.ts +8 -10
  115. package/src/components/modal/buttons/AutoAnnotateBtn.vue +29 -0
  116. package/src/components/modal/buttons/__tests__/AutoAnnotateBtn.spec.ts +28 -0
  117. package/src/components/modal/menus/FileMenu.vue +80 -0
  118. package/src/components/modal/menus/SettingsMenu.vue +111 -0
  119. package/src/components/modal/menus/__tests__/FileMenu.spec.ts +110 -0
  120. package/src/components/modal/menus/__tests__/SettingsMenu.spec.ts +71 -0
  121. package/src/components/shared/DoubleSliderSelector.vue +142 -0
  122. package/src/components/shared/UpdateSnackbar.vue +72 -0
  123. package/src/components/{selectors → shared}/ValueSelector.vue +9 -12
  124. package/src/components/shared/__tests__/DoubleSliderSelector.spec.ts +83 -0
  125. package/src/components/shared/__tests__/LoadingSpinner.spec.ts +9 -0
  126. package/src/components/shared/__tests__/UpdateSnackbar.spec.ts +116 -0
  127. package/src/components/shared/__tests__/ValueSelector.spec.ts +39 -0
  128. package/src/components/shared/__tests__/VerticalSliderSelector.spec.ts +50 -0
  129. package/src/components/views/AnnotationTreeView.vue +234 -0
  130. package/src/components/{modal/ViewerDisplaySettings.vue → views/DisplaySettings.vue} +7 -15
  131. package/src/components/views/MarkupTreeView.vue +199 -0
  132. package/src/components/views/McadObjectTreeView.vue +119 -0
  133. package/src/components/views/__tests__/AnnotationTreeView.spec.ts +62 -0
  134. package/src/components/{modal/__tests__/ViewerDisplaySettings.spec.ts → views/__tests__/DisplaySettings.spec.ts} +24 -20
  135. package/src/components/views/__tests__/MarkupTreeView.spec.ts +41 -0
  136. package/src/components/views/__tests__/McadObjectTreeView.spec.ts +47 -0
  137. package/src/components/views/modals/DataOverlayModal.vue +89 -0
  138. package/src/components/views/modals/DataOverlayModalManager.vue +104 -0
  139. package/src/components/views/modals/__tests__/DataOverlayModal.spec.ts +33 -0
  140. package/src/components/views/modals/__tests__/DataOverlayModalManager.spec.ts +93 -0
  141. package/src/components/views/shared/MaskIcon.vue +44 -0
  142. package/src/components/views/shared/ObjectColor.vue +31 -0
  143. package/src/components/views/shared/ObjectLabel.vue +30 -0
  144. package/src/components/views/shared/Opacity.vue +66 -0
  145. package/src/components/views/shared/VisibilityBtn.vue +25 -0
  146. package/src/components/views/shared/__tests__/MaskIcon.spec.ts +10 -0
  147. package/src/components/views/shared/__tests__/ObjectColor.spec.ts +10 -0
  148. package/src/components/views/shared/__tests__/ObjectLabel.spec.ts +10 -0
  149. package/src/components/views/shared/__tests__/Opacity.spec.ts +24 -0
  150. package/src/components/views/shared/__tests__/VisibilityBtn.spec.ts +11 -0
  151. package/src/components/views/types/annotation-tree-view-item-child-action.ts +6 -0
  152. package/src/components/views/types/annotation-tree-view-item-child.ts +9 -0
  153. package/src/components/views/types/annotation-tree-view-item.ts +13 -0
  154. package/src/components/views/types/markup-tree-view-item-child.ts +6 -0
  155. package/src/components/views/types/markup-tree-view-item.ts +14 -0
  156. package/src/components/views/types/mcad-object-tree-view-item.ts +13 -0
  157. package/src/composables/__tests__/useAnnotations.spec.ts +35 -0
  158. package/src/composables/__tests__/useEventListener.spec.ts +32 -0
  159. package/src/composables/__tests__/useIntroJs.spec.ts +51 -0
  160. package/src/composables/__tests__/useMarkups.spec.ts +39 -0
  161. package/src/composables/__tests__/useMcadObjects.spec.ts +36 -0
  162. package/src/composables/__tests__/useMouse.spec.ts +20 -0
  163. package/src/{components/modal/composables → composables}/__tests__/useNavigationCubeObserver.spec.ts +17 -12
  164. package/src/{dataLayer → composables}/__tests__/useViewer3cr.spec.ts +1 -2
  165. package/src/composables/useAnnotations.ts +37 -0
  166. package/src/composables/useEventListener.ts +25 -0
  167. package/src/composables/useIntroJs.ts +125 -0
  168. package/src/composables/useMarkups.ts +41 -0
  169. package/src/composables/useMcadObjects.ts +32 -0
  170. package/src/composables/useMouse.ts +14 -0
  171. package/src/{components/modal/composables → composables}/useNavigationCubeObserver.ts +35 -25
  172. package/src/composables/useScanMovement.ts +25 -0
  173. package/src/composables/useScanSliders.ts +36 -0
  174. package/src/composables/useVersion3cr.ts +7 -0
  175. package/src/composables/useViewer3cr.ts +7 -0
  176. package/src/composables/useViewerOptions.ts +35 -0
  177. package/src/{dataLayer → functions}/__tests__/clamp.spec.ts +1 -2
  178. package/src/functions/__tests__/layoutOverlayStyle.spec.ts +325 -0
  179. package/src/{helpers/__tests__/model-helper.spec.ts → functions/__tests__/modelHelper.spec.ts} +77 -40
  180. package/src/{notifications → functions}/__tests__/notification.spec.ts +19 -29
  181. package/src/functions/__tests__/parseAction.spec.ts +9 -0
  182. package/src/functions/__tests__/parseCallToAction.spec.ts +11 -0
  183. package/src/functions/__tests__/parseDataOverlay.spec.ts +15 -0
  184. package/src/functions/__tests__/parseDataOverlayData.spec.ts +9 -0
  185. package/src/functions/__tests__/parseDataOverlayEvent.spec.ts +10 -0
  186. package/src/functions/__tests__/parseMcadEvent.spec.ts +10 -0
  187. package/src/functions/layoutOverlayStyle.ts +84 -0
  188. package/src/{helpers → functions}/modelHelper.ts +79 -18
  189. package/src/{notifications → functions}/notification.ts +12 -14
  190. package/src/functions/parseAction.ts +9 -0
  191. package/src/functions/parseCallToAction.ts +9 -0
  192. package/src/functions/parseDataOverlay.ts +10 -0
  193. package/src/functions/parseDataOverlayData.ts +10 -0
  194. package/src/functions/parseDataOverlayEvent.ts +17 -0
  195. package/src/functions/parseMcadEvent.ts +10 -0
  196. package/src/functions/rgbaToCss.ts +13 -0
  197. package/src/main.ts +48 -9
  198. package/src/{dataLayer → models}/__tests__/eventHandlers.spec.ts +2 -3
  199. package/src/models/__tests__/loadViewerOptions.spec.ts +72 -0
  200. package/src/models/__tests__/loadViewerPayload.spec.ts +10 -0
  201. package/src/models/__tests__/scanState.spec.ts +190 -0
  202. package/src/models/callbacks.ts +4 -0
  203. package/src/models/loadViewerOptions.ts +40 -0
  204. package/src/models/loadViewerPayload.ts +24 -0
  205. package/src/{dataLayer → models}/scanState.ts +63 -74
  206. package/src/plugins/__tests__/usePlugins.spec.ts +12 -0
  207. package/src/plugins/__tests__/vuetify.spec.ts +3 -4
  208. package/src/plugins/usePlugins.ts +8 -0
  209. package/src/plugins/vuetify.ts +31 -65
  210. package/src/services/{gpt/__tests__ → __tests__}/gpt.service.spec.ts +2 -2
  211. package/src/services/__tests__/service-worker.service.spec.ts +32 -0
  212. package/src/{dataLayer/__tests__/viewer3cr.spec.ts → services/__tests__/viewer-3cr.service.spec.ts} +97 -36
  213. package/src/services/gpt.service.ts +17 -0
  214. package/src/services/service-worker.service.ts +16 -0
  215. package/src/{dataLayer/viewer3cr.ts → services/viewer-3cr.service.ts} +269 -150
  216. package/src/types/action.ts +13 -0
  217. package/src/types/call-to-action.ts +9 -0
  218. package/src/types/colour.ts +6 -0
  219. package/src/types/data-overlay-angle.ts +16 -0
  220. package/src/types/data-overlay-annotation.ts +18 -0
  221. package/src/types/data-overlay-data.ts +15 -0
  222. package/src/types/data-overlay-info.ts +14 -0
  223. package/src/types/data-overlay-interaction.ts +15 -0
  224. package/src/types/data-overlay-length.ts +16 -0
  225. package/src/types/data-overlay-markup.ts +7 -0
  226. package/src/types/data-overlay-mcad.ts +20 -0
  227. package/src/types/data-overlay-polygon.ts +18 -0
  228. package/src/types/data-overlay.ts +16 -0
  229. package/src/types/gpt-question.ts +4 -0
  230. package/src/types/gpt-response-payload.ts +6 -0
  231. package/src/types/mcad-object-interaction.ts +15 -0
  232. package/src/types/segment-angle.ts +5 -0
  233. package/src/types/vector2.ts +4 -0
  234. package/src/types/vector3.ts +5 -0
  235. package/test/fakers/action-data.faker.ts +11 -0
  236. package/test/fakers/action.faker.ts +19 -0
  237. package/test/fakers/call-to-action.faker.ts +17 -0
  238. package/test/fakers/colour.faker.ts +17 -0
  239. package/test/fakers/data-overlay-angle.faker.ts +37 -0
  240. package/test/fakers/data-overlay-annotation.faker.ts +41 -0
  241. package/test/fakers/data-overlay-data.faker.ts +97 -0
  242. package/test/fakers/data-overlay-info.faker.ts +29 -0
  243. package/test/fakers/data-overlay-interaction.faker.ts +62 -0
  244. package/test/fakers/data-overlay-length.faker.ts +37 -0
  245. package/test/fakers/data-overlay-mcad.faker.ts +40 -0
  246. package/test/fakers/data-overlay-polygon.faker.ts +39 -0
  247. package/test/fakers/gpt-question.faker.ts +11 -0
  248. package/test/fakers/gpt-response.faker.ts +12 -0
  249. package/test/fakers/invert-transform.faker.ts +16 -0
  250. package/test/fakers/mcad-object-interaction.faker.ts +22 -0
  251. package/test/fakers/orientation.faker.ts +17 -0
  252. package/test/fakers/segment-angle.faker.ts +12 -0
  253. package/test/fakers/vector2.faker.ts +12 -0
  254. package/test/fakers/vector3.faker.ts +16 -0
  255. package/test/plugins/findByTestId.ts +25 -0
  256. package/test/plugins/vuetify.ts +16 -0
  257. package/test/setup.ts +16 -5
  258. package/tsconfig.json +4 -15
  259. package/vite.config.mts +20 -46
  260. package/vitest.config.mts +24 -43
  261. package/index.ts +0 -72
  262. package/src/assets/images/dark/3DICOM.png +0 -0
  263. package/src/assets/images/dark/3dicom-logo.svg +0 -1
  264. package/src/assets/images/light/3DICOM.png +0 -0
  265. package/src/assets/images/light/3dicom-logo.svg +0 -1
  266. package/src/assets/logo.png +0 -0
  267. package/src/assets/logo.svg +0 -6
  268. package/src/components/WebGL3DR.vue +0 -102
  269. package/src/components/__tests__/webgl3dr.spec.ts +0 -37
  270. package/src/components/icons/liver.vue +0 -21
  271. package/src/components/loading/__tests__/loading-spinner.spec.ts +0 -11
  272. package/src/components/modal/ViewerAnnotationModal.vue +0 -111
  273. package/src/components/modal/ViewerAnnotations.vue +0 -289
  274. package/src/components/modal/__tests__/ViewerAnnotationModal.spec.ts +0 -79
  275. package/src/components/modal/composables/useEventListener.ts +0 -22
  276. package/src/components/selectors/__tests__/value-selector.spec.ts +0 -53
  277. package/src/components/sliders/DoubleSliderSelector.vue +0 -141
  278. package/src/components/sliders/__tests__/double-slider-selector.spec.ts +0 -104
  279. package/src/components/sliders/__tests__/vertical-slider-selector.spec.ts +0 -61
  280. package/src/dataLayer/__tests__/getIconForPreset.spec.ts +0 -40
  281. package/src/dataLayer/__tests__/patchDataOverlay.spec.ts +0 -88
  282. package/src/dataLayer/__tests__/scanState.spec.ts +0 -93
  283. package/src/dataLayer/getIconForPreset.ts +0 -11
  284. package/src/dataLayer/patchDataOverlay.ts +0 -101
  285. package/src/dataLayer/useViewer3cr.ts +0 -7
  286. package/src/helpers/__tests__/layout-overlay-style.spec.ts +0 -290
  287. package/src/helpers/__tests__/utils.spec.ts +0 -70
  288. package/src/helpers/layoutOverlayStyle.ts +0 -96
  289. package/src/helpers/utils.ts +0 -16
  290. package/src/models/Callbacks.ts +0 -2
  291. package/src/models/LoadViewerOptions.ts +0 -31
  292. package/src/models/LoadViewerPayload.ts +0 -9
  293. package/src/models/__tests__/load-viewer-options.spec.ts +0 -22
  294. package/src/plugins/__tests__/index.spec.ts +0 -19
  295. package/src/plugins/index.ts +0 -17
  296. package/src/services/gpt/gpt.service.ts +0 -35
  297. package/static/3cr-types-browser/index.ts +0 -74
  298. package/static/3cr-types-browser/types/Action.ts +0 -6
  299. package/static/3cr-types-browser/types/AlphaKeys.ts +0 -5
  300. package/static/3cr-types-browser/types/AnchorPoint.ts +0 -12
  301. package/static/3cr-types-browser/types/CallToAction.ts +0 -5
  302. package/static/3cr-types-browser/types/ColourData.ts +0 -7
  303. package/static/3cr-types-browser/types/ColourPresetData.ts +0 -9
  304. package/static/3cr-types-browser/types/CurrentDataOverlayState.ts +0 -6
  305. package/static/3cr-types-browser/types/CurrentScanState.ts +0 -22
  306. package/static/3cr-types-browser/types/DataOverlay.ts +0 -22
  307. package/static/3cr-types-browser/types/DataOverlayActions.ts +0 -14
  308. package/static/3cr-types-browser/types/DataOverlayData.ts +0 -8
  309. package/static/3cr-types-browser/types/DataOverlayEvent.ts +0 -8
  310. package/static/3cr-types-browser/types/DecryptionKey.ts +0 -4
  311. package/static/3cr-types-browser/types/DisplaySettings.ts +0 -10
  312. package/static/3cr-types-browser/types/EmptyPayload.ts +0 -3
  313. package/static/3cr-types-browser/types/EnumPayload.ts +0 -4
  314. package/static/3cr-types-browser/types/FileManagementActions.ts +0 -11
  315. package/static/3cr-types-browser/types/FlipValue.ts +0 -7
  316. package/static/3cr-types-browser/types/FrontEndInterfaces.ts +0 -14
  317. package/static/3cr-types-browser/types/GradientKeys.ts +0 -7
  318. package/static/3cr-types-browser/types/GreyscalePresetData.ts +0 -6
  319. package/static/3cr-types-browser/types/InitialDataOverlayState.ts +0 -6
  320. package/static/3cr-types-browser/types/InitialScanState.ts +0 -19
  321. package/static/3cr-types-browser/types/InteractionType.ts +0 -8
  322. package/static/3cr-types-browser/types/InteractivityActions.ts +0 -6
  323. package/static/3cr-types-browser/types/InteractivityState.ts +0 -4
  324. package/static/3cr-types-browser/types/InvertTransformData.ts +0 -6
  325. package/static/3cr-types-browser/types/LayoutActions.ts +0 -6
  326. package/static/3cr-types-browser/types/LayoutData.ts +0 -7
  327. package/static/3cr-types-browser/types/LoadDataSet.ts +0 -6
  328. package/static/3cr-types-browser/types/LoadSessionState.ts +0 -4
  329. package/static/3cr-types-browser/types/LocalLoadDataset.ts +0 -3
  330. package/static/3cr-types-browser/types/MovementData.ts +0 -7
  331. package/static/3cr-types-browser/types/NavigationCubeActions.ts +0 -8
  332. package/static/3cr-types-browser/types/NavigationCubeData.ts +0 -12
  333. package/static/3cr-types-browser/types/NavigationCubeTransform.ts +0 -9
  334. package/static/3cr-types-browser/types/NotificationPayload.ts +0 -7
  335. package/static/3cr-types-browser/types/NotificationsActions.ts +0 -6
  336. package/static/3cr-types-browser/types/Object.ts +0 -1
  337. package/static/3cr-types-browser/types/ObjectColour.ts +0 -7
  338. package/static/3cr-types-browser/types/ObjectIcon.ts +0 -5
  339. package/static/3cr-types-browser/types/ObjectInvert.ts +0 -7
  340. package/static/3cr-types-browser/types/ObjectSize.ts +0 -7
  341. package/static/3cr-types-browser/types/ObjectSize2D.ts +0 -7
  342. package/static/3cr-types-browser/types/ObjectVisible.ts +0 -5
  343. package/static/3cr-types-browser/types/PositionData.ts +0 -14
  344. package/static/3cr-types-browser/types/PresetsActions.ts +0 -4
  345. package/static/3cr-types-browser/types/RotationValue.ts +0 -7
  346. package/static/3cr-types-browser/types/ScanMovementActions.ts +0 -27
  347. package/static/3cr-types-browser/types/ScanMovementData.ts +0 -3
  348. package/static/3cr-types-browser/types/ScanOrientationActions.ts +0 -6
  349. package/static/3cr-types-browser/types/ScanStateActions.ts +0 -4
  350. package/static/3cr-types-browser/types/ScanView.ts +0 -6
  351. package/static/3cr-types-browser/types/SettingsData.ts +0 -12
  352. package/static/3cr-types-browser/types/SlicerData.ts +0 -9
  353. package/static/3cr-types-browser/types/SliderValue.ts +0 -4
  354. package/static/3cr-types-browser/types/SlidersActions.ts +0 -18
  355. package/static/3cr-types-browser/types/Vector2Data.ts +0 -5
  356. package/static/3cr-types-browser/types/Vector3Data.ts +0 -6
  357. package/static/3cr-types-browser/types/VectorMovementData.ts +0 -8
  358. package/static/3cr-types-browser/types/ViewInteractiveMode.ts +0 -5
  359. package/static/3cr-types-browser/types/ViewOrientation.ts +0 -8
  360. package/static/3cr-types-browser/types/ViewOrientations.ts +0 -10
  361. package/static/3cr-types-browser/types/ViewSelectionActions.ts +0 -9
  362. package/static/3cr-types-browser/types/ViewToggleData.ts +0 -7
  363. package/static/3cr-types-browser/types/VolumeOrientation.ts +0 -7
  364. package/test/helper.ts +0 -44
  365. /package/src/components/{loading → shared}/LoadingSpinner.vue +0 -0
  366. /package/src/components/{sliders → shared}/VerticalSliderSelector.vue +0 -0
  367. /package/{config.ts → src/config.ts} +0 -0
  368. /package/src/{dataLayer → functions}/clamp.ts +0 -0
  369. /package/src/{dataLayer → models}/eventHandlers.ts +0 -0
  370. /package/{static/3cr-types-browser/types/ActionData.ts → src/types/action-data.ts} +0 -0
@@ -0,0 +1,25 @@
1
+ <template>
2
+ <v-btn size="x-small" :icon="icon" variant="text" />
3
+ </template>
4
+
5
+ <script setup lang="ts">
6
+ import { computed } from 'vue';
7
+
8
+ interface Props {
9
+ isVisible: boolean;
10
+ }
11
+
12
+ const props = withDefaults(defineProps<Props>(), {
13
+ isVisible: true
14
+ });
15
+
16
+ const icon = computed(() => {
17
+ return props.isVisible ? 'visibility' : 'visibility_off';
18
+ });
19
+ </script>
20
+
21
+ <style scoped lang="css">
22
+ :deep(.v-icon) {
23
+ font-size: 20px;
24
+ }
25
+ </style>
@@ -0,0 +1,10 @@
1
+ import { mount } from '@vue/test-utils';
2
+ import MaskIcon from '@/components/views/shared/MaskIcon.vue';
3
+
4
+ describe('MaskIcon tests', () => {
5
+ it('should mount', () => {
6
+ const props = { data: '0', color: 'white' };
7
+ const wrapper = mount(MaskIcon, { props });
8
+ expect(wrapper).toBeTruthy();
9
+ });
10
+ });
@@ -0,0 +1,10 @@
1
+ import { mount } from '@vue/test-utils';
2
+ import ObjectColor from '@/components/views/shared/ObjectColor.vue';
3
+
4
+ describe('ObjectColor tests', () => {
5
+ it('should mount', () => {
6
+ const props = { color: 'red' };
7
+ const wrapper = mount(ObjectColor, { props });
8
+ expect(wrapper).toBeTruthy();
9
+ });
10
+ });
@@ -0,0 +1,10 @@
1
+ import { mount } from '@vue/test-utils';
2
+ import ObjectLabel from '@/components/views/shared/ObjectLabel.vue';
3
+
4
+ describe('ObjectLabel tests', () => {
5
+ it('should mount', () => {
6
+ const props = { label: 'test' };
7
+ const wrapper = mount(ObjectLabel, { props });
8
+ expect(wrapper).toBeTruthy();
9
+ });
10
+ });
@@ -0,0 +1,24 @@
1
+ import { mount } from '@vue/test-utils';
2
+ import Opacity from '@/components/views/shared/Opacity.vue';
3
+ import { VTextField } from 'vuetify/components';
4
+
5
+ describe('Opacity tests', () => {
6
+ it('should mount', () => {
7
+ const props = { modelValue: 50 };
8
+ const wrapper = mount(Opacity, { props });
9
+ expect(wrapper).toBeTruthy();
10
+ });
11
+
12
+ it('should set value', async () => {
13
+ const wrapper = mount(Opacity);
14
+ await wrapper.findComponent(VTextField).setValue('100');
15
+ expect(wrapper.emitted('update:modelValue')).toEqual([[100]]);
16
+ });
17
+
18
+ it('should set native value', async () => {
19
+ const wrapper = mount(Opacity);
20
+ await wrapper.find('input').setValue('');
21
+ await wrapper.find('input').setValue('100');
22
+ expect(wrapper.emitted('update:modelValue')).toEqual([[0], [100]]);
23
+ });
24
+ });
@@ -0,0 +1,11 @@
1
+ import { mount } from '@vue/test-utils';
2
+ import VisibilityBtn from '@/components/views/shared/VisibilityBtn.vue';
3
+
4
+ describe('VisibilityBtn tests', () => {
5
+ it('should mount', async () => {
6
+ const props = { isVisible: true };
7
+ const wrapper = mount(VisibilityBtn, { props });
8
+ await wrapper.setProps({ isVisible: false });
9
+ expect(wrapper).toBeTruthy();
10
+ });
11
+ });
@@ -0,0 +1,6 @@
1
+ export interface AnnotationTreeViewItemChildAction {
2
+ title: string;
3
+ description: string;
4
+ url: string;
5
+ isBtn: boolean;
6
+ }
@@ -0,0 +1,9 @@
1
+ import { AnnotationTreeViewItemChildAction } from '@/components/views/types/annotation-tree-view-item-child-action';
2
+
3
+ export interface AnnotationTreeViewItemChild {
4
+ props: {
5
+ key: string;
6
+ value: string;
7
+ actions: AnnotationTreeViewItemChildAction[];
8
+ };
9
+ }
@@ -0,0 +1,13 @@
1
+ import { Vector3 } from '@/types/vector3';
2
+ import { Colour } from '@/types/colour';
3
+ import { AnnotationTreeViewItemChild } from '@/components/views/types/annotation-tree-view-item-child';
4
+
5
+ export interface AnnotationTreeViewItem {
6
+ id: string;
7
+ title: string;
8
+ isVisible: boolean;
9
+ icon: string;
10
+ position: Vector3;
11
+ colour: Colour;
12
+ children: AnnotationTreeViewItemChild[];
13
+ }
@@ -0,0 +1,6 @@
1
+ export interface MarkupTreeViewItemChild {
2
+ props: {
3
+ key: string;
4
+ value: string;
5
+ };
6
+ }
@@ -0,0 +1,14 @@
1
+ import { Vector3 } from '@/types/vector3';
2
+ import { MarkupTreeViewItemChild } from '@/components/views/types/markup-tree-view-item-child';
3
+
4
+ export interface MarkupTreeViewItem {
5
+ id: string;
6
+ title: string;
7
+ description: string;
8
+ isVisible: boolean;
9
+ tooltip: string;
10
+ colour: string;
11
+ icon: string;
12
+ position: Vector3;
13
+ children: MarkupTreeViewItemChild[];
14
+ }
@@ -0,0 +1,13 @@
1
+ export interface McadObjectTreeViewItem {
2
+ id: string;
3
+ key: string;
4
+ title: string;
5
+ description: string;
6
+ isVisible: boolean;
7
+ colour: {
8
+ r: number;
9
+ g: number;
10
+ b: number;
11
+ a: number;
12
+ };
13
+ }
@@ -0,0 +1,35 @@
1
+ import { useAnnotations } from '@/composables/useAnnotations';
2
+ import { dataOverlayEvent, dataOverlayState } from '@/models/scanState';
3
+ import { DataOverlayDataFaker } from '@test/fakers/data-overlay-data.faker';
4
+ import { Interactiontype } from '@3cr/types-ts';
5
+ import { inflateInitialDataOverlayState } from '@/functions/modelHelper';
6
+
7
+ describe('useAnnotations tests', () => {
8
+ it('should have no annotations', () => {
9
+ const { annotations, hasAnnotations } = useAnnotations();
10
+ expect(annotations.value.length).toBe(0);
11
+ expect(hasAnnotations.value).toBeFalsy();
12
+ });
13
+
14
+ it('should have annotations', () => {
15
+ const dataOverlay = inflateInitialDataOverlayState();
16
+ dataOverlay.DataOverlay.DataOverlay.push(DataOverlayDataFaker.annotationRaw());
17
+ dataOverlayState.value = dataOverlay;
18
+
19
+ const { annotations } = useAnnotations();
20
+ expect(annotations.value.length).toBe(1);
21
+ expect(typeof annotations.value[0].Data).not.toBe('string');
22
+ });
23
+
24
+ it('should have null event', () => {
25
+ const { annotationEvent } = useAnnotations();
26
+ expect(annotationEvent.value).toBeNull();
27
+ });
28
+
29
+ it('should have non-null event', () => {
30
+ dataOverlayEvent.value = DataOverlayDataFaker.annotationEventRaw(Interactiontype.HOVER_START);
31
+ const { annotationEvent } = useAnnotations();
32
+ expect(annotationEvent.value).not.toBeNull();
33
+ expect(typeof annotationEvent.value?.DataOverlay).not.toBe('string');
34
+ });
35
+ });
@@ -0,0 +1,32 @@
1
+ import { defineComponent, ref, PropType, nextTick } from 'vue';
2
+ import { useEventListener } from '@/composables/useEventListener';
3
+ import { mount } from '@vue/test-utils';
4
+
5
+ describe('useEventListener tests', () => {
6
+ it('should attach event listener', async () => {
7
+ const component = defineComponent({
8
+ template: '<div></div>',
9
+ props: {
10
+ callback: {
11
+ type: Function as PropType<(e: Event) => void>,
12
+ required: true
13
+ }
14
+ },
15
+ setup(props, context) {
16
+ const target = ref<EventTarget>(document);
17
+ useEventListener(target, 'click', props.callback);
18
+ const swap = () => (target.value = document.body);
19
+ context.expose({ swap });
20
+ }
21
+ });
22
+
23
+ const props = { callback: vi.fn() };
24
+ const wrapper = mount(component, { props });
25
+ document.dispatchEvent(new MouseEvent('click'));
26
+ (wrapper.vm as any).swap();
27
+ await nextTick();
28
+ document.body.dispatchEvent(new MouseEvent('click'));
29
+ expect(props.callback).toHaveBeenCalledTimes(2);
30
+ wrapper.unmount();
31
+ });
32
+ });
@@ -0,0 +1,51 @@
1
+ import { describe } from 'vitest';
2
+ import { mount } from '@vue/test-utils';
3
+ import { defineComponent } from 'vue';
4
+ import { useIntroJs } from '@/composables/useIntroJs';
5
+ import { Viewer3crService } from '@/services/viewer-3cr.service';
6
+ import { Tour } from 'intro.js/src/packages/tour';
7
+ import { scanState } from '@/models/scanState';
8
+ import { inflateScanState } from '@/functions/modelHelper';
9
+
10
+ describe('useIntroJs tests', () => {
11
+ vi.spyOn(Viewer3crService.prototype, 'layouts').mockResolvedValue();
12
+
13
+ beforeEach(() => {
14
+ vi.useFakeTimers();
15
+ });
16
+
17
+ afterEach(() => {
18
+ vi.useRealTimers();
19
+ });
20
+
21
+ it('should start introjs', async () => {
22
+ const component = defineComponent({
23
+ template: `
24
+ <div>
25
+ <div id="skin-to-bone"></div>
26
+ <div id="view-0"></div>
27
+ <div id="view-1"></div>
28
+ <div id="view-2"></div>
29
+ <div id="view-3"></div>
30
+ <div id="settings-card"></div>
31
+ </div>`,
32
+ setup(_, context) {
33
+ const { intro } = useIntroJs();
34
+ context.expose({ intro });
35
+ }
36
+ });
37
+
38
+ const wrapper = mount(component);
39
+ const intro = (wrapper.vm as any).intro as Tour;
40
+
41
+ await intro.start();
42
+ scanState.value = inflateScanState();
43
+ vi.advanceTimersByTime(1000);
44
+ for (let i = 0; i < 5; ++i) {
45
+ await intro.nextStep();
46
+ vi.advanceTimersByTime(1000);
47
+ }
48
+
49
+ expect(wrapper).toBeTruthy();
50
+ });
51
+ });
@@ -0,0 +1,39 @@
1
+ import { inflateInitialDataOverlayState } from '@/functions/modelHelper';
2
+ import { DataOverlayDataFaker } from '@test/fakers/data-overlay-data.faker';
3
+ import { dataOverlayEvent, dataOverlayState } from '@/models/scanState';
4
+ import { Interactiontype } from '@3cr/types-ts';
5
+ import { useMarkups } from '@/composables/useMarkups';
6
+
7
+ describe('useMarkups tests', () => {
8
+ it('should have no markups', () => {
9
+ const { markups, hasMarkups } = useMarkups();
10
+ expect(markups.value.length).toBe(0);
11
+ expect(hasMarkups.value).toBeFalsy();
12
+ });
13
+
14
+ it('should have markups', () => {
15
+ const dataOverlay = inflateInitialDataOverlayState();
16
+ dataOverlay.DataOverlay.DataOverlay.push(
17
+ DataOverlayDataFaker.lengthRaw(),
18
+ DataOverlayDataFaker.polygonRaw(),
19
+ DataOverlayDataFaker.angleRaw()
20
+ );
21
+ dataOverlayState.value = dataOverlay;
22
+
23
+ const { markups } = useMarkups();
24
+ expect(markups.value.length).toBe(3);
25
+ expect(typeof markups.value[0].Data).not.toBe('string');
26
+ });
27
+
28
+ it('should have null event', () => {
29
+ const { markupEvent } = useMarkups();
30
+ expect(markupEvent.value).toBeNull();
31
+ });
32
+
33
+ it('should have non-null event', () => {
34
+ dataOverlayEvent.value = DataOverlayDataFaker.polygonEventRaw(Interactiontype.HOVER_START);
35
+ const { markupEvent } = useMarkups();
36
+ expect(markupEvent.value).not.toBeNull();
37
+ expect(typeof markupEvent.value?.DataOverlay).not.toBe('string');
38
+ });
39
+ });
@@ -0,0 +1,36 @@
1
+ import { inflateInitialMcadObjectState } from '@/functions/modelHelper';
2
+ import { mcadObjectEvent, mcadObjectState } from '@/models/scanState';
3
+ import { Interactiontype } from '@3cr/types-ts';
4
+ import { useMcadObjects } from '@/composables/useMcadObjects';
5
+ import { DataOverlayMcadFaker } from '@test/fakers/data-overlay-mcad.faker';
6
+ import { McadObjectInteractionFaker } from '@test/fakers/mcad-object-interaction.faker';
7
+
8
+ describe('useMcadObjects tests', () => {
9
+ it('should have no mcad objects', () => {
10
+ const { mcadObjects, hasMcadObjects } = useMcadObjects();
11
+ expect(mcadObjects.value.length).toBe(0);
12
+ expect(hasMcadObjects.value).toBeFalsy();
13
+ });
14
+
15
+ it('should have mcad objects', () => {
16
+ const mcad = inflateInitialMcadObjectState();
17
+ mcad.Models.Models.push(DataOverlayMcadFaker.randomRaw() as any);
18
+ mcadObjectState.value = mcad;
19
+
20
+ const { mcadObjects } = useMcadObjects();
21
+ expect(mcadObjects.value.length).toBe(1);
22
+ expect(typeof mcadObjects.value[0].CallToAction).not.toBe('string');
23
+ });
24
+
25
+ it('should have null event', () => {
26
+ const { mcadObjectEvent } = useMcadObjects();
27
+ expect(mcadObjectEvent.value).toBeNull();
28
+ });
29
+
30
+ it('should have non-null event', () => {
31
+ mcadObjectEvent.value = McadObjectInteractionFaker.randomRaw(Interactiontype.HOVER_START) as any;
32
+ const { mcadObjectEvent: event } = useMcadObjects();
33
+ expect(event.value).not.toBeNull();
34
+ expect(typeof event.value?.Mcad).not.toBe('string');
35
+ });
36
+ });
@@ -0,0 +1,20 @@
1
+ import { useMouse } from '@/composables/useMouse';
2
+ import { defineComponent, onMounted } from 'vue';
3
+ import { mount } from '@vue/test-utils';
4
+
5
+ describe('useMouse tests', () => {
6
+ it('should set mouse position', () => {
7
+ const component = defineComponent({
8
+ template: '<div></div>',
9
+ setup() {
10
+ const { x, y } = useMouse(document);
11
+ onMounted(() => {
12
+ document.dispatchEvent(new MouseEvent('mousemove', { clientX: 100, clientY: 100 }));
13
+ expect(x.value).toBe(100);
14
+ expect(y.value).toBe(100);
15
+ });
16
+ }
17
+ });
18
+ mount(component);
19
+ });
20
+ });
@@ -1,9 +1,8 @@
1
- import { describe, expect, it, vi } from 'vitest';
2
- import { useNavigationCubeObserver } from "@/components/modal/composables/useNavigationCubeObserver";
3
- import { isFullscreen, isLayout1x3, isLayout2x2, scanState } from "@/dataLayer/scanState";
4
- import { Viewer3cr } from "@/dataLayer/viewer3cr";
5
- import { AnchorPoint, CurrentScanState, ScanView } from "@3cr/types-ts";
6
- import { flushPromises } from "@vue/test-utils";
1
+ import { useNavigationCubeObserver } from '@/composables/useNavigationCubeObserver';
2
+ import { isFullscreen, isLayout1x3, isLayout2x2, scanState } from '@/models/scanState';
3
+ import { Viewer3crService } from '@/services/viewer-3cr.service';
4
+ import { AnchorPoint, CurrentScanState, ScanView } from '@3cr/types-ts';
5
+ import { flushPromises } from '@vue/test-utils';
7
6
 
8
7
  function setupMocks(state: CurrentScanState, fullscreen: boolean, layout1x3: boolean, layout2x2: boolean): void {
9
8
  vi.spyOn(scanState, 'value', 'get').mockReturnValue(state);
@@ -13,15 +12,21 @@ function setupMocks(state: CurrentScanState, fullscreen: boolean, layout1x3: boo
13
12
  }
14
13
 
15
14
  describe('useNavigationCubeObserver tests', () => {
16
- vi.spyOn(ResizeObserver.prototype, 'observe').mockReturnValue()
15
+ vi.spyOn(ResizeObserver.prototype, 'observe').mockReturnValue();
17
16
  vi.spyOn(ResizeObserver.prototype, 'unobserve').mockReturnValue();
18
17
 
19
18
  const canvas = { clientWidth: 100, clientHeight: 100 } as HTMLCanvasElement;
20
- const fullscreen2d = { CurrentView: ScanView.Sagittal, NavigationCube: { Interactivity: { Value: true } } } as CurrentScanState;
21
- const fullscreen3d = { CurrentView: ScanView.Volume, NavigationCube: { Interactivity: { Value: true } } } as CurrentScanState;
22
-
23
- const visibilitySpy = vi.spyOn(Viewer3cr.prototype, 'setNavCubeVisibility');
24
- const positionSizeSpy = vi.spyOn(Viewer3cr.prototype, 'setNavCubePositionSize');
19
+ const fullscreen2d = {
20
+ CurrentView: ScanView.Sagittal,
21
+ NavigationCube: { Interactivity: { Value: true } }
22
+ } as CurrentScanState;
23
+ const fullscreen3d = {
24
+ CurrentView: ScanView.Volume,
25
+ NavigationCube: { Interactivity: { Value: true } }
26
+ } as CurrentScanState;
27
+
28
+ const visibilitySpy = vi.spyOn(Viewer3crService.prototype, 'setNavCubeVisibility');
29
+ const positionSizeSpy = vi.spyOn(Viewer3crService.prototype, 'setNavCubePositionSize');
25
30
 
26
31
  it('should update on 3d fullscreen changes', async () => {
27
32
  setupMocks(fullscreen3d, true, false, false);
@@ -1,5 +1,4 @@
1
- import { describe, expect, it } from 'vitest';
2
- import { useViewer3cr } from '@/dataLayer/useViewer3cr';
1
+ import { useViewer3cr } from '@/composables/useViewer3cr';
3
2
 
4
3
  describe('useViewer3cr tests', () => {
5
4
  it('should return same service instance', () => {
@@ -0,0 +1,37 @@
1
+ import { computed } from 'vue';
2
+ import { dataOverlayEvent, dataOverlayState } from '@/models/scanState';
3
+ import { parseDataOverlayData } from '@/functions/parseDataOverlayData';
4
+ import { DataOverlayDataRaw, DataOverlayData } from '@/types/data-overlay-data';
5
+ import { DataOverlayAnnotation } from '@/types/data-overlay-annotation';
6
+ import { DataOverlayType } from '@3cr/types-ts';
7
+ import { DataOverlayInteraction } from '@/types/data-overlay-interaction';
8
+ import { parseDataOverlayEvent } from '@/functions/parseDataOverlayEvent';
9
+
10
+ function isAnnotation(data: DataOverlayDataRaw): boolean {
11
+ return data.DataType === DataOverlayType.Annotation;
12
+ }
13
+
14
+ function toAnnotation(data: DataOverlayDataRaw): DataOverlayData<DataOverlayAnnotation> {
15
+ return parseDataOverlayData<DataOverlayAnnotation>(data);
16
+ }
17
+
18
+ function toAnnotationEvent(data: DataOverlayDataRaw): DataOverlayInteraction<DataOverlayAnnotation> {
19
+ return parseDataOverlayEvent<DataOverlayAnnotation>(data).Data;
20
+ }
21
+
22
+ const annotations = computed(() => {
23
+ return dataOverlayState.value.DataOverlay.DataOverlay.filter(isAnnotation).map(toAnnotation);
24
+ });
25
+
26
+ const hasAnnotations = computed(() => {
27
+ return annotations.value.length > 0;
28
+ });
29
+
30
+ const annotationEvent = computed(() => {
31
+ const value = dataOverlayEvent.value;
32
+ return value && isAnnotation(value) ? toAnnotationEvent(value) : null;
33
+ });
34
+
35
+ export function useAnnotations() {
36
+ return { annotations, hasAnnotations, annotationEvent };
37
+ }
@@ -0,0 +1,25 @@
1
+ import { onBeforeUnmount, onMounted, Ref, unref, watch } from 'vue';
2
+
3
+ type Target = Ref<EventTarget> | EventTarget;
4
+ type EventType = keyof HTMLElementEventMap;
5
+ type Handler<T extends Event> = (event: T) => void | Promise<void>;
6
+
7
+ export function useEventListener<T extends Event>(target: Target, event: EventType, handler: Handler<T>) {
8
+ const wrapper = (e: Event) => handler(e as T);
9
+
10
+ onMounted(() => {
11
+ unref(target).addEventListener(event, wrapper);
12
+ });
13
+
14
+ watch(
15
+ () => unref(target),
16
+ (next, prev) => {
17
+ prev.removeEventListener(event, wrapper);
18
+ next.addEventListener(event, wrapper);
19
+ }
20
+ );
21
+
22
+ onBeforeUnmount(() => {
23
+ unref(target).removeEventListener(event, wrapper);
24
+ });
25
+ }
@@ -0,0 +1,125 @@
1
+ import { TourOptions } from 'intro.js/src/packages/tour/option';
2
+ import { Tour } from 'intro.js/src/packages/tour';
3
+ import { demoType } from '@/components/demo/options';
4
+ import { computed, nextTick, ref, watch, WatchStopHandle } from 'vue';
5
+ import { ScanView } from '@3cr/types-ts';
6
+ import { useViewer3cr } from '@/composables/useViewer3cr';
7
+ import { isFullscreen, previousLayout, scanState } from '@/models/scanState';
8
+ import introJs from 'intro.js';
9
+
10
+ const viewer3cr = useViewer3cr();
11
+
12
+ const demo = computed<string>(() => {
13
+ const value = demoType.value;
14
+ return value.charAt(0).toUpperCase() + value.substring(1);
15
+ });
16
+
17
+ const options = computed<Partial<TourOptions>>(() => ({
18
+ exitOnOverlayClick: false,
19
+ keyboardNavigation: false,
20
+ dontShowAgain: true,
21
+ steps: [
22
+ {
23
+ title: 'Take the Viewer Tour',
24
+ intro:
25
+ `Welcome to the ${demo.value} Online DICOM Viewer.` +
26
+ '<br/><br/>Take the short interative tour to better visualize your medical images in 2D and 3D.',
27
+ position: 'floating'
28
+ },
29
+ {
30
+ title: 'Density Slider',
31
+ intro:
32
+ 'Move the <em>lower density slider</em> to the right to hide softer tissue like skin and view internal organs.' +
33
+ '<br/><br/>For more precise control, change the numbers in the boxes above or use the <em>Fine Adjustment</em> slider below.',
34
+ element: '#skin-to-bone',
35
+ position: 'right'
36
+ },
37
+ {
38
+ title: '3D Viewing Controls',
39
+ intro:
40
+ 'With your cursor placed in the 3D view, <b>scroll to zoom</b> & <b>click and drag to rotate</b>.' +
41
+ '<br/><br/>You can also view the 3D view in full screen, reset the view, and cut into the 3D model from each side using the <em>3D slicing tool</em>.',
42
+ element: `#view-${ScanView.Volume}`
43
+ },
44
+ {
45
+ title: '2D Viewing Controls',
46
+ intro:
47
+ 'With your mouse in the 2D views, <b>scroll to navigate through the 2D images</b>, and use <b>Shift + Arrows to Pan and Zoom</b>.' +
48
+ '<br/><br/>Use the icons to <em>Fullscreen</em>, <em>Reset</em>, <em>Rotate</em>, and <em>Flip</em> each individual 2D view.',
49
+ element: `#view-${ScanView.Sagittal}`
50
+ },
51
+ {
52
+ title: 'Global settings',
53
+ intro:
54
+ 'Accurately change the <b>brightness</b>, <b>contrast</b>, and <b>opacity</b> to enhance the appearance of your medical images.' +
55
+ '<br/><br/>Adjust the sensitivity of mouse and keyboard inputs to suit your preferences.',
56
+ element: '#settings-card',
57
+ position: 'right'
58
+ },
59
+ {
60
+ title: 'Stay Tuned for Updates',
61
+ intro:
62
+ '<img src="https://c.tenor.com/S4Sz_yvlLn4AAAAC/cats-cat.gif" alt="cat" width="260" height="260">' +
63
+ '<br/>Us working hard on new features',
64
+ position: 'floating'
65
+ }
66
+ ]
67
+ }));
68
+
69
+ function blurActiveElement(): void {
70
+ (document.activeElement as HTMLElement | null)?.blur();
71
+ }
72
+
73
+ export function useIntroJs() {
74
+ let scanStateHandle: WatchStopHandle;
75
+
76
+ function onStart(this: Tour): void {
77
+ scanStateHandle = watch(scanState, () => {
78
+ this.refresh(true);
79
+ });
80
+ }
81
+
82
+ function onBeforeChange(this: Tour, el: HTMLElement, step: number, direction: 'forward' | 'backward'): boolean {
83
+ // If the user has enabled full-screen, turn it off for steps 2 and 3
84
+ /* istanbul ignore next: does not work with jsdom -- @preserve */
85
+ if (isFullscreen.value && (step === 2 || step === 3)) {
86
+ viewer3cr
87
+ .layouts(previousLayout.value)
88
+ .then(() => nextTick())
89
+ .then(() => this.refresh(true))
90
+ .then(() => (direction === 'forward' ? this.nextStep() : this.previousStep()));
91
+ return false;
92
+ }
93
+
94
+ // Only show Don't Show Again on last step
95
+ const introjsDontShowAgain = document.querySelector('.introjs-dontShowAgain') as HTMLElement | null;
96
+ if (introjsDontShowAgain) {
97
+ const lastStep = this.getSteps().length - 1;
98
+ introjsDontShowAgain.style.display = step !== lastStep ? 'none' : 'block';
99
+ }
100
+
101
+ return true;
102
+ }
103
+
104
+ function onChange(): void {
105
+ setTimeout(() => blurActiveElement(), 500);
106
+ }
107
+
108
+ /* istanbul ignore next: does not work with jsdom -- @preserve */
109
+ function onExit(this: Tour): void {
110
+ scanStateHandle();
111
+ setTimeout(() => blurActiveElement(), 500);
112
+ }
113
+
114
+ const tour = introJs
115
+ .tour()
116
+ .setOptions(options.value)
117
+ .onStart(onStart)
118
+ .onBeforeChange(onBeforeChange)
119
+ .onChange(onChange)
120
+ .onExit(onExit);
121
+
122
+ const intro = ref<Tour>(tour);
123
+
124
+ return { intro };
125
+ }