react-iiif-vault 1.3.5 → 1.4.0

package/dist/bundle.d.ts

@@ -1,11 +1,11 @@
 import * as React$1 from 'react';
-import React__default, { ReactNode, FC, RefObject, ForwardRefExoticComponent, RefAttributes, FunctionComponent } from 'react';
+import React__default, { ReactNode, FC, ComponentType, RefObject, ForwardRefExoticComponent, RefAttributes, FunctionComponent, Context } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { AtlasProps, Preset, BoxStyle, ViewerMode } from '@atlas-viewer/atlas';
 import { AnnotationPage, ImageService, 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 * as _iiif_helpers from '@iiif/helpers';
-import { ChoiceDescription, Paintables, SupportedTarget, ComplexChoice, BoxSelector as BoxSelector$1, TemporalBoxSelector as TemporalBoxSelector$1 } from '@iiif/helpers';
+import { ChoiceDescription, Paintables, SupportedTarget, ComplexChoice, BoxSelector as BoxSelector$1, TemporalBoxSelector as TemporalBoxSelector$1, Vault as Vault$1 } from '@iiif/helpers';
 import { BoxSelector, TemporalBoxSelector, TemporalSelector } from '@iiif/helpers/annotation-targets';
 export * from '@iiif/helpers/annotation-targets';
 import * as mitt from 'mitt';
@@ -153,6 +153,13 @@ type MediaStrategy = {
     media: SingleAudio | SingleVideo | AudioSequence | VideoSequence | SingleYouTubeVideo;
     choice?: ChoiceDescription;
     annotations?: AnnotationPageDescription;
+    captions?: Array<{
+        id: string;
+        type: string;
+        format: string;
+        label?: InternationalString;
+        language?: string;
+    }>;
 };
 type ComplexTimelineStrategy = {
     type: 'complex-timeline';
@@ -215,6 +222,38 @@ type UseRenderingStrategyOptions = {
 };
 declare function useRenderingStrategy(options?: UseRenderingStrategyOptions): UseRenderingStrategy;
 
+interface AudioComponentProps {
+    media: SingleAudio;
+    startTime?: number | null;
+    children: ReactNode;
+}
+declare function AudioHTML({ media, startTime, children }: AudioComponentProps): react_jsx_runtime.JSX.Element;
+declare function Audio({ media, mediaControlsDeps, audioCopmonent, children, }: {
+    media: SingleAudio;
+    mediaControlsDeps?: any[];
+    children: ReactNode;
+    audioCopmonent?: ComponentType<AudioComponentProps>;
+}): null;
+
+interface VideoComponentProps {
+    element: RefObject<HTMLVideoElement>;
+    media: SingleVideo;
+    playPause: () => void;
+    canvas: CanvasNormalized;
+    poster?: string;
+    startTime?: number;
+    captions?: MediaStrategy['captions'];
+}
+declare function VideoHTML({ element, media, startTime, playPause, poster }: VideoComponentProps): react_jsx_runtime.JSX.Element;
+declare function Video({ media, mediaControlsDeps, children, videoComponent, captions, }: {
+    media: SingleVideo;
+    mediaControlsDeps?: any[];
+    children: ReactNode;
+    posterCanvasId?: string;
+    videoComponent?: ComponentType<VideoComponentProps>;
+    captions?: MediaStrategy['captions'];
+}): null;
+
 type CanvasProps = {
     x?: number;
     y?: number;
@@ -241,8 +280,12 @@ type CanvasProps = {
     ignoreSize?: boolean;
     throwOnUnknown?: boolean;
     onClickPaintingAnnotation?: (id: string, image: ImageWithOptionalService, e: any) => void;
+    components?: {
+        Video?: React__default.ComponentType<VideoComponentProps>;
+        Audio?: React__default.ComponentType<AudioComponentProps>;
+    };
 };
-declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, renderComplexTimelineControls, viewControlsDeps, mediaControlsDeps, strategies, throwOnUnknown, backgroundStyle, alwaysShowBackground, keepCanvasScale, enableSizes, enableYouTube, onClickPaintingAnnotation, children, }: CanvasProps): react_jsx_runtime.JSX.Element | null;
+declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, renderComplexTimelineControls, viewControlsDeps, mediaControlsDeps, strategies, throwOnUnknown, backgroundStyle, alwaysShowBackground, keepCanvasScale, enableSizes, enableYouTube, onClickPaintingAnnotation, components, children, }: CanvasProps): react_jsx_runtime.JSX.Element | null;
 
 declare function RenderImage({ id, image, thumbnail, isStatic, x, y, children, selector, onClick, enableSizes, }: {
     id: string;
@@ -305,33 +348,6 @@ type SimpleViewerActionsType = {
     };
 }[keyof SimpleViewerActions];
 
-declare function AudioHTML({ media, startTime, children, }: {
-    media: SingleAudio;
-    startTime?: number | null;
-    children: ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function Audio({ media, mediaControlsDeps, children, }: {
-    media: SingleAudio;
-    mediaControlsDeps?: any[];
-    children: ReactNode;
-}): null;
-
-interface VideoComponentProps {
-    element: RefObject<HTMLVideoElement>;
-    media: SingleVideo;
-    playPause: () => void;
-    poster?: string;
-    startTime?: number;
-}
-declare function VideoHTML({ element, media, startTime, playPause, poster }: VideoComponentProps): react_jsx_runtime.JSX.Element;
-declare function Video({ media, mediaControlsDeps, children, videoComponent, }: {
-    media: SingleVideo;
-    mediaControlsDeps?: any[];
-    children: ReactNode;
-    posterCanvasId?: string;
-    videoComponent?: FC<VideoComponentProps>;
-}): null;
-
 declare function ModelHTML({ model }: {
     model: any;
 }): react_jsx_runtime.JSX.Element;
@@ -956,6 +972,20 @@ interface Search1Store {
     nextResult: () => void;
 }
 
+declare function useCustomContextBridge(): Record<string, {
+    value: any;
+    Provider: React__default.Provider<any>;
+}>;
+declare function CustomContextBridge(props: Record<string, {
+    value: any;
+    Provider: React__default.Provider<any>;
+}> & {
+    children: React__default.ReactNode;
+}): ReactNode;
+declare function CustomContextBridgeProvider(props: {
+    providers: Record<string, Context<any>>;
+    children: React__default.ReactNode;
+}): react_jsx_runtime.JSX.Element;
 declare function useContextBridge(): {
     VaultContext: {
         vault: _iiif_helpers.Vault | null;
@@ -972,6 +1002,7 @@ declare function useContextBridge(): {
 };
 declare function ContextBridge(props: {
     bridge: ReturnType<typeof useContextBridge>;
+    custom?: ReturnType<typeof useCustomContextBridge>;
     children: ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
@@ -1100,17 +1131,18 @@ 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): UnknownStrategy | MediaStrategy;
+declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables, vault: Vault$1): UnknownStrategy | MediaStrategy;
 
 interface GetRenderStrategyOptions {
     canvas: CanvasNormalized | null | undefined;
     paintables: Paintables$1;
     supports: string[];
     loadImageService: ImageServiceLoaderType;
+    vault: Vault$1;
 }
-declare function getRenderingStrategy({ canvas, paintables, supports, loadImageService }: GetRenderStrategyOptions): RenderingStrategy;
+declare function getRenderingStrategy({ canvas, paintables, supports, loadImageService, vault, }: GetRenderStrategyOptions): RenderingStrategy;
 
-declare function getComplexTimelineStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType): ComplexTimelineStrategy;
+declare function getComplexTimelineStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType, vault: Vault$1): ComplexTimelineStrategy;
 
 declare function useAnnotation(options?: {
     id: string;
@@ -1501,4 +1533,4 @@ declare function findAllCanvasesInRange(vault: Vault, range: RangeNormalized): A
 declare function findManifestSelectedRange(vault: Vault, manifest: ManifestNormalized, canvasId: string): null | RangeNormalized;
 declare function findSelectedRange(vault: Vault, range: RangeNormalized, canvasId: string): null | RangeNormalized;
 
-export { AnnotationContext, AnnotationPageContext, type AnnotationPageDescription, AnnotationStyleProvider, type AnnotationStyles, type AnnotationThemeDefinition, type AudioSequence, Auth, type AuthAccessState, type AuthContextActions, type AuthContextCurrentActions, type AuthContextState, AuthProvider, AuthRContext, AuthReactContext, AuthReactContextActions, type AuthState, CanvasAnnotations, CanvasContext, CanvasPanel, type ChoiceEvents, CollectionContext, CombinedMetadata, ComplexTimelineProvider, type ComplexTimelineStrategy, ContextBridge, CreateCustomShape, type CreateCustomShapeProps, type EmptyStrategy, EventsProvider, Image, type ImageProps, ImageServiceLoaderContext, type ImageServiceLoaderType, type ImageServiceRequestOptions, type ImageWithOptionalService, InnerViewerProvider, LanguageProvider, LanguageString, LocaleString, ManifestContext, ManifestMetadata, type MediaPlayerActions, MediaPlayerProvider, type MediaPlayerState, type MediaStrategy, Metadata, type MetadataProps, PolygonSelector, type PolygonSelectorProps, type ProbeStore, RangeContext, ReactEventContext, ReactVaultContext, RenderSvgEditorControls, type RenderingStrategy, type ResourceContextType, ResourceProvider, ResourceReactContext, type ResourceRequestOptions, SelectorControllerProvider, type SelectorHelperEventTypes, SequenceThumbnails, type SimpleViewerActions, type SimpleViewerActionsType, type SimpleViewerContext, type SimpleViewerProps, SimpleViewerProvider, SimpleViewerReactContext, type SimpleViewerReducerState, type Single3DModelStrategy, type SingleAudio, SingleCanvasThumbnail, type SingleImageStrategy, type SingleVideo, type SingleYouTubeVideo, type StrategyActions, type SvgTheme, type TextContent, type TextualContentStrategy, type TimelineKeyframe, TranslationProvider, TransliterationProvider, type UnknownStrategy, type UseRenderingStrategy, type UseRenderingStrategyOptions, type VaultActivatedAnnotation, VaultProvider, type VideoSequence, ViewerPresetContext, VirtualAnnotationProvider, VisibleCanvasReactContext, authDetailsForResource, createAuthStateStore, createProbe, defaultEmitter, emptyActions, emptyStrategy, findAllCanvasesInRange, findFirstCanvasFromRange, findManifestSelectedRange, findSelectedRange, flattenAnnotationPageIds, formatTime, get3dStrategy, getComplexTimelineStrategy, getDefaultAnnotationStyles, getImageStrategy, getManifestSequence, getParsedTargetSelector, getRenderingStrategy, getTextualContentStrategy, getVideoStrategy, getVisibleCanvasesFromCanvasId, hasAuth, makeAccessServiceRequest, makeAccessTokenRequest, parseSpecificResource, svgThemes, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPage, useAnnotationPageManager, useAnnotationStyles, useAnnotationsAtTime, useAuthActions, useAuthService, useAuthStore, useAuthToken, useAuthTokens, useCanvas, useCanvasChoices, useCanvasClock, useCanvasSequence, useCanvasStartTime, useCanvasSubset, useClosestLanguage, useCollection, useComplexTimeline, useContextBridge, useCreateLocaleString, useCurrentAuth, useDispatch, useEventEmitter, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useIIIFLanguage, useImage, useImageService, useImageServiceLoader, useImageTile, useIsAuthEnabled, useLoadImageService, useLocaleString, useManifest, useMediaActions, useMediaElements, useMediaState, usePaintables, usePaintingAnnotations, usePolygonHelper, useRange, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSelectorController, useSelectorEmitter, useSelectorEvents, useSelectorHelper, useSimpleMediaPlayer, useSimpleViewer, useStyleHelper, useStyles, useSvgEditor, useThumbnail, useTranslations, useTransliteration, useVault, useVaultEffect, useVaultSelector, useViewerPreset, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };
+export { AnnotationContext, AnnotationPageContext, type AnnotationPageDescription, AnnotationStyleProvider, type AnnotationStyles, type AnnotationThemeDefinition, type AudioSequence, Auth, type AuthAccessState, type AuthContextActions, type AuthContextCurrentActions, type AuthContextState, AuthProvider, AuthRContext, AuthReactContext, AuthReactContextActions, type AuthState, CanvasAnnotations, CanvasContext, CanvasPanel, type ChoiceEvents, CollectionContext, CombinedMetadata, ComplexTimelineProvider, type ComplexTimelineStrategy, ContextBridge, CreateCustomShape, type CreateCustomShapeProps, CustomContextBridge, CustomContextBridgeProvider, type EmptyStrategy, EventsProvider, Image, type ImageProps, ImageServiceLoaderContext, type ImageServiceLoaderType, type ImageServiceRequestOptions, type ImageWithOptionalService, InnerViewerProvider, LanguageProvider, LanguageString, LocaleString, ManifestContext, ManifestMetadata, type MediaPlayerActions, MediaPlayerProvider, type MediaPlayerState, type MediaStrategy, Metadata, type MetadataProps, PolygonSelector, type PolygonSelectorProps, type ProbeStore, RangeContext, ReactEventContext, ReactVaultContext, RenderSvgEditorControls, type RenderingStrategy, type ResourceContextType, ResourceProvider, ResourceReactContext, type ResourceRequestOptions, SelectorControllerProvider, type SelectorHelperEventTypes, SequenceThumbnails, type SimpleViewerActions, type SimpleViewerActionsType, type SimpleViewerContext, type SimpleViewerProps, SimpleViewerProvider, SimpleViewerReactContext, type SimpleViewerReducerState, type Single3DModelStrategy, type SingleAudio, SingleCanvasThumbnail, type SingleImageStrategy, type SingleVideo, type SingleYouTubeVideo, type StrategyActions, type SvgTheme, type TextContent, type TextualContentStrategy, type TimelineKeyframe, TranslationProvider, TransliterationProvider, type UnknownStrategy, type UseRenderingStrategy, type UseRenderingStrategyOptions, type VaultActivatedAnnotation, VaultProvider, type VideoSequence, ViewerPresetContext, VirtualAnnotationProvider, VisibleCanvasReactContext, authDetailsForResource, createAuthStateStore, createProbe, defaultEmitter, emptyActions, emptyStrategy, findAllCanvasesInRange, findFirstCanvasFromRange, findManifestSelectedRange, findSelectedRange, flattenAnnotationPageIds, formatTime, get3dStrategy, getComplexTimelineStrategy, getDefaultAnnotationStyles, getImageStrategy, getManifestSequence, getParsedTargetSelector, getRenderingStrategy, getTextualContentStrategy, getVideoStrategy, getVisibleCanvasesFromCanvasId, hasAuth, makeAccessServiceRequest, makeAccessTokenRequest, parseSpecificResource, svgThemes, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPage, useAnnotationPageManager, useAnnotationStyles, useAnnotationsAtTime, useAuthActions, useAuthService, useAuthStore, useAuthToken, useAuthTokens, useCanvas, useCanvasChoices, useCanvasClock, useCanvasSequence, useCanvasStartTime, useCanvasSubset, useClosestLanguage, useCollection, useComplexTimeline, useContextBridge, useCreateLocaleString, useCurrentAuth, useCustomContextBridge, useDispatch, useEventEmitter, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useIIIFLanguage, useImage, useImageService, useImageServiceLoader, useImageTile, useIsAuthEnabled, useLoadImageService, useLocaleString, useManifest, useMediaActions, useMediaElements, useMediaState, usePaintables, usePaintingAnnotations, usePolygonHelper, useRange, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSelectorController, useSelectorEmitter, useSelectorEvents, useSelectorHelper, useSimpleMediaPlayer, useSimpleViewer, useStyleHelper, useStyles, useSvgEditor, useThumbnail, useTranslations, useTransliteration, useVault, useVaultEffect, useVaultSelector, useViewerPreset, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };