react-iiif-vault 1.5.10 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,32 +1,39 @@
1
- import { A as AudioComponentProps, V as VideoComponentProps, S as SimpleViewerContext, a as SimpleViewerProps } from './index-CrfymD6m.js';
2
- export { C as CanvasPanel, c as SimpleViewerActions, d as SimpleViewerActionsType, b as SimpleViewerReducerState } from './index-CrfymD6m.js';
1
+ export * from '@iiif/helpers/annotation-targets';
2
+ import { S as SVGTheme, R as RenderContextProps, A as AudioComponentProps, V as VideoComponentProps, u as useSvgEditor, a as SimpleViewerContext, b as AtlasStore, c as AnnotationRequest, d as AnnotationResponse, e as AnnotationRequestOptions, f as SimpleViewerProps } from './index-yy_738ck.js';
3
+ export { h as AtlasStoreEvents, n as AtlasStoreProvider, k as AtlasStoreReactContext, g as CanvasPanel, C as CanvasPanelProps, i as CreateAtlasStoreProps, o as RenderAnnotation, q as RenderAnnotationPage, x as SimpleViewerActions, y as SimpleViewerActionsType, w as SimpleViewerReducerState, j as createAtlasStore, v as defaultSvgTheme, m as getAtlasStoreByName, p as polygonToTarget, r as requestToAnnotationResponse, t as useAtlasContextMenu, l as useAtlasStore, s as useContextMenuStore } from './index-yy_738ck.js';
3
4
  import * as react_jsx_runtime from 'react/jsx-runtime';
4
5
  import * as React$1 from 'react';
5
6
  import React__default, { ReactNode, FunctionComponent, RefObject, Context } from 'react';
6
- import { R as RenderingStrategy, b as StrategyActions, M as MediaStrategy, c as SingleImageStrategy, E as EmptyStrategy, C as ComplexTimelineStrategy, I as ImageWithOptionalService, T as TimelineKeyframe, U as UnknownStrategy, d as ImageServiceLoaderType } from './useRenderingStrategy-BiuSDiXu.js';
7
- export { f as AnnotationPageDescription, A as AudioSequence, n as ChoiceEvents, k as Single3DModelStrategy, S as SingleAudio, a as SingleVideo, e as SingleYouTubeVideo, i as TextContent, h as TextualContentStrategy, m as UseRenderingStrategy, o as UseRenderingStrategyOptions, V as VideoSequence, l as get3dStrategy, g as getImageStrategy, j as getTextualContentStrategy, u as useLoadImageService, p as useRenderingStrategy } from './useRenderingStrategy-BiuSDiXu.js';
7
+ import { R as RenderingStrategy, b as StrategyActions, M as MediaStrategy, c as SingleImageStrategy, E as EmptyStrategy, C as ComplexTimelineStrategy, I as ImageWithOptionalService, T as TimelineKeyframe, d as ImageServiceLoaderType, U as UnknownStrategy } from './useRenderingStrategy-PvoNjiMV.js';
8
+ export { i as AnnotationPageDescription, A as AudioSequence, n as ChoiceEvents, e as Single3DModelStrategy, S as SingleAudio, a as SingleVideo, h as SingleYouTubeVideo, k as TextContent, j as TextualContentStrategy, m as UseRenderingStrategy, o as UseRenderingStrategyOptions, V as VideoSequence, g as get3dStrategy, f as getImageStrategy, l as getTextualContentStrategy, u as useLoadImageService, p as useRenderingStrategy } from './useRenderingStrategy-PvoNjiMV.js';
8
9
  import * as _iiif_helpers from '@iiif/helpers';
9
- import { ChoiceDescription, Paintables, ComplexChoice } from '@iiif/helpers';
10
+ import { ChoiceDescription, Paintables, ComplexChoice, SupportedSelector, SvgSelector, BoxSelector } from '@iiif/helpers';
10
11
  import { BoxStyle, AtlasProps, Preset } from '@atlas-viewer/atlas';
11
- import { InternationalString, ImageService as ImageService$1, ImageSize, AuthProbeService2, Auth2LocationResource, Auth2SubstituteResource, AuthAccessService2, AuthAccessTokenService2, AuthAccessToken2, SearchServiceQueryParams, SearchServiceSearchResponse, SearchService as SearchService$1, SearchServiceAutocomplete, Reference, Annotation } from '@iiif/presentation-3';
12
- import { RegionParameter, RotationParameter, SizeParameter } from '@iiif/parser/image-3';
13
12
  import * as polygon_editor from 'polygon-editor';
14
- import { RenderState, InputShape, SlowState } from 'polygon-editor';
13
+ import { InputShape, PolygonEvents } from 'polygon-editor';
14
+ import { InternationalString, ImageService as ImageService$1, ImageSize, AuthProbeService2, Auth2LocationResource, Auth2SubstituteResource, AuthAccessService2, AuthAccessTokenService2, AuthAccessToken2, SearchServiceQueryParams, SearchServiceSearchResponse, SearchService as SearchService$1, SearchServiceAutocomplete, Reference, Annotation, SvgSelector as SvgSelector$1, FragmentSelector } from '@iiif/presentation-3';
15
+ import { RegionParameter, RotationParameter, SizeParameter } from '@iiif/parser/image-3';
15
16
  import * as zustand_vanilla from 'zustand/vanilla';
16
17
  import { StoreApi } from 'zustand/vanilla';
17
18
  import * as zustand from 'zustand';
18
19
  import { StoreApi as StoreApi$1 } from 'zustand';
19
20
  import * as mitt from 'mitt';
20
21
  import { Emitter, EventType, Handler } from 'mitt';
22
+ import { ImageServiceLoader, ImageCandidateRequest, ImageCandidate } from '@iiif/helpers/image-service';
21
23
  import { Vault, VaultOptions, NormalizedEntity, IIIFStore } from '@iiif/helpers/vault';
22
24
  import { CanvasNormalized, AnnotationNormalized, AnnotationPageNormalized, CollectionNormalized, ManifestNormalized, RangeNormalized } from '@iiif/presentation-3-normalized';
23
- import { ImageServiceLoader, ImageCandidateRequest, ImageCandidate } from '@iiif/helpers/image-service';
24
- import { C as CompatVault } from './utils-C-h4SU3S.js';
25
- export { e as emptyActions, b as emptyStrategy, g as getParsedTargetSelector, c as getRenderingStrategy, p as parseSpecificResource, u as unknownResponse, a as unsupportedStrategy } from './utils-C-h4SU3S.js';
25
+ import { C as CompatVault } from './utils-DyrEcegR.js';
26
+ export { e as emptyActions, c as emptyStrategy, a as getParsedTargetSelector, g as getRenderingStrategy, p as parseSpecificResource, u as unknownResponse, b as unsupportedStrategy } from './utils-DyrEcegR.js';
26
27
  import { VaultZustandStore } from '@iiif/helpers/vault/store';
27
28
  import * as _iiif_helpers_painting_annotations from '@iiif/helpers/painting-annotations';
28
29
  import * as _iiif_helpers_styles from '@iiif/helpers/styles';
29
- export * from '@iiif/helpers/annotation-targets';
30
+
31
+ declare function RenderAnnotationEditing({ theme, renderContextMenu, children, }: {
32
+ theme?: Partial<SVGTheme>;
33
+ renderContextMenu?: (options: RenderContextProps) => React.ReactNode;
34
+ children?: React.ReactNode;
35
+ }): react_jsx_runtime.JSX.Element | null;
36
+ declare function DefaultEditingTools(): react_jsx_runtime.JSX.Element | null;
30
37
 
