react-iiif-vault 1.2.1 → 1.2.2

package/dist/bundle.d.ts

@@ -1,13 +1,15 @@
 import * as React$1 from 'react';
 import React__default, { ReactNode, FC, RefObject, ForwardRefExoticComponent, RefAttributes, FunctionComponent } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { AtlasProps, BoxStyle, ViewerMode, Preset } from '@atlas-viewer/atlas';
+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, BoxSelector as BoxSelector$1, TemporalBoxSelector as TemporalBoxSelector$1 } from '@iiif/helpers';
+import { ChoiceDescription, Paintables, SupportedTarget, ComplexChoice, 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 { ImageCandidate, RegionParameter, RotationParameter, SizeParameter, ImageServiceLoader, ImageCandidateRequest } from '@atlas-viewer/iiif-image-api';
 import { Vault, VaultOptions, NormalizedEntity, IIIFStore } from '@iiif/helpers/vault';
 import * as polygon_editor from 'polygon-editor';
@@ -15,8 +17,6 @@ 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 * as mitt from 'mitt';
-import { Handler } from 'mitt';
 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';
@@ -30,6 +30,7 @@ declare function Viewer({ children, errorFallback, outerContainerProps, worldSca
     outerContainerProps?: any;
     aspectRatio?: number;
     errorFallback?: any;
+    renderPreset?: Preset;
     worldScale?: number;
 } & {
     children: ReactNode;
@@ -178,11 +179,26 @@ type StrategyActions = {
     }) => void;
 };
 type UseRenderingStrategy = [RenderingStrategy, StrategyActions];
+type ChoiceEvents = {
+    'choice-change': {
+        choice: ComplexChoice;
+        partOf: {
+            canvasId?: string;
+            manifestId?: string;
+        };
+    };
+    'make-choice': {
+        choiceId: string;
+        deselectOthers?: boolean;
+        deselect?: boolean;
+    };
+};
 type UseRenderingStrategyOptions = {
     strategies?: Array<RenderingStrategy['type']>;
     annotationPageManagerId?: string;
     enableSingleAnnotation?: boolean;
     defaultChoices?: string[];
+    emitter?: Emitter<ChoiceEvents>;
 };
 declare function useRenderingStrategy(options?: UseRenderingStrategyOptions): UseRenderingStrategy;
 
@@ -285,15 +301,17 @@ declare function Audio({ media, mediaControlsDeps, children, }: {
     children: ReactNode;
 }): null;
 
-declare function VideoHTML({ element, media, playPause, }: {
-    element: RefObject<any>;
+interface VideoComponentProps {
+    element: RefObject<HTMLVideoElement>;
     media: SingleVideo;
     playPause: () => void;
-}): react_jsx_runtime.JSX.Element;
-declare function Video({ media, mediaControlsDeps, children, }: {
+}
+declare function VideoHTML({ element, media, playPause }: VideoComponentProps): react_jsx_runtime.JSX.Element;
+declare function Video({ media, mediaControlsDeps, children, videoComponent, }: {
     media: SingleVideo;
     mediaControlsDeps?: any[];
     children: ReactNode;
+    videoComponent?: FC<VideoComponentProps>;
 }): null;
 
 declare function ModelHTML({ model }: {
@@ -313,6 +331,8 @@ interface CanvasPanelProps {
     children?: ReactNode;
     mode?: ViewerMode;
     reuseAtlas?: boolean;
+    runtimeOptions?: any;
+    renderPreset?: any;
     height?: number;
     spacing?: number;
     components?: {
@@ -717,9 +737,6 @@ declare const AuthReactContextActions: React$1.Context<AuthContextActions | null
 declare function AuthProvider({ children }: {
     children: ReactNode;
 }): react_jsx_runtime.JSX.Element;
-declare function AuthProvider_Old({ children }: {
-    children: ReactNode;
-}): react_jsx_runtime.JSX.Element;
 declare function useIsAuthEnabled(): boolean;
 declare function useAuthStore(): StoreApi<AuthContextState & AuthContextCurrentActions & AuthContextActions>;
 declare function useAuthActions(): {
@@ -735,11 +752,6 @@ declare function useCurrentAuth(): AuthContextState & AuthContextCurrentActions
 declare function useAuthService(id: string): AuthAccessState | undefined;
 declare function useAuthTokens(id?: string): string | undefined;
 declare function useAuthToken(id: string): string | null;
-declare function useCurrentAuth_old(): AuthContextState & AuthContextCurrentActions;
-declare function useAuthService_old(id: string): AuthState | null;
-declare function useAuthTokens_old(id?: string): string | null;
-declare function useAuthToken_old(id?: string): string | null;
-declare function useAuthActions_old(): AuthContextActions | null;
 interface AuthProps<T, Extra> {
     resource: T;
     extra?: Extra;
@@ -766,6 +778,15 @@ declare function CollectionContext({ collection, children }: {
     children: ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
+interface EventContext {
+    emitter: Emitter<any>;
+}
+declare const defaultEmitter: Emitter<Record<EventType, unknown>>;
+declare function useEventEmitter<Events extends Record<EventType, unknown>>(): Emitter<Events>;
+declare function EventsProvider({ emitter, children }: EventContext & {
+    children: React__default.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
 declare function ManifestContext({ manifest, children }: {
     manifest: string;
     children: ReactNode;
@@ -1062,6 +1083,21 @@ declare function useCanvas<T>(options?: {
     selector: (canvas: CanvasNormalized) => T;
 }, deps?: any[]): T | undefined;
 
+declare function useCanvasChoices({ canvasId }?: {
+    canvasId?: string;
+}): {
+    choices: Array<{
+        canvasId: string;
+        choice: ComplexChoice;
+    }>;
+    actions: {
+        makeChoice: (id: string, options?: {
+            deselectOthers?: boolean;
+            deselect?: boolean;
+        }) => void;
+    };
+};
+
 declare function useCanvasClock(canvasId?: string, autoplay?: boolean): void;
 
 declare function useCanvasSubset(idsOrRefs?: Array<string | Reference>): Reference<'Canvas'>[];
@@ -1387,4 +1423,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, AuthProvider_Old, AuthRContext, AuthReactContext, AuthReactContextActions, type AuthState, CanvasAnnotations, CanvasContext, CanvasPanel, CollectionContext, CombinedMetadata, type ComplexTimelineStrategy, ContextBridge, CreateCustomShape, type CreateCustomShapeProps, type EmptyStrategy, 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, 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 TextualContentStrategy, TranslationProvider, type UnknownStrategy, type UseRenderingStrategy, type UseRenderingStrategyOptions, type VaultActivatedAnnotation, VaultProvider, type VideoSequence, ViewerPresetContext, VirtualAnnotationProvider, VisibleCanvasReactContext, authDetailsForResource, createAuthStateStore, createProbe, emptyActions, emptyStrategy, findAllCanvasesInRange, findFirstCanvasFromRange, findManifestSelectedRange, findSelectedRange, flattenAnnotationPageIds, formatTime, get3dStrategy, getDefaultAnnotationStyles, getImageStrategy, getManifestSequence, getParsedTargetSelector, getRenderingStrategy, getTextualContentStrategy, getVideoStrategy, getVisibleCanvasesFromCanvasId, hasAuth, makeAccessServiceRequest, makeAccessTokenRequest, parseSpecificResource, svgThemes, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPage, useAnnotationPageManager, useAnnotationStyles, useAnnotationsAtTime, useAuthActions, useAuthActions_old, useAuthService, useAuthService_old, useAuthStore, useAuthToken, useAuthToken_old, useAuthTokens, useAuthTokens_old, useCanvas, useCanvasClock, useCanvasSequence, useCanvasSubset, useClosestLanguage, useCollection, useContextBridge, useCreateLocaleString, useCurrentAuth, useCurrentAuth_old, useDispatch, 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, 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, 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, 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 TextualContentStrategy, TranslationProvider, 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, 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, useCanvasSubset, useClosestLanguage, useCollection, 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, useVault, useVaultEffect, useVaultSelector, useViewerPreset, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };