@soomo/text-annotator 3.0.0-staging.4 → 3.0.0-staging.40

package/dist/src/SelectionHandler.d.ts

@@ -1,7 +1,9 @@
+import { Filter, User } from '@annotorious/core';
 import { TextAnnotatorState } from './state';
-import { User } from '@annotorious/core';
 
-export declare const SelectionHandler: (container: HTMLElement, state: TextAnnotatorState, offsetReferenceSelector?: string) => {
+export declare const createSelectionHandler: (container: HTMLElement, state: TextAnnotatorState, offsetReferenceSelector?: string) => {
     destroy: () => void;
-    setUser: (user: User) => User;
+    setFilter: (filter?: Filter) => Filter;
+    setUser: (user?: User) => User;
+    setAnnotatingEnabled: (enabled: boolean) => boolean;
 };

package/dist/src/TextAnnotator.d.ts

@@ -1,13 +1,15 @@
-import { TextAnnotatorOptions } from './TextAnnotatorOptions';
-import { TextAnnotation } from './model';
-import { TextAnnotatorState } from './state';
-import { HighlightStyleExpression } from './highlight';
 import { Annotator } from '@annotorious/core';
+import { HighlightStyleExpression } from './highlight';
+import { TextAnnotatorState } from './state';
+import { TextAnnotation } from './model';
+import { TextAnnotatorOptions } from './TextAnnotatorOptions';
 
 export interface TextAnnotator<E extends unknown = TextAnnotation> extends Annotator<TextAnnotation, E> {
     element: HTMLElement;
     setStyle(style: HighlightStyleExpression | undefined): void;
+    redraw(force?: boolean): void;
     scrollIntoView(annotation: TextAnnotation): boolean;
+    setAnnotatingEnabled: (enabled: boolean) => void;
     state: TextAnnotatorState;
 }
-export declare const createTextAnnotator: <E extends unknown = TextAnnotation>(container: HTMLElement, opts?: TextAnnotatorOptions<E>) => TextAnnotator<E>;
+export declare const createTextAnnotator: <E extends unknown = TextAnnotation>(container: HTMLElement, options?: TextAnnotatorOptions<E>) => TextAnnotator<E>;

package/dist/src/TextAnnotatorOptions.d.ts

@@ -1,14 +1,17 @@
-import { HighlightStyleExpression } from './highlight';
-import { TextAnnotation } from './model';
+import { FormatAdapter, UserSelectActionExpression, User } from '@annotorious/core';
 import { PresencePainterOptions } from './presence';
-import { FormatAdapter, PointerSelectAction } from '@annotorious/core';
+import { TextAnnotation } from './model';
+import { HighlightStyleExpression } from './highlight';
 
 export interface TextAnnotatorOptions<T extends unknown = TextAnnotation> {
     adapter?: FormatAdapter<TextAnnotation, T> | null;
+    annotatingEnabled?: boolean;
     renderer?: RendererType;
     offsetReferenceSelector?: string;
-    pointerAction?: PointerSelectAction | ((annotation: TextAnnotation) => PointerSelectAction);
+    userSelectAction?: UserSelectActionExpression<TextAnnotation>;
     presence?: PresencePainterOptions;
     style?: HighlightStyleExpression;
+    user?: User;
 }
 export type RendererType = 'SPANS' | 'CANVAS' | 'CSS_HIGHLIGHTS';
+export declare const fillDefaults: <T extends unknown = TextAnnotation>(opts: TextAnnotatorOptions<T>, defaults: TextAnnotatorOptions<T>) => TextAnnotatorOptions<T>;

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

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

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

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

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

@@ -1,6 +1,6 @@
-import { ViewportBounds } from './viewport';
-import { HighlightStyle, HighlightStyleExpression } from './HighlightStyle';
 import { Highlight } from './Highlight';
+import { HighlightStyle, HighlightStyleExpression } from './HighlightStyle';
+import { ViewportBounds } from './viewport';
 
 export interface HighlightPainter {
     clear(): void;

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

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

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

@@ -1,9 +1,9 @@
-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';
+import { TextAnnotatorState } from '../state';
+import { ViewportBounds } from './viewport';
+import { HighlightPainter } from './HighlightPainter';
+import { Highlight } from './Highlight';
+import { HighlightStyleExpression } from './HighlightStyle';
 
 export interface RendererImplementation {
     destroy(): void;

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

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

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

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

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

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

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

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

package/dist/src/index.d.ts

@@ -1,4 +1,3 @@
-import { Origin as _Origin } from '@annotorious/core';
 export * from './highlight';
 export * from './model';
 export * from './state';
@@ -6,5 +5,5 @@ export * from './utils';
 export * from './presence/PresencePainterOptions';
 export * from './TextAnnotator';
 export * from './TextAnnotatorOptions';
-export type { Filter } from '@annotorious/core';
-export { _Origin as Origin };
+export type { Annotation, AnnotationBody, AnnotationTarget, Annotator, AnnotatorState, Color, Filter, FormatAdapter, HoverState, Selection, SelectionState, Store, StoreChangeEvent, StoreObserver, ParseResult, User, UserSelectActionExpression, W3CAnnotation, W3CAnnotationBody, W3CAnnotationTarget } from '@annotorious/core';
+export { createBody, Origin, UserSelectAction } from '@annotorious/core';

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

@@ -1,6 +1,6 @@
-import { W3CTextAnnotation } from '../w3c';
-import { TextAnnotation } from '../core';
 import { FormatAdapter, ParseResult } from '@annotorious/core';
+import { TextAnnotation } from '../core';
+import { W3CTextAnnotation } from '../w3c';
 
 export type W3CTextFormatAdapter = FormatAdapter<TextAnnotation, W3CTextAnnotation>;
 /**

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

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

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

@@ -1,14 +1,18 @@
+import { Unsubscribe } from 'nanoevents';
+import { Filter, Origin, Store } from '@annotorious/core';
 import { TextAnnotation } from '../model';
-import { Origin, Store } from '@annotorious/core';
+import { SpatialTreeEvents } from './spatialTree';
 
 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[];
-    getAnnotationBounds(id: string, hintX?: number, hintY?: number, buffer?: number): DOMRect;
-    getAt(x: number, y: number): TextAnnotation | undefined;
+    getAnnotationRects(id: string): DOMRect[];
+    getAnnotationBounds(id: string, hintX?: number, hintY?: number, buffer?: number): DOMRect | undefined;
+    getAt(x: number, y: number, filter?: Filter): TextAnnotation | undefined;
     getIntersecting(minX: number, minY: number, maxX: number, maxY: number): AnnotationRects[];
     recalculatePositions(): void;
+    onRecalculatePositions(callback: SpatialTreeEvents['recalculate']): Unsubscribe;
 }
 export interface AnnotationRects {
     annotation: TextAnnotation;

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

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

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

@@ -1,6 +1,7 @@
-import { AnnotationRects } from './TextAnnotationStore';
-import { TextAnnotation, TextAnnotationTarget } from '../model';
 import { Store } from '@annotorious/core';
+import { Unsubscribe } from 'nanoevents';
+import { TextAnnotation, TextAnnotationTarget } from '../model';
+import { AnnotationRects } from './TextAnnotationStore';
 
 interface IndexedHighlightRect {
     minX: number;
@@ -12,10 +13,13 @@ interface IndexedHighlightRect {
         rects: DOMRect[];
     };
 }
+export interface SpatialTreeEvents {
+    recalculate(): void;
+}
 export declare const createSpatialTree: (store: Store<TextAnnotation>, container: HTMLElement) => {
     all: () => IndexedHighlightRect[][];
     clear: () => void;
-    getAt: (x: number, y: number) => string | undefined;
+    getAt: (x: number, y: number, all?: boolean) => string[];
     getAnnotationBounds: (id: string) => DOMRect;
     getAnnotationRects: (id: string) => DOMRect[];
     getIntersecting: (minX: number, minY: number, maxX: number, maxY: number) => AnnotationRects[];
@@ -25,5 +29,6 @@ export declare const createSpatialTree: (store: Store<TextAnnotation>, container
     set: (targets: TextAnnotationTarget[], replace?: boolean) => void;
     size: () => number;
     update: (target: TextAnnotationTarget) => void;
+    on: <E extends keyof SpatialTreeEvents>(event: E, callback: SpatialTreeEvents[E]) => Unsubscribe;
 };
 export {};

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

@@ -0,0 +1,6 @@
+/**
+ * Calls .preventDefault() on click events in annotable areas, in order
+ * to prevent problematic default browser behavior. (Specifically: keep
+ * Chrome Android from triggering word selection on single click.)
+ */
+export declare const cancelSingleClickEvents: (container: HTMLElement) => void;

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

@@ -0,0 +1,11 @@
+/**
+ * Events need to be manually mapped into new objects:
+ * 1. It preserves the `target` and `currentTarget` properties.
+ *    Otherwise, they will be `null` when the event is read beyond the handler.
+ * 2. Spread operator can copy only own enumerable properties, not inherited ones.
+ *    Therefore, we need to manually copy the props we're interested in.
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Event/currentTarget
+ * @see https://github.com/recogito/text-annotator-js/commit/65d13f3108c429311cf8c2523f6babbbc946013d#r144041390
+ */
+export declare const clonePointerEvent: (event: PointerEvent) => PointerEvent;
+export declare const cloneKeyboardEvent: (event: KeyboardEvent) => KeyboardEvent;

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

@@ -1,3 +1,5 @@
+export * from './cancelSingleClickEvents';
+export * from './programmaticallyFocusable';
 export * from './debounce';
 export * from './getAnnotatableFragment';
 export * from './getClientRectsPonyfill';
@@ -10,3 +12,6 @@ export * from './reviveAnnotation';
 export * from './reviveSelector';
 export * from './reviveTarget';
 export * from './splitAnnotatableRanges';
+export * from './trimRangeToContainer';
+export * from './normalizeRects';
+export * from './cloneEvents';

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

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

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

@@ -0,0 +1,2 @@
+export declare const normalizeRectWithOffset: (rect: DOMRect, offset: DOMRect) => DOMRect;
+export declare const denormalizeRectWithOffset: (rect: DOMRect, offset: DOMRect) => DOMRect;

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

@@ -0,0 +1,6 @@
+/**
+ * Makes an element programmatically focusable by adding a `tabindex="-1"` attribute.
+ * Or does nothing if the element is already focusable 🤷🏻
+ * It's required to process keyboard events on an element that is not natively focusable.
+ */
+export declare const programmaticallyFocusable: (container: HTMLElement) => void;

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

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

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}
+.r6o-canvas-highlight-layer{position:fixed;top:0;bottom:0;left:0;width:100vw;height:100vh;pointer-events:none}.r6o-canvas-highlight-layer.bg{mix-blend-mode:multiply;z-index:1}.r6o-annotatable .r6o-span-highlight-layer{position:absolute;top:0;left:0;width:100%;height:100%;mix-blend-mode:multiply;pointer-events:none;z-index:1}.r6o-annotatable .r6o-span-highlight-layer.hidden{display:none}.r6o-annotatable .r6o-span-highlight-layer .r6o-annotation{border-style:solid;border-width:0;box-sizing:content-box;display:block;position:absolute}.r6o-annotation{box-sizing:content-box}.r6o-presence-layer{left:0;position:fixed;top:0;bottom:0;width:100vw;pointer-events:none}html,body{overscroll-behavior-y:none}.r6o-annotatable{position:relative;-webkit-tap-highlight-color:transparent}.r6o-annotatable.no-focus-outline{outline:none}.hovered *{cursor:pointer}*::selection,::selection{background:#0080ff2e}::-moz-selection{background:#0080ff2e}