@knaw-huc/text-annotation-segmenter 0.1.0 → 0.1.1

package/README.md

@@ -11,7 +11,7 @@ However, HTML is hierarchical. How to display these kinds of annotations that do
 
 The `segment` function creates an array of segments: a flat, non-overlapping list where each segment links to both the text and all the annotations that apply. Each segment translates into a single DOM element. Elements linked to multiple overlapping annotations can now be decorated with their own styling, classes and callbacks.
 
-A special case is the marker: an annotation of zero width marking a position in the text. Markers result in zero-width segments, also linking all annotations that start at, end at, or span across that position.
+A special case is the marker: an annotation of zero width marking a position in the text. Markers result in zero-width segments, also linking all annotations that start at or span across that position.
 
 ## API
 

package/dist/Model.d.ts

@@ -1,13 +1,13 @@
 /**
- * Input list of objects linking annotations to the text using character offsets.
+ * Input: object linking annotation to the text using character offsets.
  */
-export type AnnotationSegment<T = unknown> = {
+export type AnnotationOffsets<T = unknown> = {
     begin: number;
     end: number;
     body: T;
 };
 /**
- * Output list of segments with character offsets and the annotations that apply.
+ * Output: segment of text and the annotations that apply.
  */
 export type TextSegment<T = unknown> = {
     id: SegmentId;

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { segment } from './segment.ts';
 export type { AnnotationSegmentsByChar } from './segment.ts';
 export { groupSegments } from './groupSegments.ts';
 export type { Group } from './groupSegments.ts';
-export type { AnnotationSegment, TextSegment, SegmentId, } from './Model.ts';
+export type { AnnotationOffsets, TextSegment, SegmentId, } from './Model.ts';

package/dist/segment.d.ts

@@ -1,10 +1,10 @@
-import { AnnotationSegment, TextSegment } from './Model';
+import { AnnotationOffsets, TextSegment } from './Model';
 /**
  * Split a text into {@link TextSegment}s with character offsets and a list of applying annotations.
  */
-export declare function segment<T>(text: string, annotations: AnnotationSegment<T>[]): TextSegment<T>[];
+export declare function segment<T>(text: string, annotations: AnnotationOffsets<T>[]): TextSegment<T>[];
 export type AnnotationSegmentsByChar<T = unknown> = {
     charIndex: number;
-    starting: AnnotationSegment<T>[];
-    ending: AnnotationSegment<T>[];
+    starting: AnnotationOffsets<T>[];
+    ending: AnnotationOffsets<T>[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knaw-huc/text-annotation-segmenter",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/knaw-huc/text-annotation-segmenter.git"