react-iiif-vault 0.9.4 → 0.9.7

package/dist/index.d.ts

@@ -1,81 +1,23 @@
-import React, { FC } from 'react';
+import * as _atlas_viewer_atlas from '@atlas-viewer/atlas';
+import * as React from 'react';
+import React__default, { ReactNode, FC } 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, 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 { ImageCandidate, ImageServiceLoader, ImageCandidateRequest } from '@atlas-viewer/iiif-image-api';
 import * as _iiif_vault__ from '@iiif/vault/*';
-import { CanvasNormalized, InternationalString, ImageService, AnnotationPageNormalized, ContentResource, IIIFExternalWebResource, SpecificResource, AnnotationNormalized, CollectionNormalized, Reference, ManifestNormalized, RangeNormalized, SearchService, Annotation, ExternalWebResource, W3CAnnotationTarget, Selector } from '@iiif/presentation-3';
-import { ImageServiceLoader, ImageCandidateRequest, ImageCandidate } from '@atlas-viewer/iiif-image-api';
-import { QueryOptions } from 'react-query';
 import * as _iiif_vault_helpers from '@iiif/vault-helpers';
 
-declare const AnnotationContext: React.FC<{
-    annotation: string;
-}>;
-
-declare const CanvasContext: React.FC<{
-    canvas: string;
-}>;
-
-declare const CollectionContext: React.FC<{
-    collection: string;
-}>;
-
-declare const ManifestContext: React.FC<{
-    manifest: string;
-}>;
-
-declare const RangeContext: React.FC<{
-    range: string;
-}>;
-
-declare type ResourceContextType = {
-    collection?: string;
-    manifest?: string;
-    range?: string;
-    canvas?: string;
-    annotation?: string;
-};
-declare const ResourceReactContext: React.Context<ResourceContextType>;
-declare const useResourceContext: () => ResourceContextType;
-declare const ResourceProvider: React.FC<{
-    value: ResourceContextType;
-}>;
-
-declare const ReactVaultContext: React.Context<{
-    vault: Vault | null;
-    setVaultInstance: (vault: Vault) => void;
-}>;
-declare const VaultProvider: React.FC<{
-    vault?: Vault;
-    useGlobal?: boolean;
-    vaultOptions?: VaultOptions;
-    resources?: ResourceContextType;
-}>;
-
-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 const ContextBridge: React.FC<{
-    bridge: ReturnType<typeof useContextBridge>;
-}>;
-
-declare const VisibleCanvasReactContext: React.Context<string[]>;
-declare function useVisibleCanvases(): CanvasNormalized[];
-
-declare const ImageServiceLoaderContext: React.Context<ImageServiceLoader>;
-declare function useImageServiceLoader(): ImageServiceLoader;
+declare function Viewer({ children, ...props }: AtlasProps & {
+    height?: number | string;
+    width?: number | string;
+    resizeHash?: number;
+    containerProps?: any;
+    aspectRatio?: number;
+} & {
+    children: ReactNode;
+}): JSX.Element;
 
 interface SingleChoice {
     type: 'single-choice';
@@ -187,6 +129,39 @@ 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 MediaStrategy = {
     type: 'media';
     media: SingleAudio | SingleVideo | AudioSequence | VideoSequence;
@@ -206,12 +181,6 @@ declare type UnknownStrategy = {
 };
 declare type RenderingStrategy = SingleImageStrategy | MediaStrategy | ComplexTimelineStrategy | UnknownStrategy;
 
-declare type ImageServiceLoaderType = (imageService: any | undefined, { height, width }: {
-    height: number;
-    width: number;
-}) => ImageService | undefined;
-declare function useLoadImageService(): readonly [ImageServiceLoaderType, Record<string, string>];
-
 declare type StrategyActions = {
     makeChoice: (id: string, options?: {
         deselectOthers?: boolean;
@@ -226,32 +195,116 @@ declare type UseRenderingStrategyOptions = {
 };
 declare function useRenderingStrategy(options?: UseRenderingStrategyOptions): UseRenderingStrategy;
 
-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 type CanvasProps = {
+    x?: number;
+    y?: number;
+    onCreated?: any;
+    onChoiceChange?: (choice?: ChoiceDescription) => void;
+    registerActions?: (actions: StrategyActions) => void;
+    defaultChoices?: Array<{
+        id: string;
+        opacity?: number;
     }>;
-}
-declare function getPaintables(vault: Vault, paintingAnnotations: AnnotationNormalized[], enabledChoices: string[]): Paintables;
-declare const emptyActions: {
-    makeChoice: () => void;
+    isStatic?: boolean;
 };
-declare const unknownResponse: UseRenderingStrategy[0];
-declare const unsupportedStrategy: (reason: string) => UseRenderingStrategy[0];
+declare function RenderCanvas({ x, y, onChoiceChange, registerActions, defaultChoices, isStatic }: CanvasProps): JSX.Element | null;
 
-declare type SingleImageStrategy = {
-    type: 'images';
+declare function RenderImage({ id, image, thumbnail, isStatic, x, y, annotations, }: {
+    id: string;
     image: ImageWithOptionalService;
-    images: Array<ImageWithOptionalService>;
-    choice?: ChoiceDescription;
-    annotations?: AnnotationPageDescription;
+    thumbnail?: ImageCandidate;
+    isStatic?: boolean;
+    x?: number;
+    y?: number;
+    annotations?: JSX.Element;
+}): 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 getImageStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType): RenderingStrategy;
+
+declare const AnnotationContext: React__default.FC<{
+    annotation: string;
+}>;
+
+declare const CanvasContext: React__default.FC<{
+    canvas: string;
+}>;
+
+declare const CollectionContext: React__default.FC<{
+    collection: string;
+}>;
+
+declare const ManifestContext: React__default.FC<{
+    manifest: string;
+}>;
+
+declare const RangeContext: React__default.FC<{
+    range: string;
+}>;
+
+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 const ResourceProvider: React__default.FC<{
+    value: ResourceContextType;
+}>;
+
+declare const ReactVaultContext: React__default.Context<{
+    vault: Vault | null;
+    setVaultInstance: (vault: Vault) => void;
+}>;
+declare const VaultProvider: React__default.FC<{
+    vault?: Vault;
+    useGlobal?: boolean;
+    vaultOptions?: VaultOptions;
+    resources?: ResourceContextType;
+}>;
+
+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 const ContextBridge: React__default.FC<{
+    bridge: ReturnType<typeof useContextBridge>;
+}>;
+
+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;
@@ -301,23 +354,54 @@ declare function useEventListener<T>(resource: Reference, name: SupportedEvents,
 
 declare function useExistingVault(): any;
 
-declare const useExternalCollection: (id: string, config?: QueryOptions<CollectionNormalized>) => {
+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;
-    collection?: CollectionNormalized | undefined;
+    error: any;
+    cached: boolean;
+    resource?: T;
 };
 
-declare const useExternalManifest: (id: string, config?: QueryOptions<ManifestNormalized>) => {
+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 | undefined;
+    manifest?: ManifestNormalized;
 };
 
-declare function useImageService(): {
+interface ImageServiceRequestOptions {
+    cacheKey?: string;
+}
+declare function useImageService({ cacheKey }?: ImageServiceRequestOptions): {
     data: ImageService | undefined;
     isFetching: boolean;
-    status: 'error' | 'success' | 'loading';
+    status: 'error' | 'success' | 'loading' | 'idle';
 };
 
 declare function useImageTile(): {
@@ -394,6 +478,14 @@ declare function useVirtualAnnotationPage(): readonly [AnnotationPageNormalized
     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 | {
@@ -434,11 +526,11 @@ declare type SimpleViewerContext = {
     nextCanvas: () => void;
     previousCanvas: () => void;
 };
-declare const SimpleViewerReactContext: React.Context<SimpleViewerContext>;
+declare const SimpleViewerReactContext: React__default.Context<SimpleViewerContext>;
 declare const SimpleViewerProvider: FC<{
     manifest: string;
     pagingEnabled?: boolean;
 }>;
 declare function useSimpleViewer(): SimpleViewerContext;
 
-export { AnnotationContext, AnnotationPageDescription, AudioSequence, BoxSelector, CanvasContext, ChoiceDescription, CollectionContext, ComplexChoice, ComplexTimelineStrategy, ContextBridge, ImageServiceLoaderContext, ImageServiceLoaderType, ImageWithOptionalService, ManifestContext, MediaStrategy, Paintables, ParsedSelector, PointSelector, RangeContext, ReactVaultContext, RenderingStrategy, ResourceContextType, ResourceProvider, ResourceReactContext, SimpleViewerProvider, SimpleViewerReactContext, SingleAudio, SingleChoice, SingleImageStrategy, SingleVideo, StrategyActions, SupportedSelector, SupportedSelectors, SupportedTarget, TemporalBoxSelector, TemporalSelector, UnknownStrategy, UseRenderingStrategy, UseRenderingStrategyOptions, VaultActivatedAnnotation, VaultProvider, VideoSequence, VisibleCanvasReactContext, emptyActions, expandTarget, flattenAnnotationPageIds, getImageStrategy, getPaintables, parseSelector, parseSpecificResource, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPageManager, useAnnotationsAtTime, useCanvas, useCanvasClock, useCollection, useContextBridge, useDispatch, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useImageService, useImageServiceLoader, useImageTile, useLoadImageService, useManifest, usePaintables, usePaintingAnnotations, useRange, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSimpleViewer, useStyleHelper, useStyles, useThumbnail, useVault, useVaultEffect, useVaultSelector, useVirtualAnnotationPage, useVisibleCanvases };
+export { AnnotationContext, AnnotationPageDescription, AudioSequence, BoxSelector, CanvasContext, CanvasPanel, ChoiceDescription, CollectionContext, ComplexChoice, ComplexTimelineStrategy, ContextBridge, ImageServiceLoaderContext, ImageServiceLoaderType, ImageServiceRequestOptions, ImageWithOptionalService, ManifestContext, MediaStrategy, Paintables, ParsedSelector, PointSelector, 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, getImageStrategy, getPaintables, parseSelector, parseSpecificResource, unknownResponse, unsupportedStrategy, useAnnotation, useAnnotationPageManager, useAnnotationsAtTime, useCanvas, useCanvasClock, useCollection, useContextBridge, useDispatch, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useImageService, useImageServiceLoader, useImageTile, useLoadImageService, useManifest, usePaintables, usePaintingAnnotations, useRange, useRenderingStrategy, useResourceContext, useResourceEvents, useResources, useSearchService, useSimpleViewer, useStyleHelper, useStyles, useThumbnail, useVault, useVaultEffect, useVaultSelector, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };