@triiiceratops/plugin-annotation-editor 1.0.0-rc.6 → 1.0.0

package/dist/loader.svelte.d.ts

@@ -6,6 +6,6 @@ import type { AnnotationStore } from './AnnotationStore.svelte';
  * (the panel may never open), so it drives the shared store directly: point the
  * store at the current canvas and load; the store injects into this viewer's
  * per-viewer display state (F10, ADR 0007). When the editor panel is mounted,
- * its manager shares this same store, so both paths converge on one cache.
+ * its drawing layer shares this same store, so both paths converge on one cache.
  */
 export declare function createLoader(store: AnnotationStore): (viewerState: ViewerState) => void;

package/dist/plugin.d.ts

@@ -3,11 +3,15 @@
  *
  * `definePlugin` returns the framework-neutral factory core activates through the
  * structural seam (it carries its own `activate(host)`); core never imports this
- * package or its Svelte runtime. The full domain machinery — Store, Adapter seam,
- * per-viewer display sync, undo/redo, body editors, Annotorious integration — is
- * carried intact and driven from the neutral `view.mount(container, context)`
- * contract (see `mount.svelte.ts`). Annotorious needs the raw OSD viewer, so the
- * plugin declares `requiredCapabilities: ['osd@5']` (ADR 0009).
+ * package or its Svelte runtime. The domain machinery — Store, Adapter seam,
+ * per-viewer display sync, undo/redo, body editors, the drawing layer — is driven
+ * from the neutral `view.mount(container, context)` contract (see
+ * `mount.svelte.ts`).
+ *
+ * `uiId` is load-bearing, not cosmetic: core decides whether an annotation shape
+ * is editable by finding a toolbar button whose plugin id is the literal
+ * `'annotation-editor'` (`AnnotationShapeOverlay.svelte`). Renaming it makes
+ * every shape non-editable, and no test in this package would catch it.
  */
 import { type SdkPlugin } from '@triiiceratops/plugin-sdk';
 import type { AnnotationEditorConfig } from './types';

package/dist/testing/index.d.ts

