react-iiif-vault 1.5.0 → 1.5.1

package/dist/bundle.d.ts

@@ -3,13 +3,14 @@ import React__default, { ReactNode, FC, ComponentType, RefObject, ForwardRefExot
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { AtlasProps, Preset, BoxStyle, ViewerMode } from '@atlas-viewer/atlas';
 import { AnnotationPage, ImageService as ImageService$1, ExternalWebResource, InternationalString, Reference, ImageSize, AuthProbeService2, Auth2LocationResource, Auth2SubstituteResource, AuthAccessService2, AuthAccessTokenService2, AuthAccessToken2, SearchServiceQueryParams, SearchServiceSearchResponse, SearchService as SearchService$1, SearchServiceAutocomplete, ContentResource, W3CAnnotationTarget, PointSelector, Annotation } from '@iiif/presentation-3';
-import { AnnotationPageNormalized, CanvasNormalized, AnnotationNormalized, CollectionNormalized, ManifestNormalized, RangeNormalized } from '@iiif/presentation-3-normalized';
+import { AnnotationPageNormalized, AnnotationNormalized, CanvasNormalized, CollectionNormalized, ManifestNormalized, RangeNormalized } from '@iiif/presentation-3-normalized';
 import * as _iiif_helpers from '@iiif/helpers';
-import { ChoiceDescription, Paintables, SupportedTarget, ComplexChoice, ImageCandidate, BoxSelector as BoxSelector$1, TemporalBoxSelector as TemporalBoxSelector$1, Vault as Vault$1 } from '@iiif/helpers';
+import { ChoiceDescription, Paintables, SupportedTarget, ComplexChoice, ImageCandidate, BoxSelector as BoxSelector$1, TemporalBoxSelector as TemporalBoxSelector$1 } from '@iiif/helpers';
 import { BoxSelector, TemporalBoxSelector, TemporalSelector } from '@iiif/helpers/annotation-targets';
 export * from '@iiif/helpers/annotation-targets';
 import * as mitt from 'mitt';
 import { Emitter, EventType, Handler } from 'mitt';
+import * as _iiif_helpers_vault from '@iiif/helpers/vault';
 import { Vault, VaultOptions, NormalizedEntity, IIIFStore } from '@iiif/helpers/vault';
 import { RegionParameter, RotationParameter, SizeParameter } from '@iiif/parser/image-3';
 import * as polygon_editor from 'polygon-editor';
@@ -53,6 +54,7 @@ declare const RenderAnnotationPage: FC<{
 type ImageWithOptionalService = {
     id: string;
     annotationId: string;
+    annotation: AnnotationNormalized;
     type: 'Image';
     service?: ImageService$1;
     width?: number;
@@ -67,6 +69,7 @@ type ImageWithOptionalService = {
 type SingleAudio = {
     type: 'Sound';
     annotationId: string;
+    annotation: AnnotationNormalized;
     url: string;
     format: string;
     duration: number;
@@ -79,6 +82,7 @@ type SingleAudio = {
 type SingleYouTubeVideo = {
     type: 'VideoYouTube';
     annotationId: string;
+    annotation: AnnotationNormalized;
     url: string;
     youTubeId: string;
     duration: number;
@@ -88,6 +92,7 @@ type SingleYouTubeVideo = {
 type SingleVideo = {
     type: 'Video';
     annotationId: string;
+    annotation: AnnotationNormalized;
     url: string;
     format: string;
     duration: number;
@@ -138,6 +143,8 @@ type Single3DModelStrategy = {
     model: ExternalWebResource;
     choice?: ChoiceDescription;
     annotations?: AnnotationPageDescription;
+    annotation: AnnotationNormalized;
+    annotationId: string;
 };
 declare function get3dStrategy(canvas: CanvasNormalized, paintables: Paintables): RenderingStrategy;
 
@@ -149,9 +156,10 @@ type TextualContentStrategy = {
 };
 type TextContent = {
     type: 'Text';
-    annotationId: string;
     text: InternationalString;
     target: SupportedTarget | null;
+    annotationId: string;
+    annotation: AnnotationNormalized;
 };
 declare function getTextualContentStrategy(canvas: CanvasNormalized, paintables: Paintables): RenderingStrategy;
 
@@ -1247,18 +1255,26 @@ declare const unknownResponse: UseRenderingStrategy[0];
 declare const unsupportedStrategy: (reason: string) => UnknownStrategy;
 declare const emptyStrategy: (width: number, height: number) => UseRenderingStrategy[0];
 
-declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables, vault: Vault$1): UnknownStrategy | MediaStrategy;
+type CompatVault = {
+    get: _iiif_helpers_vault.Vault['get'];
+    setMetaValue: _iiif_helpers_vault.Vault['setMetaValue'];
+    getResourceMeta: _iiif_helpers_vault.Vault['getResourceMeta'];
+    load: _iiif_helpers_vault.Vault['load'];
+    requestStatus: _iiif_helpers_vault.Vault['requestStatus'];
+};
+
+declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables, vault: CompatVault): UnknownStrategy | MediaStrategy;
 
 interface GetRenderStrategyOptions {
     canvas: CanvasNormalized | null | undefined;
     paintables: Paintables$1;
     supports: string[];
     loadImageService: ImageServiceLoaderType;
-    vault: Vault$1;
+    vault?: CompatVault;
 }
 declare function getRenderingStrategy({ canvas, paintables, supports, loadImageService, vault, }: GetRenderStrategyOptions): RenderingStrategy;
 
-declare function getComplexTimelineStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType, vault: Vault$1): ComplexTimelineStrategy;
+declare function getComplexTimelineStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType, vault: CompatVault): ComplexTimelineStrategy;
 
 declare function useAnnotation(options?: {
     id: string;