@soomo/text-annotator 3.0.0-staging.30 → 3.0.0-staging.32

package/dist/src/SelectionHandler.d.ts

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

package/dist/src/TextAnnotatorOptions.d.ts

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

package/dist/src/index.d.ts

@@ -5,5 +5,5 @@ export * from './utils';
 export * from './presence/PresencePainterOptions';
 export * from './TextAnnotator';
 export * from './TextAnnotatorOptions';
-export type { Annotation, AnnotationBody, AnnotationTarget, Annotator, AnnotatorState, Color, Filter, FormatAdapter, HoverState, Selection, SelectionState, Store, StoreChangeEvent, StoreObserver, ParseResult, User, W3CAnnotation, W3CAnnotationBody, W3CAnnotationTarget } from '@annotorious/core';
-export { createBody, Origin, PointerSelectAction } from '@annotorious/core';
+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/state/TextAnnotationStore.d.ts

@@ -5,7 +5,8 @@ export interface TextAnnotationStore extends Omit<Store<TextAnnotation>, 'addAnn
     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;
+    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;

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

@@ -1,4 +1,4 @@
-import { PointerSelectAction, ViewportState, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
+import { ViewportState, UserSelectActionExpression, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
 import { TextAnnotation } from '../model';
 import { TextAnnotationStore } from './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, defaultUserAction?: UserSelectActionExpression<TextAnnotation>) => TextAnnotatorState;

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,4 +1,5 @@
 export * from './cancelSingleClickEvents';
+export * from './programmaticallyFocusable';
 export * from './debounce';
 export * from './getAnnotatableFragment';
 export * from './getClientRectsPonyfill';
@@ -11,3 +12,5 @@ export * from './reviveAnnotation';
 export * from './reviveSelector';
 export * from './reviveTarget';
 export * from './splitAnnotatableRanges';
+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/text-annotator.css

@@ -1 +1 @@
-.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%;pointer-events:none}.r6o-annotatable .r6o-span-highlight-layer.hidden{display:none}.r6o-annotatable .r6o-span-highlight-layer .r6o-annotation{position:absolute;display:block;border-width:0;border-style:solid}.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}.hovered *{cursor:pointer}*::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{height:100%;left:0;mix-blend-mode:multiply;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;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}