fix(state manager): Make viewport-related data optional for annotation event

common/reviews/api/tools.api.md

@@ -262,8 +262,8 @@ export { annotation }
 
 // @public (undocumented)
 type AnnotationAddedEventDetail = {
-    viewportId: string;
-    renderingEngineId: string;
+    viewportId?: string;
+    renderingEngineId?: string;
     annotation: Annotation;
 };
 

packages/tools/src/stateManagement/annotation/annotationState.ts

@@ -80,18 +80,18 @@ function addAnnotation(
   }
 
   const manager = getAnnotationManager();
-  const groupKey = manager.getGroupKey(annotationGroupSelector);
-
-  manager.addAnnotation(annotation, groupKey);
 
   // if the annotation manager selector is an element, trigger the
   // annotation added event for that element.
   if (annotationGroupSelector instanceof HTMLDivElement) {
+    const groupKey = manager.getGroupKey(annotationGroupSelector);
+    manager.addAnnotation(annotation, groupKey);
     triggerAnnotationAddedForElement(annotation, annotationGroupSelector);
   } else {
     // if no element is provided, render all viewports that have the
     // same frame of reference.
     // Todo: we should do something else here for other types of annotation managers.
+    manager.addAnnotation(annotation);
     triggerAnnotationAddedForFOR(annotation);
   }
 

packages/tools/src/stateManagement/annotation/helpers/state.ts

@@ -41,14 +41,12 @@ function triggerAnnotationAddedForFOR(annotation: Annotation) {
   const { toolName } = annotation.metadata;
 
   const toolGroups = getToolGroupsWithToolName(toolName);
-
   if (!toolGroups.length) {
     return;
   }
 
   // Find the viewports in the toolGroups who has the same FrameOfReferenceUID
   const viewportsToRender = [];
-
   toolGroups.forEach((toolGroup) => {
     toolGroup.viewportsInfo.forEach((viewportInfo) => {
       const { renderingEngineId, viewportId } = viewportInfo;
@@ -63,19 +61,17 @@ function triggerAnnotationAddedForFOR(annotation: Annotation) {
     });
   });
 
+  const eventType = Events.ANNOTATION_ADDED;
+  const eventDetail: AnnotationAddedEventDetail = { annotation };
+
   if (!viewportsToRender.length) {
+    triggerEvent(eventTarget, eventType, eventDetail);
     return;
   }
 
-  const eventType = Events.ANNOTATION_ADDED;
-
   viewportsToRender.forEach(({ renderingEngineId, viewportId }) => {
-    const eventDetail: AnnotationAddedEventDetail = {
-      annotation,
-      viewportId,
-      renderingEngineId,
-    };
-
+    eventDetail.viewportId = viewportId;
+    eventDetail.renderingEngineId = renderingEngineId;
     triggerEvent(eventTarget, eventType, eventDetail);
   });
 }

packages/tools/src/types/EventTypes.ts

@@ -104,9 +104,9 @@ type ToolActivatedEventDetail = {
  */
 type AnnotationAddedEventDetail = {
   /** unique id of the viewport */
-  viewportId: string;
+  viewportId?: string;
   /** unique id of the rendering engine */
-  renderingEngineId: string;
+  renderingEngineId?: string;
   /** The annotation that is being added to the annotations manager. */
   annotation: Annotation;
 };