@soomo/text-annotator 3.4.14-staging.0 → 4.1.0-staging.0

package/dist/utils/annotation/get-quote-context.d.ts

@@ -0,0 +1,4 @@
+export declare const getQuoteContext: (range: Range, container: HTMLElement, length?: number, offsetReferenceSelector?: string) => {
+    prefix: string;
+    suffix: string;
+};

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/annotation/range-to-selector.d.ts

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

package/dist/utils/annotation/revive-annotation.d.ts

@@ -0,0 +1,14 @@
+import type { TextAnnotation, TextAnnotationTarget, TextSelector, TextSelectorLike } from '../../model';
+export declare const isRevived: (selector: TextSelectorLike[]) => 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
+ *
+ * @param selector annotation selector with start and end positions
+ * @param container the HTML container of the annotated content
+ *
+ * @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/utils/annotation/scroll-into-view.d.ts

@@ -0,0 +1,3 @@
+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/device.d.ts

@@ -0,0 +1 @@
+export declare const isMac: 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/dom/is-not-annotatable.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: (container: Node, node: Node) => boolean;
+export declare const isRangeAnnotatable: (container: Node, range: Range) => boolean;

package/dist/utils/dom/is-whitespace-or-empty.d.ts

@@ -0,0 +1,3 @@
+export declare const whitespaceOrEmptyRegex: RegExp;
+export declare const isRangeWhitespaceOrEmpty: (range: Range) => boolean;
+export declare const isNodeWhitespaceOrEmpty: (node: Node) => boolean;

package/dist/utils/dom/merge-ranges.d.ts

@@ -0,0 +1 @@
+export declare const mergeRanges: (ranges: Range[]) => Range[];

package/dist/utils/dom/programmatically-focusable.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/utils/dom/split-annotatable-ranges.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Splits a DOM Range into one or more ranges that span annotatable content only.
+ */
+export declare const splitAnnotatableRanges: (container: Node, range: Range) => Range[];
+export declare const getRangeAnnotatableContents: (range: Range) => DocumentFragment;

package/dist/utils/dom/trim-range-to-container.d.ts

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

package/dist/utils/events/cancel-single-click-events.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/utils/events/clone-events.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/utils/events/debounce.d.ts

@@ -0,0 +1 @@
+export declare const debounce: <T extends (...args: any[]) => void>(func: T, delay?: number) => T;

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/get-highlight-client-rects.d.ts

@@ -0,0 +1 @@
+export declare const getHighlightClientRects: (range: Range) => DOMRect[];

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/dist/utils/highlight/merge-client-rects.d.ts

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

package/dist/utils/highlight/rects-to-bounds.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Offsets the given rect relative to the offset parent.
+ */
+export declare const toParentBounds: (rect: DOMRect, offset: DOMRect) => DOMRect;
+/**
+ * Inverse: translates the given relative rect back into viewport bounds.
+ */
+export declare const toViewportBounds: (rect: DOMRect, offset: DOMRect) => DOMRect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soomo/text-annotator",
-  "version": "3.4.14-staging.0",
+  "version": "4.1.0-staging.0",
   "description": "A JavaScript text annotation library",
   "author": "Rainer Simon",
   "license": "BSD-3-Clause",
@@ -26,23 +26,23 @@
     "./text-annotator.css": "./dist/text-annotator.css"
   },
   "devDependencies": {
-    "@types/jsdom": "^27.0.0",
+    "@types/jsdom": "^28.0.3",
     "@types/rbush": "^4.0.0",
-    "jsdom": "^27.2.0",
+    "jsdom": "^29.1.1",
     "typescript": "^5.9.3",
-    "vite": "^7.2.2",
+    "vite": "^7.3.3",
     "vite-plugin-externalize-deps": "^0.10.0",
-    "vitest": "^4.0.10"
+    "vitest": "^4.1.7"
   },
   "dependencies": {
-    "@annotorious/core": "^3.7.13",
+    "@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",
-    "uuid": "^13.0.0"
+    "uuid": "^14.0.0"
   }
 }