@annotorious/annotorious 3.0.0-rc.16 → 3.0.0-rc.18

package/src/annotation/editors/rectangle/RectangleEditor.svelte

@@ -1,19 +1,18 @@
-<script type="ts">
-  import type { Rectangle } from '../../../model';
+<script lang="ts">
+  import Handle from '../Handle.svelte';
+  import type { Rectangle, Shape } from '../../../model';
   import type { Transform } from '../../Transform';
-  import { Editor, Handle } from '..';
+  import { Editor } from '..';
 
   /** Props */
   export let shape: Rectangle;
-  export let computedStyle: string = undefined;
+  export let computedStyle: string | undefined;
   export let transform: Transform;
   export let viewportScale: number = 1;
 
   $: geom = shape.geometry;
 
-  $: handleSize = 10 / viewportScale;
-
-  const editor = (rectangle: Rectangle, handle: Handle, delta: [number, number]) => {
+  const editor = (rectangle: Shape, handle: string, delta: [number, number]) => {
     const initialBounds = rectangle.geometry.bounds;
 
     let [x0, y0] = [initialBounds.minX, initialBounds.minY];
@@ -21,39 +20,39 @@
 
     const [dx, dy] = delta;
 
-    if (handle === Handle.SHAPE) {
+    if (handle === 'SHAPE') {
       x0 += dx;
       x1 += dx;
       y0 += dy;
       y1 += dy;
     } else {
       switch (handle) {
-        case Handle.TOP:
-        case Handle.TOP_LEFT:
-        case Handle.TOP_RIGHT: {
+        case 'TOP':
+        case 'TOP_LEFT':
+        case 'TOP_RIGHT': {
           y0 += dy;
           break;
         }
 
-        case Handle.BOTTOM:
-        case Handle.BOTTOM_LEFT:
-        case Handle.BOTTOM_RIGHT: {
+        case 'BOTTOM':
+        case 'BOTTOM_LEFT':
+        case 'BOTTOM_RIGHT': {
           y1 += dy;
           break;
         }
       }
 
       switch (handle) {
-        case Handle.LEFT:
-        case Handle.TOP_LEFT:
-        case Handle.BOTTOM_LEFT: {
+        case 'LEFT':
+        case 'TOP_LEFT':
+        case 'BOTTOM_LEFT': {
           x0 += dx;
           break;
         }
 
-        case Handle.RIGHT:
-        case Handle.TOP_RIGHT:
-        case Handle.BOTTOM_RIGHT: {
+        case 'RIGHT':
+        case 'TOP_RIGHT':
+        case 'BOTTOM_RIGHT': {
           x1 += dx;
           break;
         }
@@ -92,52 +91,56 @@
   <rect 
     class="a9s-outer"
     style={computedStyle ? 'display:none;' : undefined}
-    on:pointerdown={grab(Handle.SHAPE)}
+    on:pointerdown={grab('SHAPE')}
     x={geom.x} y={geom.y} width={geom.w} height={geom.h} />
 
   <rect 
     class="a9s-inner a9s-shape-handle"
     style={computedStyle}
-    on:pointerdown={grab(Handle.SHAPE)}
+    on:pointerdown={grab('SHAPE')}
     x={geom.x} y={geom.y} width={geom.w} height={geom.h} />
 
   <rect 
     class="a9s-edge-handle a9s-edge-handle-top" 
-    on:pointerdown={grab(Handle.TOP)}
+    on:pointerdown={grab('TOP')}
     x={geom.x} y={geom.y} height={1} width={geom.w} />
 
   <rect 
     class="a9s-edge-handle a9s-edge-handle-right"
-    on:pointerdown={grab(Handle.RIGHT)}
+    on:pointerdown={grab('RIGHT')}
     x={geom.x + geom.w} y={geom.y} height={geom.h} width={1}/>
 
   <rect 
     class="a9s-edge-handle a9s-edge-handle-bottom" 
-    on:pointerdown={grab(Handle.BOTTOM)}
+    on:pointerdown={grab('BOTTOM')}
     x={geom.x} y={geom.y + geom.h} height={1} width={geom.w} />
 
   <rect 
     class="a9s-edge-handle a9s-edge-handle-left" 
-    on:pointerdown={grab(Handle.LEFT)}
+    on:pointerdown={grab('LEFT')}
     x={geom.x} y={geom.y} height={geom.h} width={1} />
 
-  <rect 
-    class="a9s-corner-handle a9s-corner-handle-topleft"
-    on:pointerdown={grab(Handle.TOP_LEFT)}
-    x={geom.x - handleSize / 2} y={geom.y - handleSize / 2} height={handleSize} width={handleSize} />
-
-  <rect 
-    class="a9s-corner-handle a9s-corner-handle-topright"
-    on:pointerdown={grab(Handle.TOP_RIGHT)}
-    x={geom.x + geom.w - handleSize / 2} y={geom.y - handleSize / 2} height={handleSize} width={handleSize} />
+  <Handle
+    class="a9s-corner-handle-topleft"
+    on:pointerdown={grab('TOP_LEFT')}
+    x={geom.x} y={geom.y}
+    scale={viewportScale} /> 
+
+  <Handle
+    class="a9s-corner-handle-topright"
+    on:pointerdown={grab('TOP_RIGHT')}
+    x={geom.x + geom.w} y={geom.y} 
+    scale={viewportScale} />
   
-  <rect 
-    class="a9s-corner-handle a9s-corner-handle-bottomright"
-    on:pointerdown={grab(Handle.BOTTOM_RIGHT)}
-    x={geom.x + geom.w - handleSize / 2} y={geom.y + geom.h - handleSize / 2} height={handleSize} width={handleSize} />
+  <Handle 
+    class="a9s-corner-handle-bottomright"
+    on:pointerdown={grab('BOTTOM_RIGHT')}
+    x={geom.x + geom.w} y={geom.y + geom.h} 
+    scale={viewportScale} />
     
-  <rect 
-    class="a9s-corner-handle a9s-corner-handle-bottomleft"
-    on:pointerdown={grab(Handle.BOTTOM_LEFT)}
-    x={geom.x - handleSize / 2} y={geom.y + geom.h - handleSize / 2} height={handleSize} width={handleSize} />
+  <Handle 
+    class="a9s-corner-handle-bottomleft"
+    on:pointerdown={grab('BOTTOM_LEFT')}
+    x={geom.x} y={geom.y + geom.h} 
+    scale={viewportScale} />
 </Editor>

package/src/annotation/shapes/Ellipse.svelte

@@ -1,4 +1,4 @@
-<script type="ts">
+<script lang="ts">
   import type { DrawingStyle } from '@annotorious/core';
   import type { Geometry, EllipseGeometry, ImageAnnotation } from '../../model';
   import { computeStyle } from '../utils/styling';
@@ -6,7 +6,7 @@
   /** Props */
   export let annotation: ImageAnnotation;
   export let geom: Geometry;
-  export let style: DrawingStyle | ((annotation: ImageAnnotation) => DrawingStyle) = undefined;
+  export let style: DrawingStyle | ((annotation: ImageAnnotation) => DrawingStyle) | undefined;
 
   $: computedStyle = computeStyle(annotation, style);
 

package/src/annotation/shapes/Polygon.svelte

@@ -1,4 +1,4 @@
-<script type="ts">
+<script lang="ts">
   import type { DrawingStyle } from '@annotorious/core';
   import type { Geometry, ImageAnnotation, PolygonGeometry } from '../../model';
   import { computeStyle } from '../utils/styling';
@@ -6,7 +6,7 @@
   /** Props **/
   export let annotation: ImageAnnotation;
   export let geom: Geometry;
-  export let style: DrawingStyle | ((annotation: ImageAnnotation) => DrawingStyle) = undefined;
+  export let style: DrawingStyle | ((annotation: ImageAnnotation) => DrawingStyle) | undefined;
 
   $: computedStyle = computeStyle(annotation, style);
 

package/src/annotation/shapes/Rectangle.svelte

@@ -1,4 +1,4 @@
-<script type="ts">
+<script lang="ts">
   import type { DrawingStyle } from '@annotorious/core';
   import type { Geometry, ImageAnnotation, RectangleGeometry } from '../../model';
   import { computeStyle } from '../utils/styling';
@@ -6,7 +6,7 @@
   /** Props **/
   export let annotation: ImageAnnotation;
   export let geom: Geometry;
-  export let style: DrawingStyle | ((annotation: ImageAnnotation) => DrawingStyle) = undefined;
+  export let style: DrawingStyle | ((annotation: ImageAnnotation) => DrawingStyle) | undefined;
 
   $: computedStyle = computeStyle(annotation, style);
 

package/src/annotation/tools/ToolMount.svelte

@@ -23,9 +23,9 @@
 
     const cleanup: Function[] = [];
 
-    const addEventListener = (name: string, handler: (evt: PointerEvent) => void, capture?: boolean) => {
-      svg.addEventListener(name, handler, capture);
-      cleanup.push(() => svg.removeEventListener(name, handler, capture));
+    const addEventListener = (name: keyof SVGSVGElementEventMap, handler: EventListenerOrEventListenerObject, capture?: boolean) => {
+      svg?.addEventListener(name, handler, capture);
+      cleanup.push(() => svg?.removeEventListener(name, handler, capture));
     }
 
     toolComponent = new tool({

package/src/annotation/tools/drawingToolsRegistry.ts

@@ -9,10 +9,11 @@ export type DrawingToolOpts = {
 
   drawingMode?: DrawingMode;
 
-  [key: string]: string;
+  [key: string]: any;
 
 }
 
+// @ts-ignore
 const REGISTERED = new Map<DrawingTool, { tool: typeof SvelteComponent, opts?: DrawingToolOpts }>([
   ['rectangle', { tool: RubberbandRectangle }],
   ['polygon', { tool: RubberbandPolygon }]

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,15 +17,24 @@
 
   let points: [number, number][] = [];
   
-  let cursor: [number, number] = null;
+  let cursor: [number, number] | undefined;
+
+  // Keep track of the user keeping the finger
+  // in place. Long pauses will be interpreted like a 
+  // double click and close the shape.
+  let touchPauseTimer: number | undefined;
 
   let isClosable: boolean = false;
 
   const CLOSE_DISTANCE = 20;
 
+  const TOUCH_PAUSE_LIMIT = 1500;
+
   $: 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 +49,11 @@
     }
   }
 
-  const onPointerMove = (evt: PointerEvent) => {
+  const onPointerMove = (event: Event) => {
+    const evt = event as PointerEvent;
+
+    if (touchPauseTimer) clearTimeout(touchPauseTimer);
+
     if (points.length > 0) {
       cursor = transform.elementToImage(evt.offsetX, evt.offsetY);
 
@@ -48,10 +61,18 @@
         const d = distance(cursor, points[0]) * viewportScale;
         isClosable = d < CLOSE_DISTANCE;
       }
+
+      if (evt.pointerType === 'touch') {
+        touchPauseTimer = setTimeout(() => {
+          onDblClick();
+        }, TOUCH_PAUSE_LIMIT);
+      }
     }
   }
 
-  const onPointerUp = (evt: PointerEvent) => {
+  const onPointerUp = (event: Event) => {
+    const evt = event as PointerEvent;
+
     if (drawingMode === 'click') {
       const timeDifference = evt.timeStamp - lastPointerDown.timeStamp;
 
@@ -71,17 +92,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,12 +114,14 @@
       if (isClosable) {
         stopDrawing();
       } else {
-        points.push(cursor);
+        points.push(cursor!);
       }
     }
   }
 
   const onDblClick = () => {
+    if (!cursor) return;
+
     // Require min 3 points (incl. cursor) and minimum
     // polygon area
     const p = [...points, cursor];
@@ -114,7 +137,7 @@
     const area = computeArea(shape);
     if (area > 4) {
       points = [];
-      cursor = null;
+      cursor = undefined;
     
       dispatch('create', shape);
     }
@@ -130,7 +153,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/annotation/utils/touch.ts

@@ -1 +1,4 @@
-export const isTouch = 'ontouchstart' in window || navigator.maxTouchPoints > 0;
+export const isTouch = 'ontouchstart' in window 
+  || navigator.maxTouchPoints > 0
+  // @ts-ignore
+  || navigator.msMaxTouchPoints > 0;

package/src/index.ts

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

package/src/keyboardCommands.ts

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

@@ -3,12 +3,13 @@ import { parseW3CUser, parseW3CBodies, serializeW3CBodies } from '@annotorious/c
 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,
@@ -33,22 +34,23 @@ export const parseW3CImageAnnotation = (
   const { 
     creator,
     created,
-    updatedBy,
-    updated,
+    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 ? { 
@@ -59,13 +61,14 @@ export const parseW3CImageAnnotation = (
       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)}`)
   };
 
 }
@@ -73,13 +76,13 @@ export const parseW3CImageAnnotation = (
 export const serializeW3CImageAnnotation = (
   annotation: ImageAnnotation, 
   source: string
-): W3CAnnotation => {
+): W3CImageAnnotation => {
   const { 
     selector, 
     creator, 
     created, 
-    updated, 
-    updatedBy, 
+    updated,
+    updatedBy, // Excluded from serialization
     ...rest 
   } = annotation.target;
 
@@ -94,12 +97,13 @@ export const serializeW3CImageAnnotation = (
     id: annotation.id,
     type: 'Annotation',
     body: serializeW3CBodies(annotation.bodies),
-    creator,
     created: created?.toISOString(),
+    creator,
+    modified: updated?.toISOString(),
     target: {
       ...rest,
       source,
       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);