@recogito/text-annotator 3.0.0-rc.10 → 3.0.0-rc.11

package/dist/src/api/scrollIntoView.d.ts

@@ -1,3 +1,3 @@
 import { type TextAnnotationStore } from '../state';
-import type { TextAnnotation } from '../model/TextAnnotation';
+import type { TextAnnotation } from '../model';
 export declare const scrollIntoView: (container: HTMLElement, store: TextAnnotationStore) => (annotation: TextAnnotation) => boolean;

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

@@ -3,6 +3,7 @@ import type { TextAnnotation } from '../model';
 import type { TextAnnotatorState } from '../state';
 import { type HighlightPainter } from './HighlightPainter';
 export declare const createHighlightLayer: (container: HTMLElement, state: TextAnnotatorState, viewport: ViewportState) => {
+    destroy: () => void;
     redraw: () => number;
     setDrawingStyle: (style: DrawingStyle | ((a: TextAnnotation, selected?: boolean) => DrawingStyle)) => void;
     setFilter: (filter?: Filter) => void;

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

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

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

@@ -1 +1,2 @@
-export * from './TextAnnotation';
+export * from './core';
+export * from './w3c';

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

@@ -0,0 +1,33 @@
+import type { 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

@@ -0,0 +1,12 @@
+import { type FormatAdapter, ParseResult } from '@annotorious/core';
+import type { TextAnnotation } from '../core';
+import type { W3CTextAnnotation } from '../w3c';
+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, container: HTMLElement) => ParseResult<TextAnnotation>;
+export declare const serializeW3CTextAnnotation: (annotation: TextAnnotation, source: string, container: HTMLElement) => W3CTextAnnotation;

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

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

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

@@ -1,3 +1,4 @@
 export * from './getClientRectsPonyfill';
+export * from './getQuoteContext';
 export * from './mergeClientRects';
 export * from './trimRange';

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

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

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

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