@recogito/text-annotator 3.0.0-rc.19 → 3.0.0-rc.3

package/dist/src/SelectionHandler.d.ts

@@ -1,7 +1,7 @@
-import { TextAnnotatorState } from './state';
-import { User } from '@annotorious/core';
-
+import { type User } from '@annotorious/core';
+import type { TextAnnotatorState } from './state';
+import type { TextSelector } from './model';
+export declare const rangeToSelector: (range: Range, container: HTMLElement, offsetReferenceSelector?: string) => TextSelector;
 export declare const SelectionHandler: (container: HTMLElement, state: TextAnnotatorState, offsetReferenceSelector?: string) => {
-    destroy: () => void;
     setUser: (user: User) => User;
 };

package/dist/src/TextAnnotator.d.ts

@@ -1,11 +1,8 @@
-import { TextAnnotatorOptions } from './TextAnnotatorOptions';
-import { TextAnnotation } from './model';
-import { TextAnnotatorState } from './state';
-import { Annotator } from '@annotorious/core';
-
-export interface TextAnnotator<E extends unknown = TextAnnotation> extends Annotator<TextAnnotation, E> {
+import type { Annotator } from '@annotorious/core';
+import type { TextAnnotation } from './model';
+import type { TextAnnotatorOptions } from './TextAnnotatorOptions';
+export interface TextAnnotator<T extends unknown = TextAnnotation> extends Annotator<TextAnnotation, T> {
     element: HTMLElement;
     scrollIntoView(annotation: TextAnnotation): boolean;
-    state: TextAnnotatorState;
 }
 export declare const createTextAnnotator: <E extends unknown = TextAnnotation>(container: HTMLElement, opts?: TextAnnotatorOptions<E>) => TextAnnotator<E>;

package/dist/src/TextAnnotatorOptions.d.ts

@@ -1,14 +1,10 @@
-import { HighlightStyleExpression } from './highlight/HighlightStyle';
-import { TextAnnotation } from './model';
-import { PresencePainterOptions } from './presence';
-import { FormatAdapter, PointerSelectAction } from '@annotorious/core';
-
+import type { DrawingStyle, FormatAdapter, PointerSelectAction } from '@annotorious/core';
+import type { PresencePainterOptions } from './presence';
+import type { TextAnnotation } from './model';
 export interface TextAnnotatorOptions<T extends unknown = TextAnnotation> {
     adapter?: FormatAdapter<TextAnnotation, T> | null;
-    renderer?: RendererType;
     offsetReferenceSelector?: string;
     pointerAction?: PointerSelectAction | ((annotation: TextAnnotation) => PointerSelectAction);
     presence?: PresencePainterOptions;
-    style?: HighlightStyleExpression;
+    style?: DrawingStyle | ((annotation: TextAnnotation) => DrawingStyle);
 }
-export type RendererType = 'SPANS' | 'CANVAS' | 'CSS_HIGHLIGHTS';

package/dist/src/api/scrollIntoView.d.ts

@@ -1,4 +1,3 @@
-import { TextAnnotation } from '../model';
-import { TextAnnotationStore } from '../state';
-
+import type { TextAnnotationStore } from 'src/state';
+import type { TextAnnotation } from '../model/TextAnnotation';
 export declare const scrollIntoView: (container: HTMLElement, store: TextAnnotationStore) => (annotation: TextAnnotation) => boolean;

package/dist/src/highlight/HighlightPainter.d.ts

@@ -1,12 +1,20 @@
-import { ViewportBounds } from './viewport';
-import { HighlightStyle, HighlightStyleExpression } from './HighlightStyle';
-import { Highlight } from './Highlight';
-
-export interface HighlightPainter {
-    clear(): void;
-    destroy(): void;
-    paint(highlight: Highlight, viewportBounds: ViewportBounds): HighlightStyle;
-    reset(): void;
+import type { DrawingStyle } from '@annotorious/core';
+import type { TextAnnotation } from '../model';
+import type { Rect } from '../state';
+/**
+ * A painter implements the actual CANVAS highlight drawing logic.
+ */
+export type HighlightPainter = {
+    paint(annotation: TextAnnotation, rects: Rect[], bg: CanvasRenderingContext2D, fg: CanvasRenderingContext2D, isSelected?: boolean, style?: DrawingStyle | ((annotation: TextAnnotation, selected?: boolean) => DrawingStyle)): void;
+};
+/**
+ * The default painter.
+ */
+export declare const defaultPainter: HighlightPainter;
+export interface HighlightStyle {
+    fill?: string;
+    fillOpacity?: number;
+    underline?: string;
+    underlineOpacity?: number;
+    underlineWidth?: number;
 }
-/** Helper **/
-export declare const paint: (highlight: Highlight, viewportBounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, zIndex?: number) => HighlightStyle;

package/dist/src/highlight/highlightLayer.d.ts

@@ -0,0 +1,10 @@
+import type { DrawingStyle, Filter, ViewportState } from '@annotorious/core';
+import type { TextAnnotation } from '../model';
+import type { TextAnnotatorState } from '../state';
+import { type HighlightPainter } from './HighlightPainter';
+export declare const createHighlightLayer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => {
+    redraw: () => number;
+    setDrawingStyle: (style: DrawingStyle | ((a: TextAnnotation, selected?: boolean) => DrawingStyle)) => void;
+    setFilter: (filter?: Filter) => void;
+    setPainter: (painter: HighlightPainter) => HighlightPainter;
+};

package/dist/src/highlight/index.d.ts

@@ -1,3 +1,2 @@
-export * from './canvas';
-export * from './highlights';
-export * from './span';
+export * from './highlightLayer';
+export * from './HighlightPainter';

package/dist/src/highlight/trackViewport.d.ts

@@ -0,0 +1,3 @@
+import type { ViewportState } from '@annotorious/core';
+import type { TextAnnotation } from '../model';
+export declare const trackViewport: (viewport: ViewportState) => (annotations: TextAnnotation[]) => void;

package/dist/src/index.d.ts

@@ -1,10 +1,9 @@
-import { _Origin } from '@annotorious/core';
 export * from './highlight';
 export * from './model';
 export * from './state';
-export * from './utils';
 export * from './presence/PresencePainterOptions';
 export * from './TextAnnotator';
 export * from './TextAnnotatorOptions';
-export type { Filter } from '@annotorious/core';
-export { _Origin as Origin };
+export * from '@annotorious/core/src/model';
+import { Origin as _Origin } from '@annotorious/core/src/state';
+export declare const Origin: typeof _Origin;

package/dist/src/model/{core/TextAnnotation.d.ts → TextAnnotation.d.ts}

@@ -1,13 +1,11 @@
-import { Annotation, AnnotationTarget } from '@annotorious/core';
-
+import type { Annotation, AnnotationTarget } from '@annotorious/core';
 export interface TextAnnotation extends Annotation {
     target: TextAnnotationTarget;
 }
 export interface TextAnnotationTarget extends AnnotationTarget {
-    selector: TextSelector[];
+    selector: TextSelector;
 }
 export interface TextSelector {
-    id?: string;
     quote: string;
     start: number;
     end: number;

package/dist/src/model/index.d.ts

@@ -1,2 +1 @@
-export * from './core';
-export * from './w3c';
+export * from './TextAnnotation';

package/dist/src/presence/PresencePainter.d.ts

@@ -1,5 +1,4 @@
-import { PresencePainterOptions } from 'src/presence';
-import { HighlightPainter } from '../highlight/HighlightPainter';
-import { PresenceProvider } from '@annotorious/core';
-
-export declare const createPresencePainter: (container: HTMLElement, provider: PresenceProvider, opts?: PresencePainterOptions) => HighlightPainter;
+import type { PresenceProvider } from '@annotorious/core';
+import type { HighlightPainter } from '../highlight';
+import type { PresencePainterOptions } from './PresencePainterOptions';
+export declare const createPainter: (provider: PresenceProvider, opts?: PresencePainterOptions) => HighlightPainter;

package/dist/src/state/TextAnnotationStore.d.ts

@@ -1,13 +1,12 @@
-import { TextAnnotation } from '../model';
-import { Origin, Store } from '@annotorious/core';
-
+import type { Origin, Store } from '@annotorious/core';
+import type { TextAnnotation } from '../model';
 export interface TextAnnotationStore extends Omit<Store<TextAnnotation>, 'addAnnotation' | 'bulkAddAnnotation'> {
-    addAnnotation(annotation: TextAnnotation, origin?: Origin): boolean;
-    bulkAddAnnotation(annotations: TextAnnotation[], replace: boolean, origin?: Origin): TextAnnotation[];
-    bulkUpsertAnnotations(annotations: TextAnnotation[], origin?: Origin): TextAnnotation[];
+    addAnnotation(annotation: TextAnnotation, origin: Origin): boolean;
+    bulkAddAnnotation(annotations: TextAnnotation[], replace: boolean, origin: Origin): TextAnnotation[];
     getAnnotationBounds(id: string, hintX?: number, hintY?: number, buffer?: number): DOMRect;
     getAt(x: number, y: number): TextAnnotation | undefined;
-    getIntersecting(minX: number, minY: number, maxX: number, maxY: number): AnnotationRects[];
+    getIntersecting(minX: number, minY: number, maxX: number, maxY: number): TextAnnotation[];
+    getIntersectingRects(minX: number, minY: number, maxX: number, maxY: number): AnnotationRects[];
     recalculatePositions(): void;
 }
 export interface AnnotationRects {

package/dist/src/state/TextAnnotatorState.d.ts

@@ -1,11 +1,11 @@
-import { TextAnnotationStore } from './TextAnnotationStore';
-import { TextAnnotation } from '../model';
-import { PointerSelectAction, ViewportState, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
-
-export interface TextAnnotatorState extends AnnotatorState<TextAnnotation> {
+import type { PointerSelectAction, ViewportState } from '@annotorious/core';
+import { AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
+import type { TextAnnotation } from '../model';
+import type { TextAnnotationStore } from './TextAnnotationStore';
+export type TextAnnotatorState = AnnotatorState<TextAnnotation> & {
     store: TextAnnotationStore;
     selection: SelectionState<TextAnnotation>;
     hover: HoverState<TextAnnotation>;
     viewport: ViewportState;
-}
+};
 export declare const createTextAnnotatorState: (container: HTMLElement, defaultPointerAction?: PointerSelectAction | ((annotation: TextAnnotation) => PointerSelectAction)) => TextAnnotatorState;

package/dist/src/state/index.d.ts

@@ -1,2 +1,3 @@
+export * from './reviveTarget';
 export * from './TextAnnotationStore';
 export * from './TextAnnotatorState';

package/dist/src/state/reviveTarget.d.ts

@@ -0,0 +1,9 @@
+import type { TextAnnotationTarget } from '../model';
+/**
+ * Recalculates the DOM range from the given text annotation target.
+ *
+ * @param annotation the text annotation
+ * @param container the HTML container of the annotated content
+ * @returns the DOM range
+ */
+export declare const reviveTarget: (target: TextAnnotationTarget, container: HTMLElement) => TextAnnotationTarget;

package/dist/src/state/spatialTree.d.ts

@@ -1,8 +1,6 @@
-import { AnnotationRects } from './TextAnnotationStore';
-import { TextAnnotation, TextAnnotationTarget } from '../model';
-import { Store } from '@annotorious/core';
-
-interface IndexedHighlightRect {
+import type { Store } from '@annotorious/core';
+import type { TextAnnotation, TextAnnotationTarget } from '../model';
+export interface IndexedHighlightRect {
     minX: number;
     minY: number;
     maxX: number;
@@ -16,9 +14,9 @@ export declare const createSpatialTree: (store: Store<TextAnnotation>, container
     all: () => IndexedHighlightRect[][];
     clear: () => void;
     getAt: (x: number, y: number) => string | undefined;
-    getAnnotationBounds: (id: string) => DOMRect;
-    getAnnotationRects: (id: string) => DOMRect[];
-    getIntersecting: (minX: number, minY: number, maxX: number, maxY: number) => AnnotationRects[];
+    getBoundsForAnnotation: (id: string) => DOMRect;
+    getDOMRectsForAnnotation: (id: string) => DOMRect[];
+    getIntersectingRects: (minX: number, minY: number, maxX: number, maxY: number) => IndexedHighlightRect[];
     insert: (target: TextAnnotationTarget) => void;
     recalculate: () => void;
     remove: (target: TextAnnotationTarget) => void;
@@ -26,4 +24,3 @@ export declare const createSpatialTree: (store: Store<TextAnnotation>, container
     size: () => number;
     update: (target: TextAnnotationTarget) => void;
 };
-export {};

package/dist/src/utils/index.d.ts

@@ -1,12 +1,3 @@
-export * from './debounce';
-export * from './getAnnotatableFragment';
 export * from './getClientRectsPonyfill';
-export * from './getQuoteContext';
-export * from './isRevived';
 export * from './mergeClientRects';
-export * from './rangeToSelector';
-export * from './reviveAnnotation';
-export * from './reviveSelector';
-export * from './reviveTarget';
-export * from './splitAnnotatableRanges';
 export * from './trimRange';

package/dist/text-annotator.css

@@ -1 +1 @@
-.r6o-annotatable .r6o-span-highlight-layer{height:100%;left:0;pointer-events:none;position:absolute;top:0;width:100%}.r6o-annotatable .r6o-span-highlight-layer.hidden{display:none}.r6o-annotatable .r6o-span-highlight-layer .r6o-annotation{border-style:solid;border-width:0;position:absolute;display:block}html,body{overscroll-behavior-y:none}.r6o-annotatable{-webkit-tap-highlight-color:transparent}.r6o-annotatable,.r6o-annotatable *{position:relative}.hovered *{cursor:pointer}.r6o-highlight-layer{left:0;position:fixed;top:0;bottom:0;width:100vw;pointer-events:none}*::selection,::selection{background:#0080ff2e}::-moz-selection{background:#0080ff2e}
+html,body{overscroll-behavior-y:none}.r6o-annotatable,.r6o-annotatable *{position:relative}.r6o-annotatable.hovered{cursor:pointer}.r6o-highlight-layer{height:100vh;left:0;position:fixed;top:0;pointer-events:none;width:100vw}*::selection,::selection{background:rgba(0,128,255,.18)}::-moz-selection{background:rgba(0,128,255,.18)}