@@ -1,8 +1,8 @@
 import type { AnnotationStorageAdapter } from '../types';
 /**
  * Adapter authoring kit — a reusable conformance suite so adapter authors can
- * verify their implementation against the contract the plugin relies on (ticket
- * 10, F28 / SPEC §2.6).
+ * verify their implementation against the contract the plugin relies on (F28 /
+ * SPEC §2.6).
  *
  * An adapter is pure storage: the plugin owns display sync, caching, id
  * bookkeeping, timestamp/attribution stamping, and error handling. This suite

package/dist/testing/index.js

@@ -1,158 +1 @@
-import { describe as _, beforeEach as A, it as c, expect as n } from "vitest";
-function w(i) {
-  const u = { ...i };
-  return delete u.__fullBodyLoaded, delete u.__bodyPreview, u;
-}
-function b(i, u) {
-  return typeof i == "string" ? i : i && typeof i == "object" ? i.id : u;
-}
-function f(i, u, h) {
-  return {
-    "@context": "http://www.w3.org/ns/anno.jsonld",
-    id: i,
-    type: "Annotation",
-    motivation: "commenting",
-    body: h ?? [
-      { type: "TextualBody", purpose: "commenting", value: "hello" }
-    ],
-    target: {
-      type: "SpecificResource",
-      source: u,
-      selector: {
-        type: "FragmentSelector",
-        conformsTo: "http://www.w3.org/TR/media-frags/",
-        value: "xywh=10,20,30,40"
-      }
-    }
-  };
-}
-function C(i, u = {}) {
-  const { supportsIdReconciliation: h, supportsHydrate: g, label: x } = u;
-  _(x ?? "AnnotationStorageAdapter contract", () => {
-    let o, d, t, m = 0;
-    A(() => {
-      o = i(), m += 1, d = `contract-manifest-${m}`, t = `contract-canvas-${m}`;
-    });
-    async function p(a) {
-      const r = await o.create(
-        d,
-        t,
-        structuredClone(a)
-      ), e = b(r, a.id), s = (await o.load(d, t)).find((l) => l.id === e) ?? null;
-      if (!s) return { id: e, resolved: null };
-      if (s.__fullBodyLoaded === !1) {
-        n(typeof o.hydrate).toBe("function");
-        const l = await o.hydrate(d, t, e);
-        return { id: e, resolved: l };
-      }
-      return { id: e, resolved: s };
-    }
-    c("load returns an empty array for a canvas with no annotations", async () => {
-      const a = await o.load(d, t);
-      n(Array.isArray(a)).toBe(!0), n(a).toHaveLength(0);
-    }), c("create then load round-trips the annotation verbatim", async () => {
-      const a = f("anno-1", t), { id: r, resolved: e } = await p(a);
-      n(e).not.toBeNull(), n(w(e)).toEqual({
-        ...a,
-        id: r
-      });
-    }), c("create preserves structured / unknown body shapes verbatim", async () => {
-      const a = {
-        type: "Dataset",
-        purpose: "linking",
-        value: {
-          nested: { deep: [1, 2, 3], flag: !0 },
-          ref: "https://example.org/entity/42"
-        },
-        extra: null
-      }, r = f(
-        "anno-structured",
-        t,
-        a
-      ), { resolved: e } = await p(r);
-      n(e).not.toBeNull(), n(e.body).toEqual(a);
-    }), c("update replaces a stored annotation body", async () => {
-      const a = f("anno-2", t), { id: r } = await p(a), e = {
-        ...a,
-        id: r,
-        body: [
-          {
-            type: "TextualBody",
-            purpose: "commenting",
-            value: "edited"
-          }
-        ]
-      };
-      await o.update(
-        d,
-        t,
-        structuredClone(e)
-      );
-      const s = (await o.load(d, t)).find((v) => v.id === r);
-      n(s).toBeDefined();
-      const l = s?.__fullBodyLoaded === !1 ? await o.hydrate(d, t, r) : s;
-      n(w(l).body).toEqual(e.body);
-    }), c("delete removes a stored annotation", async () => {
-      const a = f("anno-3", t), { id: r } = await p(a);
-      await o.delete(d, t, r);
-      const e = await o.load(d, t);
-      n(e.find((y) => y.id === r)).toBeUndefined();
-    }), c("isolates annotations by manifest and canvas", async () => {
-      const a = f("anno-iso", t), { id: r } = await p(a), e = `${t}-other`, y = `${d}-other`;
-      n(await o.load(d, e)).toHaveLength(0), n(await o.load(y, t)).toHaveLength(0);
-      const s = await o.load(d, t);
-      n(s.find((l) => l.id === r)).toBeDefined();
-    }), h && c("returns a server-assigned id honored by update and delete", async () => {
-      const a = f("local-temp-id", t), r = await o.create(
-        d,
-        t,
-        structuredClone(a)
-      );
-      n(r == null).toBe(!1);
-      const e = b(r, a.id);
-      n(typeof e).toBe("string");
-      const y = {
-        ...a,
-        id: e,
-        body: [
-          {
-            type: "TextualBody",
-            purpose: "commenting",
-            value: "reconciled-edit"
-          }
-        ]
-      };
-      await o.update(
-        d,
-        t,
-        structuredClone(y)
-      );
-      let s = await o.load(d, t);
-      const l = s.find((B) => B.id === e);
-      n(l).toBeDefined();
-      const v = l?.__fullBodyLoaded === !1 ? await o.hydrate(
-        d,
-        t,
-        e
-      ) : l;
-      n(w(v).body).toEqual(y.body), await o.delete(d, t, e), s = await o.load(d, t), n(
-        s.find((B) => B.id === e)
-      ).toBeUndefined();
-    }), g && (c("exposes a hydrate method", () => {
-      n(typeof o.hydrate).toBe("function");
-    }), c("hydrate returns the full annotation for a known id", async () => {
-      const a = f("anno-hydrate", t), { id: r } = await p(a), e = await o.hydrate(d, t, r);
-      n(e).not.toBeNull(), n(w(e).body).toEqual(a.body);
-    }), c("hydrate returns null for an unknown id", async () => {
-      const a = await o.hydrate(
-        d,
-        t,
-        "no-such-annotation"
-      );
-      n(a).toBeNull();
-    }));
-  });
-}
-export {
-  C as runAdapterContractTests
-};
+import{describe as t,beforeEach as e,it as a,expect as o}from"vitest";function n(t){const e={...t};return delete e.__fullBodyLoaded,delete e.__bodyPreview,e}function d(t,e){return"string"==typeof t?t:t&&"object"==typeof t?t.id:e}function i(t,e,a){return{"@context":"http://www.w3.org/ns/anno.jsonld",id:t,type:"Annotation",motivation:"commenting",body:a??[{type:"TextualBody",purpose:"commenting",value:"hello"}],target:{type:"SpecificResource",source:e,selector:{type:"FragmentSelector",conformsTo:"http://www.w3.org/TR/media-frags/",value:"xywh=10,20,30,40"}}}}function r(r,s={}){const{supportsIdReconciliation:l,supportsHydrate:c,label:u}=s;t(u??"AnnotationStorageAdapter contract",()=>{let t,s,u,y=0;async function p(e){const a=d(await t.create(s,u,structuredClone(e)),e.id),n=(await t.load(s,u)).find(t=>t.id===a)??null;if(!n)return{id:a,resolved:null};if(!1===n.__fullBodyLoaded){o(typeof t.hydrate).toBe("function");const e=await t.hydrate(s,u,a);return{id:a,resolved:e}}return{id:a,resolved:n}}e(()=>{t=r(),y+=1,s=`contract-manifest-${y}`,u=`contract-canvas-${y}`}),a("load returns an empty array for a canvas with no annotations",async()=>{const e=await t.load(s,u);o(Array.isArray(e)).toBe(!0),o(e).toHaveLength(0)}),a("create then load round-trips the annotation verbatim",async()=>{const t=i("anno-1",u),{id:e,resolved:a}=await p(t);o(a).not.toBeNull(),o(n(a)).toEqual({...t,id:e})}),a("create preserves structured / unknown body shapes verbatim",async()=>{const t={type:"Dataset",purpose:"linking",value:{nested:{deep:[1,2,3],flag:!0},ref:"https://example.org/entity/42"},extra:null},e=i("anno-structured",u,t),{resolved:a}=await p(e);o(a).not.toBeNull(),o(a.body).toEqual(t)}),a("update replaces a stored annotation body",async()=>{const e=i("anno-2",u),{id:a}=await p(e),d={...e,id:a,body:[{type:"TextualBody",purpose:"commenting",value:"edited"}]};await t.update(s,u,structuredClone(d));const r=(await t.load(s,u)).find(t=>t.id===a);o(r).toBeDefined();const l=!1===r?.__fullBodyLoaded?await t.hydrate(s,u,a):r;o(n(l).body).toEqual(d.body)}),a("delete removes a stored annotation",async()=>{const e=i("anno-3",u),{id:a}=await p(e);await t.delete(s,u,a);const n=await t.load(s,u);o(n.find(t=>t.id===a)).toBeUndefined()}),a("isolates annotations by manifest and canvas",async()=>{const e=i("anno-iso",u),{id:a}=await p(e),n=`${u}-other`,d=`${s}-other`;o(await t.load(s,n)).toHaveLength(0),o(await t.load(d,u)).toHaveLength(0);const r=await t.load(s,u);o(r.find(t=>t.id===a)).toBeDefined()}),l&&a("returns a server-assigned id honored by update and delete",async()=>{const e=i("local-temp-id",u),a=await t.create(s,u,structuredClone(e));o(null==a).toBe(!1);const r=d(a,e.id);o(typeof r).toBe("string");const l={...e,id:r,body:[{type:"TextualBody",purpose:"commenting",value:"reconciled-edit"}]};await t.update(s,u,structuredClone(l));let c=await t.load(s,u);const y=c.find(t=>t.id===r);o(y).toBeDefined();const p=!1===y?.__fullBodyLoaded?await t.hydrate(s,u,r):y;o(n(p).body).toEqual(l.body),await t.delete(s,u,r),c=await t.load(s,u),o(c.find(t=>t.id===r)).toBeUndefined()}),c&&(a("exposes a hydrate method",()=>{o(typeof t.hydrate).toBe("function")}),a("hydrate returns the full annotation for a known id",async()=>{const e=i("anno-hydrate",u),{id:a}=await p(e),d=await t.hydrate(s,u,a);o(d).not.toBeNull(),o(n(d).body).toEqual(e.body)}),a("hydrate returns null for an unknown id",async()=>{const e=await t.hydrate(s,u,"no-such-annotation");o(e).toBeNull()}))})}export{r as runAdapterContractTests};

package/dist/tools.d.ts

@@ -0,0 +1,16 @@
+import type { DrawingTool } from './types';
+/** Every tool the plugin knows how to draw, in default button order. */
+export declare const ALL_TOOLS: DrawingTool[];
+/**
+ * Resolve the effective tool set and default tool from config so the panel and
+ * the drawing layer share one source of truth (F8). An empty/absent `tools` list
+ * means "all tools"; `defaultTool` is honored only when it's within `tools`,
+ * otherwise the first available tool wins.
+ */
+export declare function resolveTools(config: {
+    tools?: DrawingTool[];
+    defaultTool?: DrawingTool;
+}): {
+    tools: DrawingTool[];
+    defaultTool: DrawingTool;
+};

package/dist/types.d.ts

@@ -1,15 +1,21 @@
-import type { User, DrawingStyle } from '@annotorious/openseadragon';
 import type { Component } from 'svelte';
 import type { PluginUiTarget } from '@triiiceratops/plugin-sdk';
-import type { PointStyle } from 'triiiceratops/image-export';
 import type { W3CAnnotation, AdapterLoadResult } from './adapters/types';
-export type { PointStyle };
+/**
+ * The person an annotation is attributed to. Only `id` and `name` are ever
+ * read — they are what creator stamping writes onto a new annotation — so the
+ * shape is declared here rather than borrowed from a drawing library.
+ */
+export interface AnnotationEditorUser {
+    id: string;
+    name?: string;
+}
 export interface AnnotationEditorRuntimeContext<HostContext = unknown, TBody = W3CAnnotationBody> {
     manifestId: string | null;
     canvasId: string | null;
     isEditing: boolean;
     selectedAnnotation: W3CAnnotation<TBody> | null;
-    user?: User;
+    user?: AnnotationEditorUser;
     hostContext: HostContext | null;
 }
 export interface AnnotationEditorExtension<HostContext = unknown, TBody = W3CAnnotationBody> {
@@ -115,16 +121,7 @@ export interface AnnotationEditorConfig<TBody = W3CAnnotationBody, THostContext
     /** Storage adapter for persistence */
     adapter?: AnnotationStorageAdapter<TBody>;
     /** Current user for attribution */
-    user?: User;
-    /** Drawing style for annotations while editing */
-    drawingStyle?: DrawingStyle;
-    /**
-     * Marker styling for point annotations (`PointSelector`). Consumed by both
-     * the read-only overlay and the editor so a point looks the same selected or
-     * not; `radius` is in screen pixels. Defaults to a red marker of radius 5
-     * (spec §3.4).
-     */
-    pointStyle?: PointStyle;
+    user?: AnnotationEditorUser;
     /** Available drawing tools */
     tools?: DrawingTool[];
     /** Default drawing tool */
@@ -157,7 +154,7 @@ export interface AnnotationEditorConfig<TBody = W3CAnnotationBody, THostContext
      */
     onPersistenceError?: (error: AnnotationPersistenceError) => void;
 }
