react-iiif-vault 0.9.3 → 0.9.6

package/dist/index.d.ts

@@ -3,7 +3,6 @@ import { Vault, VaultOptions, ReduxStore, NormalizedEntity, IIIFStore } from '@i
 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<{
@@ -301,23 +300,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;
+    error: any;
+    cached: boolean;
+    resource?: T;
+};
+
+declare function useExternalCollection(idOrRef: string | {
+    id: string;
+    type: string;
+}, options?: ResourceRequestOptions): {
     id: string;
+    requestId: string;
     isLoaded: boolean;
-    collection?: CollectionNormalized | undefined;
+    cached?: boolean;
+    error: any;
+    manifest?: CollectionNormalized;
 };
 
-declare const useExternalManifest: (id: string, config?: QueryOptions<ManifestNormalized>) => {
+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(): {
@@ -441,4 +471,4 @@ declare const SimpleViewerProvider: FC<{
 }>;
 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, 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, 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, useVisibleCanvases };