react-iiif-vault 0.9.9 → 0.9.12

package/dist/index.d.ts

@@ -1,615 +0,0 @@
-import * as _atlas_viewer_atlas from '@atlas-viewer/atlas';
-import * as React 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 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, errorFallback, outerContainerProps, ...props }: AtlasProps & {
-    height?: number | string;
-    width?: number | string;
-    resizeHash?: number;
-    containerProps?: any;
-    outerContainerProps?: any;
-    aspectRatio?: number;
-    errorFallback?: any;
-} & {
-    children: ReactNode;
-}): JSX.Element;
-
-interface SingleChoice {
-    type: 'single-choice';
-    label?: InternationalString;
-    items: Array<{
-        id: string;
-        label?: InternationalString;
-        selected?: true;
-    }>;
-}
-interface ComplexChoice {
-    type: 'complex-choice';
-    items: SingleChoice[];
-}
-declare type ChoiceDescription = SingleChoice | ComplexChoice;
-
-interface SupportedSelector {
-    type: string;
-    temporal?: {
-        startTime: number;
-        endTime?: number;
-    };
-    spatial?: {
-        unit?: 'percent' | 'pixel';
-        x: number;
-        y: number;
-        width?: number;
-        height?: number;
-    };
-}
-interface BoxSelector extends SupportedSelector {
-    type: 'BoxSelector';
-    spatial: {
-        unit?: 'percent' | 'pixel';
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-}
-interface PointSelector extends SupportedSelector {
-    type: 'PointSelector';
-    spatial: {
-        x: number;
-        y: number;
-    };
-}
-interface TemporalSelector extends SupportedSelector {
-    type: 'TemporalSelector';
-    temporal: {
-        startTime: number;
-        endTime?: number;
-    };
-}
-interface TemporalBoxSelector extends SupportedSelector {
-    type: 'TemporalBoxSelector';
-    spatial: {
-        unit?: 'percent' | 'pixel';
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
-    temporal: {
-        startTime: number;
-        endTime?: number;
-    };
-}
-declare type SupportedSelectors = TemporalSelector | BoxSelector | TemporalBoxSelector | PointSelector;
-
-declare type ImageWithOptionalService = {
-    id: string;
-    type: 'Image';
-    service?: ImageService;
-    width?: number;
-    height?: number;
-    sizes?: Array<{
-        width: number;
-        height: number;
-    }>;
-    target: BoxSelector | TemporalBoxSelector;
-    selector: BoxSelector;
-};
-declare type SingleAudio = {
-    type: 'Sound';
-    url: string;
-    format: string;
-    duration: number;
-    target: TemporalSelector;
-    selector: TemporalSelector;
-};
-declare type SingleVideo = {
-    type: 'Video';
-    url: string;
-    format: string;
-    duration: number;
-    target: TemporalSelector | TemporalBoxSelector;
-    selector: TemporalSelector | TemporalBoxSelector;
-};
-declare type AudioSequence = {
-    type: 'SoundSequence';
-    items: SingleAudio[];
-};
-declare type VideoSequence = {
-    type: 'VideoSequence';
-    items: SingleVideo[];
-};
-declare type AnnotationPageDescription = {
-    pages: AnnotationPageNormalized[];
-};
-
-declare type ImageServiceLoaderType = (imageService: any | undefined, { height, width }: {
-    height: number;
-    width: number;
-}) => ImageService | undefined;
-declare function useLoadImageService(): readonly [ImageServiceLoaderType, Record<string, string>];
-
-declare function parseSpecificResource(resource: ContentResource): any[];
-interface Paintables {
-    choice: ChoiceDescription | null;
-    types: string[];
-    items: Array<{
-        type: string;
-        resource: IIIFExternalWebResource | SpecificResource;
-        target: any;
-        selector: any;
-    }>;
-}
-declare function getPaintables(vault: Vault, paintingAnnotations: AnnotationNormalized[], enabledChoices: string[]): Paintables;
-declare const emptyActions: {
-    makeChoice: () => void;
-};
-declare const unknownResponse: UseRenderingStrategy[0];
-declare const unsupportedStrategy: (reason: string) => UseRenderingStrategy[0];
-
-declare type SingleImageStrategy = {
-    type: 'images';
-    image: ImageWithOptionalService;
-    images: Array<ImageWithOptionalService>;
-    choice?: ChoiceDescription;
-    annotations?: AnnotationPageDescription;
-};
-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;
-    choice?: ChoiceDescription;
-    annotations?: AnnotationPageDescription;
-};
-declare type ComplexTimelineStrategy = {
-    type: 'complex-timeline';
-    items: Array<ImageWithOptionalService | SingleAudio | SingleVideo>;
-    choice?: ChoiceDescription;
-    annotations?: AnnotationPageDescription;
-};
-declare type UnknownStrategy = {
-    type: 'unknown';
-    reason?: string;
-    annotations?: AnnotationPageDescription;
-};
-declare type RenderingStrategy = SingleImageStrategy | MediaStrategy | ComplexTimelineStrategy | Single3DModelStrategy | UnknownStrategy;
-
-declare type StrategyActions = {
-    makeChoice: (id: string, options?: {
-        deselectOthers?: boolean;
-        deselect?: boolean;
-    }) => void;
-};
-declare type UseRenderingStrategy = [RenderingStrategy, StrategyActions];
-declare type UseRenderingStrategyOptions = {
-    strategies?: Array<RenderingStrategy['type']>;
-    annotationPageManagerId?: string;
-    defaultChoices?: string[];
-};
-declare function useRenderingStrategy(options?: UseRenderingStrategyOptions): UseRenderingStrategy;
-
-declare type CanvasProps = {
-    x?: number;
-    y?: number;
-    onCreated?: any;
-    onChoiceChange?: (choice?: ChoiceDescription) => void;
-    registerActions?: (actions: StrategyActions) => void;
-    defaultChoices?: Array<{
-        id: string;
-        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, renderViewerControls, renderMediaControls, strategies, children, }: CanvasProps): JSX.Element | null;
-
-declare function RenderImage({ id, image, thumbnail, isStatic, x, y, annotations, children, }: {
-    id: string;
-    image: ImageWithOptionalService;
-    thumbnail?: ImageCandidate;
-    isStatic?: boolean;
-    x?: number;
-    y?: number;
-    annotations?: ReactNode;
-    children?: ReactNode;
-}): JSX.Element;
-
-declare const CanvasPanel: {
-    RenderImage: typeof RenderImage;
-    RenderCanvas: typeof RenderCanvas;
-    RenderAnnotationPage: React.FC<{
-        page: _iiif_presentation_3.AnnotationPageNormalized | _iiif_presentation_3.AnnotationPage;
-        className?: string | undefined;
-    }>;
-    RenderAnnotation: React.FC<{
-        id: string;
-        className?: string | undefined;
-        style?: _atlas_viewer_atlas.BoxStyle | undefined;
-        interactive?: boolean | undefined;
-    }>;
-    Viewer: typeof Viewer;
-};
-
-declare function AnnotationContext({ annotation, children }: {
-    annotation: string;
-    children: ReactNode;
-}): JSX.Element;
-
-declare function CanvasContext({ canvas, children }: {
-    canvas: string;
-    children: ReactNode;
-}): JSX.Element;
-
-declare function CollectionContext({ collection, children }: {
-    collection: string;
-    children: ReactNode;
-}): JSX.Element;
-
-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 function RangeContext({ range, children }: {
-    range: string;
-    children: ReactNode;
-}): JSX.Element;
-
-declare type ResourceContextType = {
-    collection?: string;
-    manifest?: string;
-    range?: string;
-    canvas?: string;
-    annotation?: string;
-};
-declare const ResourceReactContext: React__default.Context<ResourceContextType>;
-declare const useResourceContext: () => ResourceContextType;
-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 function VaultProvider({ vault, vaultOptions, useGlobal, resources, children, }: {
-    vault?: Vault;
-    useGlobal?: boolean;
-    vaultOptions?: VaultOptions;
-    resources?: ResourceContextType;
-    children: ReactNode;
-}): JSX.Element;
-
-declare function useContextBridge(): {
-    VaultContext: {
-        vault: _iiif_vault__.Vault | null;
-        setVaultInstance: (vault: _iiif_vault__.Vault) => void;
-    };
-    ResourceContext: ResourceContextType;
-    SimpleViewerReactContext: {
-        setCurrentCanvasId: (newId: string | ((prev: string) => string)) => void;
-        setCurrentCanvasIndex: (newId: number | ((prev: number) => number)) => void;
-        currentCanvasIndex: number;
-        pagingView: boolean;
-        totalCanvases: number;
-        nextCanvas: () => void;
-        previousCanvas: () => void;
-    };
-    VisibleCanvasReactContext: string[];
-};
-declare function ContextBridge(props: {
-    bridge: ReturnType<typeof useContextBridge>;
-    children: ReactNode;
-}): JSX.Element;
-
-declare const VisibleCanvasReactContext: React__default.Context<string[]>;
-declare function useVisibleCanvases(): CanvasNormalized[];
-
-declare const ImageServiceLoaderContext: React__default.Context<ImageServiceLoader>;
-declare function useImageServiceLoader(): ImageServiceLoader;
-
-declare function useAnnotation(options?: {
-    id: string;
-}): AnnotationNormalized | undefined;
-declare function useAnnotation<T>(options?: {
-    id: string;
-    selector: (annotation: AnnotationNormalized) => T;
-}, deps?: any[]): T | undefined;
-
-declare function useAnnotationPageManager(resourceId?: string, options?: {
-    all?: boolean;
-}): {
-    availablePageIds: string[];
-    enabledPageIds: string[];
-    setPageEnabled: (id: string, opt?: {
-        deselectOthers?: boolean;
-    }) => void;
-    setPageDisabled: (deselectId: string) => void;
-};
-
-declare function useAnnotationsAtTime(time: number, options?: {
-    canvasId?: string;
-}): AnnotationNormalized[];
-
-declare function useCanvas(options?: {
-    id: string;
-}): CanvasNormalized | undefined;
-declare function useCanvas<T>(options?: {
-    id: string;
-    selector: (canvas: CanvasNormalized) => T;
-}, deps?: any[]): T | undefined;
-
-declare function useCanvasClock(canvasId?: string, autoplay?: boolean): void;
-
-declare function useCollection(options: {
-    id: string;
-}): CollectionNormalized | undefined;
-declare function useCollection<T>(options: {
-    id: string;
-    selector: (collection: CollectionNormalized) => T;
-}, deps?: any[]): T | undefined;
-
-declare function useDispatch(): ReduxStore['dispatch'];
-
-declare type SupportedEvents = 'onClick';
-declare function useEventListener<T>(resource: Reference, name: SupportedEvents, listener: (e: any, resource: T) => void, scope?: string[], deps?: any[]): void;
-
-declare function useExistingVault(): any;
-
-declare type ResourceRequestOptions = {
-    noCache?: boolean;
-};
-declare function useExternalResource<T extends {
-    id: string;
-}>(idOrRef: string | {
-    id: string;
-    type: string;
-}, { noCache }?: ResourceRequestOptions): {
-    id: string;
-    requestId: string;
-    isLoaded: boolean;
-    error: any;
-    cached: boolean;
-    resource?: T;
-};
-
-declare function useExternalCollection(idOrRef: string | {
-    id: string;
-    type: string;
-}, options?: ResourceRequestOptions): {
-    id: string;
-    requestId: string;
-    isLoaded: boolean;
-    cached?: boolean;
-    error: any;
-    manifest?: CollectionNormalized;
-};
-
-declare function useExternalManifest(idOrRef: string | {
-    id: string;
-    type: string;
-}, options?: ResourceRequestOptions): {
-    id: string;
-    requestId: string;
-    isLoaded: boolean;
-    cached?: boolean;
-    error: any;
-    manifest?: ManifestNormalized;
-};
-
-interface ImageServiceRequestOptions {
-    cacheKey?: string;
-}
-declare function useImageService({ cacheKey }?: ImageServiceRequestOptions): {
-    data: ImageService | undefined;
-    isFetching: boolean;
-    status: 'error' | 'success' | 'loading' | 'idle';
-};
-
-declare function useImageTile(): {
-    isLoading: boolean;
-    tile: {
-        id: string | undefined;
-        width: number | null | undefined;
-        height: number | null | undefined;
-        imageService: ImageService;
-        thumbnail: undefined;
-    } | null;
-};
-
-declare function useManifest(options?: {
-    id: string;
-}): ManifestNormalized | undefined;
-declare function useManifest<T>(options?: {
-    id: string;
-    selector: (manifest: ManifestNormalized) => T;
-}, deps?: any[]): T | undefined;
-
-declare function usePaintables(options?: {
-    defaultChoices?: string[];
-}, deps?: any[]): readonly [Paintables, {
-    makeChoice: (id: string, { deselectOthers, deselect }?: {
-        deselectOthers?: boolean | undefined;
-        deselect?: boolean | undefined;
-    }) => void;
-}];
-
-declare function usePaintingAnnotations(options?: {
-    canvasId?: string;
-}): AnnotationNormalized[];
-
-declare function useRange(options?: {
-    id: string;
-}): RangeNormalized | undefined;
-declare function useRange<T>(options?: {
-    id: string;
-    selector: (range: RangeNormalized) => T;
-}, deps?: any[]): T | undefined;
-
-declare function useResourceEvents<T extends NormalizedEntity>(resource?: Reference, scope?: string[]): any;
-
-declare function useResources<Type>(ids: string[], type: string): Type[];
-
-declare function useSearchService(): SearchService | undefined;
-
-declare function useStyleHelper(): _iiif_vault_helpers.StyledHelper<_iiif_vault_helpers.StyleDefinition>;
-
-declare function useStyles<Style extends Record<string, Record<string, any>>>(resource: undefined | Reference<any>): Style;
-declare function useStyles<Style extends Record<string, any>>(resource: undefined | Reference<any>, scope: string): Style;
-
-declare function useThumbnail(request: ImageCandidateRequest, dereference?: boolean, { canvasId, manifestId }?: {
-    canvasId?: string;
-    manifestId?: string;
-}): ImageCandidate | undefined;
-
-declare const useVault: () => Vault;
-
-declare const useVaultEffect: (callback: (vault: Vault) => void, deps?: any[]) => void;
-
-declare function useVaultSelector<T>(selector: (state: IIIFStore, vault: Vault) => T, deps?: any[]): T;
-
-interface VaultActivatedAnnotation {
-    __vault?: Vault;
-    bindToVault(vault: Vault): void;
-    source: string | {
-        id: string;
-    };
-}
-declare function useVirtualAnnotationPage(): readonly [AnnotationPageNormalized | null, {
-    readonly addAnnotation: (id: string | Annotation | VaultActivatedAnnotation | AnnotationNormalized, atIndex?: number | undefined) => void;
-    readonly removeAnnotation: (id: string | Annotation | VaultActivatedAnnotation | AnnotationNormalized) => void;
-}];
-
-declare function useVirtualAnnotationPageContext(): readonly [AnnotationPageNormalized | null, {
-    readonly addAnnotation: (id: string | AnnotationNormalized | VaultActivatedAnnotation | Annotation, atIndex?: number | undefined) => void;
-    readonly removeAnnotation: (id: string | AnnotationNormalized | VaultActivatedAnnotation | Annotation) => void;
-}];
-declare function VirtualAnnotationProvider({ children }: {
-    children: any;
-}): JSX.Element;
-
-declare type SupportedTarget = {
-    type: 'SpecificResource';
-    source: ExternalWebResource$1 | {
-        id: string;
-        type: 'Unknown' | 'Canvas' | 'Range' | 'Manifest';
-        partOf?: Array<{
-            id: string;
-            type: string;
-        }>;
-    };
-    purpose?: string;
-    selector: SupportedSelectors | null;
-    selectors: SupportedSelectors[];
-};
-declare function expandTarget(target: W3CAnnotationTarget | W3CAnnotationTarget[], options?: {
-    typeMap?: Record<string, string>;
-}): SupportedTarget;
-
-declare function flattenAnnotationPageIds({ canvas, manifest, all, canvases, }: {
-    manifest?: ManifestNormalized;
-    canvas?: CanvasNormalized;
-    canvases?: CanvasNormalized[];
-    all?: boolean;
-}): string[];
-
-declare type ParsedSelector = {
-    selector: SupportedSelectors | null;
-    selectors: SupportedSelectors[];
-};
-declare function parseSelector(source: Selector | Selector[]): ParsedSelector;
-
-declare type SimpleViewerContext = {
-    setCurrentCanvasId: (newId: string | ((prev: string) => string)) => void;
-    setCurrentCanvasIndex: (newId: number | ((prev: number) => number)) => void;
-    currentCanvasIndex: number;
-    pagingView: boolean;
-    totalCanvases: number;
-    nextCanvas: () => void;
-    previousCanvas: () => void;
-};
-declare const SimpleViewerReactContext: React__default.Context<SimpleViewerContext>;
-declare function SimpleViewerProvider(props: {
-    manifest: string;
-    pagingEnabled?: boolean;
-    children: ReactNode;
-}): JSX.Element;
-declare function useSimpleViewer(): SimpleViewerContext;
-
-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 };