triiiceratops 0.1.0 → 0.2.0

package/README.md

@@ -1,22 +1,25 @@
 # Triiiceratops IIIF Viewer
 
-A modern, lightweight IIIF viewer built with Svelte and OpenSeadragon. It is distributed as a web component that can be dropped into any HTML page or frontend framework.
+A modern IIIF viewer with a small footprint (despite the name) distributed as a web component that can be dropped into any HTML page or frontend framework.
 
-This is a work in progress and does not support all client IIIF features.
+This is a work in progress and does not support all required IIIF client features (_yet_).
+
+This project is heavily inspired by Mirador 4, which I still view as the premier IIIF viewer.
 
 ## Features
 
 - Explore all canvases in a manfifest in a flexible thumbnail gallery that can be a floating window or docked to any of the four sides of the viewer.
-- Handles IIIF annotations.
-- Theme support with Tailwind CSS and DaisyUI.
+- Renders IIIF annotations.
+- Flexible theme support using Tailwind CSS and DaisyUI.
 - IIIF Search support.
 
 ## Current Limitations (but actively working on supporting)
 
-- Does not fully support multiple images per canvas.
+- Does not fully support multiple images per canvas (either multiple images in the same canvas or the `choice` property).
 - Does not support IIIF collection navigation.
 - Other IIIF client features are missing.
-- IIIF Annotation Creation is not supported.
+
+The goal is to support all IIIF client mandatory features with pluggable optional features. The footprint of Triiiceratops, despite the name, is intended to remain considerably small than other fully featured viewers while attaining feature parity.
 
 ## Usage
 

package/dist/src/lib/state/viewer.svelte.d.ts

@@ -9,8 +9,6 @@ export declare class ViewerState {
     showMetadataDialog: boolean;
     dockSide: string;
     visibleAnnotationIds: Set<string>;
-    createdAnnotations: Record<string, any[]>;
-    isCreatingAnnotation: boolean;
     constructor(initialManifestId?: string | null);
     get manifest(): any;
     get canvases(): any;
@@ -21,9 +19,6 @@ export declare class ViewerState {
     previousCanvas(): void;
     setManifest(manifestId: string): void;
     setCanvas(canvasId: string): void;
-    toggleCreationMode(enable?: boolean): void;
-    loadAnnotationsFromStorage(canvasId: string): void;
-    addAnnotation(annotation: any, canvasId: string): void;
     toggleAnnotations(): void;
     toggleThumbnailGallery(): void;
     toggleFullScreen(): void;

package/dist/src/lib/utils/annotationAdapter.d.ts

@@ -1,9 +1,31 @@
-import { ImageAnnotation } from '@annotorious/annotorious';
 /**
- * Convert Manifesto/IIIF annotation to Annotorious ImageAnnotation format
+ * Parsed annotation interface for custom rendering
  */
-export declare function convertToAnnotoriousFormat(annotation: any, index: number, isSearchHit?: boolean): ImageAnnotation | null;
+export interface ParsedAnnotation {
+    id: string;
+    geometry: RectangleGeometry | PolygonGeometry;
+    body: {
+        value: string;
+        isHtml: boolean;
+    };
+    isSearchHit: boolean;
+}
+export interface RectangleGeometry {
+    type: 'RECTANGLE';
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export interface PolygonGeometry {
+    type: 'POLYGON';
+    points: [number, number][];
+}
 /**
- * Batch convert annotations
+ * Parse Manifesto/IIIF annotation to internal format
  */
-export declare function convertAnnotations(annotations: any[], searchHitIds?: Set<string>): ImageAnnotation[];
+export declare function parseAnnotation(annotation: any, index: number, isSearchHit?: boolean): ParsedAnnotation | null;
+/**
+ * Batch parse annotations
+ */
+export declare function parseAnnotations(annotations: any[], searchHitIds?: Set<string>): ParsedAnnotation[];