31
38
  interface CanvasStrategyProviderProps {
32
39
  onChoiceChange?: (choice?: ChoiceDescription) => void;
@@ -52,27 +59,36 @@ interface CanvasWorldObjectProps {
52
59
  y?: number;
53
60
  keepCanvasScale?: boolean;
54
61
  children?: ReactNode;
62
+ renderContextMenu?: (options: RenderContextProps) => ReactNode;
55
63
  }
56
- declare function CanvasWorldObject({ x, y, keepCanvasScale, children }: CanvasWorldObjectProps): react_jsx_runtime.JSX.Element | null;
64
+ declare function CanvasWorldObject({ x, y, keepCanvasScale, renderContextMenu, children, }: CanvasWorldObjectProps): react_jsx_runtime.JSX.Element | null;
57
65
 
58
66
  declare function ThumbnailFallbackImage({ x, y }: {
59
67
  x?: number;
60
68
  y?: number;
61
69
  }): react_jsx_runtime.JSX.Element | null;
62
70
 
63
- interface RenderEmptyStrategyProps {
64
- backgroundStyle?: BoxStyle;
65
- alwaysShowBackground?: boolean;
71
+ declare function Render3DModelStrategy(): react_jsx_runtime.JSX.Element | null;
72
+
73
+ declare function RenderAccompanyingCanvas(): react_jsx_runtime.JSX.Element;
74
+
75
+ interface AnnotationStrategyProps {
76
+ children?: ReactNode;
66
77
  }
67
- declare function RenderEmptyStrategy({ backgroundStyle, alwaysShowBackground }: RenderEmptyStrategyProps): react_jsx_runtime.JSX.Element | null;
78
+ declare function RenderAnnotationStrategy({ children }: AnnotationStrategyProps): react_jsx_runtime.JSX.Element | null;
79
+
80
+ interface RenderAudioStrategyProps {
81
+ as?: React.ComponentType<AudioComponentProps>;
82
+ }
83
+ declare function RenderAudioStrategy({ as: CustomAudio }: RenderAudioStrategyProps): react_jsx_runtime.JSX.Element | null;
68
84
 
69
85
  declare function RenderComplexTimelineStrategy(): react_jsx_runtime.JSX.Element | null;
70
86
 
71
- interface TextualContextStrategyProps {
72
- onClickPaintingAnnotation?: (id: string, e: any) => void;
73
- children?: ReactNode;
87
+ interface RenderEmptyStrategyProps {
88
+ backgroundStyle?: BoxStyle;
89
+ alwaysShowBackground?: boolean;
74
90
  }
75
- declare function RenderTextualContentStrategy({ onClickPaintingAnnotation, children }: TextualContextStrategyProps): react_jsx_runtime.JSX.Element | null;
91
+ declare function RenderEmptyStrategy({ backgroundStyle, alwaysShowBackground }: RenderEmptyStrategyProps): react_jsx_runtime.JSX.Element | null;
76
92
 
77
93
  interface ImageStrategyProps {
78
94
  isStatic?: boolean;
@@ -82,19 +98,11 @@ interface ImageStrategyProps {
82
98
  }
83
99
  declare function RenderImageStrategy({ isStatic, enableSizes, onClickPaintingAnnotation, children, }: ImageStrategyProps): react_jsx_runtime.JSX.Element | null;
84
100
 
85
- declare function Render3DModelStrategy(): react_jsx_runtime.JSX.Element | null;
86
-
87
- interface AnnotationStrategyProps {
101
+ interface TextualContextStrategyProps {
102
+ onClickPaintingAnnotation?: (id: string, e: any) => void;
88
103
  children?: ReactNode;
89
104
  }
90
- declare function RenderAnnotationStrategy({ children }: AnnotationStrategyProps): react_jsx_runtime.JSX.Element | null;
91
-
92
- interface RenderAudioStrategyProps {
93
- as?: React.ComponentType<AudioComponentProps>;
94
- }
95
- declare function RenderAudioStrategy({ as: CustomAudio, }: RenderAudioStrategyProps): react_jsx_runtime.JSX.Element | null;
96
-
97
- declare function RenderAccompanyingCanvas(): react_jsx_runtime.JSX.Element;
105
+ declare function RenderTextualContentStrategy({ onClickPaintingAnnotation, children }: TextualContextStrategyProps): react_jsx_runtime.JSX.Element | null;
98
106
 
99
107
  interface RenderVideoStrategyProps {
100
108
  as?: React__default.ComponentType<VideoComponentProps>;
@@ -103,6 +111,74 @@ declare function RenderVideoStrategy({ as: CustomVideo, }: RenderVideoStrategyPr
103
111
 
104
112
  declare function RenderYouTubeStrategy(): react_jsx_runtime.JSX.Element | null;
105
113
 
114
+ declare const svgThemes: ({
115
+ name: string;
116
+ outer: {
117
+ borderWidth: number;
118
+ borderColor: string;
119
+ };
120
+ inner: {
121
+ borderWidth: number;
122
+ borderColor: string;
123
+ };
124
+ } | {
125
+ name: string;
126
+ outer: {
127
+ borderWidth: string;
128
+ borderColor: string;
129
+ };
130
+ inner: {
131
+ borderWidth: string;
132
+ borderColor: string;
133
+ };
134
+ } | {
135
+ name: string;
136
+ outer: {
137
+ borderWidth: string;
138
+ borderColor: string;
139
+ };
140
+ inner: {
141
+ borderWidth?: undefined;
142
+ borderColor?: undefined;
143
+ };
144
+ })[];
145
+ type HelperType = ReturnType<typeof useSvgEditor>['helper'];
146
+ type StateType = ReturnType<typeof useSvgEditor>['state'];
147
+ type SvgTheme = {
148
+ name?: string;
149
+ outer: BoxStyle;
150
+ inner: BoxStyle;
151
+ };
152
+ interface CreateCustomShapeProps {
153
+ image: {
154
+ width: number;
155
+ height: number;
156
+ };
157
+ shape?: any;
158
+ updateShape: any;
159
+ theme?: {
160
+ name?: string;
161
+ outer: BoxStyle;
162
+ inner: BoxStyle;
163
+ };
164
+ controlsHtmlId?: string;
165
+ renderControls?: (helper: HelperType, state: StateType, showShapes: boolean) => any;
166
+ }
167
+ declare function CreateCustomShape(props: CreateCustomShapeProps): null;
168
+
169
+ interface PolygonSelectorProps {
170
+ id: string;
171
+ polygon: InputShape;
172
+ annotationBucket?: string;
173
+ isHighlighted?: boolean;
174
+ updatePolygon?: (shape: InputShape) => void;
175
+ readOnly?: boolean;
176
+ theme?: SvgTheme;
177
+ controlsHtmlId?: string;
178
+ renderControls?: CreateCustomShapeProps['renderControls'];
179
+ }
180
+ declare function PolygonSelector(props: PolygonSelectorProps): react_jsx_runtime.JSX.Element | null;
181
+
106
182
  declare const CanvasAnnotations: React$1.ForwardRefExoticComponent<{
107
183
  canvasId?: string | undefined;
108
184
  } & React$1.RefAttributes<{
@@ -169,6 +245,21 @@ interface ImageProps {
169
245
  }
170
246
  declare function Image(props: ImageProps): react_jsx_runtime.JSX.Element | null;
171
247
 
248
+ interface ImageServiceProps {
249
+ src: string;
250
+ atlas?: AtlasProps;
251
+ errorFallback?: React__default.FC;
252
+ interactive?: boolean;
253
+ skipSizes?: boolean;
254
+ renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
255
+ viewControlsDeps?: any[];
256
+ fluid?: boolean;
257
+ x?: number;
258
+ y?: number;
259
+ children?: React__default.ReactNode;
260
+ }
261
+ declare function ImageService({ src, errorFallback, interactive, skipSizes, children, renderViewerControls, viewControlsDeps, fluid, x, y, ...atlasProps }: ImageServiceProps & Omit<AtlasProps, 'children'>): react_jsx_runtime.JSX.Element | null;
262
+
172
263
  type ManifestMetadataProps = Omit<MetadataProps, 'metadata'>;
173
264
  declare function ManifestMetadata(props: ManifestMetadataProps): react_jsx_runtime.JSX.Element;
174
265
 
@@ -222,89 +313,17 @@ interface SingleCanvasThumbnailProps {
222
313
  }
223
314
  declare function SingleCanvasThumbnail(props: SingleCanvasThumbnailProps): react_jsx_runtime.JSX.Element;
224
315
 
225
- interface SvgEditorOptions {
226
- image: {
227
- height: number;
228
- width: number;
229
- };
230
- currentShape: InputShape | null;
231
- onChange: (e: InputShape) => void;
232
- hideShapeLines?: boolean;
233
- }
234
- declare function useSvgEditor(options: SvgEditorOptions, deps: any[]): {
235
- helper: {
236
- draw: {
237
- enable(): void;
238
- disable(): void;
239
- toggle(): void;
240
- };
241
- state: RenderState;
242
- modifiers: {
243
- reset(): void;
244
- getForType(type: string | null): Record<string, string>;
245
- set(modifier: string): void;
246
- unset(modifier: string): void;
247
- };
248
- stamps: {
249
- set(selectedStamp: InputShape | null): void;
250
- clear(): void;
251
- square(): void;
252
- triangle(): void;
253
- pentagon(): void;
254
- hexagon(): void;
255
- };
256
- key: {
257
- down(key: string): true | undefined;
258
- up(key: string): void;
259
- };
260
- setScale: (scale: number) => void;
261
- clock: {
262
- set: (renderFunc: polygon_editor.RenderFunc) => void;
263
- start: (renderFunc?: polygon_editor.RenderFunc | undefined, setStateFunc?: polygon_editor.SetState | undefined) => void;
264
- stop: () => void;
265
- step: (deltaTime?: number | undefined) => void;
266
- };
267
- pointer: (pointers: ([number, number] | [number, number, number, number, number, number])[]) => void;
268
- blur: () => void;
269
- pointerDown: () => void;
270
- pointerUp: () => void;
271
- setShape: (shape: InputShape | null) => void;
272
- modes: {
273
- toggleLineBoxMode: () => void;
274
- toggleLineMode: () => void;
275
- enableLineMode(): void;
276
- disableLineMode(): void;
277
- enableLineBoxMode(): void;
278
- disableLineBoxMode(): void;
279
- };
280
- label: (type: string | null) => string;
281
- };
282
- state: SlowState;
283
- isAddingPoint: boolean;
284
- isSplitting: boolean;
285
- isStamping: boolean | null;
286
- isHoveringPoint: boolean;
287
- transitionDirection: string | null;
288
- transitionRotate: boolean;
289
- defs: react_jsx_runtime.JSX.Element;
290
- editor: react_jsx_runtime.JSX.Element | null;
291
- };
292
-
293
- type HelperType$1 = ReturnType<typeof useSvgEditor>['helper'];
294
- type StateType$1 = ReturnType<typeof useSvgEditor>['state'];
295
316
  interface RenderSvgEditorControlsProps {
296
- helper: HelperType$1;
297
- state: StateType$1;
298
- showShapes: boolean;
317
+ showShapes?: boolean;
299
318
  classNames?: Partial<{
300
319
  button: string;
301
320
  }>;
302
321
  enabled?: {
303
322
  draw?: boolean;
304
- polygon?: boolean;
323
+ pen?: boolean;
305
324
  line?: boolean;
306
325
  lineBox?: boolean;
307
- square?: boolean;
326
+ box?: boolean;
308
327
  triangle?: boolean;
309
328
  hexagon?: boolean;
310
329
  circle?: boolean;
@@ -312,101 +331,20 @@ interface RenderSvgEditorControlsProps {
312
331
  };
313
332
  icons?: Partial<{
314
333
  DrawIcon: ReactNode;
315
- PolygonIcon: ReactNode;
334
+ PenIcon: ReactNode;
316
335
  LineIcon: ReactNode;
317
336
  LineBoxIcon: ReactNode;
318
337
  ShapesIcon: ReactNode;
319
- SquareIcon: ReactNode;
338
+ BoxIcon: ReactNode;
320
339
  TriangleIcon: ReactNode;
321
340
  HexagonIcon: ReactNode;
322
341
  CircleIcon: ReactNode;
323
342
  DeleteForeverIcon: ReactNode;
343
+ PointerIcon: ReactNode;
344
+ HandIcon: ReactNode;
324
345
  }>;
325
346
  }
326
- declare function RenderSvgEditorControls({ helper, showShapes, state, enabled, classNames, icons, }: RenderSvgEditorControlsProps): react_jsx_runtime.JSX.Element;
327
-
328
- declare const svgThemes: ({
329
- name: string;
330
- outer: {
331
- borderWidth: number;
332
- borderColor: string;
333
- };
334
- inner: {
335
- borderWidth: number;
336
- borderColor: string;
337
- };
338
- } | {
339
- name: string;
340
- outer: {
341
- borderWidth: string;
342
- borderColor: string;
343
- };
344
- inner: {
345
- borderWidth: string;
346
- borderColor: string;
347
- };
348
- } | {
349
- name: string;
350
- outer: {
351
- borderWidth: string;
352
- borderColor: string;
353
- };
354
- inner: {
355
- borderWidth?: undefined;
356
- borderColor?: undefined;
357
- };
358
- })[];
359
- type HelperType = ReturnType<typeof useSvgEditor>['helper'];
360
- type StateType = ReturnType<typeof useSvgEditor>['state'];
361
- type SvgTheme = {
362
- name?: string;
363
- outer: BoxStyle;
364
- inner: BoxStyle;
365
- };
366
- interface CreateCustomShapeProps {
367
- image: {
368
- width: number;
369
- height: number;
370
- };
371
- shape?: any;
372
- updateShape: any;
373
- theme?: {
374
- name?: string;
375
- outer: BoxStyle;
376
- inner: BoxStyle;
377
- };
378
- controlsHtmlId?: string;
379
- renderControls?: (helper: HelperType, state: StateType, showShapes: boolean) => any;
380
- }
381
- declare function CreateCustomShape(props: CreateCustomShapeProps): react_jsx_runtime.JSX.Element;
382
-
383
- interface PolygonSelectorProps {
384
- id: string;
385
- polygon: InputShape;
386
- annotationBucket?: string;
387
- isHighlighted?: boolean;
388
- updatePolygon?: (shape: InputShape) => void;
389
- readOnly?: boolean;
390
- theme?: SvgTheme;
391
- controlsHtmlId?: string;
392
- renderControls?: CreateCustomShapeProps['renderControls'];
393
- }
394
- declare function PolygonSelector(props: PolygonSelectorProps): react_jsx_runtime.JSX.Element | null;
395
-
396
- interface ImageServiceProps {
397
- src: string;
398
- atlas?: AtlasProps;
399
- errorFallback?: React__default.FC;
400
- interactive?: boolean;
401
- skipSizes?: boolean;
402
- renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
403
- viewControlsDeps?: any[];
404
- fluid?: boolean;
405
- x?: number;
406
- y?: number;
407
- children?: React__default.ReactNode;
408
- }
409
- declare function ImageService({ src, errorFallback, interactive, skipSizes, children, renderViewerControls, viewControlsDeps, fluid, x, y, ...atlasProps }: ImageServiceProps & Omit<AtlasProps, 'children'>): react_jsx_runtime.JSX.Element | null;
347
+ declare function RenderSvgEditorControls({ showShapes, enabled, classNames, icons, }: RenderSvgEditorControlsProps): react_jsx_runtime.JSX.Element;
410
348
 
411
349
  declare function AnnotationContext({ annotation, children }: {
412
350
  annotation: string;
@@ -418,6 +356,37 @@ declare function AnnotationPageContext({ annotationPage, children }: {
418
356
  children: ReactNode;
419
357
  }): react_jsx_runtime.JSX.Element;
420
358
 
359
+ interface AnnotationStyles {
360
+ id: number;
361
+ name: string;
362
+ creator?: {
363
+ id: number;
364
+ name: string;
365
+ };
366
+ createdAt: Date;
367
+ theme: {
368
+ default: AnnotationThemeDefinition;
369
+ hidden: AnnotationThemeDefinition;
370
+ highlighted: AnnotationThemeDefinition;
371
+ } & Record<string, AnnotationThemeDefinition>;
372
+ }
373
+ type AnnotationThemeDefinition = BoxStyle & {
374
+ hidden?: boolean;
375
+ interactive?: boolean;
376
+ hotspot?: boolean;
377
+ hotspotSize?: 'lg' | 'md' | 'sm';
378
+ };
379
+ declare function getDefaultAnnotationStyles(): AnnotationStyles['theme'];
380
+ declare function useAnnotationStyles(): {
381
+ default: AnnotationThemeDefinition;
382
+ hidden: AnnotationThemeDefinition;
383
+ highlighted: AnnotationThemeDefinition;
384
+ } & Record<string, AnnotationThemeDefinition>;
385
+ declare function AnnotationStyleProvider({ theme, children, }: {
386
+ theme?: AnnotationStyles['theme'];
387
+ children: React.ReactNode;
388
+ }): react_jsx_runtime.JSX.Element;
389
+
421
390
  declare function hasAuth(resource: any): boolean;
422
391
  interface ProbeStore {
423
392
  service?: AuthProbeService2;
@@ -595,82 +564,24 @@ interface ComplexTimelineStore extends MediaPlayerActions {
595
564
  removeElement: (id: string) => void;
596
565
  applyKeyframes(newIdx: number, keyframes: TimelineKeyframe[]): void;
597
566
  nextKeyframeIndex: number;
598
- setProgressElement(div: HTMLDivElement): void;
599
- setCurrentTimeElement(div: HTMLDivElement): void;
600
- clearProgressElement(): void;
601
- clearCurrentTimeElement(): void;
602
- }
603
-
604
- declare function ComplexTimelineProvider({ children, store, }: {
605
- children: React.ReactNode;
606
- store: StoreApi$1<ComplexTimelineStore>;
607
- }): react_jsx_runtime.JSX.Element;
608
- declare function useComplexTimeline<T>(selector: (store: ComplexTimelineStore) => T): T;
609
-
610
- interface EventContext {
611
- emitter: Emitter<any>;
612
- }
613
- declare const defaultEmitter: Emitter<Record<EventType, unknown>>;
614
- declare const ReactEventContext: React__default.Context<{
615
- emitter: Emitter<Record<EventType, unknown>>;
616
- }>;
617
- declare function useEventEmitter<Events extends Record<EventType, unknown>>(): Emitter<Events>;
618
- declare function EventsProvider({ emitter, children }: EventContext & {
619
- children: React__default.ReactNode;
620
- }): react_jsx_runtime.JSX.Element;
621
-
622
- declare function ManifestContext({ manifest, children }: {
623
- manifest: string;
624
- children: ReactNode;
625
- }): react_jsx_runtime.JSX.Element;
626
-
627
- declare function useMediaState(): MediaPlayerState;
628
- declare function useMediaActions(): MediaPlayerActions;
629
- declare function useMediaElements(): {
630
- element: RefObject<HTMLAudioElement | HTMLVideoElement>;
631
- currentTime: RefObject<HTMLDivElement>;
632
- progress: RefObject<HTMLDivElement>;
633
- };
634
- declare function MediaPlayerProvider({ actions, state, children, currentTime, progress, element, }: {
635
- actions: MediaPlayerActions;
636
- state: MediaPlayerState;
637
- children: ReactNode;
638
- currentTime: RefObject<HTMLDivElement>;
639
- progress: RefObject<HTMLDivElement>;
640
- element: RefObject<HTMLAudioElement | HTMLVideoElement>;
641
- }): react_jsx_runtime.JSX.Element;
642
-
643
- declare function RangeContext({ range, children }: {
644
- range: string;
645
- children: ReactNode;
646
- }): react_jsx_runtime.JSX.Element;
647
-
648
- type ResourceContextType = {
649
- collection?: string;
650
- manifest?: string;
651
- range?: string;
652
- canvas?: string;
653
- annotation?: string;
654
- annotationPage?: string;
655
- };
656
- declare const ResourceReactContext: React__default.Context<ResourceContextType>;
657
- declare const useResourceContext: () => ResourceContextType;
658
- declare function ResourceProvider({ value, children }: {
659
- value: ResourceContextType;
660
- children: ReactNode;
661
- }): react_jsx_runtime.JSX.Element;
567
+ setProgressElement(div: HTMLDivElement): void;
568
+ setCurrentTimeElement(div: HTMLDivElement): void;
569
+ clearProgressElement(): void;
570
+ clearCurrentTimeElement(): void;
571
+ }
662
572
 
663
- declare const ReactVaultContext: React__default.Context<{
664
- vault: Vault | null;
665
- setVaultInstance: (vault: Vault) => void;
666
- }>;
667
- declare function VaultProvider({ vault, vaultOptions, useGlobal, resources, children, }: {
668
- vault?: Vault;
669
- useGlobal?: boolean;
670
- vaultOptions?: VaultOptions;
671
- resources?: ResourceContextType;
672
- children: ReactNode;
573
+ declare function ComplexTimelineProvider({ children, store, }: {
574
+ children: React.ReactNode;
575
+ store: StoreApi$1<ComplexTimelineStore>;
673
576
  }): react_jsx_runtime.JSX.Element;
577
+ declare function useComplexTimeline<T>(selector: (store: ComplexTimelineStore) => T): T;
578
+
579
+ interface StrategyContext {
580
+ strategy: RenderingStrategy;
581
+ choices: ChoiceDescription | null;
582
+ }
583
+ declare const StrategyReactContext: React$1.Context<StrategyContext | null>;
584
+ declare function useStrategy(): StrategyContext;
674
585
 
675
586
  type SearchService = SearchService$1 & {
676
587
  service: SearchServiceAutocomplete | SearchServiceAutocomplete[];
@@ -693,6 +604,21 @@ interface Search1Store {
693
604
  nextResult: () => void;
694
605
  }
695
606
 
607
+ type ResourceContextType = {
608
+ collection?: string;
609
+ manifest?: string;
610
+ range?: string;
611
+ canvas?: string;
612
+ annotation?: string;
613
+ annotationPage?: string;
614
+ };
615
+ declare const ResourceReactContext: React__default.Context<ResourceContextType>;
616
+ declare const useResourceContext: () => ResourceContextType;
617
+ declare function ResourceProvider({ value, children }: {
618
+ value: ResourceContextType;
619
+ children: ReactNode;
620
+ }): react_jsx_runtime.JSX.Element;
621
+
696
622
  declare function useCustomContextBridge(): Record<string, {
697
623
  value: any;
698
624
  Provider: React__default.Provider<any>;
@@ -702,7 +628,7 @@ declare function CustomContextBridge(props: Record<string, {
702
628
  Provider: React__default.Provider<any>;
703
629
  }> & {
704
630
  children: React__default.ReactNode;
705
- }): ReactNode;
631
+ }): React__default.ReactNode;
706
632
  declare function CustomContextBridgeProvider(props: {
707
633
  providers: Record<string, Context<any>>;
708
634
  children: React__default.ReactNode;
@@ -720,6 +646,9 @@ declare function useContextBridge(): {
720
646
  ReactEventContext: {
721
647
  emitter: mitt.Emitter<Record<mitt.EventType, unknown>>;
722
648
  };
649
+ ContextBridgeReactContext: Record<string, React__default.Context<any>>;
650
+ StrategyReactContext: StrategyContext | null;
651
+ AtlasStoreReactContext: zustand.StoreApi<AtlasStore> | null;
723
652
  };
724
653
  declare function ContextBridge(props: {
725
654
  bridge: ReturnType<typeof useContextBridge>;
@@ -727,15 +656,58 @@ declare function ContextBridge(props: {
727
656
  children: ReactNode;
728
657
  }): react_jsx_runtime.JSX.Element;
729
658
 
730
- declare const VisibleCanvasReactContext: React__default.Context<string[]>;
731
- declare function useVisibleCanvases(): CanvasNormalized[];
659
+ interface ControlsContext {
660
+ renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
661
+ viewControlsDeps: any[];
662
+ renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
663
+ mediaControlsDeps: any[];
664
+ renderComplexTimelineControls?: (strategy: ComplexTimelineStrategy) => ReactNode;
665
+ complexTimelineControlsDeps: any[];
666
+ }
667
+ declare const ControlsReactContext: React$1.Context<ControlsContext | null>;
668
+ declare function useRenderControls(): ControlsContext;
732
669
 
733
- declare const ViewerPresetContext: React$1.Context<Preset | null | undefined>;
734
- declare function useViewerPreset(): Preset | null | undefined;
670
+ interface EventContext {
671
+ emitter: Emitter<any>;
672
+ }
673
+ declare const defaultEmitter: Emitter<Record<EventType, unknown>>;
674
+ declare const ReactEventContext: React__default.Context<{
675
+ emitter: Emitter<Record<EventType, unknown>>;
676
+ }>;
677
+ declare function useEventEmitter<Events extends Record<EventType, unknown>>(): Emitter<Events>;
678
+ declare function EventsProvider({ emitter, children }: EventContext & {
679
+ children: React__default.ReactNode;
680
+ }): react_jsx_runtime.JSX.Element;
735
681
 
736
682
  declare const ImageServiceLoaderContext: React__default.Context<ImageServiceLoader>;
737
683
  declare function useImageServiceLoader(): ImageServiceLoader;
738
684
 
685
+ declare function ManifestContext({ manifest, children }: {
686
+ manifest: string;
687
+ children: ReactNode;
688
+ }): react_jsx_runtime.JSX.Element;
689
+
690
+ declare function useMediaState(): MediaPlayerState;
691
+ declare function useMediaActions(): MediaPlayerActions;
692
+ declare function useMediaElements(): {
693
+ element: RefObject<HTMLAudioElement | HTMLVideoElement>;
694
+ currentTime: RefObject<HTMLDivElement>;
695
+ progress: RefObject<HTMLDivElement>;
696
+ };
697
+ declare function MediaPlayerProvider({ actions, state, children, currentTime, progress, element, }: {
698
+ actions: MediaPlayerActions;
699
+ state: MediaPlayerState;
700
+ children: ReactNode;
701
+ currentTime: RefObject<HTMLDivElement>;
702
+ progress: RefObject<HTMLDivElement>;
703
+ element: RefObject<HTMLAudioElement | HTMLVideoElement>;
704
+ }): react_jsx_runtime.JSX.Element;
705
+
706
+ declare function RangeContext({ range, children }: {
707
+ range: string;
708
+ children: ReactNode;
709
+ }): react_jsx_runtime.JSX.Element;
710
+
739
711
  type SelectorHelperEventTypes = 'click' | 'hover' | 'selector-updated' | 'highlight' | 'clear-highlight' | 'zoom-to' | 'event-listener' | 'remove-event-listener' | 'image-preview-request';
740
712
  declare function SelectorControllerProvider({ children }: {
741
713
  children: ReactNode;
@@ -805,59 +777,28 @@ declare function useSelectorHelper(): {
805
777
  } = any>(type: SelectorHelperEventTypes, handler: Handler<T_1>): () => void;
806
778
  };
807
779
 
808
- interface AnnotationStyles {
809
- id: number;
810
- name: string;
811
- creator?: {
812
- id: number;
813
- name: string;
814
- };
815
- createdAt: Date;
816
- theme: {
817
- default: AnnotationThemeDefinition;
818
- hidden: AnnotationThemeDefinition;
819
- highlighted: AnnotationThemeDefinition;
820
- } & Record<string, AnnotationThemeDefinition>;
821
- }
822
- type AnnotationThemeDefinition = BoxStyle & {
823
- hidden?: boolean;
824
- interactive?: boolean;
825
- hotspot?: boolean;
826
- hotspotSize?: 'lg' | 'md' | 'sm';
827
- };
828
- declare function getDefaultAnnotationStyles(): AnnotationStyles['theme'];
829
- declare function useAnnotationStyles(): {
830
- default: AnnotationThemeDefinition;
831
- hidden: AnnotationThemeDefinition;
832
- highlighted: AnnotationThemeDefinition;
833
- } & Record<string, AnnotationThemeDefinition>;
834
- declare function AnnotationStyleProvider({ theme, children, }: {
835
- theme?: AnnotationStyles['theme'];
836
- children: React.ReactNode;
780
+ declare const ReactVaultContext: React__default.Context<{
781
+ vault: Vault | null;
782
+ setVaultInstance: (vault: Vault) => void;
783
+ }>;
784
+ declare function VaultProvider({ vault, vaultOptions, useGlobal, resources, children, }: {
785
+ vault?: Vault;
786
+ useGlobal?: boolean;
787
+ vaultOptions?: VaultOptions;
788
+ resources?: ResourceContextType;
789
+ children: ReactNode;
837
790
  }): react_jsx_runtime.JSX.Element;
838
791
 
839
- interface StrategyContext {
840
- strategy: RenderingStrategy;
841
- choices: ChoiceDescription | null;
842
- }
843
- declare const StrategyReactContext: React$1.Context<StrategyContext | null>;
844
- declare function useStrategy(): StrategyContext;
845
-
846
- interface ControlsContext {
847
- renderMediaControls?: (strategy: MediaStrategy) => ReactNode;
848
- viewControlsDeps: any[];
849
- renderViewerControls?: (strategy: SingleImageStrategy | EmptyStrategy) => ReactNode;
850
- mediaControlsDeps: any[];
851
- renderComplexTimelineControls?: (strategy: ComplexTimelineStrategy) => ReactNode;
852
- complexTimelineControlsDeps: any[];
853
- }
854
- declare const ControlsReactContext: React$1.Context<ControlsContext | null>;
855
- declare function useRenderControls(): ControlsContext;
792
+ declare const ViewerPresetContext: React$1.Context<Preset | null | undefined>;
793
+ declare function useViewerPreset(): Preset | null | undefined;
856
794
 
857
- declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables, vault: CompatVault): UnknownStrategy | MediaStrategy;
795
+ declare const VisibleCanvasReactContext: React__default.Context<string[]>;
796
+ declare function useVisibleCanvases(): CanvasNormalized[];
858
797
 
859
798
  declare function getComplexTimelineStrategy(canvas: CanvasNormalized, paintables: Paintables, loadImageService: ImageServiceLoaderType, vault: CompatVault): ComplexTimelineStrategy;
860
799
 
800
+ declare function getVideoStrategy(canvas: CanvasNormalized, paintables: Paintables, vault: CompatVault): UnknownStrategy | MediaStrategy;
801
+
861
802
  declare function useAnnotation(options?: {
862
803
  id: string;
863
804
  }): AnnotationNormalized | undefined;
@@ -914,13 +855,13 @@ declare function useCanvasChoices({ canvasId }?: {
914
855
 
915
856
  declare function useCanvasClock(canvasId?: string, autoplay?: boolean): void;
916
857
 
917
- declare function useCanvasSubset(idsOrRefs?: Array<string | Reference>): Reference<'Canvas'>[];
918
-
919
858
  declare function useCanvasStartTime(): {
920
859
  startTime: number;
921
860
  endTime?: number | undefined;
922
861
  } | null;
923
862
 
863
+ declare function useCanvasSubset(idsOrRefs?: Array<string | Reference>): Reference<'Canvas'>[];
864
+
924
865
  declare function useCollection(options: {
925
866
  id: string;
926
867
  }): CollectionNormalized | undefined;
@@ -929,11 +870,37 @@ declare function useCollection<T>(options: {
929
870
  selector: (collection: CollectionNormalized) => T;
930
871
  }, deps?: any[]): T | undefined;
931
872
 
873
+ declare function useCurrentAnnotationActions(): {
874
+ saveAnnotation: () => void;
875
+ cancelRequest: (requestId?: string | undefined) => void;
876
+ };
877
+
878
+ declare function useCurrentAnnotationMetadata({ requestId: customRequestId }?: {
879
+ requestId?: string;
880
+ }): readonly [Record<string, any>, (data: Record<string, any>) => void];
881
+
882
+ declare function useCurrentAnnotationRequest(): AnnotationRequest | null;
883
+
884
+ declare function useCurrentAnnotationTransition(options: {
885
+ requestId?: string | null;
886
+ onStart?: (type: string) => void;
887
+ onEnd?: (type: string, response: PolygonEvents['polygons.end-transition']['response']) => void;
888
+ onTransition?: (type: string) => void;
889
+ }): void;
890
+
932
891
  declare function useDispatch(): VaultZustandStore['dispatch'];
933
892
 
934
893
  type SupportedEvents = 'onClick';
935
894
  declare function useEventListener<T>(resource: Reference, name: SupportedEvents, listener: (e: any, resource: T) => void, scope?: string[], deps?: any[]): void;
936
895
 
896
+ declare const ReactEmitterContext: React$1.Context<Emitter<any>>;
897
+ declare function EventEmitterProvider({ children, emitter, }: {
898
+ children: React.ReactNode;
899
+ emitter: Emitter<any>;
900
+ }): react_jsx_runtime.JSX.Element;
901
+ declare function useEmitter<Event extends Record<string | symbol, unknown>>(): Emitter<Event>;
902
+ declare function useEvent<Event extends Record<string | symbol, unknown>, Key extends keyof Event>(key: Key, listener: (data: Event[Key]) => void, deps?: any[]): void;
903
+
937
904
  declare function useExistingVault(vault?: Vault): Vault;
938
905
 
939
906
  type ResourceRequestOptions = {
@@ -1034,6 +1001,126 @@ declare function usePaintingAnnotations(options?: {
1034
1001
  enableSingleAnnotation?: boolean;
1035
1002
  }): AnnotationNormalized[];
1036
1003
 
1004
+ declare function usePolygonHelper(render: (t: any, s: any, dt: number) => void): {
1005
+ currentShape: polygon_editor.InputShape | null;
1006
+ state: polygon_editor.SlowState;
1007
+ helper: {
1008
+ state: polygon_editor.RenderState;
1009
+ setState: (newState: Partial<polygon_editor.SlowState>) => void;
1010
+ emitter: mitt.Emitter<polygon_editor.PolygonEvents>;
1011
+ modifiers: {
1012
+ reset(): void;
1013
+ getForType(type: string | null): Record<string, string>;
1014
+ set(modifier: string): void;
1015
+ unset(modifier: string): void;
1016
+ };
1017
+ stamps: {
1018
+ set(selectedStamp: polygon_editor.InputShape | null): void;
1019
+ clear(): void;
1020
+ square(): void;
1021
+ triangle(): void;
1022
+ pentagon(): void;
1023
+ hexagon(): void;
1024
+ circle(): void;
1025
+ };
1026
+ history: {
1027
+ undo: () => void;
1028
+ redo: () => void;
1029
+ readonly canUndo: boolean;
1030
+ readonly canRedo: boolean;
1031
+ };
1032
+ key: {
1033
+ down(inputKey: string): boolean | undefined;
1034
+ up(inputKey: string): void;
1035
+ };
1036
+ setScale: (scale: number) => void;
1037
+ clock: {
1038
+ set: (renderFunc: polygon_editor.RenderFunc) => void;
1039
+ start: (renderFunc?: polygon_editor.RenderFunc | undefined, setStateFunc?: polygon_editor.SetState | undefined) => void;
1040
+ stop: () => void;
1041
+ step: (deltaTime?: number | undefined) => void;
1042
+ };
1043
+ pointer: (pointers: ([number, number] | [number, number, number, number, number, number])[]) => void;
1044
+ blur: () => void;
1045
+ pointerDown: () => void;
1046
+ pointerUp: () => void;
1047
+ setShape: (shape: polygon_editor.InputShape | null) => void;
1048
+ label: (type: string | null) => string;
1049
+ tools: {
1050
+ setTool: (tool: polygon_editor.ValidTools) => void;
1051
+ unsetTool: (tool: polygon_editor.ValidTools) => void;
1052
+ toggleTool: (tool: polygon_editor.ValidTools) => void;
1053
+ updateVisibility: (tool: polygon_editor.ValidTools) => void;
1054
+ setCanDelete(canDelete: boolean): void;
1055
+ setCanDeselect(canDeselect: boolean): void;
1056
+ lockToolSwitching(): void;
1057
+ unlockToolSwitching(): void;
1058
+ toggleToolSwitching(): void;
1059
+ shortcuts: {
1060
+ [k: string]: string;
1061
+ };
1062
+ getValidIntents(tool?: polygon_editor.ValidTools | undefined): {
1063
+ actions: polygon_editor.ActionIntent[];
1064
+ transitions: polygon_editor.TransitionIntent[];
1065
+ keys: polygon_editor.ActionIntent[];
1066
+ all: Record<string, string>;
1067
+ current: Record<string, string>;
1068
+ };
1069
+ getToolInfo(): {
1070
+ name: polygon_editor.ValidTools;
1071
+ cursor: string;
1072
+ selectionCount: number;
1073
+ pointCount: number;
1074
+ isOpen: boolean;
1075
+ };
1076
+ smartSelect(): void;
1077
+ clearSelection(): void;
1078
+ autoSelect(): void;
1079
+ };
1080
+ snap: {
1081
+ enabled: () => boolean;
1082
+ enable: () => void;
1083
+ disable: () => void;
1084
+ toggle: () => void;
1085
+ pointsEnabled: () => boolean;
1086
+ enablePoints: () => void;
1087
+ disablePoints: () => void;
1088
+ togglePoints: () => void;
1089
+ linesEnabled: () => boolean;
1090
+ enableLines: () => void;
1091
+ disableLines: () => void;
1092
+ toggleLines: () => void;
1093
+ intersectionsEnabled: () => boolean;
1094
+ enableIntersections: () => void;
1095
+ disableIntersections: () => void;
1096
+ toggleIntersections: () => void;
1097
+ gridEnabled: () => boolean;
1098
+ enableGrid: () => void;
1099
+ disableGrid: () => void;
1100
+ toggleGrid: () => void;
1101
+ parallelEnabled: () => boolean;
1102
+ enableParallel: () => void;
1103
+ disableParallel: () => void;
1104
+ toggleParallel: () => void;
1105
+ getThreshold: () => number;
1106
+ setThreshold: (threshold: number) => void;
1107
+ isActive: () => boolean;
1108
+ getSnapPoint: () => ([number, number] | [number, number, number, number, number, number]) | null;
1109
+ getActiveGuides: () => polygon_editor.SnapGuide[];
1110
+ getTargets: () => polygon_editor.SnapTarget[];
1111
+ };
1112
+ selectAllPoints: () => void;
1113
+ setBounds: (bounds: {
1114
+ x: number;
1115
+ y: number;
1116
+ width: number;
1117
+ height: number;
1118
+ } | null) => void;
1119
+ lockAspectRatio: () => void;
1120
+ unlockAspectRatio: () => void;
1121
+ };
1122
+ };
1123
+
1037
1124
  declare function useRange(options?: {
1038
1125
  id: string;
1039
1126
  }): RangeNormalized | undefined;
@@ -1042,6 +1129,21 @@ declare function useRange<T>(options?: {
1042
1129
  selector: (range: RangeNormalized) => T;
1043
1130
  }, deps?: any[]): T | undefined;
1044
1131
 
1132
+ declare function useRequestAnnotation(opts?: {
1133
+ onSuccess?: (r: AnnotationResponse) => void;
1134
+ }): {
1135
+ id: number;
1136
+ busy: boolean;
1137
+ isPending: boolean;
1138
+ isActive: boolean;
1139
+ requestId: string | null;
1140
+ requestAnnotation: (request: AnnotationRequest, options?: Omit<AnnotationRequestOptions, 'requestId'>) => Promise<AnnotationResponse | null>;
1141
+ cancelRequest: () => void;
1142
+ completeRequest: () => void;
1143
+ reset: () => void;
1144
+ data: AnnotationResponse | null;
1145
+ };
1146
+
1045
1147
  declare function useResourceEvents<T extends NormalizedEntity>(resource?: Reference, scope?: string[]): any;
1046
1148
 
1047
1149
  declare function useResources<Type>(ids: string[], type: string): Type[];
@@ -1053,6 +1155,25 @@ declare function useStyleHelper(): _iiif_helpers_styles.StyledHelper<_iiif_helpe
1053
1155
  declare function useStyles<Style extends Record<string, Record<string, any>>>(resource: undefined | Reference<any>): Style;
1054
1156
  declare function useStyles<Style extends Record<string, any>>(resource: undefined | Reference<any>, scope: string): Style;
1055
1157
 
1158
+ declare function useSvgEditorControls(): {
1159
+ completeRequest: (requestId?: string | undefined) => void;
1160
+ currentTool: polygon_editor.ValidTools;
1161
+ selectedStamp: polygon_editor.InputShape | null;
1162
+ switchTool: {
1163
+ draw(): void;
1164
+ pen(): void;
1165
+ line(): void;
1166
+ lineBox(): void;
1167
+ box(): void;
1168
+ triangle(): void;
1169
+ hexagon(): void;
1170
+ circle(): void;
1171
+ remove(): void;
1172
+ hand(): void;
1173
+ pointer(): void;
1174
+ };
1175
+ };
1176
+
1056
1177
  declare function useThumbnail(request: ImageCandidateRequest, dereference?: boolean, { canvasId, manifestId }?: {
1057
1178
  canvasId?: string;
1058
1179
  manifestId?: string;
@@ -1084,57 +1205,6 @@ declare function VirtualAnnotationProvider({ children }: {
1084
1205
  children: any;
1085
1206
  }): react_jsx_runtime.JSX.Element;
1086
1207
 
1087
- declare function usePolygonHelper(data: any, render: (t: any, s: any) => void, commitShape: (shape: InputShape) => void): {
1088
- state: SlowState;
1089
- helper: {
1090
- draw: {
1091
- enable(): void;
1092
- disable(): void;
1093
- toggle(): void;
1094
- };
1095
- state: polygon_editor.RenderState;
1096
- modifiers: {
1097
- reset(): void;
1098
- getForType(type: string | null): Record<string, string>;
1099
- set(modifier: string): void;
1100
- unset(modifier: string): void;
1101
- };
1102
- stamps: {
1103
- set(selectedStamp: InputShape | null): void;
1104
- clear(): void;
1105
- square(): void;
1106
- triangle(): void;
1107
- pentagon(): void;
1108
- hexagon(): void;
1109
- };
1110
- key: {
1111
- down(key: string): true | undefined;
1112
- up(key: string): void;
1113
- };
1114
- setScale: (scale: number) => void;
1115
- clock: {
1116
- set: (renderFunc: polygon_editor.RenderFunc) => void;
1117
- start: (renderFunc?: polygon_editor.RenderFunc | undefined, setStateFunc?: polygon_editor.SetState | undefined) => void;
1118
- stop: () => void;
1119
- step: (deltaTime?: number | undefined) => void;
1120
- };
1121
- pointer: (pointers: ([number, number] | [number, number, number, number, number, number])[]) => void;
1122
- blur: () => void;
1123
- pointerDown: () => void;
1124
- pointerUp: () => void;
1125
- setShape: (shape: InputShape | null) => void;
1126
- modes: {
1127
- toggleLineBoxMode: () => void;
1128
- toggleLineMode: () => void;
1129
- enableLineMode(): void;
1130
- disableLineMode(): void;
1131
- enableLineBoxMode(): void;
1132
- disableLineBoxMode(): void;
1133
- };
1134
- label: (type: string | null) => string;
1135
- };
1136
- };
1137
-
1138
1208
  declare function flattenAnnotationPageIds({ canvas, manifest, all, canvases, }: {
1139
1209
  manifest?: ManifestNormalized;
1140
1210
  canvas?: CanvasNormalized;
@@ -1180,6 +1250,36 @@ type LocaleStringProps = {
1180
1250
  } & Record<string, any>;
1181
1251
  declare function LocaleString({ as: Component, defaultText, enableDangerouslySetInnerHTML, children, separator, ...props }: LocaleStringProps): react_jsx_runtime.JSX.Element;
1182
1252
 
1253
+ declare function targetIntersects(a: {
1254
+ x: number;
1255
+ y: number;
1256
+ width: number;
1257
+ height: number;
1258
+ }, b: {
1259
+ x: number;
1260
+ y: number;
1261
+ width: number;
1262
+ height: number;
1263
+ }): boolean;
1264
+
1265
+ declare function annotationResponseToSelector(response: {
1266
+ polygon: AnnotationResponse['polygon'];
1267
+ boundingBox?: AnnotationResponse['boundingBox'];
1268
+ target?: AnnotationResponse['target'];
1269
+ }, on?: {
1270
+ width: number;
1271
+ height: number;
1272
+ } | null): SupportedSelector;
1273
+
1274
+ declare function isRectangle(points: InputShape['points']): boolean;
1275
+
1276
+ declare function isSvgSelector(t: SupportedSelector): t is SvgSelector;
1277
+ declare function isBoxSelector(t: SupportedSelector): t is BoxSelector;
1278
+ declare function seraliseSupportedSelector(selector: SupportedSelector, on?: {
1279
+ width: number;
1280
+ height: number;
1281
+ } | null): null | SvgSelector$1 | FragmentSelector;
1282
+
1183
1283
  declare const SimpleViewerReactContext: React__default.Context<SimpleViewerContext>;
1184
1284
  declare function InnerViewerProvider(props: SimpleViewerProps): react_jsx_runtime.JSX.Element | null;
1185
1285
  declare function SimpleViewerProvider(props: SimpleViewerProps): react_jsx_runtime.JSX.Element;
@@ -1205,6 +1305,11 @@ declare function useCanvasSequence({ startCanvas, disablePaging }: {
1205
1305
  previous: () => void;
1206
1306
  };
1207
1307
 
1308
+ declare function findFirstCanvasFromRange(vault: Vault, range: RangeNormalized): null | Reference<'Canvas'>;
1309
+ declare function findAllCanvasesInRange(vault: Vault, range: RangeNormalized): Array<Reference<'Canvas'>>;
1310
+ declare function findManifestSelectedRange(vault: Vault, manifest: ManifestNormalized, canvasId: string): null | RangeNormalized;
1311
+ declare function findSelectedRange(vault: Vault, range: RangeNormalized, canvasId: string): null | RangeNormalized;
1312
+
1208
1313
  /**
1209
1314
  * Get visible canvases from canvas ID
1210
1315
  *
@@ -1242,9 +1347,4 @@ declare function getManifestSequence(vault: Vault, manifestOrRange: ManifestNorm
1242
1347
  skipNonPaged?: boolean;
1243
1348
  }): [Reference<'Canvas'>[], number[][]];
1244
1349
 
1245
- declare function findFirstCanvasFromRange(vault: Vault, range: RangeNormalized): null | Reference<'Canvas'>;
1246
- declare function findAllCanvasesInRange(vault: Vault, range: RangeNormalized): Array<Reference<'Canvas'>>;
1247
- declare function findManifestSelectedRange(vault: Vault, manifest: ManifestNormalized, canvasId: string): null | RangeNormalized;
1248
- declare function findSelectedRange(vault: Vault, range: RangeNormalized, canvasId: string): null | RangeNormalized;
1249
-
1250
- export { AnnotationContext, AnnotationPageContext, type AnnotationStrategyProps, AnnotationStyleProvider, type AnnotationStyles, type AnnotationThemeDefinition, Auth, type AuthAccessState, type AuthContextActions, type AuthContextCurrentActions, type AuthContextState, AuthProvider, AuthRContext, AuthReactContext, AuthReactContextActions, type AuthState, CanvasAnnotations, CanvasContext, CanvasStrategyProvider, CanvasWorldObject, CollectionContext, CombinedMetadata, ComplexTimelineProvider, ComplexTimelineStrategy, ContextBridge, type ControlsContext, ControlsReactContext, CreateCustomShape, type CreateCustomShapeProps, CustomContextBridge, CustomContextBridgeProvider, EmptyStrategy, EventsProvider, Image, type ImageProps, ImageService, ImageServiceLoaderContext, ImageServiceLoaderType, type ImageServiceRequestOptions, type ImageStrategyProps, ImageWithOptionalService, InnerViewerProvider, LanguageProvider, LanguageString, LocaleString, ManifestContext, ManifestMetadata, type MediaPlayerActions, MediaPlayerProvider, type MediaPlayerState, MediaStrategy, Metadata, type MetadataProps, PolygonSelector, type PolygonSelectorProps, type ProbeStore, RangeContext, ReactEventContext, ReactVaultContext, Render3DModelStrategy, RenderAccompanyingCanvas, RenderAnnotationStrategy, RenderAudioStrategy, RenderComplexTimelineStrategy, RenderEmptyStrategy, RenderImageStrategy, RenderSvgEditorControls, RenderTextualContentStrategy, RenderVideoStrategy, RenderYouTubeStrategy, RenderingStrategy, type ResourceContextType, ResourceProvider, ResourceReactContext, type ResourceRequestOptions, SelectorControllerProvider, type SelectorHelperEventTypes, SequenceThumbnails, SimpleViewerContext, SimpleViewerProps, SimpleViewerProvider, SimpleViewerReactContext, SingleCanvasThumbnail, SingleImageStrategy, StrategyActions, type StrategyContext, StrategyReactContext, type SvgTheme, ThumbnailFallbackImage, TimelineKeyframe, TranslationProvider, TransliterationProvider, UnknownStrategy, type VaultActivatedAnnotation, VaultProvider, ViewerPresetContext, VirtualAnnotationProvider, VisibleCanvasReactContext, authDetailsForResource, createAuthStateStore, createProbe, defaultEmitter, findAllCanvasesInRange, findFirstCanvasFromRange, findManifestSelectedRange, findSelectedRange, flattenAnnotationPageIds, formatTime, getComplexTimelineStrategy, getDefaultAnnotationStyles, getManifestSequence, getVideoStrategy, getVisibleCanvasesFromCanvasId, hasAuth, makeAccessServiceRequest, makeAccessTokenRequest, svgThemes, useAnnotation, useAnnotationPage, useAnnotationPageManager, useAnnotationStyles, useAnnotationsAtTime, useAuthActions, useAuthService, useAuthStore, useAuthToken, useAuthTokens, useCanvas, useCanvasChoices, useCanvasClock, useCanvasSequence, useCanvasStartTime, useCanvasSubset, useClosestLanguage, useCollection, useComplexTimeline, useContextBridge, useCreateLocaleString, useCurrentAuth, useCustomContextBridge, useDispatch, useEventEmitter, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useIIIFLanguage, useImage, useImageService, useImageServiceLoader, useImageTile, useIsAuthEnabled, useLocaleString, useManifest, useMediaActions, useMediaElements, useMediaState, usePaintables, usePaintingAnnotations, usePolygonHelper, useRange, useRenderControls, useResourceContext, useResourceEvents, useResources, useSearchService, useSelectorController, useSelectorEmitter, useSelectorEvents, useSelectorHelper, useSimpleMediaPlayer, useSimpleViewer, useStrategy, useStyleHelper, useStyles, useSvgEditor, useThumbnail, useTranslations, useTransliteration, useVault, useVaultEffect, useVaultSelector, useViewerPreset, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };
1350
+ export { AnnotationContext, AnnotationPageContext, AnnotationRequest, AnnotationRequestOptions, AnnotationResponse, type AnnotationStrategyProps, AnnotationStyleProvider, type AnnotationStyles, type AnnotationThemeDefinition, AtlasStore, Auth, type AuthAccessState, type AuthContextActions, type AuthContextCurrentActions, type AuthContextState, AuthProvider, AuthRContext, AuthReactContext, AuthReactContextActions, type AuthState, CanvasAnnotations, CanvasContext, CanvasStrategyProvider, CanvasWorldObject, CollectionContext, CombinedMetadata, ComplexTimelineProvider, ComplexTimelineStrategy, ContextBridge, type ControlsContext, ControlsReactContext, CreateCustomShape, type CreateCustomShapeProps, CustomContextBridge, CustomContextBridgeProvider, DefaultEditingTools, EmptyStrategy, EventEmitterProvider, EventsProvider, Image, type ImageProps, ImageService, ImageServiceLoaderContext, ImageServiceLoaderType, type ImageServiceRequestOptions, type ImageStrategyProps, ImageWithOptionalService, InnerViewerProvider, LanguageProvider, LanguageString, LocaleString, ManifestContext, ManifestMetadata, type MediaPlayerActions, MediaPlayerProvider, type MediaPlayerState, MediaStrategy, Metadata, type MetadataProps, PolygonSelector, type PolygonSelectorProps, type ProbeStore, RangeContext, ReactEmitterContext, ReactEventContext, ReactVaultContext, Render3DModelStrategy, RenderAccompanyingCanvas, RenderAnnotationEditing, RenderAnnotationStrategy, RenderAudioStrategy, RenderComplexTimelineStrategy, RenderContextProps, RenderEmptyStrategy, RenderImageStrategy, RenderSvgEditorControls, RenderTextualContentStrategy, RenderVideoStrategy, RenderYouTubeStrategy, RenderingStrategy, type ResourceContextType, ResourceProvider, ResourceReactContext, type ResourceRequestOptions, SVGTheme, SelectorControllerProvider, type SelectorHelperEventTypes, SequenceThumbnails, SimpleViewerContext, SimpleViewerProps, SimpleViewerProvider, SimpleViewerReactContext, SingleCanvasThumbnail, SingleImageStrategy, StrategyActions, type StrategyContext, StrategyReactContext, type SvgTheme, ThumbnailFallbackImage, TimelineKeyframe, TranslationProvider, TransliterationProvider, UnknownStrategy, type VaultActivatedAnnotation, VaultProvider, ViewerPresetContext, VirtualAnnotationProvider, VisibleCanvasReactContext, annotationResponseToSelector, authDetailsForResource, createAuthStateStore, createProbe, defaultEmitter, findAllCanvasesInRange, findFirstCanvasFromRange, findManifestSelectedRange, findSelectedRange, flattenAnnotationPageIds, formatTime, getComplexTimelineStrategy, getDefaultAnnotationStyles, getManifestSequence, getVideoStrategy, getVisibleCanvasesFromCanvasId, hasAuth, isBoxSelector, isRectangle, isSvgSelector, makeAccessServiceRequest, makeAccessTokenRequest, seraliseSupportedSelector, svgThemes, targetIntersects, useAnnotation, useAnnotationPage, useAnnotationPageManager, useAnnotationStyles, useAnnotationsAtTime, useAuthActions, useAuthService, useAuthStore, useAuthToken, useAuthTokens, useCanvas, useCanvasChoices, useCanvasClock, useCanvasSequence, useCanvasStartTime, useCanvasSubset, useClosestLanguage, useCollection, useComplexTimeline, useContextBridge, useCreateLocaleString, useCurrentAnnotationActions, useCurrentAnnotationMetadata, useCurrentAnnotationRequest, useCurrentAnnotationTransition, useCurrentAuth, useCustomContextBridge, useDispatch, useEmitter, useEvent, useEventEmitter, useEventListener, useExistingVault, useExternalCollection, useExternalManifest, useExternalResource, useIIIFLanguage, useImage, useImageService, useImageServiceLoader, useImageTile, useIsAuthEnabled, useLocaleString, useManifest, useMediaActions, useMediaElements, useMediaState, usePaintables, usePaintingAnnotations, usePolygonHelper, useRange, useRenderControls, useRequestAnnotation, useResourceContext, useResourceEvents, useResources, useSearchService, useSelectorController, useSelectorEmitter, useSelectorEvents, useSelectorHelper, useSimpleMediaPlayer, useSimpleViewer, useStrategy, useStyleHelper, useStyles, useSvgEditor, useSvgEditorControls, useThumbnail, useTranslations, useTransliteration, useVault, useVaultEffect, useVaultSelector, useViewerPreset, useVirtualAnnotationPage, useVirtualAnnotationPageContext, useVisibleCanvases };