@recogito/text-annotator 3.4.10 → 4.0.0

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

@@ -0,0 +1,4 @@
+export * from './get-quote-context';
+export * from './range-to-selector';
+export * from './revive-annotation';
+export * from './scroll-into-view';

package/dist/utils/{rangeToSelector.d.ts → annotation/range-to-selector.d.ts}

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

package/dist/utils/{reviveSelector.d.ts → annotation/revive-annotation.d.ts}

@@ -1,4 +1,5 @@
-import type { TextSelector } from '../model';
+import type { TextAnnotation, TextAnnotationTarget, TextSelector } from '../../model';
+export declare const isRevived: (selector: TextSelector[]) => boolean;
 /**
  * Creates a new selector object with the revived DOM range from the given text annotation position
  * Only the annotatable elements are processed and counted towards the range
@@ -9,3 +10,5 @@ import type { TextSelector } from '../model';
  * @returns the revived selector
  */
 export declare const reviveSelector: <T extends TextSelector>(selector: T, container: HTMLElement) => T;
+export declare const reviveTarget: <T extends TextAnnotationTarget = TextAnnotationTarget>(target: T, container: HTMLElement) => T;
+export declare const reviveAnnotation: <T extends TextAnnotation>(annotation: T, container: HTMLElement) => T;

package/dist/{api/scrollIntoView.d.ts → utils/annotation/scroll-into-view.d.ts}

@@ -1,3 +1,3 @@
-import type { TextAnnotationStore } from '../state';
-import type { TextAnnotation } from '../model';
+import type { TextAnnotationStore } from '../../state';
+import type { TextAnnotation } from '../../model';
 export declare const scrollIntoView: <I extends TextAnnotation = TextAnnotation>(container: HTMLElement, store: TextAnnotationStore<I>) => <E extends Element = Element>(annotationOrId: string | I, scrollParentOrId?: string | E) => boolean;

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

@@ -0,0 +1,7 @@
+export * from './device';
+export * from './is-not-annotatable';
+export * from './is-whitespace-or-empty';
+export * from './merge-ranges';
+export * from './programmatically-focusable';
+export * from './split-annotatable-ranges';
+export * from './trim-range-to-container';

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

@@ -0,0 +1,3 @@
+export * from './cancel-single-click-events';
+export * from './clone-events';
+export * from './debounce';

package/dist/utils/highlight/compute-z-index.d.ts

@@ -0,0 +1,3 @@
+import type { Highlight } from '../../rendering';
+import type { Rect } from '../../state';
+export declare const computeZIndex: (rect: Rect, all: Highlight[]) => number;

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

@@ -0,0 +1,4 @@
+export * from './compute-z-index';
+export * from './get-highlight-client-rects';
+export * from './merge-client-rects';
+export * from './rects-to-bounds';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@recogito/text-annotator",
-  "version": "3.4.10",
+  "version": "4.0.0",
   "description": "A JavaScript text annotation library",
   "author": "Rainer Simon",
   "license": "BSD-3-Clause",
@@ -35,11 +35,11 @@
     "vitest": "^4.1.5"
   },
   "dependencies": {
-    "@annotorious/core": "^3.8.1",
+    "@annotorious/core": "^3.8.2",
     "colord": "^2.9.3",
     "debounce": "^3.0.0",
     "dequal": "^2.0.3",
-    "hotkeys-js": "^3.13.15",
+    "hotkeys-js": "^4.0.4",
     "poll": "^3.2.2",
     "nanoevents": "^9.1.0",
     "rbush": "^4.0.1",

package/dist/SelectionHandler.d.ts

@@ -1,12 +0,0 @@
-import type { Filter, Lifecycle, User } from '@annotorious/core';
-import type { TextAnnotatorState } from './state';
-import type { TextAnnotation } from './model';
-import type { AnnotatingMode } from './TextAnnotator';
-import type { TextAnnotatorOptions } from './TextAnnotatorOptions';
-export declare const createSelectionHandler: (container: HTMLElement, state: TextAnnotatorState<TextAnnotation, unknown>, lifecycle: Lifecycle<TextAnnotation, unknown>, options: TextAnnotatorOptions<TextAnnotation, unknown>) => {
-    destroy: () => void;
-    setFilter: (filter?: Filter) => Filter;
-    setUser: (user?: User) => User;
-    setAnnotatingEnabled: (enabled: boolean) => void;
-    setAnnotatingMode: (mode?: AnnotatingMode) => AnnotatingMode;
-};

package/dist/api/index.d.ts

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

package/dist/highlight/HighlightPainter.d.ts

@@ -1,11 +0,0 @@
-import type { Highlight } from './Highlight';
-import type { HighlightStyle, HighlightStyleExpression } from './HighlightStyle';
-import type { ViewportBounds } from './viewport';
-export interface HighlightPainter {
-    clear(): void;
-    destroy(): void;
-    paint(highlight: Highlight, viewportBounds: ViewportBounds): HighlightStyle;
-    reset(): void;
-}
-/** Helper **/
-export declare const paint: (highlight: Highlight, viewportBounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, zIndex?: number) => HighlightStyle;

package/dist/highlight/Renderer.d.ts

@@ -1,22 +0,0 @@
-import { type Filter, type ViewportState } from '@annotorious/core';
-import type { TextAnnotation } from '../model';
-import type { TextAnnotatorState } from '../state';
-import { type ViewportBounds } from './viewport';
-import type { HighlightPainter } from './HighlightPainter';
-import type { Highlight } from './Highlight';
-import type { HighlightStyleExpression } from './HighlightStyle';
-export type RendererFactory = (container: HTMLElement, state: TextAnnotatorState<TextAnnotation, unknown>, viewport: ViewportState) => Renderer;
-export interface RendererImplementation {
-    destroy(): void;
-    redraw(highlights: Highlight[], bounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, lazy?: boolean): void;
-    setVisible(visible: boolean): void;
-}
-export interface Renderer {
-    destroy(): void;
-    redraw(force?: boolean): void;
-    setStyle(style?: HighlightStyleExpression): void;
-    setFilter(filter?: Filter): void;
-    setPainter(painter?: HighlightPainter): void;
-    setVisible(visible: boolean): void;
-}
-export declare const createBaseRenderer: <T extends TextAnnotatorState = TextAnnotatorState>(container: HTMLElement, state: T, viewport: ViewportState, renderer: RendererImplementation) => Renderer;

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

@@ -1,5 +0,0 @@
-import type { ViewportState } from '@annotorious/core';
-import type { TextAnnotatorState } from '../../state';
-import type { TextAnnotation } from 'src/model';
-import './canvasRenderer.css';
-export declare const createCanvasRenderer: (container: HTMLElement, state: TextAnnotatorState<TextAnnotation, unknown>, viewport: ViewportState) => import("..").Renderer;

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

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

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

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

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

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

package/dist/highlight/index.d.ts

@@ -1,8 +0,0 @@
-export * from './canvas';
-export * from './highlights';
-export * from './span';
-export * from './Highlight';
-export * from './HighlightPainter';
-export * from './HighlightStyle';
-export * from './Renderer';
-export * from './viewport';

package/dist/highlight/span/color.d.ts

@@ -1,2 +0,0 @@
-import { type HighlightStyle } from '../HighlightStyle';
-export declare const getBackgroundColor: (style?: HighlightStyle) => string;

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

@@ -1,2 +0,0 @@
-export * from './color';
-export * from './spansRenderer';

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

@@ -1,3 +0,0 @@
-import { type RendererFactory } from '../Renderer';
-import './spansRenderer.css';
-export declare const createSpansRenderer: RendererFactory;

package/dist/presence/PresencePainter.d.ts

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

package/dist/presence/PresencePainterOptions.d.ts

@@ -1,3 +0,0 @@
-export interface PresencePainterOptions {
-    font?: string;
-}

package/dist/presence/index.d.ts

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

package/dist/utils/index.d.ts

@@ -1,19 +0,0 @@
-export * from './cancelSingleClickEvents';
-export * from './cloneEvents';
-export * from './debounce';
-export * from './device';
-export * from './programmaticallyFocusable';
-export * from './getHighlightClientRects';
-export * from './getQuoteContext';
-export * from './isNotAnnotatable';
-export * from './isRevived';
-export * from './isWhitespaceOrEmpty';
-export * from './mergeClientRects';
-export * from './mergeRanges';
-export * from './rangeToSelector';
-export * from './rectsToBounds';
-export * from './reviveAnnotation';
-export * from './reviveSelector';
-export * from './reviveTarget';
-export * from './splitAnnotatableRanges';
-export * from './trimRangeToContainer';

package/dist/utils/isRevived.d.ts

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

package/dist/utils/reviveAnnotation.d.ts

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

package/dist/utils/reviveTarget.d.ts

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