@annotorious/annotorious 3.0.0-rc.15 → 3.0.0-rc.17

package/src/annotation/tools/polygon/RubberbandPolygon.svelte

@@ -1,4 +1,4 @@
-<script type="ts">
+<script lang="ts">
   import { onMount, createEventDispatcher } from 'svelte';
   import type { DrawingMode } from '../../../AnnotoriousOpts';
   import { boundsFromPoints, computeArea, ShapeType, type Polygon } from '../../../model';
@@ -17,7 +17,7 @@
 
   let points: [number, number][] = [];
   
-  let cursor: [number, number] = null;
+  let cursor: [number, number] | undefined;
 
   let isClosable: boolean = false;
 
@@ -25,7 +25,9 @@
 
   $: handleSize = 10 / viewportScale;
 
-  const onPointerDown = (evt: PointerEvent) => {
+  const onPointerDown = (event: Event) => {
+    const evt = event as PointerEvent;
+
     // Note that the event itself is ephemeral!
     const { timeStamp, offsetX, offsetY } = evt;
     lastPointerDown = { timeStamp, offsetX, offsetY };
@@ -40,7 +42,9 @@
     }
   }
 
-  const onPointerMove = (evt: PointerEvent) => {
+  const onPointerMove = (event: Event) => {
+    const evt = event as PointerEvent;
+
     if (points.length > 0) {
       cursor = transform.elementToImage(evt.offsetX, evt.offsetY);
 
@@ -51,7 +55,9 @@
     }
   }
 
-  const onPointerUp = (evt: PointerEvent) => {
+  const onPointerUp = (event: Event) => {
+    const evt = event as PointerEvent;
+
     if (drawingMode === 'click') {
       const timeDifference = evt.timeStamp - lastPointerDown.timeStamp;
 
@@ -71,17 +77,17 @@
 
         cursor = point;
       } else {
-        points.push(cursor);
+        points.push(cursor!);
       }
     } else {
       // Require minimum drag of 4px
       if (points.length === 1) {
-        const dist = distance(points[0], cursor);
+        const dist = distance(points[0], cursor!);
 
         if (dist <= 4) {
           // Cancel
           points = [];
-          cursor = null;
+          cursor = undefined;
 
           return;
         }
@@ -93,7 +99,7 @@
       if (isClosable) {
         stopDrawing();
       } else {
-        points.push(cursor);
+        points.push(cursor!);
       }
     }
   }
@@ -101,7 +107,7 @@
   const onDblClick = () => {
     // Require min 3 points (incl. cursor) and minimum
     // polygon area
-    const p = [...points, cursor];
+    const p = [...points, cursor!];
 
     const shape: Polygon = {
       type: ShapeType.POLYGON, 
@@ -114,7 +120,7 @@
     const area = computeArea(shape);
     if (area > 4) {
       points = [];
-      cursor = null;
+      cursor = undefined;
     
       dispatch('create', shape);
     }
@@ -130,7 +136,7 @@
     }
 
     points = [];
-    cursor = null;
+    cursor = undefined;
   
     dispatch('create', shape);
   }

package/src/annotation/tools/rectangle/RubberbandRectangle.svelte

@@ -1,4 +1,4 @@
-<script type="ts">
+<script lang="ts">
   import { createEventDispatcher, onMount } from 'svelte';
   import type { DrawingMode } from '../../../AnnotoriousOpts';
   import { ShapeType, type Rectangle } from '../../../model';
@@ -13,13 +13,15 @@
 
   let lastPointerDown: number;
 
-  let origin: [x: number, y: number]; 
+  let origin: [x: number, y: number] | undefined; 
 
-  let anchor: [number, number];
+  let anchor: [number, number] | undefined;
 
   let x: number, y: number, w: number, h: number;
 
-  const onPointerDown = (evt: PointerEvent) => {
+  const onPointerDown = (event: Event) => {
+    const evt = event as PointerEvent;
+
     lastPointerDown = performance.now();
 
     if (drawingMode === 'drag') {
@@ -33,7 +35,9 @@
     }
   }
 
-  const onPointerMove = (evt: PointerEvent) => {
+  const onPointerMove = (event: Event) => {
+    const evt = event as PointerEvent;
+
     if (origin) {
       anchor = transform.elementToImage(evt.offsetX, evt.offsetY);
 
@@ -44,7 +48,9 @@
     }
   }
     
-  const onPointerUp = (evt: PointerEvent) => {
+  const onPointerUp = (event: Event) => {
+    const evt = event as PointerEvent;
+
     const timeDifference = performance.now() - lastPointerDown;
 
     if (drawingMode === 'click') {
@@ -71,8 +77,8 @@
         evt.stopPropagation();
         stopDrawing();
       } else {
-        origin = null;
-        anchor = null;
+        origin = undefined;
+        anchor = undefined;
       }
     }
   }
@@ -96,8 +102,8 @@
       dispatch('create', shape);
     }
     
-    origin = null;
-    anchor = null;
+    origin = undefined;
+    anchor = undefined;
   }
 
   onMount(() => {

package/src/annotation/utils/responsive.ts

@@ -42,7 +42,7 @@ export const enableResponsive = (image: HTMLImageElement | HTMLCanvasElement, sv
       set(scale);
     });
   
-    resizeObserver.observe(svg.parentElement);
+    resizeObserver.observe(svg.parentElement!);
   }
 
   const destroy = () => {

package/src/index.ts

@@ -33,6 +33,5 @@ export type {
   User,
   W3CAnnotation,
   W3CAnnotationBody,
-  W3CAnnotationTarget,
-  W3CSelector
+  W3CAnnotationTarget
 } from '@annotorious/core';

package/src/keyboardCommands.ts

@@ -9,7 +9,9 @@ export const initKeyboardCommands = <T extends Annotation>(
 
   const el = container || document;
 
-  const onWinKeyDown = (event: KeyboardEvent) => {
+  const onWinKeyDown = (evt: Event) => {
+    const event = evt as KeyboardEvent;
+    
     if (event.key === 'Z' && event.ctrlKey) {
       undoStack.undo();
     } else if (event.key === 'Y' && event.ctrlKey) {
@@ -17,7 +19,9 @@ export const initKeyboardCommands = <T extends Annotation>(
     }
   };
 
-  const onMacKeyDown = (event: KeyboardEvent) => {
+  const onMacKeyDown = (evt: Event) => {
+    const event = evt as KeyboardEvent;
+
     if (event.key === 'z' && event.metaKey) {
       if (event.shiftKey) {
         undoStack.redo()

package/src/model/w3c/W3CImageAnnotation.ts

@@ -0,0 +1,17 @@
+import type { W3CAnnotation, W3CAnnotationTarget } from '@annotorious/core';
+import type { FragmentSelector } from './fragment';
+import type { SVGSelector } from './svg';
+
+export interface W3CImageAnnotation extends W3CAnnotation {
+
+  target: W3CImageAnnotationTarget | W3CImageAnnotationTarget[];
+
+}
+
+export interface W3CImageAnnotationTarget extends W3CAnnotationTarget {
+
+  selector: W3CImageSelector | W3CImageSelector[];
+
+}
+
+export type W3CImageSelector = FragmentSelector | SVGSelector;

package/src/model/w3c/W3CImageFormatAdapter.ts

@@ -1,14 +1,15 @@
 import { v4 as uuidv4 } from 'uuid';
-import { parseW3CBodies, serializeW3CBodies } from '@annotorious/core';
+import { parseW3CUser, parseW3CBodies, serializeW3CBodies } from '@annotorious/core';
 import type { FormatAdapter, ParseResult, W3CAnnotation } from '@annotorious/core';
 import { ShapeType } from '../core';
 import type { ImageAnnotation, RectangleGeometry } from '../core';
-import type { FragmentSelector } from './fragment';
+import type {FragmentSelector } from './fragment';
 import { parseFragmentSelector, serializeFragmentSelector } from './fragment';
 import type { SVGSelector } from './svg';
 import { parseSVGSelector, serializeSVGSelector } from './svg';
+import type { W3CImageAnnotation } from './W3CImageAnnotation';
 
-export type W3CImageFormatAdapter = FormatAdapter<ImageAnnotation, W3CAnnotation>;
+export type W3CImageFormatAdapter = FormatAdapter<ImageAnnotation, W3CImageAnnotation>;
 
 export const W3CImageFormat = (
   source: string,
@@ -30,18 +31,26 @@ export const parseW3CImageAnnotation = (
 ): ParseResult<ImageAnnotation> => {
   const annotationId = annotation.id || uuidv4();
 
-  const { body, ...rest } = annotation;
+  const { 
+    creator,
+    created,
+    modified,
+    body, 
+    ...rest 
+  } = annotation;
 
   const bodies = parseW3CBodies(body, annotationId);
 
-  const target = Array.isArray(annotation.target) ? annotation.target[0] : annotation.target;
+  const w3cTarget = Array.isArray(annotation.target) 
+    ? annotation.target[0] : annotation.target;
 
-  const w3cSelector = Array.isArray(target.selector) ? target.selector[0] : target.selector;
+  const w3cSelector = Array.isArray(w3cTarget.selector) 
+    ? w3cTarget.selector[0] : w3cTarget.selector;
 
   const selector = 
-    w3cSelector.type === 'FragmentSelector' ?
+    w3cSelector?.type === 'FragmentSelector' ?
       parseFragmentSelector(w3cSelector as FragmentSelector, invertY) :
-    w3cSelector.type === 'SvgSelector' ?
+    w3cSelector?.type === 'SvgSelector' ?
       parseSVGSelector(w3cSelector as SVGSelector) : undefined;
 
   return selector ? { 
@@ -50,13 +59,16 @@ export const parseW3CImageAnnotation = (
       id: annotationId,
       bodies,
       target: {
+        created: created ? new Date(created) : undefined,
+        creator: parseW3CUser(creator),
+        updated: modified ? new Date(modified) : undefined,
         ...rest.target,
         annotation: annotationId,
         selector
       }
     }
   } : {
-    error: Error(`Unknown selector type: ${w3cSelector.type}`)
+    error: Error(`Invalid selector: ${JSON.stringify(w3cSelector)}`)
   };
 
 }
@@ -64,13 +76,20 @@ export const parseW3CImageAnnotation = (
 export const serializeW3CImageAnnotation = (
   annotation: ImageAnnotation, 
   source: string
-): W3CAnnotation => {
-  const shape = annotation.target.selector;
-
-  const selector =
-    shape.type == ShapeType.RECTANGLE ?
-      serializeFragmentSelector(shape.geometry as RectangleGeometry) :
-      serializeSVGSelector(shape);
+): W3CImageAnnotation => {
+  const { 
+    selector, 
+    creator, 
+    created, 
+    updated,
+    updatedBy, // Excluded from serialization
+    ...rest 
+  } = annotation.target;
+
+  const w3CSelector =
+    selector.type == ShapeType.RECTANGLE ?
+      serializeFragmentSelector(selector.geometry as RectangleGeometry) :
+      serializeSVGSelector(selector);
 
   return {
     ...annotation,
@@ -78,9 +97,13 @@ export const serializeW3CImageAnnotation = (
     id: annotation.id,
     type: 'Annotation',
     body: serializeW3CBodies(annotation.bodies),
+    created: created?.toISOString(),
+    creator,
+    modified: updated?.toISOString(),
     target: {
+      ...rest,
       source,
-      selector
+      selector: w3CSelector
     }
-  };
-};
+  }
+}

package/src/model/w3c/fragment/FragmentSelector.ts

@@ -1,15 +1,14 @@
-import type { W3CSelector } from '@annotorious/core';
-import { ShapeType } from '../../core';
 import type { Rectangle, RectangleGeometry } from '../../core';
+import { ShapeType } from '../../core';
 
-export interface FragmentSelector extends W3CSelector {
+export interface FragmentSelector {
 
   type: 'FragmentSelector';
 
   conformsTo: 'http://www.w3.org/TR/media-frags/',
 
   value: string;
-  
+
 }
 
 export const parseFragmentSelector = (
@@ -46,7 +45,7 @@ export const parseFragmentSelector = (
       }
     }
   }
-};
+}
 
 export const serializeFragmentSelector = (geometry: RectangleGeometry): FragmentSelector => {
   const { x, y, w, h } = geometry;
@@ -56,4 +55,4 @@ export const serializeFragmentSelector = (geometry: RectangleGeometry): Fragment
     conformsTo: 'http://www.w3.org/TR/media-frags/',
     value: `xywh=pixel:${x},${y},${w},${h}`
   };
-};
+}

package/src/model/w3c/index.ts

@@ -1,3 +1,4 @@
 export * from './fragment';
 export * from './svg';
+export * from './W3CImageAnnotation';
 export * from './W3CImageFormatAdapter';

package/src/model/w3c/svg/SVG.ts

@@ -13,8 +13,7 @@ export const sanitize = (doc: Element | Document) => {
   // Remove script tags
   const scripts = doc.getElementsByTagName('script');
 
-  Array.from(scripts).reverse().forEach(el =>
-    el.parentNode.removeChild(el));
+  Array.from(scripts).reverse().forEach(el => el.parentNode!.removeChild(el));
 
   Array.from(doc.querySelectorAll('*')).forEach(cleanEl);
 

package/src/model/w3c/svg/SVGSelector.ts

@@ -1,14 +1,13 @@
-import type { W3CSelector } from '@annotorious/core';
-import { boundsFromPoints, ShapeType } from '../../core';
 import type { Ellipse, EllipseGeometry, Polygon, PolygonGeometry, Shape } from '../../core';
-import { SVG_NAMESPACE, insertSVGNamespace, sanitize } from './SVG';
+import { boundsFromPoints, ShapeType } from '../../core';
+import { insertSVGNamespace, sanitize, SVG_NAMESPACE } from './SVG';
 
-export interface SVGSelector extends W3CSelector {
+export interface SVGSelector {
 
   type: 'SvgSelector';
 
   value: string;
-  
+
 }
 
 const parseSVGXML = (value: string): Element => {
@@ -29,9 +28,6 @@ const parseSVGXML = (value: string): Element => {
 
 const parseSVGPolygon = (value: string): Polygon => {
   const [a, b, str] = value.match(/(<polygon points=["|'])([^("|')]*)/) || [];
-
-  if (!str) return;
-
   const points = str.split(' ').map((p) => p.split(',').map(parseFloat));
 
   return {
@@ -46,10 +42,10 @@ const parseSVGPolygon = (value: string): Polygon => {
 const parseSVGEllipse = (value: string): Ellipse => {
   const doc = parseSVGXML(value);
 
-  const cx = parseFloat(doc.getAttribute('cx'));
-  const cy = parseFloat(doc.getAttribute('cy'));
-  const rx = parseFloat(doc.getAttribute('rx'));
-  const ry = parseFloat(doc.getAttribute('ry'));
+  const cx = parseFloat(doc.getAttribute('cx')!);
+  const cy = parseFloat(doc.getAttribute('cy')!);
+  const rx = parseFloat(doc.getAttribute('rx')!);
+  const ry = parseFloat(doc.getAttribute('ry')!);
 
   const bounds = {
     minX: cx - rx,
@@ -77,10 +73,12 @@ export const parseSVGSelector = <T extends Shape>(valueOrSelector: SVGSelector |
     return parseSVGPolygon(value) as unknown as T;
   else if (value.includes('<ellipse ')) 
     return parseSVGEllipse(value) as unknown as T;
+  else 
+    throw 'Unsupported SVG shape: ' + value;
 }
 
 export const serializeSVGSelector = (shape: Shape): SVGSelector => {
-  let value: string;
+  let value: string | undefined;
 
   if (shape.type === ShapeType.POLYGON) {
     const geom = shape.geometry as PolygonGeometry;

package/src/state/ImageAnnotatorState.ts

@@ -44,11 +44,11 @@ export const createImageAnnotatorState = <E extends unknown>(
   const viewport = createViewportState();
 
   store.observe(({ changes }) => {
-    tree.set(changes.created.map(a => a.target as ImageAnnotationTarget), false);
+    tree.set((changes.created || []).map(a => a.target as ImageAnnotationTarget), false);
     
-    changes.deleted.forEach(a => tree.remove(a.target as ImageAnnotationTarget));
+    (changes.deleted || []).forEach(a => tree.remove(a.target as ImageAnnotationTarget));
     
-    changes.updated.forEach(({ oldValue, newValue }) =>
+    (changes.updated || []).forEach(({ oldValue, newValue }) =>
       tree.update(oldValue.target, newValue.target));
   });
 

package/src/state/spatialTree.ts

@@ -40,7 +40,8 @@ export const createSpatialTree = () => {
 
   const remove = (target: ImageAnnotationTarget) => {
     const item = index.get(target.annotation);
-    tree.remove(item);
+    if (item)
+      tree.remove(item);
     index.delete(target.annotation);
   };
 
@@ -62,7 +63,7 @@ export const createSpatialTree = () => {
     tree.load(indexedTargets);
   };
 
-  const getAt = (x: number, y: number): ImageAnnotationTarget | null => {
+  const getAt = (x: number, y: number): ImageAnnotationTarget | undefined => {
     const idxHits = tree.search({
       minX: x,
       minY: y,

package/src/themes/smart/setTheme.ts

@@ -8,7 +8,7 @@ export const sampleBrightness = (imageOrCanvas: HTMLElement) => {
 
   if (imageOrCanvas.nodeName === 'CANVAS') {
     canvas = imageOrCanvas as HTMLCanvasElement;
-    context = canvas.getContext('2d', { willReadFrequently: true });
+    context = canvas.getContext('2d', { willReadFrequently: true })!;
   } else {
     const img = imageOrCanvas as HTMLImageElement;
     // Copy image to in-memory canvas for processing
@@ -16,7 +16,7 @@ export const sampleBrightness = (imageOrCanvas: HTMLElement) => {
     canvas.width = img.width;
     canvas.height = img.height;
 
-    context = canvas.getContext('2d', { willReadFrequently: true });
+    context = canvas.getContext('2d', { willReadFrequently: true })!;
     context.drawImage(img, 0, 0, img.width, img.height);
   }