react-iiif-vault 1.0.11 → 1.1.1

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

@@ -1,2 +0,0 @@
-import { Reference } from '@iiif/presentation-3';
-export declare function useCanvasSubset(idsOrRefs?: Array<string | Reference>): Reference<'Canvas'>[];

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

@@ -1,8 +0,0 @@
-import { CollectionNormalized } from '@iiif/presentation-3-normalized';
-export declare function useCollection(options: {
-    id: string;
-}): CollectionNormalized | undefined;
-export declare function useCollection<T>(options: {
-    id: string;
-    selector: (collection: CollectionNormalized) => T;
-}, deps?: any[]): T | undefined;

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

@@ -1,2 +0,0 @@
-import { VaultZustandStore } from '@iiif/helpers/vault/store';
-export declare function useDispatch(): VaultZustandStore['dispatch'];

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

@@ -1 +0,0 @@
-export declare function useEnabledAnnotationPageIds(resourceId?: string, availablePageIds?: string[]): string[];

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

@@ -1,4 +0,0 @@
-import { Reference } from '@iiif/presentation-3';
-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/useExistingVault.d.ts

@@ -1,2 +0,0 @@
-import { Vault } from '@iiif/helpers/vault';
-export declare function useExistingVault(vault?: Vault): Vault;

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

@@ -1,13 +0,0 @@
-import { CollectionNormalized } from '@iiif/presentation-3-normalized';
-import { ResourceRequestOptions } from './useExternalResource';
-export declare function useExternalCollection(idOrRef: string | {
-    id: string;
-    type: string;
-}, options?: ResourceRequestOptions): {
-    id: string;
-    requestId: string;
-    isLoaded: boolean;
-    cached?: boolean;
-    error: any;
-    manifest?: CollectionNormalized;
-};

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

@@ -1,13 +0,0 @@
-import { ManifestNormalized } from '@iiif/presentation-3-normalized';
-import { ResourceRequestOptions } from './useExternalResource';
-export declare function useExternalManifest(idOrRef: string | {
-    id: string;
-    type: string;
-}, options?: ResourceRequestOptions): {
-    id: string;
-    requestId: string;
-    isLoaded: boolean;
-    cached?: boolean;
-    error: any;
-    manifest?: ManifestNormalized;
-};

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

@@ -1,16 +0,0 @@
-export type ResourceRequestOptions = {
-    noCache?: boolean;
-};
-export 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;
-};

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

@@ -1,10 +0,0 @@
-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/useImageService.d.ts

@@ -1,9 +0,0 @@
-import { ImageService } from '@iiif/presentation-3';
-export interface ImageServiceRequestOptions {
-    cacheKey?: string;
-}
-export declare function useImageService({ cacheKey }?: ImageServiceRequestOptions): {
-    data: ImageService | undefined;
-    isFetching: boolean;
-    status: 'error' | 'success' | 'loading' | 'idle';
-};

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

@@ -1,11 +0,0 @@
-import { ImageService } from '@iiif/presentation-3';
-export declare function useImageTile(): {
-    isLoading: boolean;
-    tile: {
-        id: string | undefined;
-        width: number | null | undefined;
-        height: number | null | undefined;
-        imageService: ImageService;
-        thumbnail: undefined;
-    } | null;
-};

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

@@ -1,6 +0,0 @@
-import { ImageService } from '@iiif/presentation-3';
-export type ImageServiceLoaderType = (imageService: any | undefined, { height, width }: {
-    height: number;
-    width: number;
-}) => ImageService | undefined;
-export declare function useLoadImageService(): readonly [ImageServiceLoaderType, Record<string, string>];

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

@@ -1,8 +0,0 @@
-import { ManifestNormalized } from '@iiif/presentation-3-normalized';
-export declare function useManifest(options?: {
-    id: string;
-}): ManifestNormalized | undefined;
-export declare function useManifest<T>(options?: {
-    id: string;
-    selector: (manifest: ManifestNormalized) => T;
-}, deps?: any[]): T | undefined;

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

@@ -1,9 +0,0 @@
-export declare function usePaintables(options?: {
-    defaultChoices?: string[];
-    enableSingleAnnotation?: boolean;
-}, deps?: any[]): readonly [import("@iiif/helpers/painting-annotations").Paintables, {
-    makeChoice: (id: string, { deselectOthers, deselect }?: {
-        deselectOthers?: boolean | undefined;
-        deselect?: boolean | undefined;
-    }) => void;
-}];

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

