react-iiif-vault 0.9.7 → 0.9.10

package/dist/index.d.ts

@@ -1,20 +1,23 @@
 import * as _atlas_viewer_atlas from '@atlas-viewer/atlas';
 import * as React from 'react';
-import React__default, { ReactNode, FC } from 'react';
+import React__default, { ReactNode, RefObject } from 'react';
 import * as _iiif_presentation_3 from '@iiif/presentation-3';
-import { InternationalString, ImageService, AnnotationPageNormalized, ContentResource, IIIFExternalWebResource, SpecificResource, AnnotationNormalized, CanvasNormalized, CollectionNormalized, Reference, ManifestNormalized, RangeNormalized, SearchService, Annotation, ExternalWebResource, W3CAnnotationTarget, Selector } from '@iiif/presentation-3';
+import { InternationalString, ImageService, AnnotationPageNormalized, ContentResource, IIIFExternalWebResource, SpecificResource, AnnotationNormalized, CanvasNormalized, CollectionNormalized, Reference, ManifestNormalized, RangeNormalized, SearchService, Annotation, ExternalWebResource as ExternalWebResource$1, W3CAnnotationTarget, Selector } from '@iiif/presentation-3';
 import { AtlasProps } from '@atlas-viewer/atlas/dist/types/modules/react-reconciler/Atlas';
 import { Vault, VaultOptions, ReduxStore, NormalizedEntity, IIIFStore } from '@iiif/vault';
+import { ExternalWebResource } from '@iiif/presentation-3/resources/annotation';
 import { ImageCandidate, ImageServiceLoader, ImageCandidateRequest } from '@atlas-viewer/iiif-image-api';
 import * as _iiif_vault__ from '@iiif/vault/*';
 import * as _iiif_vault_helpers from '@iiif/vault-helpers';
 
