react-iiif-vault 2.0.19 → 4.0.0

package/dist/SimpleViewerContext.types-Df-cpBss.d.cts

@@ -0,0 +1,51 @@
+import * as _iiif_helpers_vault_4 from '@iiif/helpers/vault-4';
+import { Vault } from '@iiif/helpers/vault';
+import { Reference } from '@iiif/parser/presentation-3/types';
+import { ReactNode } from 'react';
+import { q as ViewableContainerReference } from './useRenderingStrategy-Vubk-vUU.cjs';
+
+type SimpleViewerContext = {
+    items: ViewableContainerReference[];
+    sequence: number[][];
+    hasNext: boolean;
+    hasPrevious: boolean;
+    setSequenceIndex: (newId: number) => void;
+    setCurrentCanvasId: (newId: string) => void;
+    setCurrentCanvasIndex: (newId: number) => void;
+    currentSequenceIndex: number;
+    nextCanvas: () => void;
+    previousCanvas: () => void;
+};
+type SimpleViewerProps = {
+    vault?: Vault | _iiif_helpers_vault_4.Vault4;
+    manifest: string;
+    pagingEnabled?: boolean;
+    children: ReactNode;
+    startCanvas?: string;
+    rangeId?: string;
+};
+type SimpleViewerReducerState = {
+    sequence: number[][];
+    availableCanvases: Reference<'Canvas'>[];
+    visibleCanvases: Reference<'Canvas'>[];
+    currentCanvas: string | null;
+    isPaged: boolean;
+    rangeId: string | null;
+};
+interface SimpleViewerActions {
+    setCurrentCanvasId(newId: string): void;
+    setCurrentCanvasIndex(newId: number): void;
+    nextCanvas(): void;
+    previousCanvas(): void;
+    setCurrentRange(newId: string): void;
+    clearRange(): void;
+    setPagingEnabled(isEnabled: boolean): void;
+}
+type SimpleViewerActionsType = {
+    [T in keyof SimpleViewerActions]: {
+        type: T;
+        payload: Parameters<SimpleViewerActions[T]>[0];
+    };
+}[keyof SimpleViewerActions];
+
+export type { SimpleViewerContext as S, SimpleViewerProps as a, SimpleViewerReducerState as b, SimpleViewerActions as c, SimpleViewerActionsType as d };

package/dist/ViewerPresetContext-D7N6KH9p.d.ts

@@ -0,0 +1,144 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { StoreApi } from 'zustand';
+import * as mitt from 'mitt';
+import * as zustand_vanilla from 'zustand/vanilla';
+import { C as ComplexTimelineStrategy, T as TimelineKeyframe, R as RenderingStrategy, l as StrategyActions } from './useRenderingStrategy-Vubk-vUU.js';
+import * as React$1 from 'react';
+import { RefObject } from 'react';
+import { ChoiceDescription } from '@iiif/helpers';
+import { Preset } from '@atlas-viewer/atlas';
+
+type MediaPlayerState = {
+    isPlaying: boolean;
+    isMuted: boolean;
+    playRequested: boolean;
+    volume: number;
+    isFinished: boolean;
+    duration: number;
+};
+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 | ((t: number) => 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
+];
+
+interface ComplexTimelineStore extends MediaPlayerActions {
+    complexTimeline: ComplexTimelineStrategy;
+    visibleElements: Record<string, TimelineKeyframe | null>;
+    isReady: boolean;
+    unseekableMedia: string[];
+    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;
+    playbackError: unknown | null;
+    attachMediaElement: (id: string, element: HTMLMediaElement) => () => void;
+    dispose: () => void;
+    updateTimeline: (timeline: ComplexTimelineStrategy) => 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;
+}
+type ComplexTimelineEvents = {
+    'complex-timeline.ready': {
+        complexTimeline: ComplexTimelineStrategy;
+    };
+    'complex-timeline.keyframe': {
+        keyframe: TimelineKeyframe;
+    };
+    'complex-timeline.prime-change': {
+        prime: TimelineKeyframe | null;
+    };
+    'complex-timeline.buffering': {
+        id: string;
+        isBuffering: boolean;
+    };
+    'complex-timeline.finished-buffering': {};
+    'complex-timeline.play': {
+        id: string;
+    };
+    'complex-timeline.pause': {
+        id: string;
+    };
+    'complex-timeline.exit': {
+        id: string;
+    };
+    'complex-timeline.enter': {
+        id: string;
+    };
+};
+declare function resolveKeyframeChanges({ currentKeyFrameIndex, keyframes, targetTime, currentTime, }: {
+    currentTime: number;
+    targetTime: number;
+    currentKeyFrameIndex: number;
+    keyframes: TimelineKeyframe[];
+}): [number, TimelineKeyframe[]];
+type ComplexTimelineController = ReturnType<typeof createComplexTimelineStore>;
+declare function createComplexTimelineStore({ complexTimeline, startTime, }: {
+    complexTimeline: ComplexTimelineStrategy;
+    startTime?: number;
+}): {
+    store: zustand_vanilla.StoreApi<ComplexTimelineStore>;
+    emitter: mitt.Emitter<ComplexTimelineEvents>;
+    attachMediaElement: (id: string, element: HTMLMediaElement) => () => void;
+    dispose: () => void;
+    getSnapshot: () => ComplexTimelineStore;
+    subscribe: (listener: (state: ComplexTimelineStore, prevState: ComplexTimelineStore) => void) => () => void;
+};
+
+declare function ComplexTimelineProvider({ children, store, }: {
+    children: React.ReactNode;
+    store: StoreApi<ComplexTimelineStore>;
+}): react_jsx_runtime.JSX.Element;
+declare function useComplexTimelineStore(): StoreApi<ComplexTimelineStore>;
+declare function useComplexTimeline<T>(selector: (store: ComplexTimelineStore) => T): T;
+
+interface StrategyContext {
+    strategy: RenderingStrategy;
+    actions?: StrategyActions;
+    imageStyles?: Record<string, {
+        opacity?: number;
+    }>;
+    choices: ChoiceDescription | null;
+}
+declare const StrategyReactContext: React$1.Context<StrategyContext | null>;
+declare function useStrategy(): StrategyContext;
+
+declare const ViewerPresetContext: React$1.Context<Preset | null | undefined>;
+declare function useViewerPreset(): Preset | null | undefined;
+
+export { ComplexTimelineProvider as C, type MediaPlayerState as M, type StrategyContext as S, ViewerPresetContext as V, useComplexTimeline as a, StrategyReactContext as b, useStrategy as c, useViewerPreset as d, type MediaPlayerActions as e, formatTime as f, useSimpleMediaPlayer as g, type ComplexTimelineController as h, createComplexTimelineStore as i, type ComplexTimelineStore as j, type ComplexTimelineEvents as k, resolveKeyframeChanges as r, useComplexTimelineStore as u };

