@recogito/text-annotator 3.3.2 → 3.4.0

package/dist/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/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/utils/device.d.ts

@@ -0,0 +1 @@
+export declare const isMac: boolean;

package/dist/utils/getHighlightClientRects.d.ts

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

package/dist/utils/getQuoteContext.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/index.d.ts

@@ -0,0 +1,17 @@
+export * from './cancelSingleClickEvents';
+export * from './cloneEvents';
+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 './rangeToSelector';
+export * from './rectsToBounds';
+export * from './reviveAnnotation';
+export * from './reviveSelector';
+export * from './reviveTarget';
+export * from './splitAnnotatableRanges';
+export * from './trimRangeToContainer';

package/dist/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: (container: Node, node: Node) => boolean;
+export declare const isRangeAnnotatable: (container: Node, range: Range) => boolean;

package/dist/utils/isRevived.d.ts

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

package/dist/utils/isWhitespaceOrEmpty.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/mergeClientRects.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/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/utils/rangeToSelector.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/rectsToBounds.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/dist/utils/reviveAnnotation.d.ts

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

package/dist/utils/reviveSelector.d.ts

@@ -0,0 +1,11 @@
+import type { TextSelector } from '../model';
+/**
+ * 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;

package/dist/utils/reviveTarget.d.ts

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

package/dist/utils/splitAnnotatableRanges.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/trimRangeToContainer.d.ts

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

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@recogito/text-annotator",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "description": "A JavaScript text annotation library",
   "author": "Rainer Simon",
   "license": "BSD-3-Clause",
   "type": "module",
   "scripts": {
     "start": "vite --host",
-    "build": "vite build && vite build --config vite.config.umd.ts",
+    "build": "tsc -p tsconfig.build.json && vite build && vite build --config vite.config.umd.ts",
     "preview": "vite preview",
     "test": "vitest"
   },
@@ -19,7 +19,7 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/text-annotator.es.js",
       "require": "./dist/text-annotator.umd.js"
     },
@@ -31,18 +31,18 @@
     "jsdom": "^27.0.0",
     "typescript": "5.9.3",
     "vite": "^6.3.6",
-    "vite-plugin-dts": "^4.5.4",
     "vite-plugin-externalize-deps": "^0.9.0",
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@annotorious/core": "^3.7.8",
+    "@annotorious/core": "^3.7.11",
     "colord": "^2.9.3",
+    "debounce": "^2.2.0",
     "dequal": "^2.0.3",
     "hotkeys-js": "^3.13.15",
     "poll": "^3.2.2",
     "rbush": "^4.0.1",
-    "ua-parser-js": "^2.0.5",
+    "ua-parser-js": "^2.0.6",
     "uuid": "^13.0.0"
   }
 }