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

package/dist/src/SelectionHandler.d.ts

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

package/dist/src/TextAnnotator.d.ts

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

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

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

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

@@ -0,0 +1,6 @@
+import { AnnotationRects } from '../state';
+import { AnnotationState } from '@annotorious/core';
+
+export interface Highlight extends AnnotationRects {
+    state: AnnotationState;
+}

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

@@ -1,9 +1,12 @@
-import type { AnnotationRects } from '../state';
-import type { HighlightStyle } from './HighlightStyle';
-import type { ViewportBounds } from './viewport';
+import { ViewportBounds } from './viewport';
+import { HighlightStyle, HighlightStyleExpression } from './HighlightStyle';
+import { Highlight } from './Highlight';
+
 export interface HighlightPainter {
     clear(): void;
     destroy(): void;
-    paint(annotation: AnnotationRects, viewportBounds: ViewportBounds, isSelected?: boolean): HighlightStyle;
+    paint(highlight: Highlight, viewportBounds: ViewportBounds): HighlightStyle;
     reset(): void;
 }
+/** Helper **/
+export declare const paint: (highlight: Highlight, viewportBounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, zIndex?: number) => HighlightStyle;

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

@@ -1,9 +1,12 @@
-import type { DrawingStyle } from '@annotorious/core';
-export declare const DEFAULT_STYLE: DrawingStyle;
-export declare const DEFAULT_SELECTED_STYLE: DrawingStyle;
+import { TextAnnotation } from 'src/model';
+import { AnnotationState, Color, DrawingStyle } from '@annotorious/core';
+
 export interface HighlightStyle extends Pick<DrawingStyle, 'fill' | 'fillOpacity'> {
     underlineStyle?: string;
-    underlineColor?: number;
+    underlineColor?: Color;
     underlineOffset?: number;
     underlineThickness?: number;
 }
+export type HighlightStyleExpression = HighlightStyle | ((annotation: TextAnnotation, state: AnnotationState, zIndex?: number) => HighlightStyle);
+export declare const DEFAULT_STYLE: HighlightStyle;
+export declare const DEFAULT_SELECTED_STYLE: HighlightStyle;

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

@@ -0,0 +1,21 @@
+import { HighlightStyleExpression } from './HighlightStyle';
+import { Highlight } from './Highlight';
+import { HighlightPainter } from './HighlightPainter';
+import { ViewportBounds } from './viewport';
+import { TextAnnotatorState } from '../state';
+import { Filter, ViewportState } from '@annotorious/core';
+
+export interface RendererImplementation {
+    destroy(): void;
+    redraw(highlights: Highlight[], bounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, force?: boolean): void;
+    setVisible(visible: boolean): void;
+}
+export interface Renderer {
+    destroy(): void;
+    redraw(force?: boolean): void;
+    setStyle(style?: HighlightStyleExpression): void;
+    setFilter(filter?: Filter): void;
+    setPainter(painter?: HighlightPainter): void;
+    setVisible(visible: boolean): void;
+}
+export declare const createBaseRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState, renderer: RendererImplementation) => Renderer;

package/dist/src/highlight/canvas/canvasRenderer.d.ts

@@ -0,0 +1,4 @@
+import { ViewportState } from '@annotorious/core';
+import { TextAnnotatorState } from 'src/state';
+
+export declare const createCanvasRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => import('../baseRenderer').Renderer;

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

@@ -1 +1 @@
-export * from './highlightRenderer';
+export * from './canvasRenderer';

package/dist/src/highlight/highlights/highlightsRenderer.d.ts

@@ -0,0 +1,6 @@
+import { RendererImplementation } from '../baseRenderer';
+import { TextAnnotatorState } from 'src/state';
+import { ViewportState } from '@annotorious/core';
+
+export declare const createRenderer: () => RendererImplementation;
+export declare const createHighlightsRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => import('../baseRenderer').Renderer;

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

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

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

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

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

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

package/dist/src/highlight/span/spansRenderer.d.ts

@@ -0,0 +1,4 @@
+import { TextAnnotatorState } from '../../state';
+import { ViewportState } from '@annotorious/core';
+
+export declare const createSpansRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => import('../baseRenderer').Renderer;

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

