triiiceratops 0.6.0 → 0.7.0

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

@@ -1,4 +1,19 @@
+import { ViewerConfig } from '../types/config';
 import { TriiiceratopsPlugin, PluginMenuButton, PluginPanel } from '../types/plugin';
+/**
+ * Snapshot of viewer state for external consumers.
+ * Used by web component events to expose state without Svelte reactivity.
+ */
+export interface ViewerStateSnapshot {
+    manifestId: string | null;
+    canvasId: string | null;
+    currentCanvasIndex: number;
+    showAnnotations: boolean;
+    showThumbnailGallery: boolean;
+    showSearchPanel: boolean;
+    isFullScreen: boolean;
+    dockSide: string;
+}
 export declare class ViewerState {
     manifestId: string | null;
     canvasId: string | null;
@@ -10,6 +25,10 @@ export declare class ViewerState {
     showMetadataDialog: boolean;
     dockSide: string;
     visibleAnnotationIds: Set<string>;
+    config: ViewerConfig;
+    get showRightMenu(): boolean;
+    get showLeftMenu(): boolean;
+    get showCanvasNav(): boolean;
     galleryPosition: {
         x: number;
         y: number;
@@ -23,7 +42,34 @@ export declare class ViewerState {
         x: number;
         y: number;
     };
-    dragOverSide: "left" | "right" | "bottom" | "top" | null;
+    dragOverSide: "left" | "right" | "top" | "bottom" | null;
+    galleryCenterPanelRect: DOMRect | null;
+    /**
+     * Event target for dispatching CustomEvents.
+     * Only set by TriiiceratopsViewerElement (web component build).
+     * Remains null for Svelte component usage → no events dispatched.
+     */
+    private eventTarget;
+    /**
+     * Set the event target for dispatching state change events.
+     * Called by TriiiceratopsViewerElement to enable event-driven API.
+     */
+    setEventTarget(target: EventTarget): void;
+    /**
+     * Get current state as a plain object snapshot.
+     * Safe to use outside Svelte's reactive system.
+     * NOTE: We calculate currentCanvasIndex inline to avoid triggering the canvases getter
+     * which can cause infinite loops when it auto-sets canvasId.
+     */
+    getSnapshot(): ViewerStateSnapshot;
+    /**
+     * Dispatch a state change event to the web component.
+     * No-op if eventTarget is null (Svelte component usage).
+     *
+     * Uses queueMicrotask to dispatch asynchronously AFTER the current
+     * reactive cycle completes, preventing infinite update loops.
+     */
+    private dispatchStateChange;
     constructor(initialManifestId?: string | null, initialCanvasId?: string | null, initialPlugins?: TriiiceratopsPlugin[]);
     get manifest(): any;
     get canvases(): any;
@@ -34,6 +80,7 @@ export declare class ViewerState {
     previousCanvas(): void;
     setManifest(manifestId: string): void;
     setCanvas(canvasId: string): void;
+    updateConfig(newConfig: ViewerConfig): void;
     toggleAnnotations(): void;
     toggleThumbnailGallery(): void;
     toggleFullScreen(): void;

package/dist/src/lib/types/config.d.ts

@@ -0,0 +1,129 @@
+export interface RequestConfig {
+    /**
+     * Extra headers to send with the IIIF manifest request
+     */
+    headers?: Record<string, string>;
+    /**
+     * Whether to use credentials (cookies) for the request
+     */
+    withCredentials?: boolean;
+}
+export interface GalleryConfig {
+    /**
+     * Where the gallery should be docked by default if shown.
+     * @default 'bottom'
+     */
+    dockPosition?: 'left' | 'right' | 'top' | 'bottom' | 'none';
+    /**
+     * Whether the gallery can be dragged/moved by the user.
+     * @default true
+     */
+    draggable?: boolean;
+    /**
+     * Whether the gallery is currently open/visible.
+     * @default false
+     */
+    open?: boolean;
+    /**
+     * Whether to show the close button on the gallery.
+     * @default true
+     */
+    showCloseButton?: boolean;
+}
+export interface SearchConfig {
+    /**
+     * Where the search panel should appear.
+     * @default 'right'
+     */
+    position?: 'left' | 'right';
+    /**
+     * Whether the search panel is currently open.
+     * @default false
+     */
+    open?: boolean;
+    /**
+     * Whether to show the close button.
+     * @default true
+     */
+    showCloseButton?: boolean;
+}
+export interface AnnotationsConfig {
+    /**
+     * Whether the annotations panel/list is open.
+     * @default false
+     */
+    open?: boolean;
+    /**
+     * Whether annotations are currently visible on the canvas.
+     * @default false
+     */
+    visible?: boolean;
+}
+export interface MenuConfig {
+    /**
+     * Whether the Search button is shown in this menu.
+     * @default true
+     */
+    showSearch?: boolean;
+    /**
+     * Whether the Gallery toggle button is shown in this menu.
+     * @default true
+     */
+    showGallery?: boolean;
+    /**
+     * Whether the Annotations toggle button is shown in this menu.
+     * @default true
+     */
+    showAnnotations?: boolean;
+    /**
+     * Whether the Info/Metadata button is shown in this menu.
+     * @default true
+     */
+    showInfo?: boolean;
+    /**
+     * Whether the Fullscreen button is shown in this menu.
+     * @default true
+     */
+    showFullscreen?: boolean;
+}
+export interface ViewerConfig {
+    /**
+     * Whether the right floating menu is visible.
+     * @default true
+     */
+    showRightMenu?: boolean;
+    /**
+     * Configuration for the right menu items.
+     */
+    rightMenu?: MenuConfig;
+    /**
+     * Whether the left FAB (plugins menu) is visible.
+     * @default true
+     */
+    showLeftMenu?: boolean;
+    /**
+     * Configuration for the left menu items.
+     */
+    leftMenu?: MenuConfig;
+    /**
+     * Whether to show the canvas navigation arrows/controls.
+     * @default true
+     */
+    showCanvasNav?: boolean;
+    /**
+     * Configuration for the thumbnail gallery pane.
+     */
+    gallery?: GalleryConfig;
+    /**
+     * Configuration for the search pane.
+     */
+    search?: SearchConfig;
+    /**
+     * Configuration for annotations.
+     */
+    annotations?: AnnotationsConfig;
+    /**
+     * Configuration for network requests (manifests, etc)
+     */
+    requests?: RequestConfig;
+}