@recogito/text-annotator 4.2.1 → 4.2.3

package/dist/state/spatial-tree.d.ts

@@ -1,7 +1,7 @@
 import type { Store } from '@annotorious/core';
 import { type Unsubscribe } from 'nanoevents';
 import type { AnnotationRects } from '../state/text-annotation-store';
-import type { RevivedTextAnnotationLike, RevivedTextSelectorLike, TextAnnotationLike, TextAnnotationTargetLike } from '../model';
+import type { RevivedTextAnnotationLike, RevivedTextAnnotationTargetLike, TextAnnotationLike, TextAnnotationTargetLike } from '../model';
 interface IndexedHighlightRect {
     minX: number;
     minY: number;
@@ -15,19 +15,19 @@ interface IndexedHighlightRect {
 export interface SpatialTreeEvents {
     recalculate(): void;
 }
-export declare const createSpatialTree: <T extends TextAnnotationLike>(store: Store<T>, container: HTMLElement, hMergeTolerance?: number, vMergeTolerance?: number, selectorReviveFn?: (arg: T["target"]["selector"][number], container: HTMLElement) => RevivedTextSelectorLike) => {
+export declare const createSpatialTree: <T extends TextAnnotationLike>(store: Store<T>, container: HTMLElement, hMergeTolerance?: number, vMergeTolerance?: number) => {
     all: () => IndexedHighlightRect[][];
     clear: () => void;
     getAt: (x: number, y: number, all?: boolean) => string[];
     getAnnotationBounds: (id: string) => DOMRect | undefined;
     getAnnotationRects: (id: string) => DOMRect[];
     getIntersecting: (minX: number, minY: number, maxX: number, maxY: number) => AnnotationRects<RevivedTextAnnotationLike<T>>[];
-    insert: (target: TextAnnotationTargetLike) => void;
+    insert: (target: RevivedTextAnnotationTargetLike) => void;
     recalculate: () => void;
     remove: (target: TextAnnotationTargetLike) => void;
-    set: (targets: TextAnnotationTargetLike[], replace?: boolean) => void;
+    set: (targets: RevivedTextAnnotationTargetLike[], replace?: boolean) => void;
     size: () => number;
-    update: (target: TextAnnotationTargetLike) => void;
+    update: (target: RevivedTextAnnotationTargetLike) => void;
     on: <E extends keyof SpatialTreeEvents>(event: E, callback: SpatialTreeEvents[E]) => Unsubscribe;
 };
 export {};

package/dist/state/text-annotation-store.d.ts

@@ -2,10 +2,14 @@ import type { Unsubscribe } from 'nanoevents';
 import type { Filter, Origin, Store } from '@annotorious/core';
 import type { RevivedTextAnnotationLike, TextAnnotation, TextAnnotationLike } from '../model';
 import type { SpatialTreeEvents } from '../state/spatial-tree';
-export interface TextAnnotationStore<T extends TextAnnotationLike = TextAnnotation> extends Omit<Store<T>, 'addAnnotation' | 'bulkAddAnnotations' | 'bulkUpsertAnnotations'> {
+export interface TextAnnotationStore<T extends TextAnnotationLike = TextAnnotation> extends Omit<Store<T>, 'addAnnotation' | 'bulkAddAnnotations' | 'bulkUpsertAnnotations' | 'syncAnnotations'> {
     addAnnotation(annotation: T, origin?: Origin): boolean;
+    /**
+     * @deprecated use {@link syncAnnotations} (replace) or {@link bulkUpsertAnnotations} (merge) instead.
+     */
     bulkAddAnnotations(annotations: T[], replace: boolean, origin?: Origin): T[];
     bulkUpsertAnnotations(annotations: T[], origin?: Origin): T[];
+    syncAnnotations(annotations: T[], origin?: Origin): T[];
     getAnnotationRects(id: string): DOMRect[];
     getAnnotationBounds(id: string): DOMRect | undefined;
     getAnnotationRects(id: string): DOMRect[];

package/dist/text-annotator-options.d.ts

@@ -9,7 +9,7 @@ export interface TextAnnotatorOptions<I extends TextAnnotationLike = TextAnnotat
      * Custom function that turns a stored selector into a revived one (with a live DOM `range`).
      * Used by sub-formats such as PDF to map their selector shape to a text range.
      */
-    selectorReviveFn?: (arg: I['target']['selector'][number], container: HTMLElement) => RevivedTextSelectorLike;
+    selectorReviveFn?: (arg: I['target']['selector'][number], container: HTMLElement) => RevivedTextSelectorLike | RevivedTextSelectorLike[];
     /**
      * Determines whether an active selection should be dismissed
      * when a user ends their interaction (click, selection)