@soomo/text-annotator 3.0.0-staging.2 → 3.0.0-staging.20

package/dist/src/SelectionHandler.d.ts

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

package/dist/src/TextAnnotator.d.ts

@@ -1,11 +1,14 @@
-import { TextAnnotatorOptions } from './TextAnnotatorOptions';
-import { TextAnnotation } from './model';
-import { TextAnnotatorState } from './state';
 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;
     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, PointerSelectAction, 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;
+    annotationEnabled?: boolean;
     renderer?: RendererType;
     offsetReferenceSelector?: string;
     pointerAction?: PointerSelectAction | ((annotation: TextAnnotation) => PointerSelectAction);
     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,13 +1,13 @@
-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;
-    redraw(highlights: Highlight[], bounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, force?: boolean): void;
+    redraw(highlights: Highlight[], bounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, lazy?: boolean): void;
     setVisible(visible: boolean): void;
 }
 export interface Renderer {

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

@@ -1,4 +1,4 @@
-import { ViewportState } from '@annotorious/core';
 import { TextAnnotatorState } from 'src/state';
+import { ViewportState } from '@annotorious/core';
 
 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, W3CAnnotation, W3CAnnotationBody, W3CAnnotationTarget } from '@annotorious/core';
+export { createBody, Origin, PointerSelectAction } 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 'src/presence';
 
 export declare const createPresencePainter: (container: HTMLElement, provider: PresenceProvider, opts?: PresencePainterOptions) => HighlightPainter;

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

@@ -1,5 +1,5 @@
-import { TextAnnotation } from '../model';
 import { Origin, Store } from '@annotorious/core';
+import { TextAnnotation } from '../model';
 
 export interface TextAnnotationStore extends Omit<Store<TextAnnotation>, 'addAnnotation' | 'bulkAddAnnotation'> {
     addAnnotation(annotation: TextAnnotation, origin?: Origin): boolean;

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

@@ -1,6 +1,6 @@
-import { TextAnnotationStore } from './TextAnnotationStore';
-import { TextAnnotation } from '../model';
 import { PointerSelectAction, ViewportState, AnnotatorState, SelectionState, HoverState } from '@annotorious/core';
+import { TextAnnotation } from '../model';
+import { TextAnnotationStore } from './TextAnnotationStore';
 
 export interface TextAnnotatorState extends AnnotatorState<TextAnnotation> {
     store: TextAnnotationStore;

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

@@ -1,6 +1,6 @@
-import { AnnotationRects } from './TextAnnotationStore';
-import { TextAnnotation, TextAnnotationTarget } from '../model';
 import { Store } from '@annotorious/core';
+import { TextAnnotation, TextAnnotationTarget } from '../model';
+import { AnnotationRects } from './TextAnnotationStore';
 
 interface IndexedHighlightRect {
     minX: number;

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/index.d.ts

@@ -1,3 +1,4 @@
+export * from './cancelSingleClickEvents';
 export * from './debounce';
 export * from './getAnnotatableFragment';
 export * from './getClientRectsPonyfill';

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

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