@@ -1,5 +0,0 @@
-import { AnnotationNormalized } from '@iiif/presentation-3-normalized';
-export declare function usePaintingAnnotations(options?: {
-    canvasId?: string;
-    enableSingleAnnotation?: boolean;
-}): AnnotationNormalized[];

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

@@ -1,8 +0,0 @@
-import { RangeNormalized } from '@iiif/presentation-3-normalized';
-export declare function useRange(options?: {
-    id: string;
-}): RangeNormalized | undefined;
-export declare function useRange<T>(options?: {
-    id: string;
-    selector: (range: RangeNormalized) => T;
-}, deps?: any[]): T | undefined;

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

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

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

@@ -1,3 +0,0 @@
-import { NormalizedEntity } from '@iiif/helpers/vault';
-import { Reference } from '@iiif/presentation-3';
-export declare function useResourceEvents<T extends NormalizedEntity>(resource?: Reference, scope?: string[]): any;

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

@@ -1 +0,0 @@
-export declare function useResources<Type>(ids: string[], type: string): Type[];

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

@@ -1,2 +0,0 @@
-import { SearchService } from '@iiif/presentation-3';
-export declare function useSearchService(): SearchService | undefined;

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

@@ -1,32 +0,0 @@
-import { RefObject } from 'react';
-export type MediaPlayerState = {
-    isPlaying: boolean;
-    isMuted: boolean;
-    playRequested: boolean;
-    volume: number;
-    isFinished: boolean;
-    duration: number;
-};
-export 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;
-};
-export declare function formatTime(time: number): string;
-export declare function useSimpleMediaPlayer(props: {
-    duration: number;
-}): readonly [
-    {
-        element: RefObject<HTMLAudioElement | HTMLVideoElement>;
-        currentTime: RefObject<HTMLDivElement>;
-        progress: RefObject<HTMLDivElement>;
-    },
-    MediaPlayerState,
-    MediaPlayerActions
-];

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

@@ -1 +0,0 @@
-export declare function useStyleHelper(): import("@iiif/helpers/styles").StyledHelper<import("@iiif/helpers/styles").StyleDefinition>;

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

@@ -1,3 +0,0 @@
-import { Reference } from '@iiif/presentation-3';
-export declare function useStyles<Style extends Record<string, Record<string, any>>>(resource: undefined | Reference<any>): Style;
-export declare function useStyles<Style extends Record<string, any>>(resource: undefined | Reference<any>, scope: string): Style;

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

@@ -1,5 +0,0 @@
-import { ImageCandidate, ImageCandidateRequest } from '@atlas-viewer/iiif-image-api';
-export declare function useThumbnail(request: ImageCandidateRequest, dereference?: boolean, { canvasId, manifestId }?: {
-    canvasId?: string;
-    manifestId?: string;
-}): ImageCandidate | undefined;

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

@@ -1,2 +0,0 @@
-import { Vault } from '@iiif/helpers/vault';
-export declare const useVault: () => Vault;

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

@@ -1,2 +0,0 @@
-import { Vault } from '@iiif/helpers/vault';
-export declare const useVaultEffect: (callback: (vault: Vault) => void, deps?: any[]) => void;

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

@@ -1,2 +0,0 @@
-import { IIIFStore, Vault } from '@iiif/helpers/vault';
-export declare function useVaultSelector<T>(selector: (state: IIIFStore, vault: Vault) => T, deps?: any[]): T;

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

@@ -1,14 +0,0 @@
-import { Annotation } from '@iiif/presentation-3';
-import { AnnotationNormalized, AnnotationPageNormalized } from '@iiif/presentation-3-normalized';
-import { Vault } from '@iiif/helpers/vault';
-export interface VaultActivatedAnnotation {
-    __vault?: Vault;
-    bindToVault(vault: Vault): void;
-    source: string | {
-        id: string;
-    };
-}
-export declare function useVirtualAnnotationPage(): readonly [AnnotationPageNormalized | null, {
-    readonly addAnnotation: (id: string | Annotation | VaultActivatedAnnotation | AnnotationNormalized, atIndex?: number) => void;
-    readonly removeAnnotation: (id: string | Annotation | VaultActivatedAnnotation | AnnotationNormalized) => void;
-}];