triiiceratops 0.9.13 → 0.10.0

package/dist/plugins/annotation-editor/index.js

@@ -0,0 +1,57 @@
+import AnnotationEditorController from './AnnotationEditorController.svelte';
+import PencilSimple from 'phosphor-svelte/lib/PencilSimple';
+import { LocalStorageAdapter } from './adapters/LocalStorageAdapter';
+import { createLoader } from './loader.svelte';
+/**
+ * Create an Annotation Editor plugin with custom configuration.
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { createAnnotationEditorPlugin, LocalStorageAdapter } from 'triiiceratops/plugins/annotation-editor';
+ *
+ *   const annotationPlugin = createAnnotationEditorPlugin({
+ *     adapter: new LocalStorageAdapter(),
+ *     user: { id: 'user-123', name: 'Jane Doe' },
+ *   });
+ * </script>
+ *
+ * <TriiiceratopsViewer plugins={[annotationPlugin]} />
+ * ```
+ */
+export function createAnnotationEditorPlugin(config = {}) {
+    const adapter = config.adapter || new LocalStorageAdapter();
+    const fullConfig = { ...config, adapter };
+    return {
+        id: 'annotation-editor',
+        name: 'annotation_editor_title',
+        icon: PencilSimple,
+        panel: AnnotationEditorController,
+        position: 'left',
+        props: { config: fullConfig },
+        onInit: createLoader(adapter),
+    };
+}
+/**
+ * Pre-configured Annotation Editor plugin with localStorage adapter.
+ * For advanced configuration, use createAnnotationEditorPlugin().
+ *
+ * @example
+ * ```svelte
+ * <script>
+ *   import { AnnotationEditorPlugin } from 'triiiceratops/plugins/annotation-editor';
+ * </script>
+ *
+ * <TriiiceratopsViewer plugins={[AnnotationEditorPlugin]} />
+ * ```
+ */
+export const AnnotationEditorPlugin = createAnnotationEditorPlugin({
+    adapter: new LocalStorageAdapter(),
+    tools: ['rectangle', 'polygon', 'point'],
+    defaultTool: 'rectangle',
+});
+// Individual exports for customization
+export { AnnotationEditorController };
+export { default as AnnotationEditorIcon } from 'phosphor-svelte/lib/PencilSimple';
+export { W3C_PURPOSES } from './types';
+export { LocalStorageAdapter } from './adapters/LocalStorageAdapter';

package/dist/plugins/annotation-editor/loader.svelte.d.ts

@@ -0,0 +1,7 @@
+import type { ViewerState } from '../../state/viewer.svelte';
+import type { AnnotationStorageAdapter } from './types';
+/**
+ * Creates a reactive loader that syncs annotations from the adapter to the viewer state.
+ * This runs independently of the Annotation Editor UI component.
+ */
+export declare function createLoader(adapter: AnnotationStorageAdapter): (viewerState: ViewerState) => void;

package/dist/plugins/annotation-editor/loader.svelte.js

@@ -0,0 +1,32 @@
+import { manifestsState } from '../../state/manifests.svelte';
+/**
+ * Creates a reactive loader that syncs annotations from the adapter to the viewer state.
+ * This runs independently of the Annotation Editor UI component.
+ */
+export function createLoader(adapter) {
+    return (viewerState) => {
+        // Track the last loaded combination to prevent duplicate loads
+        // Although the adapter generally handles idempotency, this is a good optimization
+        let lastLoadedId = null;
+        $effect(() => {
+            const manifestId = viewerState.manifestId;
+            const canvasId = viewerState.canvasId;
+            if (!manifestId || !canvasId)
+                return;
+            const comboId = `${manifestId}::${canvasId}`;
+            if (comboId === lastLoadedId)
+                return;
+            // Update IMMEDIATELY to prevent re-entrant calls or rapid-fire effects
+            lastLoadedId = comboId;
+            // Load annotations for this canvas
+            adapter
+                .load(manifestId, canvasId)
+                .then((annotations) => {
+                // Success handling
+            })
+                .catch((err) => {
+                console.error('[AnnotationLoader] Failed to load annotations', err);
+            });
+        });
+    };
+}

package/dist/plugins/annotation-editor/types.d.ts

@@ -0,0 +1,41 @@
+import type { User, DrawingStyle } from '@annotorious/openseadragon';
+/** Forward reference to avoid circular imports - full definition in adapters/types.ts */
+export interface AnnotationStorageAdapter {
+    readonly id: string;
+    readonly name: string;
+    load(manifestId: string, canvasId: string): Promise<any[]>;
+    create(manifestId: string, canvasId: string, annotation: any): Promise<void>;
+    update(manifestId: string, canvasId: string, annotation: any): Promise<void>;
+    delete(manifestId: string, canvasId: string, annotationId: string): Promise<void>;
+    destroy?(): void;
+}
+export interface AnnotationEditorConfig {
+    /** Storage adapter for persistence */
+    adapter?: AnnotationStorageAdapter;
+    /** Current user for attribution */
+    user?: User;
+    /** Drawing style for annotations while editing */
+    drawingStyle?: DrawingStyle;
+    /** Available drawing tools */
+    tools?: DrawingTool[];
+    /** Default drawing tool */
+    defaultTool?: DrawingTool;
+}
+export type DrawingTool = 'rectangle' | 'polygon' | 'point';
+/** W3C Annotation Body */
+export interface W3CAnnotationBody {
+    type?: string;
+    purpose?: string;
+    value?: string;
+    format?: string;
+    language?: string;
+    creator?: {
+        id?: string;
+        name?: string;
+    };
+    created?: string;
+    modified?: string;
+}
+/** Standard W3C purposes for autocomplete */
+export declare const W3C_PURPOSES: readonly ["commenting", "tagging", "describing", "classifying", "identifying", "linking", "bookmarking", "highlighting", "questioning", "replying"];
+export type W3CPurpose = (typeof W3C_PURPOSES)[number];

package/dist/plugins/annotation-editor/types.js

@@ -0,0 +1,13 @@
+/** Standard W3C purposes for autocomplete */
+export const W3C_PURPOSES = [
+    'commenting',
+    'tagging',
+    'describing',
+    'classifying',
+    'identifying',
+    'linking',
+    'bookmarking',
+    'highlighting',
+    'questioning',
+    'replying',
+];