[GreenDev]: Polish the AnnotationRepository API.

Address Connor's comments on previous CL:
https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7201324

Bug: 461428483
Change-Id: Ic3f074312124afc80262d8b25aa01eb670b6cbeb
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/7205831
Commit-Queue: Finnur Thorarinsson <finnur@chromium.org>
Reviewed-by: Alina Varkki <alinavarkki@chromium.org>

Author: finnurbreki

front_end/models/ai_assistance/agents/PerformanceAgent.ts

@@ -1101,8 +1101,7 @@ export class PerformanceAgent extends AiAgent<AgentFocus> {
 
     // eslint-disable-next-line no-console
     console.log(`AI AGENT EVENT: Performance Agent adding annotation for element ${elementId}: '${annotationMessage}'`);
-    Annotations.AnnotationRepository.instance().addAnnotationWithAnchor(
-        annotationMessage, elementId, Annotations.AnnotationType.ELEMENT_NODE);
+    Annotations.AnnotationRepository.instance().addElementsAnnotation(annotationMessage, elementId);
     return {result: {success: true}};
   }
 }

front_end/ui/components/annotations/AnnotationRepository.ts

@@ -6,33 +6,36 @@ import * as Common from '../../../core/common/common.js';
 import * as Root from '../../../core/root/root.js';
 import type * as SDK from '../../../core/sdk/sdk.js';
 
-import type {AnnotationType} from './AnnotationType.js';
+import {AnnotationType} from './AnnotationType.js';
 
-interface AnnotationData {
+interface BaseAnnotationData {
   id: number;
   type: AnnotationType;
   message: string;
   // Sometimes the anchor for an annotation is not known, but is provided using a
   // string id instead (which can be converted to an `anchor` later).
   lookupId: string;
-  // What to anchor the annotation to.
-  anchor?: SDK.DOMModel.DOMNode|SDK.NetworkRequest.NetworkRequest|null;
   // Sometimes we want annotations to anchor to a particular string on the page.
   anchorToString?: string;
 }
 
+interface ElementsAnnotationData extends BaseAnnotationData {
+  type: AnnotationType.ELEMENT_NODE;
+  anchor?: SDK.DOMModel.DOMNode;
+}
+
 export const enum Events {
   ANNOTATION_ADDED = 'AnnotationAdded',
 }
 
 export interface EventTypes {
-  [Events.ANNOTATION_ADDED]: AnnotationData;
+  [Events.ANNOTATION_ADDED]: BaseAnnotationData;
 }
 
 export class AnnotationRepository {
   static #instance: AnnotationRepository|null = null;
   #events = new Common.ObjectWrapper.ObjectWrapper<EventTypes>();
-  #annotations: AnnotationData[] = [];
+  #annotations: BaseAnnotationData[] = [];
   #nextId = 0;
 
   static instance(): AnnotationRepository {
@@ -55,7 +58,7 @@ export class AnnotationRepository {
     return this.#events.addEventListener(eventType, listener, thisObject);
   }
 
-  getAnnotationsByType(type: AnnotationType): AnnotationData[] {
+  getAnnotationsByType(type: AnnotationType): BaseAnnotationData[] {
     if (!AnnotationRepository.annotationsEnabled()) {
       console.warn('Received query for annotation types with annotations disabled');
       return [];
@@ -65,23 +68,23 @@ export class AnnotationRepository {
     return annotations;
   }
 
-  addAnnotationWithAnchor(
+  addElementsAnnotation(
       label: string,
-      anchor: SDK.DOMModel.DOMNode|SDK.NetworkRequest.NetworkRequest|string|null,
-      type: AnnotationType,
-      anchorToString = '',
+      lookupId?: string,
+      anchor?: SDK.DOMModel.DOMNode,
+      anchorToString?: string,
       ): void {
     if (!AnnotationRepository.annotationsEnabled()) {
       console.warn('Received annotation registration with annotations disabled');
       return;
     }
 
-    const annotationData = {
+    const annotationData: ElementsAnnotationData = {
       id: this.#nextId++,
-      type,
+      type: AnnotationType.ELEMENT_NODE,
       message: label,
-      lookupId: typeof anchor === 'string' ? anchor : 'None',
-      anchor: typeof anchor === 'string' ? null : anchor,
+      lookupId: lookupId || '',
+      anchor,
       anchorToString
     };
     this.#annotations.push(annotationData);