react-iiif-vault 1.0.7 → 1.0.9

package/.build/types/canvas-panel/Viewer.d.ts

@@ -11,4 +11,4 @@ export declare function Viewer({ children, errorFallback, outerContainerProps, w
     worldScale?: number;
 } & {
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/canvas-panel/index.d.ts

@@ -18,6 +18,7 @@ interface CanvasPanelProps {
     header?: ReactNode;
     children?: ReactNode;
     mode?: ViewerMode;
+    reuseAtlas?: boolean;
     height?: number;
     spacing?: number;
     components?: {
@@ -27,7 +28,7 @@ interface CanvasPanelProps {
     canvasProps?: Omit<Partial<CanvasProps>, 'x'>;
     annotations?: ReactNode;
 }
-declare type CanvasPanelType = ForwardRefExoticComponent<CanvasPanelProps & RefAttributes<SimpleViewerContext>> & {
+type CanvasPanelType = ForwardRefExoticComponent<CanvasPanelProps & RefAttributes<SimpleViewerContext>> & {
     RenderImage: typeof RenderImage;
     RenderCanvas: typeof RenderCanvas;
     RenderAnnotationPage: typeof RenderAnnotationPage;

package/.build/types/canvas-panel/render/Audio.d.ts

@@ -3,7 +3,7 @@ import { SingleAudio } from '../../features/rendering-strategy/resource-types';
 export declare function AudioHTML({ media, children }: {
     media: SingleAudio;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;
 export declare function Audio({ media, mediaControlsDeps, children, }: {
     media: SingleAudio;
     mediaControlsDeps?: any[];

package/.build/types/canvas-panel/render/Canvas.d.ts

@@ -5,7 +5,7 @@ import { EmptyStrategy, MediaStrategy, RenderingStrategy } from '../../features/
 import { SingleImageStrategy } from '../../features/rendering-strategy/image-strategy';
 import { ImageWithOptionalService } from '../../features/rendering-strategy/resource-types';
 import { ChoiceDescription } from '@iiif/helpers';
-export declare type CanvasProps = {
+export type CanvasProps = {
     x?: number;
     y?: number;
     onCreated?: any;
@@ -31,4 +31,4 @@ export declare type CanvasProps = {
     throwOnUnknown?: boolean;
     onClickPaintingAnnotation?: (id: string, image: ImageWithOptionalService, e: any) => void;
 };
-export declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, viewControlsDeps, mediaControlsDeps, strategies, throwOnUnknown, backgroundStyle, alwaysShowBackground, keepCanvasScale, enableSizes, enableYouTube, onClickPaintingAnnotation, children, }: CanvasProps): JSX.Element | null;
+export declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic, renderViewerControls, renderMediaControls, viewControlsDeps, mediaControlsDeps, strategies, throwOnUnknown, backgroundStyle, alwaysShowBackground, keepCanvasScale, enableSizes, enableYouTube, onClickPaintingAnnotation, children, }: CanvasProps): import("react/jsx-dev-runtime").JSX.Element | null;

package/.build/types/canvas-panel/render/CanvasBackground.d.ts

@@ -1,4 +1,4 @@
 import { BoxStyle } from '@atlas-viewer/atlas';
 export declare function CanvasBackground({ style }: {
     style?: BoxStyle;
-}): JSX.Element | null;
+}): import("react/jsx-dev-runtime").JSX.Element | null;

package/.build/types/canvas-panel/render/DefaultCanvasFallback.d.ts

@@ -3,4 +3,4 @@ export declare function DefaultCanvasFallback({ width, style, height, error, res
     width?: number;
     height?: number;
     style?: any;
-} & FallbackProps): JSX.Element;
+} & FallbackProps): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/canvas-panel/render/Image.d.ts

@@ -13,4 +13,4 @@ export declare function RenderImage({ id, image, thumbnail, isStatic, x, y, chil
     y?: number;
     children?: ReactNode;
     onClick?: (e: any) => void;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/canvas-panel/render/Model.d.ts

@@ -1,6 +1,6 @@
 export declare function ModelHTML({ model }: {
     model: any;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;
 export declare function Model({ model, name }: {
     model: any;
     name?: string;

package/.build/types/canvas-panel/render/Video.d.ts

@@ -4,7 +4,7 @@ export declare function VideoHTML({ element, media, playPause, }: {
     element: RefObject<any>;
     media: SingleVideo;
     playPause: () => void;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;
 export declare function Video({ media, mediaControlsDeps, children, }: {
     media: SingleVideo;
     mediaControlsDeps?: any[];

package/.build/types/canvas-panel/render/VideoYouTube.d.ts

@@ -4,7 +4,7 @@ export declare function VideoYouTubeHTML({ element, media, playPause, }: {
     element: RefObject<any>;
     media: SingleYouTubeVideo;
     playPause: () => void;
-}): JSX.Element | null;
+}): import("react/jsx-dev-runtime").JSX.Element | null;
 export declare function VideoYouTube({ media, mediaControlsDeps, children, }: {
     media: SingleYouTubeVideo;
     mediaControlsDeps?: any[];

package/.build/types/components/CanvasAnnotations.d.ts

@@ -0,0 +1,10 @@
+export declare const CanvasAnnotations: import("react").ForwardRefExoticComponent<{
+    canvasId?: string | undefined;
+} & import("react").RefAttributes<{
+    availablePageIds: string[];
+    enabledPageIds: string[];
+    setPageEnabled: (id: string, opt?: {
+        deselectOthers?: boolean | undefined;
+    }) => void;
+    setPageDisabled: (deselectId: string) => void;
+}>>;

package/.build/types/components/CombinedMetadata.d.ts

@@ -0,0 +1,4 @@
+import { MetadataProps } from './Metadata';
+type CombinedMetadataProps = Omit<MetadataProps, 'metadata'>;
+export declare function CombinedMetadata(props: CombinedMetadataProps): import("react/jsx-dev-runtime").JSX.Element;
+export {};

package/.build/types/components/Image.d.ts

@@ -0,0 +1,15 @@
+import { RegionParameter, RotationParameter } from '@atlas-viewer/iiif-image-api';
+import { ImageService, ImageSize } from '@iiif/presentation-3';
+export interface ImageProps {
+    src: string | ImageService;
+    alt?: string;
+    size?: Partial<ImageSize>;
+    region?: RegionParameter;
+    className?: string;
+    style?: React.CSSProperties;
+    fetchImageService?: boolean;
+    quality?: string;
+    rotation?: number | RotationParameter;
+    format?: string;
+}
+export declare function Image(props: ImageProps): import("react/jsx-dev-runtime").JSX.Element | null;

package/.build/types/components/ManifestMetadata.d.ts

@@ -0,0 +1,4 @@
+import { MetadataProps } from './Metadata';
+type ManifestMetadataProps = Omit<MetadataProps, 'metadata'>;
+export declare function ManifestMetadata(props: ManifestMetadataProps): import("react/jsx-dev-runtime").JSX.Element;
+export {};

package/.build/types/components/Metadata.d.ts

@@ -0,0 +1,39 @@
+import { InternationalString } from '@iiif/presentation-3';
+type FacetConfig = {
+    id: string;
+    label: InternationalString;
+    keys: string[];
+    values?: FacetConfigValue[];
+};
+type FacetConfigValue = {
+    id: string;
+    label: InternationalString;
+    values: string[];
+    key: string;
+};
+export interface MetadataProps {
+    config?: FacetConfig[];
+    metadata?: Array<{
+        label: InternationalString;
+        value: InternationalString;
+    } | null>;
+    labelWidth?: number;
+    allowHtml?: boolean;
+    showEmptyMessage?: boolean;
+    separator?: string;
+    classes?: {
+        container?: string;
+        row?: string;
+        label?: string;
+        value?: string;
+        empty?: string;
+    };
+    emptyMessage?: string;
+    emptyValueFallback?: string;
+    emptyLabelFallback?: string;
+    tableHeader?: React.ReactNode;
+    tableFooter?: React.ReactNode;
+    emptyFallback?: React.ReactNode;
+}
+export declare function Metadata({ metadata, config, labelWidth, showEmptyMessage, allowHtml, emptyFallback, classes, emptyMessage, emptyValueFallback, emptyLabelFallback, separator, tableFooter, tableHeader, }: MetadataProps): import("react/jsx-dev-runtime").JSX.Element;
+export {};

package/.build/types/components/SequenceThumbnails.d.ts

@@ -0,0 +1,29 @@
+interface SequenceThumbnailsProps {
+    flat?: boolean;
+    size?: {
+        width: number;
+        height?: number;
+    };
+    classes?: {
+        container?: string;
+        row?: string;
+        item?: string;
+        figure?: string;
+        imageWrapper?: string;
+        img?: string;
+        label?: string;
+        selected?: {
+            row?: string;
+            item?: string;
+            figure?: string;
+            img?: string;
+            label?: string;
+            imageWrapper?: string;
+        };
+    };
+    figure?: boolean;
+    showLabel?: boolean;
+    fallback?: React.ReactNode;
+}
+export declare function SequenceThumbnails({ flat, size, classes, showLabel, figure, fallback }: SequenceThumbnailsProps): import("react/jsx-dev-runtime").JSX.Element;
+export {};

package/.build/types/components/SingleCanvasThumbnail.d.ts

@@ -0,0 +1,20 @@
+import { SizeParameter } from '@atlas-viewer/iiif-image-api';
+interface SingleCanvasThumbnailProps {
+    canvasId?: string;
+    size?: Partial<SizeParameter>;
+    visible?: boolean;
+    alt?: string;
+    dereference?: boolean;
+    figure?: boolean;
+    showLabel?: boolean;
+    classes?: {
+        figure?: string;
+        img?: string;
+        label?: string;
+        imageWrapper?: string;
+    };
+    placeholder?: React.ReactNode;
+    fallback?: React.ReactNode;
+}
+export declare function SingleCanvasThumbnail(props: SingleCanvasThumbnailProps): import("react/jsx-dev-runtime").JSX.Element;
+export {};

package/.build/types/context/AnnotationContext.d.ts

@@ -2,4 +2,4 @@ import { ReactNode } from 'react';
 export declare function AnnotationContext({ annotation, children }: {
     annotation: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/AnnotationPageContext.d.ts

@@ -2,4 +2,4 @@ import { ReactNode } from 'react';
 export declare function AnnotationPageContext({ annotationPage, children }: {
     annotationPage: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/CanvasContext.d.ts

@@ -2,4 +2,4 @@ import { ReactNode } from 'react';
 export declare function CanvasContext({ canvas, children }: {
     canvas: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/CollectionContext.d.ts

@@ -2,4 +2,4 @@ import { ReactNode } from 'react';
 export declare function CollectionContext({ collection, children }: {
     collection: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/ContextBridge.d.ts

@@ -11,4 +11,4 @@ export declare function useContextBridge(): {
 export declare function ContextBridge(props: {
     bridge: ReturnType<typeof useContextBridge>;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/ManifestContext.d.ts

@@ -2,4 +2,4 @@ import { ReactNode } from 'react';
 export declare function ManifestContext({ manifest, children }: {
     manifest: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/MediaContext.d.ts

@@ -14,4 +14,4 @@ export declare function MediaPlayerProvider({ actions, state, children, currentT
     currentTime: RefObject<HTMLDivElement>;
     progress: RefObject<HTMLDivElement>;
     element: RefObject<HTMLAudioElement | HTMLVideoElement>;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/RangeContext.d.ts

@@ -2,4 +2,4 @@ import { ReactNode } from 'react';
 export declare function RangeContext({ range, children }: {
     range: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/ResourceContext.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactNode } from 'react';
-export declare type ResourceContextType = {
+export type ResourceContextType = {
     collection?: string;
     manifest?: string;
     range?: string;
@@ -12,4 +12,4 @@ export declare const useResourceContext: () => ResourceContextType;
 export declare function ResourceProvider({ value, children }: {
     value: ResourceContextType;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/context/VaultContext.d.ts

@@ -11,4 +11,4 @@ export declare function VaultProvider({ vault, vaultOptions, useGlobal, resource
     vaultOptions?: VaultOptions;
     resources?: ResourceContextType;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/demo/media-controls.d.ts

@@ -1 +1 @@
-export declare function MediaControls(): JSX.Element;
+export declare function MediaControls(): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/demo/viewer-controls.d.ts

@@ -1 +1 @@
-export declare function ViewerControls(): JSX.Element;
+export declare function ViewerControls(): import("react/jsx-dev-runtime").JSX.Element;

package/.build/types/features/rendering-strategy/3d-strategy.d.ts

@@ -3,7 +3,7 @@ import { AnnotationPageDescription } from './resource-types';
 import { ExternalWebResource } from '@iiif/presentation-3';
 import { RenderingStrategy } from './strategies';
 import { ChoiceDescription, Paintables } from '@iiif/helpers';
-export declare type Single3DModelStrategy = {
+export type Single3DModelStrategy = {
     type: '3d-model';
     model: ExternalWebResource;
     choice?: ChoiceDescription;

package/.build/types/features/rendering-strategy/image-strategy.d.ts

@@ -2,7 +2,7 @@ import { CanvasNormalized } from '@iiif/presentation-3-normalized';
 import { ImageServiceLoaderType } from '../../hooks/useLoadImageService';
 import { AnnotationPageDescription, ImageWithOptionalService } from './resource-types';
 import { ChoiceDescription, Paintables } from '@iiif/helpers';
-export declare type SingleImageStrategy = {
+export type SingleImageStrategy = {
     type: 'images';
     image: ImageWithOptionalService;
     images: Array<ImageWithOptionalService>;

package/.build/types/features/rendering-strategy/resource-types.d.ts

@@ -1,7 +1,7 @@
 import { ImageService } from '@iiif/presentation-3';
 import { AnnotationPageNormalized } from '@iiif/presentation-3-normalized';
 import { BoxSelector, TemporalBoxSelector, TemporalSelector } from '@iiif/helpers/annotation-targets';
-export declare type ImageWithOptionalService = {
+export type ImageWithOptionalService = {
     id: string;
     annotationId: string;
     type: 'Image';
@@ -15,7 +15,7 @@ export declare type ImageWithOptionalService = {
     target: BoxSelector | TemporalBoxSelector;
     selector?: BoxSelector;
 };
-export declare type SingleAudio = {
+export type SingleAudio = {
     type: 'Sound';
     annotationId: string;
     url: string;
@@ -24,7 +24,7 @@ export declare type SingleAudio = {
     target: TemporalSelector;
     selector: TemporalSelector;
 };
-export declare type SingleYouTubeVideo = {
+export type SingleYouTubeVideo = {
     type: 'VideoYouTube';
     annotationId: string;
     url: string;
@@ -33,7 +33,7 @@ export declare type SingleYouTubeVideo = {
     target: TemporalSelector | TemporalBoxSelector;
     selector: TemporalSelector | TemporalBoxSelector;
 };
-export declare type SingleVideo = {
+export type SingleVideo = {
     type: 'Video';
     annotationId: string;
     url: string;
@@ -42,14 +42,14 @@ export declare type SingleVideo = {
     target: TemporalSelector | TemporalBoxSelector;
     selector: TemporalSelector | TemporalBoxSelector;
 };
-export declare type AudioSequence = {
+export type AudioSequence = {
     type: 'SoundSequence';
     items: SingleAudio[];
 };
-export declare type VideoSequence = {
+export type VideoSequence = {
     type: 'VideoSequence';
     items: SingleVideo[];
 };
-export declare type AnnotationPageDescription = {
+export type AnnotationPageDescription = {
     pages: AnnotationPageNormalized[];
 };

package/.build/types/features/rendering-strategy/strategies.d.ts

@@ -3,19 +3,19 @@ import { AnnotationPageDescription, AudioSequence, ImageWithOptionalService, Sin
 import { SingleImageStrategy } from './image-strategy';
 import { Single3DModelStrategy } from './3d-strategy';
 import { TextualContentStrategy } from './textual-content-strategy';
-export declare type MediaStrategy = {
+export type MediaStrategy = {
     type: 'media';
     media: SingleAudio | SingleVideo | AudioSequence | VideoSequence | SingleYouTubeVideo;
     choice?: ChoiceDescription;
     annotations?: AnnotationPageDescription;
 };
-export declare type ComplexTimelineStrategy = {
+export type ComplexTimelineStrategy = {
     type: 'complex-timeline';
     items: Array<ImageWithOptionalService | SingleAudio | SingleVideo>;
     choice?: ChoiceDescription;
     annotations?: AnnotationPageDescription;
 };
-export declare type EmptyStrategy = {
+export type EmptyStrategy = {
     type: 'empty';
     image: null;
     images: [];
@@ -23,9 +23,9 @@ export declare type EmptyStrategy = {
     width: number;
     annotations?: AnnotationPageDescription;
 };
-export declare type UnknownStrategy = {
+export type UnknownStrategy = {
     type: 'unknown';
     reason?: string;
     annotations?: AnnotationPageDescription;
 };
-export declare type RenderingStrategy = SingleImageStrategy | MediaStrategy | ComplexTimelineStrategy | Single3DModelStrategy | TextualContentStrategy | UnknownStrategy | EmptyStrategy;
+export type RenderingStrategy = SingleImageStrategy | MediaStrategy | ComplexTimelineStrategy | Single3DModelStrategy | TextualContentStrategy | UnknownStrategy | EmptyStrategy;

package/.build/types/features/rendering-strategy/textual-content-strategy.d.ts

@@ -3,7 +3,7 @@ import { CanvasNormalized } from '@iiif/presentation-3-normalized';
 import { AnnotationPageDescription } from './resource-types';
 import { RenderingStrategy } from './strategies';
 import { ChoiceDescription, Paintables, SupportedTarget } from '@iiif/helpers';
-export declare type TextualContentStrategy = {
+export type TextualContentStrategy = {
     type: 'textual-content';
     items: {
         annotationId: string;

package/.build/types/hooks/useEventListener.d.ts

@@ -1,4 +1,4 @@
 import { Reference } from '@iiif/presentation-3';
-declare type SupportedEvents = 'onClick';
+type SupportedEvents = 'onClick';
 export declare function useEventListener<T>(resource: Reference, name: SupportedEvents, listener: (e: any, resource: T) => void, scope?: string[], deps?: any[]): void;
 export {};

package/.build/types/hooks/useExternalResource.d.ts

@@ -1,4 +1,4 @@
-export declare type ResourceRequestOptions = {
+export type ResourceRequestOptions = {
     noCache?: boolean;
 };
 export declare function useExternalResource<T extends {

package/.build/types/hooks/useImage.d.ts

@@ -0,0 +1,10 @@
+import { RegionParameter, RotationParameter } from '@atlas-viewer/iiif-image-api';
+import { ImageService, ImageSize } from '@iiif/presentation-3';
+export declare function useImage(service: ImageService | undefined, data?: {
+    size?: Partial<ImageSize>;
+    selector?: RegionParameter;
+    rotation?: number | RotationParameter;
+    format?: string;
+    region?: RegionParameter;
+    quality?: string;
+}, deps?: any[]): string | null;

package/.build/types/hooks/useLoadImageService.d.ts

@@ -1,5 +1,5 @@
 import { ImageService } from '@iiif/presentation-3';
-export declare type ImageServiceLoaderType = (imageService: any | undefined, { height, width }: {
+export type ImageServiceLoaderType = (imageService: any | undefined, { height, width }: {
     height: number;
     width: number;
 }) => ImageService | undefined;

package/.build/types/hooks/useRenderingStrategy.d.ts

@@ -1,12 +1,12 @@
 import { RenderingStrategy } from '../features/rendering-strategy/strategies';
-export declare type StrategyActions = {
+export type StrategyActions = {
     makeChoice: (id: string, options?: {
         deselectOthers?: boolean;
         deselect?: boolean;
     }) => void;
 };
-export declare type UseRenderingStrategy = [RenderingStrategy, StrategyActions];
-export declare type UseRenderingStrategyOptions = {
+export type UseRenderingStrategy = [RenderingStrategy, StrategyActions];
+export type UseRenderingStrategyOptions = {
     strategies?: Array<RenderingStrategy['type']>;
     annotationPageManagerId?: string;
     enableSingleAnnotation?: boolean;

package/.build/types/hooks/useSimpleMediaPlayer.d.ts

@@ -1,5 +1,5 @@
 import { RefObject } from 'react';
-export declare type MediaPlayerState = {
+export type MediaPlayerState = {
     isPlaying: boolean;
     isMuted: boolean;
     playRequested: boolean;
@@ -7,7 +7,7 @@ export declare type MediaPlayerState = {
     isFinished: boolean;
     duration: number;
 };
-export declare type MediaPlayerActions = {
+export type MediaPlayerActions = {
     play(): void;
     pause(): void;
     playPause(): void;