package/dist/ViewerPresetContext-DwFTIkDx.d.cts

@@ -0,0 +1,144 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { StoreApi } from 'zustand';
+import * as mitt from 'mitt';
+import * as zustand_vanilla from 'zustand/vanilla';
+import { C as ComplexTimelineStrategy, T as TimelineKeyframe, R as RenderingStrategy, l as StrategyActions } from './useRenderingStrategy-Vubk-vUU.cjs';
+import * as React$1 from 'react';
+import { RefObject } from 'react';
+import { ChoiceDescription } from '@iiif/helpers';
+import { Preset } from '@atlas-viewer/atlas';
+
+type MediaPlayerState = {
+    isPlaying: boolean;
+    isMuted: boolean;
+    playRequested: boolean;
+    volume: number;
+    isFinished: boolean;
+    duration: number;
+};
+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 | ((t: number) => 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
+];
+
+interface ComplexTimelineStore extends MediaPlayerActions {
+    complexTimeline: ComplexTimelineStrategy;
+    visibleElements: Record<string, TimelineKeyframe | null>;
+    isReady: boolean;
+    unseekableMedia: string[];
+    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;
+    playbackError: unknown | null;
+    attachMediaElement: (id: string, element: HTMLMediaElement) => () => void;
+    dispose: () => void;
+    updateTimeline: (timeline: ComplexTimelineStrategy) => 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;
+}
+type ComplexTimelineEvents = {
+    'complex-timeline.ready': {
+        complexTimeline: ComplexTimelineStrategy;
+    };
+    'complex-timeline.keyframe': {
+        keyframe: TimelineKeyframe;
+    };
+    'complex-timeline.prime-change': {
+        prime: TimelineKeyframe | null;
+    };
+    'complex-timeline.buffering': {
+        id: string;
+        isBuffering: boolean;
+    };
+    'complex-timeline.finished-buffering': {};
+    'complex-timeline.play': {
+        id: string;
+    };
+    'complex-timeline.pause': {
+        id: string;
+    };
+    'complex-timeline.exit': {
+        id: string;
+    };
+    'complex-timeline.enter': {
+        id: string;
+    };
+};
+declare function resolveKeyframeChanges({ currentKeyFrameIndex, keyframes, targetTime, currentTime, }: {
+    currentTime: number;
+    targetTime: number;
+    currentKeyFrameIndex: number;
+    keyframes: TimelineKeyframe[];
+}): [number, TimelineKeyframe[]];
+type ComplexTimelineController = ReturnType<typeof createComplexTimelineStore>;
+declare function createComplexTimelineStore({ complexTimeline, startTime, }: {
+    complexTimeline: ComplexTimelineStrategy;
+    startTime?: number;
+}): {
+    store: zustand_vanilla.StoreApi<ComplexTimelineStore>;
+    emitter: mitt.Emitter<ComplexTimelineEvents>;
+    attachMediaElement: (id: string, element: HTMLMediaElement) => () => void;
+    dispose: () => void;
+    getSnapshot: () => ComplexTimelineStore;
+    subscribe: (listener: (state: ComplexTimelineStore, prevState: ComplexTimelineStore) => void) => () => void;
+};
+
+declare function ComplexTimelineProvider({ children, store, }: {
+    children: React.ReactNode;
+    store: StoreApi<ComplexTimelineStore>;
+}): react_jsx_runtime.JSX.Element;
+declare function useComplexTimelineStore(): StoreApi<ComplexTimelineStore>;
+declare function useComplexTimeline<T>(selector: (store: ComplexTimelineStore) => T): T;
+
+interface StrategyContext {
+    strategy: RenderingStrategy;
+    actions?: StrategyActions;
+    imageStyles?: Record<string, {
+        opacity?: number;
+    }>;
+    choices: ChoiceDescription | null;
+}
+declare const StrategyReactContext: React$1.Context<StrategyContext | null>;
+declare function useStrategy(): StrategyContext;
+
+declare const ViewerPresetContext: React$1.Context<Preset | null | undefined>;
+declare function useViewerPreset(): Preset | null | undefined;
+
+export { ComplexTimelineProvider as C, type MediaPlayerState as M, type StrategyContext as S, ViewerPresetContext as V, useComplexTimeline as a, StrategyReactContext as b, useStrategy as c, useViewerPreset as d, type MediaPlayerActions as e, formatTime as f, useSimpleMediaPlayer as g, type ComplexTimelineController as h, createComplexTimelineStore as i, type ComplexTimelineStore as j, type ComplexTimelineEvents as k, resolveKeyframeChanges as r, useComplexTimelineStore as u };