-export type DrawingTool = 'rectangle' | 'polygon' | 'point';
+export type DrawingTool = 'rectangle' | 'ellipse' | 'polygon' | 'point' | 'wholeCanvas';
 /** W3C Annotation Body */
 export interface W3CAnnotationBody {
     type?: string;

package/dist/viewerMirror.svelte.d.ts

@@ -5,19 +5,44 @@
  * OWN Svelte runtime) reads `viewerState.canvasId` inside an `$effect`, no
  * dependency is registered because the two reactivity graphs don't cross. The
  * plugin therefore mirrors the handful of fields its UI reacts to
- * (`manifestId`, `canvasId`, `osdViewer`) into plugin-runtime `$state`, kept in
+ * (`manifestId`, `canvasId`, `annotatableCanvasIds`, `surfaceOpen`) into
+ * plugin-runtime `$state`, kept in
  * sync through the framework-neutral `ViewerState.subscribe` fan-out. Every other
  * member/method (queries, display sync, the annotation-edit bus, the style root)
  * delegates straight to the real state, so a mirror is a drop-in `ViewerState`
- * for the controller, loader, manager, and store.
+ * for the controller, loader, drawing layer, and store.
  */
+import type { PluginSurface } from '@triiiceratops/plugin-sdk';
 import type { ViewerState } from 'triiiceratops';
+/**
+ * The mirror as the plugin's UI consumes it: core's `ViewerState`, plus the
+ * mirrored fields core has no `ViewerState` member for.
+ */
+export type MirroredViewerState = ViewerState & {
+    readonly surfaceOpen: boolean;
+};
 export declare class ViewerStateMirror {
     #private;
     manifestId: string | null;
     canvasId: string | null;
-    osdViewer: import("openseadragon").Viewer | null;
-    constructor(real: ViewerState);
+    /**
+     * Raw rather than deeply reactive: core replaces the array wholesale, and a
+     * `$state` proxy would never compare equal to the source's own reference,
+     * so the gate below could not tell an unchanged list from a new one. Core
+     * keeps that reference stable while the ids are unchanged.
+     */
+    annotatableCanvasIds: string[];
+    /**
+     * Whether this plugin's own panel/flyout is open — the signal core names as
+     * the way a plugin observes open/close, since it mounts the plugin's
+     * content once per ACTIVATION and only re-parents it in and out of the
+     * surface, so a close destroys no component. It is not a `ViewerState`
+     * member: it reads off `PluginContext.surface`, which is a live projection
+     * over the viewer's plugin UI state, and every mutator of that state
+     * notifies through the same fan-out as the fields above.
+     */
+    surfaceOpen: boolean;
+    constructor(real: ViewerState, surface: PluginSurface);
     /** The per-viewer annotation-edit bus (mutated in place by the controller). */
     get annotationEditBus(): ViewerState['annotationEditBus'];
     getCanvases(manifestId: string, sequenceIndex?: number): unknown[];
@@ -25,11 +50,26 @@ export declare class ViewerStateMirror {
     setUserAnnotations(manifestId: string, canvasId: string, annotations: unknown[]): void;
     clearUserAnnotations(manifestId: string, canvasId: string): void;
     getStyleRoot(): Document | ShadowRoot | null;
+    /**
+     * The owning viewer's config. Read for `pointStyle`, which core's read-only
+     * overlay resolves its own point marker from — the editor has to answer
+     * from the same object or a point changes size the moment it is selected.
+     */
+    get config(): ViewerState['config'];
+    /**
+     * The canvas-space box the viewport shows. The keyboard's place-then-shape
+     * creation reads it to put a default shape at the centre of the view.
+     */
+    get viewportBounds(): ViewerState['viewportBounds'];
+    canvasSize(canvasId?: string): ReturnType<ViewerState['canvasSize']>;
+    canvasToScreen(point: Parameters<ViewerState['canvasToScreen']>[0], canvasId?: string): ReturnType<ViewerState['canvasToScreen']>;
+    screenToCanvas(point: Parameters<ViewerState['screenToCanvas']>[0], canvasId?: string): ReturnType<ViewerState['screenToCanvas']>;
+    subscribeFrame(listener: () => void): () => void;
     /** Drop the bridge's `ViewerState.subscribe` registration. */
     destroy(): void;
 }
-/** Build a mirror and expose it typed as a `ViewerState` for the plugin UI. */
-export declare function createViewerStateMirror(real: ViewerState): {
-    mirror: ViewerState;
+/** Build a mirror and expose it as a `ViewerState` for the plugin UI. */
+export declare function createViewerStateMirror(real: ViewerState, surface: PluginSurface): {
+    mirror: MirroredViewerState;
     destroy: () => void;
 };

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@triiiceratops/plugin-annotation-editor",
-    "version": "1.0.0-rc.6",
+    "version": "1.0.0",
     "type": "module",
-    "description": "Annotation editor plugin for the triiiceratops IIIF viewer, authored on @triiiceratops/plugin-sdk.",
+    "description": "Annotation editing for the Triiiceratops IIIF viewer: a first-party drawing layer with rectangle, ellipse, polygon, point and whole-canvas tools, full keyboard parity, and a pluggable storage adapter.",
     "license": "MIT",
     "author": "David Flood",
     "repository": {
@@ -10,12 +10,11 @@
         "url": "git+https://github.com/d-flood/triiiceratops.git",
         "directory": "packages/plugin-annotation-editor"
     },
-    "homepage": "https://d-flood.github.io/triiiceratops/",
+    "homepage": "https://triiiceratops.org/",
     "publishConfig": {
         "access": "public",
         "provenance": true
     },
-    "private": false,
     "engines": {
         "node": ">=22"
     },
@@ -41,7 +40,7 @@
         "./iife": "./dist/iife.js"
     },
     "scripts": {
-        "build": "pnpm build:esm && pnpm build:iife && pnpm build:types",
+        "build": "pnpm clean && pnpm build:esm && pnpm build:iife && pnpm build:types",
         "build:esm": "BUILD_FORMAT=es vite build",
         "build:iife": "BUILD_FORMAT=iife vite build",
         "build:types": "tsc -p tsconfig.build.json",
@@ -53,24 +52,18 @@
         "lint:fix": "eslint . --fix --max-warnings 0"
     },
     "peerDependencies": {
-        "triiiceratops": "^1.0.0-rc.30",
-        "@triiiceratops/plugin-sdk": "^1.0.0-rc.5"
-    },
-    "dependencies": {
-        "@annotorious/annotorious": "^3.7.19",
-        "@annotorious/openseadragon": "^3.7.19",
-        "openseadragon": "^5.0.1"
+        "triiiceratops": "^1.0.0",
+        "@triiiceratops/plugin-sdk": "^1.0.0"
     },
     "devDependencies": {
-        "@sveltejs/vite-plugin-svelte": "^6.2.1",
-        "@triiiceratops/plugin-sdk": "1.0.0-rc.5",
+        "@sveltejs/vite-plugin-svelte": "^6.2.4",
+        "@triiiceratops/plugin-sdk": "1.0.0",
         "@triiiceratops/ui": "0.0.0",
         "@types/node": "^24.10.1",
-        "@types/openseadragon": "^5.0.1",
         "@vitest/coverage-v8": "4.0.15",
-        "svelte": "5.45.5",
+        "svelte": "5.56.10",
         "svelte-check": "^4.3.4",
-        "triiiceratops": "1.0.0-rc.30",
+        "triiiceratops": "1.0.0",
         "typescript": "~5.9.3",
         "vite": "^6.0.0",
         "vitest": "^4.0.15"