react-iiif-vault 1.4.0 → 1.5.0

package/dist/bundle.d.ts

@@ -2,22 +2,23 @@ import * as React$1 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 { 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 * as _iiif_helpers from '@iiif/helpers';
-import { ChoiceDescription, Paintables, SupportedTarget, ComplexChoice, 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, 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';
 import { Emitter, EventType, Handler } from 'mitt';
-import { ImageCandidate, RegionParameter, RotationParameter, SizeParameter, ImageServiceLoader, ImageCandidateRequest } from '@atlas-viewer/iiif-image-api';
 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';
 import { RenderState, InputShape, SlowState } from 'polygon-editor';
 import * as zustand_vanilla from 'zustand/vanilla';
 import { StoreApi } from 'zustand/vanilla';
 import * as zustand from 'zustand';
 import { StoreApi as StoreApi$1 } from 'zustand';
+import { ImageServiceLoader, ImageCandidateRequest, ImageCandidate as ImageCandidate$1 } from '@iiif/helpers/image-service';
 import * as _iiif_helpers_painting_annotations from '@iiif/helpers/painting-annotations';
 import { Paintables as Paintables$1 } from '@iiif/helpers/painting-annotations';
 import { VaultZustandStore } from '@iiif/helpers/vault/store';
@@ -53,7 +54,7 @@ type ImageWithOptionalService = {
     id: string;
     annotationId: string;
     type: 'Image';
-    service?: ImageService;
+    service?: ImageService$1;
     width?: number;
     height?: number;
     sizes?: Array<{
@@ -114,8 +115,14 @@ type AnnotationPageDescription = {
 type ImageServiceLoaderType = (imageService: any | undefined, { height, width }: {
     height: number;
     width: number;
-}) => ImageService | undefined;
-declare function useLoadImageService(): readonly [ImageServiceLoaderType, Record<string, string>];
+}) => ImageService$1 | undefined;
+declare function useLoadImageService(): readonly [ImageServiceLoaderType, Record<string, {
+    status: "error" | "loading" | "done";
+    service: ImageService$1 | null;
+    error?: boolean | undefined;
+    errorMesage?: string | undefined;
+    real?: boolean | undefined;
+}>];
 
 type SingleImageStrategy = {
     type: 'images';
@@ -271,6 +278,7 @@ type CanvasProps = {
     viewControlsDeps?: any[];
     renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
     renderComplexTimelineControls?: (strategy: ComplexTimelineStrategy) => ReactNode;
+    complexTimelineControlsDeps?: any[];
     mediaControlsDeps?: any[];
     strategies?: Array<RenderingStrategy['type']>;
     backgroundStyle?: BoxStyle;
@@ -285,7 +293,7 @@ type CanvasProps = {
         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, components, children, }: CanvasProps): react_jsx_runtime.JSX.Element | null;
+declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, renderComplexTimelineControls, complexTimelineControlsDeps, viewControlsDeps, mediaControlsDeps, strategies, throwOnUnknown, backgroundStyle, alwaysShowBackground, keepCanvasScale, enableSizes, enableYouTube, onClickPaintingAnnotation, components, children, }: CanvasProps): react_jsx_runtime.JSX.Element;
 
 declare function RenderImage({ id, image, thumbnail, isStatic, x, y, children, selector, onClick, enableSizes, }: {
     id: string;
@@ -399,6 +407,81 @@ type CanvasPanelType = ForwardRefExoticComponent<CanvasPanelProps & RefAttribute
 };
 declare const CanvasPanel: CanvasPanelType;
 
+interface CanvasStrategyProviderProps {
+    onChoiceChange?: (choice?: ChoiceDescription) => void;
+    strategies?: Array<RenderingStrategy['type']>;
+    registerActions?: (actions: StrategyActions) => void;
+    defaultChoices?: Array<{
+        id: string;
+        opacity?: number;
+    }>;
+    children: ReactNode;
+    renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
+    viewControlsDeps?: any[];
+    renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
+    renderComplexTimelineControls?: (strategy: ComplexTimelineStrategy) => ReactNode;
+    complexTimelineControlsDeps?: any[];
+    mediaControlsDeps?: any[];
+    throwOnUnknown?: boolean;
+}
+declare function CanvasStrategyProvider({ strategies, registerActions, defaultChoices, onChoiceChange, mediaControlsDeps, renderMediaControls, renderViewerControls, viewControlsDeps, renderComplexTimelineControls, complexTimelineControlsDeps, throwOnUnknown, children, }: CanvasStrategyProviderProps): react_jsx_runtime.JSX.Element;
+
+interface CanvasWorldObjectProps {
+    x?: number;
+    y?: number;
+    keepCanvasScale?: boolean;
+    children?: ReactNode;
+}
+declare function CanvasWorldObject({ x, y, keepCanvasScale, children }: CanvasWorldObjectProps): react_jsx_runtime.JSX.Element | null;
+
+declare function ThumbnailFallbackImage({ x, y }: {
+    x?: number;
+    y?: number;
+}): react_jsx_runtime.JSX.Element | null;
+
+interface RenderEmptyStrategyProps {
+    backgroundStyle?: BoxStyle;
+    alwaysShowBackground?: boolean;
+}
+declare function RenderEmptyStrategy({ backgroundStyle, alwaysShowBackground }: RenderEmptyStrategyProps): react_jsx_runtime.JSX.Element | null;
+
+declare function RenderComplexTimelineStrategy(): react_jsx_runtime.JSX.Element | null;
+
+interface TextualContextStrategyProps {
+    onClickPaintingAnnotation?: (id: string, e: any) => void;
+    children?: ReactNode;
+}
+declare function RenderTextualContentStrategy({ onClickPaintingAnnotation, children }: TextualContextStrategyProps): react_jsx_runtime.JSX.Element | null;
+
+interface ImageStrategyProps {
+    isStatic?: boolean;
+    enableSizes?: boolean;
+    onClickPaintingAnnotation?: (id: string, image: ImageWithOptionalService, e: any) => void;
+    children?: ReactNode;
+}
+declare function RenderImageStrategy({ isStatic, enableSizes, onClickPaintingAnnotation, children, }: ImageStrategyProps): react_jsx_runtime.JSX.Element | null;
+
+declare function Render3DModelStrategy(): react_jsx_runtime.JSX.Element | null;
+
+interface AnnotationStrategyProps {
+    children?: ReactNode;
+}
+declare function RenderAnnotationStrategy({ children }: AnnotationStrategyProps): react_jsx_runtime.JSX.Element | null;
+
+interface RenderAudioStrategyProps {
+    as?: React.ComponentType<AudioComponentProps>;
+}
+declare function RenderAudioStrategy({ as: CustomAudio }: RenderAudioStrategyProps): react_jsx_runtime.JSX.Element | null;
+
+declare function RenderAccompanyingCanvas(): react_jsx_runtime.JSX.Element;
+
+interface RenderVideoStrategyProps {
+    as?: React__default.ComponentType<VideoComponentProps>;
+}
+declare function RenderVideoStrategy({ as: CustomVideo }: RenderVideoStrategyProps): react_jsx_runtime.JSX.Element | null;
+
+declare function RenderYouTubeStrategy(): react_jsx_runtime.JSX.Element | null;
+
 declare const CanvasAnnotations: React$1.ForwardRefExoticComponent<{
     canvasId?: string | undefined;
 } & React$1.RefAttributes<{
@@ -452,7 +535,7 @@ type CombinedMetadataProps = Omit<MetadataProps, 'metadata'>;
 declare function CombinedMetadata(props: CombinedMetadataProps): react_jsx_runtime.JSX.Element;
 
 interface ImageProps {
-    src: string | ImageService;
+    src: string | ImageService$1;
     alt?: string;
     size?: Partial<ImageSize>;
     region?: RegionParameter;
@@ -687,6 +770,21 @@ interface PolygonSelectorProps {
 }
 declare function PolygonSelector(props: PolygonSelectorProps): react_jsx_runtime.JSX.Element | null;
 
+interface ImageServiceProps {
+    src: string;
+    atlas?: AtlasProps;
+    errorFallback?: React__default.FC;
+    interactive?: boolean;
+    skipSizes?: boolean;
+    renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
+    viewControlsDeps?: any[];
+    fluid?: boolean;
+    x?: number;
+    y?: number;
+    children?: React__default.ReactNode;
+}
+declare function ImageService({ src, errorFallback, interactive, skipSizes, children, renderViewerControls, viewControlsDeps, fluid, x, y, ...atlasProps }: ImageServiceProps & Omit<AtlasProps, 'children'>): react_jsx_runtime.JSX.Element | null;
+
 declare function AnnotationContext({ annotation, children }: {
     annotation: string;
     children: ReactNode;
@@ -1115,6 +1213,24 @@ declare function AnnotationStyleProvider({ theme, children, }: {
     children: React.ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
+interface StrategyContext {
+    strategy: RenderingStrategy;
+    choices: ChoiceDescription | null;
+}
+declare const StrategyReactContext: React$1.Context<StrategyContext | null>;
+declare function useStrategy(): StrategyContext;
+
+interface ControlsContext {
+    renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
+    viewControlsDeps: any[];
+    renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
+    mediaControlsDeps: any[];
+    renderComplexTimelineControls?: (strategy: ComplexTimelineStrategy) => ReactNode;
+    complexTimelineControlsDeps: any[];
+}
+declare const ControlsReactContext: React$1.Context<ControlsContext | null>;
+declare function useRenderControls(): ControlsContext;
+
 /**
  * Parse specific resource.
  *
@@ -1263,7 +1379,7 @@ declare function useExternalManifest(idOrRef: string | {
     manifest?: ManifestNormalized;
 };
 
-declare function useImage(service: ImageService | undefined, data?: {
+declare function useImage(service: ImageService$1 | undefined, data?: {
     size?: Partial<ImageSize>;
     selector?: RegionParameter;
     rotation?: number | RotationParameter;
@@ -1281,7 +1397,7 @@ interface ImageServiceRequestOptions {
  * @note It is better to use the hook useRenderingStrategy for rendering.
  */
 declare function useImageService({ cacheKey }?: ImageServiceRequestOptions): {
-    data: ImageService | undefined;
+    data: ImageService$1 | undefined;
     isFetching: boolean;
     status: 'error' | 'success' | 'loading' | 'idle';
 };
@@ -1292,7 +1408,7 @@ declare function useImageTile(): {
         id: string | undefined;
         width: number | null | undefined;
         height: number | null | undefined;
-        imageService: ImageService;
+        imageService: ImageService$1;
         thumbnail: undefined;
     } | null;
 };
@@ -1342,7 +1458,7 @@ declare function useStyles<Style extends Record<string, any>>(resource: undefine
 declare function useThumbnail(request: ImageCandidateRequest, dereference?: boolean, { canvasId, manifestId }?: {
     canvasId?: string;
     manifestId?: string;
-}): ImageCandidate | undefined;
+}): ImageCandidate$1 | undefined;
 
 declare const useVault: () => Vault;
 
@@ -1533,4 +1649,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, 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 };
+export { AnnotationContext, AnnotationPageContext, type AnnotationPageDescription, type AnnotationStrategyProps, 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, CanvasStrategyProvider, CanvasWorldObject, type ChoiceEvents, CollectionContext, CombinedMetadata, ComplexTimelineProvider, type ComplexTimelineStrategy, ContextBridge, type ControlsContext, ControlsReactContext, CreateCustomShape, type CreateCustomShapeProps, CustomContextBridge, CustomContextBridgeProvider, type EmptyStrategy, EventsProvider, Image, type ImageProps, ImageService, ImageServiceLoaderContext, type ImageServiceLoaderType, type ImageServiceRequestOptions, type ImageStrategyProps, 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, Render3DModelStrategy, RenderAccompanyingCanvas, RenderAnnotationStrategy, RenderAudioStrategy, RenderComplexTimelineStrategy, RenderEmptyStrategy, RenderImageStrategy, RenderSvgEditorControls, RenderTextualContentStrategy, RenderVideoStrategy, RenderYouTubeStrategy, 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 StrategyContext, StrategyReactContext, type SvgTheme, type TextContent, type TextualContentStrategy, ThumbnailFallbackImage, 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, useRenderControls, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSelectorController, useSelectorEmitter, useSelectorEvents, useSelectorHelper, useSimpleMediaPlayer, useSimpleViewer, useStrategy, useStyleHelper, useStyles, useSvgEditor, useThumbnail, useTranslations, useTransliteration, useVault, useVaultEffect, useVaultSelector, useViewerPreset, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };