@recogito/text-annotator 3.0.0-rc.1

package/dist/src/SelectionHandler.d.ts

@@ -0,0 +1,7 @@
+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) => {
+    setUser: (user: User) => User;
+};

package/dist/src/TextAnnotator.d.ts

@@ -0,0 +1,8 @@
+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;
+}
+export declare const createTextAnnotator: <E extends unknown = TextAnnotation>(container: HTMLElement, opts?: TextAnnotatorOptions<E>) => TextAnnotator<E>;

package/dist/src/TextAnnotatorOptions.d.ts

@@ -0,0 +1,10 @@
+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;
+    offsetReferenceSelector?: string;
+    pointerAction?: PointerSelectAction | ((annotation: TextAnnotation) => PointerSelectAction);
+    presence?: PresencePainterOptions;
+    style?: DrawingStyle | ((annotation: TextAnnotation) => DrawingStyle);
+}

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

@@ -0,0 +1 @@
+export * from './scrollIntoView';

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,20 @@
+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;
+}

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

@@ -0,0 +1,9 @@
+import type { DrawingStyle, 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;
+    setPainter: (painter: HighlightPainter) => HighlightPainter;
+};

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

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,9 @@
+export * from './highlight';
+export * from './model';
+export * from './state';
+export * from './presence/PresencePainterOptions';
+export * from './TextAnnotator';
+export * from './TextAnnotatorOptions';
+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/TextAnnotation.d.ts

@@ -0,0 +1,14 @@
+import type { Annotation, AnnotationTarget } from '@annotorious/core';
+export interface TextAnnotation extends Annotation {
+    target: TextAnnotationTarget;
+}
+export interface TextAnnotationTarget extends AnnotationTarget {
+    selector: TextSelector;
+}
+export interface TextSelector {
+    quote: string;
+    start: number;
+    end: number;
+    range: Range;
+    offsetReference?: HTMLElement;
+}

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

@@ -0,0 +1 @@
+export * from './TextAnnotation';

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

@@ -0,0 +1,4 @@
+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/presence/PresencePainterOptions.d.ts

@@ -0,0 +1,3 @@
+export interface PresencePainterOptions {
+    font?: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './PresencePainter';
+export * from './PresencePainterOptions';

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

@@ -0,0 +1,21 @@
+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[];
+    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): TextAnnotation[];
+    getIntersectingRects(minX: number, minY: number, maxX: number, maxY: number): AnnotationRects[];
+    recalculatePositions(): void;
+}
+export interface AnnotationRects {
+    annotation: TextAnnotation;
+    rects: Rect[];
+}
+export interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +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

@@ -0,0 +1,26 @@
+import type { Store } from '@annotorious/core';
+import type { TextAnnotation, TextAnnotationTarget } from '../model';
+export interface IndexedHighlightRect {
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+    annotation: {
+        id: string;
+        rects: DOMRect[];
+    };
+}
+export declare const createSpatialTree: (store: Store<TextAnnotation>, container: HTMLElement) => {
+    all: () => IndexedHighlightRect[][];
+    clear: () => void;
+    getAt: (x: number, y: number) => string | undefined;
+    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;
+    set: (targets: TextAnnotationTarget[], replace?: boolean) => void;
+    size: () => number;
+    update: (target: TextAnnotationTarget) => void;
+};

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

@@ -0,0 +1 @@
+export declare const getClientRectsPonyfill: (range: Range) => DOMRect[];

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

@@ -0,0 +1,3 @@
+export * from './getClientRectsPonyfill';
+export * from './mergeClientRects';
+export * from './trimRange';

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

@@ -0,0 +1 @@
+export declare const mergeClientRects: (rects: DOMRect[]) => DOMRect[];

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

@@ -0,0 +1 @@
+export declare const trimRange: (range: Range) => Range;

package/dist/text-annotator.css

@@ -0,0 +1 @@
+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)}