@@ -1,5 +1,6 @@
-import type { ViewportState } from '@annotorious/core';
-import type { TextAnnotation } from '../model';
+import { TextAnnotation } from '../model';
+import { ViewportState } from '@annotorious/core';
+
 export interface ViewportBounds {
     top: number;
     left: number;

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
+import { _Origin } from '@annotorious/core';
 export * from './highlight';
 export * from './model';
 export * from './state';
@@ -6,5 +7,4 @@ export * from './presence/PresencePainterOptions';
 export * from './TextAnnotator';
 export * from './TextAnnotatorOptions';
 export type { Filter } from '@annotorious/core';
-import { Origin as _Origin } from '@annotorious/core';
 export { _Origin as Origin };

package/dist/src/model/core/TextAnnotation.d.ts

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

package/dist/src/model/w3c/W3CTextAnnotation.d.ts

@@ -1,4 +1,5 @@
-import type { W3CAnnotation, W3CAnnotationTarget } from '@annotorious/core';
+import { W3CAnnotation, W3CAnnotationTarget } from '@annotorious/core';
+
 export interface W3CTextAnnotation extends W3CAnnotation {
     target: W3CTextAnnotationTarget | W3CTextAnnotationTarget[];
     stylesheet?: W3CAnnotationStylesheet;

package/dist/src/model/w3c/W3CTextFormatAdapter.d.ts

@@ -1,6 +1,7 @@
-import { type FormatAdapter, ParseResult } from '@annotorious/core';
-import type { TextAnnotation } from '../core';
-import type { W3CTextAnnotation } from '../w3c';
+import { W3CTextAnnotation } from '../w3c';
+import { TextAnnotation } from '../core';
+import { FormatAdapter, ParseResult } from '@annotorious/core';
+
 export type W3CTextFormatAdapter = FormatAdapter<TextAnnotation, W3CTextAnnotation>;
 /**
  * @param source - the IRI of the annotated content
@@ -8,5 +9,5 @@ export type W3CTextFormatAdapter = FormatAdapter<TextAnnotation, W3CTextAnnotati
  *                    Required to locate the content's `range` within the DOM
  */
 export declare const W3CTextFormat: (source: string, container: HTMLElement) => W3CTextFormatAdapter;
-export declare const parseW3CTextAnnotation: (annotation: W3CTextAnnotation, container: HTMLElement) => ParseResult<TextAnnotation>;
+export declare const parseW3CTextAnnotation: (annotation: W3CTextAnnotation) => ParseResult<TextAnnotation>;
 export declare const serializeW3CTextAnnotation: (annotation: TextAnnotation, source: string, container: HTMLElement) => W3CTextAnnotation;

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

@@ -1,4 +1,5 @@
-import type { PresenceProvider } from '@annotorious/core';
-import type { HighlightPainter } from '../highlight/HighlightPainter';
-import type { PresencePainterOptions } from 'src/presence';
+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;

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

@@ -1,13 +1,13 @@
-import type { Origin, Store } from '@annotorious/core';
-import type { TextAnnotation } from '../model';
+import { TextAnnotation } from '../model';
+import { Origin, Store } from '@annotorious/core';
+
 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[];
+    bulkUpsertAnnotations(annotations: TextAnnotation[], 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[];
+    getIntersecting(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 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> & {
+import { TextAnnotationStore } from './TextAnnotationStore';
+import { TextAnnotation } from '../model';
+import { PointerSelectAction, ViewportState, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
+
+export interface TextAnnotatorState extends 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/spatialTree.d.ts

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

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

@@ -1,2 +1,3 @@
-import type { TextSelector } from '../model';
+import { TextSelector } from '../model';
+
 export declare const isRevived: (selector: TextSelector[]) => boolean;

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

@@ -1,2 +1,3 @@
-import type { TextSelector } from '../model';
+import { TextSelector } from '../model';
+
 export declare const rangeToSelector: (range: Range, container: HTMLElement, offsetReferenceSelector?: string) => TextSelector;

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

@@ -1,2 +1,3 @@
-import type { TextAnnotation } from '../model';
+import { TextAnnotation } from '../model';
+
 export declare const reviveAnnotation: (annotation: TextAnnotation, container: HTMLElement) => TextAnnotation;

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

@@ -1,4 +1,5 @@
-import type { TextSelector } from '../model';
+import { TextSelector } from '../model';
+
 /**
  * Creates a new selector object with the revived DOM range from the given text annotation position
  * Only the annotatable elements are processed and counted towards the range

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

@@ -1,2 +1,3 @@
-import type { TextAnnotationTarget } from '../model';
+import { TextAnnotationTarget } from '../model';
+
 export declare const reviveTarget: (target: TextAnnotationTarget, container: HTMLElement) => TextAnnotationTarget;

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

@@ -1,4 +1,4 @@
-export declare const NOT_ANNTOTATABLE_SELECTOR = ".not-annotatable";
+export declare const NOT_ANNOTATABLE_SELECTOR = ".not-annotatable";
 /**
  * Splits a DOM Range into one or more ranges that span annotatable content only.
  */

package/dist/test/model/w3c/fixtures.d.ts

@@ -1,3 +1,4 @@
-import type { W3CTextAnnotation } from '../../../src';
+import { W3CTextAnnotation } from '../../../src';
+
 export declare const textAnnotation: W3CTextAnnotation;
 export declare const incompleteTextAnnotation: W3CTextAnnotation;

package/dist/text-annotator.css

@@ -1 +1 @@
-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}
+.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}