@recogito/text-annotator 3.0.0-rc.10 → 3.0.0-rc.12

package/dist/src/SelectionHandler.d.ts

@@ -1,7 +1,6 @@
 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/TextAnnotatorOptions.d.ts

@@ -3,6 +3,7 @@ import type { PresencePainterOptions } from './presence';
 import type { TextAnnotation } from './model';
 export interface TextAnnotatorOptions<T extends unknown = TextAnnotation> {
     adapter?: FormatAdapter<TextAnnotation, T> | null;
+    experimentalCSSRenderer?: boolean;
     offsetReferenceSelector?: string;
     pointerAction?: PointerSelectAction | ((annotation: TextAnnotation) => PointerSelectAction);
     presence?: PresencePainterOptions;

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

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

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

@@ -1,20 +1,9 @@
-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;
+import type { AnnotationRects } from '../state';
+import type { HighlightStyle } from './HighlightStyle';
+import type { ViewportBounds } from './viewport';
+export interface HighlightPainter {
+    clear(): void;
+    destroy(): void;
+    paint(annotation: AnnotationRects, viewportBounds: ViewportBounds, isSelected?: boolean): HighlightStyle;
+    reset(): void;
 }

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

@@ -0,0 +1,9 @@
+import type { DrawingStyle } from '@annotorious/core';
+export declare const DEFAULT_STYLE: DrawingStyle;
+export declare const DEFAULT_SELECTED_STYLE: DrawingStyle;
+export interface HighlightStyle extends Pick<DrawingStyle, 'fill' | 'fillOpacity'> {
+    underlineStyle?: string;
+    underlineColor?: number;
+    underlineOffset?: number;
+    underlineThickness?: number;
+}

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

@@ -0,0 +1,11 @@
+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 createCanvasHighlightRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => {
+    destroy: () => void;
+    refresh: () => number;
+    setDrawingStyle: (style: DrawingStyle | ((a: TextAnnotation, selected?: boolean) => DrawingStyle)) => void;
+    setFilter: (filter?: Filter) => void;
+    setPainter: (painter: HighlightPainter) => HighlightPainter;
+};

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

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

package/dist/src/highlight/css/highlightRenderer.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { DrawingStyle } from '@annotorious/core';
+import type { TextAnnotation } from '../../model';
+import type { HighlightPainter } from '../HighlightPainter';
+import type { AnnotationRects } from 'src/state';
+import type { ViewportBounds } from '../viewport';
+export declare const createHighlights: () => {
+    destroy: () => void;
+    refresh: (highlights: AnnotationRects[], viewportBounds: ViewportBounds, selected: string[], currentStyle: DrawingStyle | ((annotation: TextAnnotation, selected: boolean) => DrawingStyle)) => void;
+    setPainter: (painter: HighlightPainter) => HighlightPainter;
+};

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

@@ -0,0 +1,2 @@
+export * from './highlightRenderer';
+export * from '../../presence/presencePainter';

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

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

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

@@ -0,0 +1,12 @@
+import type { ViewportState } from '@annotorious/core';
+import type { TextAnnotation } from '../model';
+export interface ViewportBounds {
+    top: number;
+    left: number;
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+}
+export declare const getViewportBounds: (container: HTMLElement) => ViewportBounds;
+export declare const trackViewport: (viewport: ViewportState) => (annotations: TextAnnotation[]) => void;

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from './highlight';
 export * from './model';
 export * from './state';
+export * from './utils';
 export * from './presence/PresencePainterOptions';
 export * from './TextAnnotator';
 export * from './TextAnnotatorOptions';

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

@@ -3,7 +3,7 @@ export interface TextAnnotation extends Annotation {
     target: TextAnnotationTarget;
 }
 export interface TextAnnotationTarget extends AnnotationTarget {
-    selector: TextSelector;
+    selector: TextSelector[];
 }
 export interface TextSelector {
     quote: string;

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

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

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

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

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

@@ -0,0 +1,33 @@
+import type { W3CAnnotation, W3CAnnotationTarget } from '@annotorious/core';
+export interface W3CTextAnnotation extends W3CAnnotation {
+    target: W3CTextAnnotationTarget | W3CTextAnnotationTarget[];
+    stylesheet?: W3CAnnotationStylesheet;
+}
+export interface W3CTextAnnotationTarget extends W3CAnnotationTarget {
+    selector: W3CTextSelector | W3CTextSelector[];
+    styleClass?: string;
+}
+/**
+ * Matches the `Text Quote Selector` spec
+ * @see https://www.w3.org/TR/annotation-model/#text-quote-selector
+ */
+export interface W3CTextQuoteSelector {
+    type: 'TextQuoteSelector';
+    exact: string;
+    prefix?: string;
+    suffix?: string;
+}
+/**
+ * Matches the `Text Position Selector` spec
+ * @see https://www.w3.org/TR/annotation-model/#text-position-selector
+ */
+export interface W3CTextPositionSelector {
+    type: 'TextPositionSelector';
+    start: number;
+    end: number;
+}
+export type W3CTextSelector = W3CTextQuoteSelector | W3CTextPositionSelector;
+export type W3CAnnotationStylesheet = string | {
+    type: 'CssStylesheet';
+    value: string;
+};

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

@@ -0,0 +1,12 @@
+import { type FormatAdapter, ParseResult } from '@annotorious/core';
+import type { TextAnnotation } from '../core';
+import type { W3CTextAnnotation } from '../w3c';
+export type W3CTextFormatAdapter = FormatAdapter<TextAnnotation, W3CTextAnnotation>;
+/**
+ * @param source - the IRI of the annotated content
+ * @param container - the HTML container of the annotated content,
+ *                    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 serializeW3CTextAnnotation: (annotation: TextAnnotation, source: string, container: HTMLElement) => W3CTextAnnotation;

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

@@ -0,0 +1,2 @@
+export * from './W3CTextAnnotation';
+export * from './W3CTextFormatAdapter';

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+export declare const debounce: <T extends (...args: any[]) => void>(func: T, delay?: number) => T;

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

@@ -0,0 +1,5 @@
+/**
+ * Returns a DocumentFragment consisting of ONLY the annotatable content
+ * in the given DOM Range.
+ */
+export declare const getAnnotatableFragment: (range: Range) => DocumentFragment;

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

@@ -0,0 +1,4 @@
+export declare const getQuoteContext: (range: Range, container: HTMLElement, length?: number, offsetReferenceSelector?: string) => {
+    prefix: string;
+    suffix: string;
+};

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

@@ -1,3 +1,12 @@
+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/src/utils/isRevived.d.ts

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+import type { TextSelector } from '../model';
+export declare const reviveSelector: (selector: TextSelector, container: HTMLElement) => TextSelector;

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

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

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

@@ -0,0 +1,6 @@
+export declare const NOT_ANNTOTATABLE_SELECTOR = ".not-annotatable";
+/**
+ * Splits a DOM Range into one or more ranges that span annotatable content only.
+ */
+export declare const splitAnnotatableRanges: (range: Range) => Range[];
+export declare const getRangeAnnotatableContents: (range: Range) => DocumentFragment;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,3 @@
+import type { 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}.r6o-annotatable.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{-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}