-declare function Viewer({ children, ...props }: AtlasProps & {
+declare function Viewer({ children, errorFallback, outerContainerProps, ...props }: AtlasProps & {
     height?: number | string;
     width?: number | string;
     resizeHash?: number;
     containerProps?: any;
+    outerContainerProps?: any;
     aspectRatio?: number;
+    errorFallback?: any;
 } & {
     children: ReactNode;
 }): JSX.Element;
@@ -114,8 +117,8 @@ declare type SingleVideo = {
     url: string;
     format: string;
     duration: number;
-    target: TemporalBoxSelector;
-    selector: TemporalBoxSelector;
+    target: TemporalSelector | TemporalBoxSelector;
+    selector: TemporalSelector | TemporalBoxSelector;
 };
 declare type AudioSequence = {
     type: 'SoundSequence';
@@ -162,6 +165,13 @@ declare type SingleImageStrategy = {
 };
 declare function getImageStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType): RenderingStrategy;
 
+declare type Single3DModelStrategy = {
+    type: '3d-model';
+    model: ExternalWebResource;
+    choice?: ChoiceDescription;
+    annotations?: AnnotationPageDescription;
+};
+
 declare type MediaStrategy = {
     type: 'media';
     media: SingleAudio | SingleVideo | AudioSequence | VideoSequence;
@@ -179,7 +189,7 @@ declare type UnknownStrategy = {
     reason?: string;
     annotations?: AnnotationPageDescription;
 };
-declare type RenderingStrategy = SingleImageStrategy | MediaStrategy | ComplexTimelineStrategy | UnknownStrategy;
+declare type RenderingStrategy = SingleImageStrategy | MediaStrategy | ComplexTimelineStrategy | Single3DModelStrategy | UnknownStrategy;
 
 declare type StrategyActions = {
     makeChoice: (id: string, options?: {
@@ -206,17 +216,22 @@ declare type CanvasProps = {
         opacity?: number;
     }>;
     isStatic?: boolean;
+    children?: ReactNode;
+    renderViewerControls?: (strategy: SingleImageStrategy) => ReactNode;
+    renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
+    strategies?: Array<RenderingStrategy['type']>;
 };
-declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic }: CanvasProps): JSX.Element | null;
+declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, strategies, children, }: CanvasProps): JSX.Element | null;
 
-declare function RenderImage({ id, image, thumbnail, isStatic, x, y, annotations, }: {
+declare function RenderImage({ id, image, thumbnail, isStatic, x, y, annotations, children, }: {
     id: string;
     image: ImageWithOptionalService;
     thumbnail?: ImageCandidate;
     isStatic?: boolean;
     x?: number;
     y?: number;
-    annotations?: JSX.Element;
+    annotations?: ReactNode;
+    children?: ReactNode;
 }): JSX.Element;
 
 declare const CanvasPanel: {
@@ -235,25 +250,85 @@ declare const CanvasPanel: {
     Viewer: typeof Viewer;
 };
 
-declare const AnnotationContext: React__default.FC<{
+declare function AnnotationContext({ annotation, children }: {
     annotation: string;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
-declare const CanvasContext: React__default.FC<{
+declare function CanvasContext({ canvas, children }: {
     canvas: string;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
-declare const CollectionContext: React__default.FC<{
+declare function CollectionContext({ collection, children }: {
     collection: string;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
-declare const ManifestContext: React__default.FC<{
+declare function ManifestContext({ manifest, children }: {
     manifest: string;
-}>;
+    children: ReactNode;
+}): JSX.Element;
+
+declare type MediaPlayerState = {
+    isPlaying: boolean;
+    isMuted: boolean;
+    playRequested: boolean;
+    volume: number;
+    isFinished: boolean;
+    duration: number;
+};
+declare type MediaPlayerActions = {
+    play(): void;
+    pause(): void;
+    playPause(): void;
+    mute(): void;
+    unmute(): void;
+    toggleMute(): void;
+    setVolume(volume: number): void;
+    setDurationPercent(percent: number): void;
+    setTime(time: number): void;
+};
+declare function formatTime(time: number): string;
+declare function useSimpleMediaPlayer(props: {
+    duration: number;
+}): readonly [
+    {
+        element: RefObject<HTMLAudioElement | HTMLVideoElement>;
+        currentTime: RefObject<HTMLDivElement>;
+        progress: RefObject<HTMLDivElement>;
+    },
+    MediaPlayerState,
+    MediaPlayerActions
+];
+
+declare function useMediaState(): MediaPlayerState;
+declare function useMediaActions(): MediaPlayerActions;
+declare function useMediaElements(): {
+    element: RefObject<HTMLAudioElement | HTMLVideoElement>;
+    currentTime: RefObject<HTMLDivElement>;
+    progress: RefObject<HTMLDivElement>;
+};
+declare function MediaPlayerProvider({ actions, state, children, currentTime, progress, element, }: {
+    actions: MediaPlayerActions;
+    state: MediaPlayerState;
+    children: ReactNode;
+    currentTime: RefObject<HTMLDivElement>;
+    progress: RefObject<HTMLDivElement>;
+    element: RefObject<HTMLAudioElement | HTMLVideoElement>;
+}): JSX.Element;
+
+declare const PortalContext: React__default.Context<HTMLDivElement | null>;
+declare const OverlayPortalContext: React__default.Context<HTMLDivElement | null>;
+declare function CanvasPortal({ children, overlay }: {
+    children: ReactNode;
+    overlay?: boolean;
+}): null;
 
-declare const RangeContext: React__default.FC<{
+declare function RangeContext({ range, children }: {
     range: string;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
 declare type ResourceContextType = {
     collection?: string;
@@ -264,20 +339,22 @@ declare type ResourceContextType = {
 };
 declare const ResourceReactContext: React__default.Context<ResourceContextType>;
 declare const useResourceContext: () => ResourceContextType;
-declare const ResourceProvider: React__default.FC<{
+declare function ResourceProvider({ value, children }: {
     value: ResourceContextType;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
 declare const ReactVaultContext: React__default.Context<{
     vault: Vault | null;
     setVaultInstance: (vault: Vault) => void;
 }>;
-declare const VaultProvider: React__default.FC<{
+declare function VaultProvider({ vault, vaultOptions, useGlobal, resources, children, }: {
     vault?: Vault;
     useGlobal?: boolean;
     vaultOptions?: VaultOptions;
     resources?: ResourceContextType;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
 declare function useContextBridge(): {
     VaultContext: {
@@ -296,9 +373,10 @@ declare function useContextBridge(): {
     };
     VisibleCanvasReactContext: string[];
 };
-declare const ContextBridge: React__default.FC<{
+declare function ContextBridge(props: {
     bridge: ReturnType<typeof useContextBridge>;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 
 declare const VisibleCanvasReactContext: React__default.Context<string[]>;
 declare function useVisibleCanvases(): CanvasNormalized[];
@@ -488,7 +566,7 @@ declare function VirtualAnnotationProvider({ children }: {
 
 declare type SupportedTarget = {
     type: 'SpecificResource';
-    source: ExternalWebResource | {
+    source: ExternalWebResource$1 | {
         id: string;
         type: 'Unknown' | 'Canvas' | 'Range' | 'Manifest';
         partOf?: Array<{
@@ -527,10 +605,11 @@ declare type SimpleViewerContext = {
     previousCanvas: () => void;
 };
 declare const SimpleViewerReactContext: React__default.Context<SimpleViewerContext>;
-declare const SimpleViewerProvider: FC<{
+declare function SimpleViewerProvider(props: {
     manifest: string;
     pagingEnabled?: boolean;
-}>;
+    children: ReactNode;
+}): JSX.Element;
 declare function useSimpleViewer(): SimpleViewerContext;
 
-export { AnnotationContext, AnnotationPageDescription, AudioSequence, BoxSelector, CanvasContext, CanvasPanel, ChoiceDescription, CollectionContext, ComplexChoice, ComplexTimelineStrategy, ContextBridge, ImageServiceLoaderContext, ImageServiceLoaderType, ImageServiceRequestOptions, ImageWithOptionalService, ManifestContext, MediaStrategy, Paintables, ParsedSelector, PointSelector, RangeContext, ReactVaultContext, RenderingStrategy, ResourceContextType, ResourceProvider, ResourceReactContext, ResourceRequestOptions, SimpleViewerProvider, SimpleViewerReactContext, SingleAudio, SingleChoice, SingleImageStrategy, SingleVideo, StrategyActions, SupportedSelector, SupportedSelectors, SupportedTarget, TemporalBoxSelector, TemporalSelector, UnknownStrategy, UseRenderingStrategy, UseRenderingStrategyOptions, VaultActivatedAnnotation, VaultProvider, VideoSequence, VirtualAnnotationProvider, VisibleCanvasReactContext, emptyActions, expandTarget, flattenAnnotationPageIds, getImageStrategy, getPaintables, parseSelector, parseSpecificResource, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPageManager, useAnnotationsAtTime, useCanvas, useCanvasClock, useCollection, useContextBridge, useDispatch, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useImageService, useImageServiceLoader, useImageTile, useLoadImageService, useManifest, usePaintables, usePaintingAnnotations, useRange, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSimpleViewer, useStyleHelper, useStyles, useThumbnail, useVault, useVaultEffect, useVaultSelector, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };
+export { AnnotationContext, AnnotationPageDescription, AudioSequence, BoxSelector, CanvasContext, CanvasPanel, CanvasPortal, ChoiceDescription, CollectionContext, ComplexChoice, ComplexTimelineStrategy, ContextBridge, ImageServiceLoaderContext, ImageServiceLoaderType, ImageServiceRequestOptions, ImageWithOptionalService, ManifestContext, MediaPlayerActions, MediaPlayerProvider, MediaPlayerState, MediaStrategy, OverlayPortalContext, Paintables, ParsedSelector, PointSelector, PortalContext, RangeContext, ReactVaultContext, RenderingStrategy, ResourceContextType, ResourceProvider, ResourceReactContext, ResourceRequestOptions, SimpleViewerProvider, SimpleViewerReactContext, SingleAudio, SingleChoice, SingleImageStrategy, SingleVideo, StrategyActions, SupportedSelector, SupportedSelectors, SupportedTarget, TemporalBoxSelector, TemporalSelector, UnknownStrategy, UseRenderingStrategy, UseRenderingStrategyOptions, VaultActivatedAnnotation, VaultProvider, VideoSequence, VirtualAnnotationProvider, VisibleCanvasReactContext, emptyActions, expandTarget, flattenAnnotationPageIds, formatTime, getImageStrategy, getPaintables, parseSelector, parseSpecificResource, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPageManager, useAnnotationsAtTime, useCanvas, useCanvasClock, useCollection, useContextBridge, useDispatch, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useImageService, useImageServiceLoader, useImageTile, useLoadImageService, useManifest, useMediaActions, useMediaElements, useMediaState, usePaintables, usePaintingAnnotations, useRange, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSimpleMediaPlayer, useSimpleViewer, useStyleHelper, useStyles, useThumbnail, useVault, useVaultEffect, useVaultSelector, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };