@soomo/text-annotator 3.1.0-staging.9 → 3.2.0-staging.1

package/dist/src/SelectionHandler.d.ts

@@ -1,7 +1,8 @@
 import { Filter, User } from '@annotorious/core';
 import { TextAnnotatorState } from './state';
 import { TextAnnotation } from './model';
-export declare const createSelectionHandler: (container: HTMLElement, state: TextAnnotatorState<TextAnnotation, unknown>, offsetReferenceSelector?: string) => {
+import { TextAnnotatorOptions } from './TextAnnotatorOptions';
+export declare const createSelectionHandler: (container: HTMLElement, state: TextAnnotatorState<TextAnnotation, unknown>, options: TextAnnotatorOptions<TextAnnotation, unknown>) => {
     destroy: () => void;
     setFilter: (filter?: Filter) => Filter;
     setUser: (user?: User) => User;

package/dist/src/TextAnnotator.d.ts

@@ -11,4 +11,4 @@ export interface TextAnnotator<I extends TextAnnotation = TextAnnotation, E exte
     setAnnotatingEnabled: (enabled: boolean) => void;
     state: TextAnnotatorState<I, E>;
 }
-export declare const createTextAnnotator: <E extends unknown = TextAnnotation>(container: HTMLElement, options?: TextAnnotatorOptions<TextAnnotation, E>) => TextAnnotator<TextAnnotation, E>;
+export declare const createTextAnnotator: <I extends TextAnnotation = TextAnnotation, E extends unknown = TextAnnotation>(container: HTMLElement, options?: TextAnnotatorOptions<I, E>) => TextAnnotator<I, E>;

package/dist/src/TextAnnotatorOptions.d.ts

@@ -9,6 +9,7 @@ export interface TextAnnotatorOptions<I extends TextAnnotation = TextAnnotation,
     offsetReferenceSelector?: string;
     userSelectAction?: UserSelectActionExpression<E>;
     presence?: PresencePainterOptions;
+    selectionMode?: 'shortest' | 'all';
     style?: HighlightStyleExpression;
     user?: User;
 }

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

@@ -6,6 +6,6 @@ export interface HighlightStyle extends Pick<DrawingStyle, 'fill' | 'fillOpacity
     underlineOffset?: number;
     underlineThickness?: number;
 }
-export type HighlightStyleExpression = HighlightStyle | ((annotation: TextAnnotation, state: AnnotationState, zIndex?: number) => HighlightStyle | undefined);
+export type HighlightStyleExpression = HighlightStyle | (<I extends TextAnnotation = TextAnnotation>(annotation: I, 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

@@ -17,4 +17,4 @@ export interface Renderer {
     setPainter(painter?: HighlightPainter): void;
     setVisible(visible: boolean): void;
 }
-export declare const createBaseRenderer: <T extends TextAnnotatorState = TextAnnotatorState<import('..').TextAnnotation, import('..').TextAnnotation>>(container: HTMLElement, state: T, viewport: ViewportState, renderer: RendererImplementation) => Renderer;
+export declare const createBaseRenderer: <T extends TextAnnotatorState = TextAnnotatorState>(container: HTMLElement, state: T, viewport: ViewportState, renderer: RendererImplementation) => Renderer;

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

@@ -4,7 +4,6 @@ export interface TextAnnotation extends Annotation {
 }
 export interface TextAnnotationTarget extends AnnotationTarget {
     selector: TextSelector[];
-    styleClass?: string;
 }
 export interface TextSelector {
     id?: string;

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

@@ -5,7 +5,9 @@ export interface W3CTextAnnotation extends W3CAnnotation {
 }
 export interface W3CTextAnnotationTarget extends W3CAnnotationTarget {
     selector: W3CTextSelector | W3CTextSelector[];
+    outdated?: boolean;
     styleClass?: string;
+    scope?: string;
 }
 /**
  * Matches the `Text Quote Selector` spec

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

@@ -1,12 +1,12 @@
 import { FormatAdapter, ParseResult } from '@annotorious/core';
 import { TextAnnotation } from '../core';
 import { W3CTextAnnotation } from '../w3c';
-export type W3CTextFormatAdapter = FormatAdapter<TextAnnotation, W3CTextAnnotation>;
+export type W3CTextFormatAdapter<I extends TextAnnotation = TextAnnotation, E extends W3CTextAnnotation = W3CTextAnnotation> = FormatAdapter<I, E>;
 /**
  * @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) => ParseResult<TextAnnotation>;
-export declare const serializeW3CTextAnnotation: (annotation: TextAnnotation, source: string, container: HTMLElement) => W3CTextAnnotation;
+export declare const W3CTextFormat: <I extends TextAnnotation = TextAnnotation, E extends W3CTextAnnotation = W3CTextAnnotation>(source: string, container?: HTMLElement) => W3CTextFormatAdapter<I, E>;
+export declare const parseW3CTextAnnotation: <I extends TextAnnotation = TextAnnotation, E extends W3CTextAnnotation = W3CTextAnnotation>(annotation: E) => ParseResult<I>;
+export declare const serializeW3CTextAnnotation: <I extends TextAnnotation = TextAnnotation, E extends W3CTextAnnotation = W3CTextAnnotation>(annotation: I, source: string, container?: HTMLElement) => E;

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

@@ -4,12 +4,14 @@ import { TextAnnotation } from '../model';
 import { SpatialTreeEvents } from './spatialTree';
 export interface TextAnnotationStore<T extends TextAnnotation = TextAnnotation> extends Omit<Store<T>, 'addAnnotation' | 'bulkAddAnnotation'> {
     addAnnotation(annotation: T, origin?: Origin): boolean;
-    bulkAddAnnotation(annotations: T[], replace: boolean, origin?: Origin): T[];
+    bulkAddAnnotations(annotations: T[], replace: boolean, origin?: Origin): T[];
     bulkUpsertAnnotations(annotations: T[], origin?: Origin): T[];
     getAnnotationRects(id: string): DOMRect[];
-    getAnnotationBounds(id: string, hintX?: number, hintY?: number, buffer?: number): DOMRect | undefined;
+    getAnnotationBounds(id: string): DOMRect | undefined;
     getAnnotationRects(id: string): DOMRect[];
-    getAt(x: number, y: number, filter?: Filter): T | undefined;
+    getAt(x: number, y: number, all: true, filter?: Filter): T[] | undefined;
+    getAt(x: number, y: number, all: false, filter?: Filter): T | undefined;
+    getAt(x: number, y: number, all?: boolean, filter?: Filter): T | T[] | undefined;
     getIntersecting(minX: number, minY: number, maxX: number, maxY: number): AnnotationRects<T>[];
     recalculatePositions(): void;
     onRecalculatePositions(callback: SpatialTreeEvents['recalculate']): Unsubscribe;

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

@@ -1,10 +1,11 @@
-import { ViewportState, UserSelectActionExpression, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
+import { ViewportState, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
 import { TextAnnotation } from '../model';
 import { TextAnnotationStore } from './TextAnnotationStore';
+import { TextAnnotatorOptions } from '../TextAnnotatorOptions';
 export interface TextAnnotatorState<I extends TextAnnotation = TextAnnotation, E extends unknown = TextAnnotation> extends AnnotatorState<I, E> {
     store: TextAnnotationStore<I>;
     selection: SelectionState<I, E>;
     hover: HoverState<I>;
     viewport: ViewportState;
 }
-export declare const createTextAnnotatorState: <I extends TextAnnotation = TextAnnotation, E extends unknown = TextAnnotation>(container: HTMLElement, defaultUserSelectAction?: UserSelectActionExpression<E>) => TextAnnotatorState<I, E>;
+export declare const createTextAnnotatorState: <I extends TextAnnotation = TextAnnotation, E extends unknown = TextAnnotation>(container: HTMLElement, opts: TextAnnotatorOptions<I, E>) => TextAnnotatorState<I, E>;

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

@@ -2,8 +2,9 @@ export * from './cancelSingleClickEvents';
 export * from './device';
 export * from './programmaticallyFocusable';
 export * from './getQuoteContext';
-export * from './isWhitespaceOrEmpty';
+export * from './isNotAnnotatable';
 export * from './isRevived';
+export * from './isWhitespaceOrEmpty';
 export * from './mergeClientRects';
 export * from './rangeToSelector';
 export * from './reviveAnnotation';
@@ -13,4 +14,4 @@ export * from './splitAnnotatableRanges';
 export * from './trimRangeToContainer';
 export * from './cloneEvents';
 export * from './rangeContains';
-export * from './normalizeRects';
+export * from './rectsToBounds';

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

@@ -0,0 +1,4 @@
+export declare const NOT_ANNOTATABLE_CLASS = "not-annotatable";
+export declare const NOT_ANNOTATABLE_SELECTOR = ".not-annotatable";
+export declare const isNotAnnotatable: (node: Node) => boolean;
+export declare const isRangeAnnotatable: (range: Range) => boolean;

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

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

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

@@ -1,7 +1,3 @@
-export declare const NOT_ANNOTATABLE_CLASS = "not-annotatable";
-export declare const NOT_ANNOTATABLE_SELECTOR = ".not-annotatable";
-export declare const isNotAnnotatable: (node: Node) => boolean;
-export declare const isRangeAnnotatable: (range: Range) => boolean;
 /**
  * Splits a DOM Range into one or more ranges that span annotatable content only.
  */