@recogito/text-annotator 3.0.0-rc.19 → 3.0.0-rc.3

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@recogito/text-annotator",
-  "version": "3.0.0-rc.19",
+  "version": "3.0.0-rc.3",
   "description": "A JavaScript text annotation library",
   "author": "Rainer Simon",
   "license": "BSD-3-Clause",
   "type": "module",
   "scripts": {
-    "start": "vite --host",
+    "start": "vite",
     "build": "vite build",
     "preview": "vite preview",
-    "test": "vitest"
+    "test": "echo 'Skipping tests in @recogito/text-annotator package'"
   },
   "main": "./dist/text-annotator.umd.js",
   "module": "./dist/text-annotator.es.js",
@@ -19,28 +19,22 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
       "import": "./dist/text-annotator.es.js",
       "require": "./dist/text-annotator.umd.js"
     },
     "./dist/text-annotator.css": "./dist/text-annotator.css"
   },
   "devDependencies": {
-    "@types/jsdom": "^21.1.6",
-    "@types/rbush": "^3.0.3",
-    "@types/uuid": "^9.0.8",
-    "jsdom": "^24.0.0",
-    "svelte": "^4.2.12",
-    "typescript": "^5.4.3",
-    "vite": "^5.2.6",
-    "vite-plugin-dts": "^3.8.0",
-    "vitest": "^1.4.0"
+    "@types/rbush": "^3.0.0",
+    "@types/uuid": "^9.0.1",
+    "svelte": "^4.0.0",
+    "typescript": "^4.9.5",
+    "vite": "^4.2.1",
+    "vite-plugin-dts": "^2.3.0"
   },
   "dependencies": {
-    "@annotorious/core": "^3.0.0-rc.22",
-    "colord": "^2.9.3",
-    "dequal": "^2.0.3",
+    "@annotorious/core": "^3.0.0-rc.4",
     "rbush": "^3.0.1",
-    "uuid": "^9.0.1"
+    "uuid": "^9.0.0"
   }
 }

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

@@ -1,6 +0,0 @@
-import { AnnotationRects } from '../state';
-import { AnnotationState } from '@annotorious/core';
-
-export interface Highlight extends AnnotationRects {
-    state: AnnotationState;
-}

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

@@ -1,12 +0,0 @@
-import { TextAnnotation } from 'src/model';
-import { AnnotationState, Color, DrawingStyle } from '@annotorious/core';
-
-export interface HighlightStyle extends Pick<DrawingStyle, 'fill' | 'fillOpacity'> {
-    underlineStyle?: string;
-    underlineColor?: Color;
-    underlineOffset?: number;
-    underlineThickness?: number;
-}
-export type HighlightStyleExpression = HighlightStyle | ((annotation: TextAnnotation, state: AnnotationState, zIndex?: number) => HighlightStyle);
-export declare const DEFAULT_STYLE: HighlightStyle;
-export declare const DEFAULT_SELECTED_STYLE: HighlightStyle;

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

@@ -1,21 +0,0 @@
-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';
-
-export interface RendererImplementation {
-    destroy(): void;
-    redraw(highlights: Highlight[], bounds: ViewportBounds, style?: HighlightStyleExpression, painter?: HighlightPainter, force?: 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: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState, renderer: RendererImplementation) => Renderer;

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

@@ -1,4 +0,0 @@
-import { ViewportState } from '@annotorious/core';
-import { TextAnnotatorState } from 'src/state';
-
-export declare const createCanvasRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => import('../baseRenderer').Renderer;

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

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

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

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

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

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

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

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

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

@@ -1,4 +0,0 @@
-import { TextAnnotatorState } from '../../state';
-import { ViewportState } from '@annotorious/core';
-
-export declare const createSpansRenderer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => import('../baseRenderer').Renderer;

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

@@ -1,13 +0,0 @@
-import { TextAnnotation } from '../model';
-import { ViewportState } from '@annotorious/core';
-
-export interface ViewportBounds {
-    top: number;
-    left: number;
-    minX: number;
-    minY: number;
-    maxX: number;
-    maxY: number;
-}
-export declare const getViewportBounds: (container: HTMLElement) => ViewportBounds;
-export declare const trackViewport: (viewport: ViewportState) => (annotations: TextAnnotation[]) => void;

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

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

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

@@ -1,34 +0,0 @@
-import { W3CAnnotation, W3CAnnotationTarget } from '@annotorious/core';
-
-export interface W3CTextAnnotation extends W3CAnnotation {
-    target: W3CTextAnnotationTarget | W3CTextAnnotationTarget[];
-    stylesheet?: W3CAnnotationStylesheet;
-}
-export interface W3CTextAnnotationTarget extends W3CAnnotationTarget {
-    selector: W3CTextSelector | W3CTextSelector[];
-    styleClass?: string;
-}
-/**
- * Matches the `Text Quote Selector` spec
- * @see https://www.w3.org/TR/annotation-model/#text-quote-selector
- */
-export interface W3CTextQuoteSelector {
-    type: 'TextQuoteSelector';
-    exact: string;
-    prefix?: string;
-    suffix?: string;
-}
-/**
- * Matches the `Text Position Selector` spec
- * @see https://www.w3.org/TR/annotation-model/#text-position-selector
- */
-export interface W3CTextPositionSelector {
-    type: 'TextPositionSelector';
-    start: number;
-    end: number;
-}
-export type W3CTextSelector = W3CTextQuoteSelector | W3CTextPositionSelector;
-export type W3CAnnotationStylesheet = string | {
-    type: 'CssStylesheet';
-    value: string;
-};

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

@@ -1,13 +0,0 @@
-import { W3CTextAnnotation } from '../w3c';
-import { TextAnnotation } from '../core';
-import { FormatAdapter, ParseResult } from '@annotorious/core';
-
-export type W3CTextFormatAdapter = FormatAdapter<TextAnnotation, W3CTextAnnotation>;
-/**
- * @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;

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

@@ -1,2 +0,0 @@
-export * from './W3CTextAnnotation';
-export * from './W3CTextFormatAdapter';

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

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

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

@@ -1,5 +0,0 @@
-/**
- * Returns a DocumentFragment consisting of ONLY the annotatable content
- * in the given DOM Range.
- */
-export declare const getAnnotatableFragment: (range: Range) => DocumentFragment;

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

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

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

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

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

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

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

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

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

@@ -1,12 +0,0 @@
-import { 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: (selector: TextSelector, container: HTMLElement) => TextSelector;

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

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

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

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

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

@@ -1 +0,0 @@
-export {};

package/dist/test/model/w3c/fixtures.d.ts

@@ -1,4 +0,0 @@
-import { W3CTextAnnotation } from '../../../src';
-
-export declare const textAnnotation: W3CTextAnnotation;
-export declare const incompleteTextAnnotation: W3CTextAnnotation;