react-iiif-vault 1.2.6 → 1.3.0

package/dist/bundle.d.ts

@@ -17,6 +17,7 @@ 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 * 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';
@@ -123,7 +124,7 @@ type SingleImageStrategy = {
     choice?: ChoiceDescription;
     annotations?: AnnotationPageDescription;
 };
-declare function getImageStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType): RenderingStrategy;
+declare function getImageStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType): SingleImageStrategy | UnknownStrategy;
 
 type Single3DModelStrategy = {
     type: '3d-model';
@@ -153,10 +154,20 @@ type MediaStrategy = {
 };
 type ComplexTimelineStrategy = {
     type: 'complex-timeline';
-    items: Array<ImageWithOptionalService | SingleAudio | SingleVideo>;
+    items: Array<SingleImageStrategy['image'] | SingleAudio | SingleVideo | SingleYouTubeVideo>;
+    keyframes: TimelineKeyframe[];
+    duration: number;
     choice?: ChoiceDescription;
     annotations?: AnnotationPageDescription;
 };
+interface TimelineKeyframe {
+    id: string;
+    type: 'enter' | 'exit' | 'change';
+    resourceType: 'image' | 'audio' | 'video';
+    timeDelta?: number;
+    isPrime?: boolean;
+    time: number;
+}
 type EmptyStrategy = {
     type: 'empty';
     image: null;
@@ -218,6 +229,7 @@ type CanvasProps = {
     renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
     viewControlsDeps?: any[];
     renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
+    renderComplexTimelineControls?: (strategy: ComplexTimelineStrategy) => ReactNode;
     mediaControlsDeps?: any[];
     strategies?: Array<RenderingStrategy['type']>;
     backgroundStyle?: BoxStyle;
@@ -228,7 +240,7 @@ type CanvasProps = {
     throwOnUnknown?: boolean;
     onClickPaintingAnnotation?: (id: string, image: ImageWithOptionalService, e: any) => void;
 };
-declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, 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, children, }: CanvasProps): react_jsx_runtime.JSX.Element | null;
 
 declare function RenderImage({ id, image, thumbnail, isStatic, x, y, children, selector, onClick, enableSizes, }: {
     id: string;
@@ -347,6 +359,7 @@ interface CanvasPanelProps {
     components?: {
         ViewerControls?: FC;
         MediaControls?: FC;
+        ComplexTimelineControls?: FC;
     };
     canvasProps?: Omit<Partial<CanvasProps>, 'x'>;
     annotations?: ReactNode;
@@ -788,23 +801,6 @@ 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 const ReactEventContext: React__default.Context<{
-    emitter: 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;
-}): react_jsx_runtime.JSX.Element;
-
 type MediaPlayerState = {
     isPlaying: boolean;
     isMuted: boolean;
@@ -837,6 +833,58 @@ declare function useSimpleMediaPlayer(props: {
     MediaPlayerActions
 ];
 
+interface ComplexTimelineStore extends MediaPlayerActions {
+    complexTimeline: ComplexTimelineStrategy;
+    visibleElements: Record<string, TimelineKeyframe | null>;
+    isReady: boolean;
+    isBuffering: boolean;
+    bufferMap: Record<string, boolean>;
+    isMuted: boolean;
+    playRequested: boolean;
+    isPlaying: boolean;
+    isFinished: boolean;
+    volume: number;
+    duration: number;
+    primeTime: number;
+    clockRunning: boolean;
+    clockStartTime: number;
+    currentPrime: TimelineKeyframe | null;
+    clockStartRequests: number;
+    startClock: () => void;
+    stopClock: () => void;
+    setElement: (id: string, element: HTMLVideoElement | HTMLAudioElement) => void;
+    removeElement: (id: string) => void;
+    applyKeyframes(newIdx: number, keyframes: TimelineKeyframe[]): void;
+    nextKeyframeIndex: number;
+    setProgressElement(div: HTMLDivElement): void;
+    setCurrentTimeElement(div: HTMLDivElement): void;
+    clearProgressElement(): void;
+    clearCurrentTimeElement(): void;
+}
+
+declare function ComplexTimelineProvider({ children, store, }: {
+    children: React.ReactNode;
+    store: StoreApi$1<ComplexTimelineStore>;
+}): react_jsx_runtime.JSX.Element;
+declare function useComplexTimeline<T>(selector: (store: ComplexTimelineStore) => T): T;
+
+interface EventContext {
+    emitter: Emitter<any>;
+}
+declare const defaultEmitter: Emitter<Record<EventType, unknown>>;
+declare const ReactEventContext: React__default.Context<{
+    emitter: 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;
+}): react_jsx_runtime.JSX.Element;
+
 declare function useMediaState(): MediaPlayerState;
 declare function useMediaActions(): MediaPlayerActions;
 declare function useMediaElements(): {
@@ -1047,10 +1095,10 @@ declare const emptyActions: {
     makeChoice: () => void;
 };
 declare const unknownResponse: UseRenderingStrategy[0];
-declare const unsupportedStrategy: (reason: string) => UseRenderingStrategy[0];
+declare const unsupportedStrategy: (reason: string) => UnknownStrategy;
 declare const emptyStrategy: (width: number, height: number) => UseRenderingStrategy[0];
 
-declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables): RenderingStrategy;
+declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables): UnknownStrategy | MediaStrategy;
 
 interface GetRenderStrategyOptions {
     canvas: CanvasNormalized | null | undefined;
@@ -1060,6 +1108,8 @@ interface GetRenderStrategyOptions {
 }
 declare function getRenderingStrategy({ canvas, paintables, supports, loadImageService }: GetRenderStrategyOptions): RenderingStrategy;
 
+declare function getComplexTimelineStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType): ComplexTimelineStrategy;
+
 declare function useAnnotation(options?: {
     id: string;
 }): AnnotationNormalized | undefined;
@@ -1353,7 +1403,7 @@ declare function LanguageProvider(props: {
     children: ReactNode;
 }): react_jsx_runtime.JSX.Element;
 declare function TransliterationProvider(props: {
-    convert: null | ((input: string) => string);
+    convert: null | ((input: string, targetLang: string) => string);
     children: ReactNode;
 }): react_jsx_runtime.JSX.Element;
 declare function useTransliteration(): ((input: string, targetLang: string) => string) | null;
@@ -1449,4 +1499,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, 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 TextualContentStrategy, 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, 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, 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, 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 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 };