@inkbar/react 0.7.0 → 0.8.0

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.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { ComponentPropsWithoutRef, ReactNode, Ref } from "react";
2
- import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, PluginHistory, Readable, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps, Writable } from "@inkbar/core";
2
+ import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, FieldValues, FieldsChange, FormAction, FormField, FormSetResult, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, PluginHistory, Readable, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps, Writable } from "@inkbar/core";
3
3
  import { AnnotationDecoration, AnnotationSlotProps, AnnotationSlotProps as AnnotationSlotProps$1, AnnotationState, ColorProperty, DecorateAnnotation, DecorateAnnotation as DecorateAnnotation$1, InkPlugin, InkPlugin as InkPlugin$1, LayoutMode, PageMount, PluginHost, SearchController, SearchState, ThreadPopoverSlotProps, ThreadPopoverSlotProps as ThreadPopoverSlotProps$1, Tool, ToolController, ToolId, ToolOptions, ToolStyle, ViewRotation, ViewerSearch, Viewport, ZoomValue } from "@inkbar/core/dom";
4
4
  import { Select, Toolbar } from "radix-ui";
5
5
  import { IconNode } from "@inkbar/icons";
@@ -87,6 +87,12 @@ interface InkContext {
87
87
  history: InkHistory;
88
88
  rootEl: HTMLElement | null;
89
89
  setViewport: (viewport: Viewport | null, tools: ToolController | null) => void;
90
+ /** InkRoot's `formHighlight`; InkViewport reads it when it builds the viewer. */
91
+ formHighlight: boolean | undefined;
92
+ /** Calls InkRoot's `onFormAction`, one microtask later. */
93
+ reportFormAction: (action: FormAction) => void;
94
+ /** Calls InkRoot's `onError`, for failures after the document opened (a refused signing). */
95
+ reportError: (error: InkError) => void;
90
96
  }
91
97
  /**
92
98
  * The context for hooks: throws a readable error when called outside a component rendered
@@ -154,7 +160,7 @@ export declare function useAnnotations(): {
154
160
  contents?: string | undefined;
155
161
  inReplyTo?: string | undefined;
156
162
  subject?: string | undefined;
157
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
163
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
158
164
  custom?: Record<string, unknown> | undefined;
159
165
  } | {
160
166
  rect: {
@@ -177,7 +183,7 @@ export declare function useAnnotations(): {
177
183
  contents?: string | undefined;
178
184
  inReplyTo?: string | undefined;
179
185
  subject?: string | undefined;
180
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
186
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
181
187
  custom?: Record<string, unknown> | undefined;
182
188
  } | {
183
189
  defaultStyle: {
@@ -227,7 +233,7 @@ export declare function useAnnotations(): {
227
233
  author?: string | undefined;
228
234
  inReplyTo?: string | undefined;
229
235
  subject?: string | undefined;
230
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
236
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
231
237
  custom?: Record<string, unknown> | undefined;
232
238
  } | {
233
239
  rect: {
@@ -253,7 +259,7 @@ export declare function useAnnotations(): {
253
259
  contents?: string | undefined;
254
260
  inReplyTo?: string | undefined;
255
261
  subject?: string | undefined;
256
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
262
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
257
263
  custom?: Record<string, unknown> | undefined;
258
264
  } | {
259
265
  rect: {
@@ -279,7 +285,7 @@ export declare function useAnnotations(): {
279
285
  contents?: string | undefined;
280
286
  inReplyTo?: string | undefined;
281
287
  subject?: string | undefined;
282
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
288
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
283
289
  custom?: Record<string, unknown> | undefined;
284
290
  } | {
285
291
  start: {
@@ -313,7 +319,7 @@ export declare function useAnnotations(): {
313
319
  contents?: string | undefined;
314
320
  inReplyTo?: string | undefined;
315
321
  subject?: string | undefined;
316
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
322
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
317
323
  custom?: Record<string, unknown> | undefined;
318
324
  } | {
319
325
  vertices: {
@@ -344,7 +350,7 @@ export declare function useAnnotations(): {
344
350
  contents?: string | undefined;
345
351
  inReplyTo?: string | undefined;
346
352
  subject?: string | undefined;
347
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
353
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
348
354
  custom?: Record<string, unknown> | undefined;
349
355
  } | {
350
356
  vertices: {
@@ -375,7 +381,7 @@ export declare function useAnnotations(): {
375
381
  contents?: string | undefined;
376
382
  inReplyTo?: string | undefined;
377
383
  subject?: string | undefined;
378
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
384
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
379
385
  custom?: Record<string, unknown> | undefined;
380
386
  } | {
381
387
  inklist: {
@@ -404,7 +410,7 @@ export declare function useAnnotations(): {
404
410
  contents?: string | undefined;
405
411
  inReplyTo?: string | undefined;
406
412
  subject?: string | undefined;
407
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
413
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
408
414
  custom?: Record<string, unknown> | undefined;
409
415
  } | {
410
416
  rect: {
@@ -428,7 +434,7 @@ export declare function useAnnotations(): {
428
434
  contents?: string | undefined;
429
435
  inReplyTo?: string | undefined;
430
436
  subject?: string | undefined;
431
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
437
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
432
438
  custom?: Record<string, unknown> | undefined;
433
439
  } | {
434
440
  rect: {
@@ -452,7 +458,7 @@ export declare function useAnnotations(): {
452
458
  contents?: string | undefined;
453
459
  inReplyTo?: string | undefined;
454
460
  subject?: string | undefined;
455
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
461
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
456
462
  custom?: Record<string, unknown> | undefined;
457
463
  } | {
458
464
  rect: {
@@ -476,7 +482,7 @@ export declare function useAnnotations(): {
476
482
  contents?: string | undefined;
477
483
  inReplyTo?: string | undefined;
478
484
  subject?: string | undefined;
479
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
485
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
480
486
  custom?: Record<string, unknown> | undefined;
481
487
  } | {
482
488
  interiorColor: string;
@@ -518,7 +524,7 @@ export declare function useAnnotations(): {
518
524
  contents?: string | undefined;
519
525
  inReplyTo?: string | undefined;
520
526
  subject?: string | undefined;
521
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
527
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
522
528
  custom?: Record<string, unknown> | undefined;
523
529
  } | undefined;
524
530
  update: (id: string, patch: AnnotationPatch) => {
@@ -559,7 +565,7 @@ export declare function useAnnotations(): {
559
565
  contents?: string | undefined;
560
566
  inReplyTo?: string | undefined;
561
567
  subject?: string | undefined;
562
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
568
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
563
569
  custom?: Record<string, unknown> | undefined;
564
570
  } | {
565
571
  rect: {
@@ -582,7 +588,7 @@ export declare function useAnnotations(): {
582
588
  contents?: string | undefined;
583
589
  inReplyTo?: string | undefined;
584
590
  subject?: string | undefined;
585
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
591
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
586
592
  custom?: Record<string, unknown> | undefined;
587
593
  } | {
588
594
  defaultStyle: {
@@ -632,7 +638,7 @@ export declare function useAnnotations(): {
632
638
  author?: string | undefined;
633
639
  inReplyTo?: string | undefined;
634
640
  subject?: string | undefined;
635
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
641
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
636
642
  custom?: Record<string, unknown> | undefined;
637
643
  } | {
638
644
  rect: {
@@ -658,7 +664,7 @@ export declare function useAnnotations(): {
658
664
  contents?: string | undefined;
659
665
  inReplyTo?: string | undefined;
660
666
  subject?: string | undefined;
661
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
667
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
662
668
  custom?: Record<string, unknown> | undefined;
663
669
  } | {
664
670
  rect: {
@@ -684,7 +690,7 @@ export declare function useAnnotations(): {
684
690
  contents?: string | undefined;
685
691
  inReplyTo?: string | undefined;
686
692
  subject?: string | undefined;
687
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
693
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
688
694
  custom?: Record<string, unknown> | undefined;
689
695
  } | {
690
696
  start: {
@@ -718,7 +724,7 @@ export declare function useAnnotations(): {
718
724
  contents?: string | undefined;
719
725
  inReplyTo?: string | undefined;
720
726
  subject?: string | undefined;
721
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
727
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
722
728
  custom?: Record<string, unknown> | undefined;
723
729
  } | {
724
730
  vertices: {
@@ -749,7 +755,7 @@ export declare function useAnnotations(): {
749
755
  contents?: string | undefined;
750
756
  inReplyTo?: string | undefined;
751
757
  subject?: string | undefined;
752
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
758
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
753
759
  custom?: Record<string, unknown> | undefined;
754
760
  } | {
755
761
  vertices: {
@@ -780,7 +786,7 @@ export declare function useAnnotations(): {
780
786
  contents?: string | undefined;
781
787
  inReplyTo?: string | undefined;
782
788
  subject?: string | undefined;
783
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
789
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
784
790
  custom?: Record<string, unknown> | undefined;
785
791
  } | {
786
792
  inklist: {
@@ -809,7 +815,7 @@ export declare function useAnnotations(): {
809
815
  contents?: string | undefined;
810
816
  inReplyTo?: string | undefined;
811
817
  subject?: string | undefined;
812
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
818
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
813
819
  custom?: Record<string, unknown> | undefined;
814
820
  } | {
815
821
  rect: {
@@ -833,7 +839,7 @@ export declare function useAnnotations(): {
833
839
  contents?: string | undefined;
834
840
  inReplyTo?: string | undefined;
835
841
  subject?: string | undefined;
836
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
842
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
837
843
  custom?: Record<string, unknown> | undefined;
838
844
  } | {
839
845
  rect: {
@@ -857,7 +863,7 @@ export declare function useAnnotations(): {
857
863
  contents?: string | undefined;
858
864
  inReplyTo?: string | undefined;
859
865
  subject?: string | undefined;
860
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
866
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
861
867
  custom?: Record<string, unknown> | undefined;
862
868
  } | {
863
869
  rect: {
@@ -881,7 +887,7 @@ export declare function useAnnotations(): {
881
887
  contents?: string | undefined;
882
888
  inReplyTo?: string | undefined;
883
889
  subject?: string | undefined;
884
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
890
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
885
891
  custom?: Record<string, unknown> | undefined;
886
892
  } | {
887
893
  interiorColor: string;
@@ -923,7 +929,7 @@ export declare function useAnnotations(): {
923
929
  contents?: string | undefined;
924
930
  inReplyTo?: string | undefined;
925
931
  subject?: string | undefined;
926
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
932
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
927
933
  custom?: Record<string, unknown> | undefined;
928
934
  } | undefined;
929
935
  remove: (id: string) => boolean;
@@ -966,7 +972,7 @@ export declare function useAnnotations(): {
966
972
  contents?: string | undefined;
967
973
  inReplyTo?: string | undefined;
968
974
  subject?: string | undefined;
969
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
975
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
970
976
  custom?: Record<string, unknown> | undefined;
971
977
  } | {
972
978
  rect: {
@@ -989,7 +995,7 @@ export declare function useAnnotations(): {
989
995
  contents?: string | undefined;
990
996
  inReplyTo?: string | undefined;
991
997
  subject?: string | undefined;
992
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
998
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
993
999
  custom?: Record<string, unknown> | undefined;
994
1000
  } | {
995
1001
  defaultStyle: {
@@ -1039,7 +1045,7 @@ export declare function useAnnotations(): {
1039
1045
  author?: string | undefined;
1040
1046
  inReplyTo?: string | undefined;
1041
1047
  subject?: string | undefined;
1042
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1048
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1043
1049
  custom?: Record<string, unknown> | undefined;
1044
1050
  } | {
1045
1051
  rect: {
@@ -1065,7 +1071,7 @@ export declare function useAnnotations(): {
1065
1071
  contents?: string | undefined;
1066
1072
  inReplyTo?: string | undefined;
1067
1073
  subject?: string | undefined;
1068
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1074
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1069
1075
  custom?: Record<string, unknown> | undefined;
1070
1076
  } | {
1071
1077
  rect: {
@@ -1091,7 +1097,7 @@ export declare function useAnnotations(): {
1091
1097
  contents?: string | undefined;
1092
1098
  inReplyTo?: string | undefined;
1093
1099
  subject?: string | undefined;
1094
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1100
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1095
1101
  custom?: Record<string, unknown> | undefined;
1096
1102
  } | {
1097
1103
  start: {
@@ -1125,7 +1131,7 @@ export declare function useAnnotations(): {
1125
1131
  contents?: string | undefined;
1126
1132
  inReplyTo?: string | undefined;
1127
1133
  subject?: string | undefined;
1128
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1134
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1129
1135
  custom?: Record<string, unknown> | undefined;
1130
1136
  } | {
1131
1137
  vertices: {
@@ -1156,7 +1162,7 @@ export declare function useAnnotations(): {
1156
1162
  contents?: string | undefined;
1157
1163
  inReplyTo?: string | undefined;
1158
1164
  subject?: string | undefined;
1159
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1165
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1160
1166
  custom?: Record<string, unknown> | undefined;
1161
1167
  } | {
1162
1168
  vertices: {
@@ -1187,7 +1193,7 @@ export declare function useAnnotations(): {
1187
1193
  contents?: string | undefined;
1188
1194
  inReplyTo?: string | undefined;
1189
1195
  subject?: string | undefined;
1190
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1196
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1191
1197
  custom?: Record<string, unknown> | undefined;
1192
1198
  } | {
1193
1199
  inklist: {
@@ -1216,7 +1222,7 @@ export declare function useAnnotations(): {
1216
1222
  contents?: string | undefined;
1217
1223
  inReplyTo?: string | undefined;
1218
1224
  subject?: string | undefined;
1219
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1225
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1220
1226
  custom?: Record<string, unknown> | undefined;
1221
1227
  } | {
1222
1228
  rect: {
@@ -1240,7 +1246,7 @@ export declare function useAnnotations(): {
1240
1246
  contents?: string | undefined;
1241
1247
  inReplyTo?: string | undefined;
1242
1248
  subject?: string | undefined;
1243
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1249
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1244
1250
  custom?: Record<string, unknown> | undefined;
1245
1251
  } | {
1246
1252
  rect: {
@@ -1264,7 +1270,7 @@ export declare function useAnnotations(): {
1264
1270
  contents?: string | undefined;
1265
1271
  inReplyTo?: string | undefined;
1266
1272
  subject?: string | undefined;
1267
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1273
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1268
1274
  custom?: Record<string, unknown> | undefined;
1269
1275
  } | {
1270
1276
  rect: {
@@ -1288,7 +1294,7 @@ export declare function useAnnotations(): {
1288
1294
  contents?: string | undefined;
1289
1295
  inReplyTo?: string | undefined;
1290
1296
  subject?: string | undefined;
1291
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1297
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1292
1298
  custom?: Record<string, unknown> | undefined;
1293
1299
  } | {
1294
1300
  interiorColor: string;
@@ -1330,7 +1336,7 @@ export declare function useAnnotations(): {
1330
1336
  contents?: string | undefined;
1331
1337
  inReplyTo?: string | undefined;
1332
1338
  subject?: string | undefined;
1333
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1339
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1334
1340
  custom?: Record<string, unknown> | undefined;
1335
1341
  })[];
1336
1342
  selection: readonly string[];
@@ -1372,7 +1378,7 @@ export declare function useAnnotations(): {
1372
1378
  contents?: string | undefined;
1373
1379
  inReplyTo?: string | undefined;
1374
1380
  subject?: string | undefined;
1375
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1381
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1376
1382
  custom?: Record<string, unknown> | undefined;
1377
1383
  } | {
1378
1384
  rect: {
@@ -1395,7 +1401,7 @@ export declare function useAnnotations(): {
1395
1401
  contents?: string | undefined;
1396
1402
  inReplyTo?: string | undefined;
1397
1403
  subject?: string | undefined;
1398
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1404
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1399
1405
  custom?: Record<string, unknown> | undefined;
1400
1406
  } | {
1401
1407
  defaultStyle: {
@@ -1445,7 +1451,7 @@ export declare function useAnnotations(): {
1445
1451
  author?: string | undefined;
1446
1452
  inReplyTo?: string | undefined;
1447
1453
  subject?: string | undefined;
1448
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1454
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1449
1455
  custom?: Record<string, unknown> | undefined;
1450
1456
  } | {
1451
1457
  rect: {
@@ -1471,7 +1477,7 @@ export declare function useAnnotations(): {
1471
1477
  contents?: string | undefined;
1472
1478
  inReplyTo?: string | undefined;
1473
1479
  subject?: string | undefined;
1474
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1480
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1475
1481
  custom?: Record<string, unknown> | undefined;
1476
1482
  } | {
1477
1483
  rect: {
@@ -1497,7 +1503,7 @@ export declare function useAnnotations(): {
1497
1503
  contents?: string | undefined;
1498
1504
  inReplyTo?: string | undefined;
1499
1505
  subject?: string | undefined;
1500
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1506
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1501
1507
  custom?: Record<string, unknown> | undefined;
1502
1508
  } | {
1503
1509
  start: {
@@ -1531,7 +1537,7 @@ export declare function useAnnotations(): {
1531
1537
  contents?: string | undefined;
1532
1538
  inReplyTo?: string | undefined;
1533
1539
  subject?: string | undefined;
1534
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1540
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1535
1541
  custom?: Record<string, unknown> | undefined;
1536
1542
  } | {
1537
1543
  vertices: {
@@ -1562,7 +1568,7 @@ export declare function useAnnotations(): {
1562
1568
  contents?: string | undefined;
1563
1569
  inReplyTo?: string | undefined;
1564
1570
  subject?: string | undefined;
1565
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1571
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1566
1572
  custom?: Record<string, unknown> | undefined;
1567
1573
  } | {
1568
1574
  vertices: {
@@ -1593,7 +1599,7 @@ export declare function useAnnotations(): {
1593
1599
  contents?: string | undefined;
1594
1600
  inReplyTo?: string | undefined;
1595
1601
  subject?: string | undefined;
1596
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1602
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1597
1603
  custom?: Record<string, unknown> | undefined;
1598
1604
  } | {
1599
1605
  inklist: {
@@ -1622,7 +1628,7 @@ export declare function useAnnotations(): {
1622
1628
  contents?: string | undefined;
1623
1629
  inReplyTo?: string | undefined;
1624
1630
  subject?: string | undefined;
1625
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1631
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1626
1632
  custom?: Record<string, unknown> | undefined;
1627
1633
  } | {
1628
1634
  rect: {
@@ -1646,7 +1652,7 @@ export declare function useAnnotations(): {
1646
1652
  contents?: string | undefined;
1647
1653
  inReplyTo?: string | undefined;
1648
1654
  subject?: string | undefined;
1649
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1655
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1650
1656
  custom?: Record<string, unknown> | undefined;
1651
1657
  } | {
1652
1658
  rect: {
@@ -1670,7 +1676,7 @@ export declare function useAnnotations(): {
1670
1676
  contents?: string | undefined;
1671
1677
  inReplyTo?: string | undefined;
1672
1678
  subject?: string | undefined;
1673
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1679
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1674
1680
  custom?: Record<string, unknown> | undefined;
1675
1681
  } | {
1676
1682
  rect: {
@@ -1694,7 +1700,7 @@ export declare function useAnnotations(): {
1694
1700
  contents?: string | undefined;
1695
1701
  inReplyTo?: string | undefined;
1696
1702
  subject?: string | undefined;
1697
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1703
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1698
1704
  custom?: Record<string, unknown> | undefined;
1699
1705
  } | {
1700
1706
  interiorColor: string;
@@ -1736,7 +1742,7 @@ export declare function useAnnotations(): {
1736
1742
  contents?: string | undefined;
1737
1743
  inReplyTo?: string | undefined;
1738
1744
  subject?: string | undefined;
1739
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1745
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1740
1746
  custom?: Record<string, unknown> | undefined;
1741
1747
  })[];
1742
1748
  byPage: (page: number) => ({
@@ -1777,7 +1783,7 @@ export declare function useAnnotations(): {
1777
1783
  contents?: string | undefined;
1778
1784
  inReplyTo?: string | undefined;
1779
1785
  subject?: string | undefined;
1780
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1786
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1781
1787
  custom?: Record<string, unknown> | undefined;
1782
1788
  } | {
1783
1789
  rect: {
@@ -1800,7 +1806,7 @@ export declare function useAnnotations(): {
1800
1806
  contents?: string | undefined;
1801
1807
  inReplyTo?: string | undefined;
1802
1808
  subject?: string | undefined;
1803
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1809
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1804
1810
  custom?: Record<string, unknown> | undefined;
1805
1811
  } | {
1806
1812
  defaultStyle: {
@@ -1850,7 +1856,7 @@ export declare function useAnnotations(): {
1850
1856
  author?: string | undefined;
1851
1857
  inReplyTo?: string | undefined;
1852
1858
  subject?: string | undefined;
1853
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1859
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1854
1860
  custom?: Record<string, unknown> | undefined;
1855
1861
  } | {
1856
1862
  rect: {
@@ -1876,7 +1882,7 @@ export declare function useAnnotations(): {
1876
1882
  contents?: string | undefined;
1877
1883
  inReplyTo?: string | undefined;
1878
1884
  subject?: string | undefined;
1879
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1885
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1880
1886
  custom?: Record<string, unknown> | undefined;
1881
1887
  } | {
1882
1888
  rect: {
@@ -1902,7 +1908,7 @@ export declare function useAnnotations(): {
1902
1908
  contents?: string | undefined;
1903
1909
  inReplyTo?: string | undefined;
1904
1910
  subject?: string | undefined;
1905
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1911
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1906
1912
  custom?: Record<string, unknown> | undefined;
1907
1913
  } | {
1908
1914
  start: {
@@ -1936,7 +1942,7 @@ export declare function useAnnotations(): {
1936
1942
  contents?: string | undefined;
1937
1943
  inReplyTo?: string | undefined;
1938
1944
  subject?: string | undefined;
1939
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1945
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1940
1946
  custom?: Record<string, unknown> | undefined;
1941
1947
  } | {
1942
1948
  vertices: {
@@ -1967,7 +1973,7 @@ export declare function useAnnotations(): {
1967
1973
  contents?: string | undefined;
1968
1974
  inReplyTo?: string | undefined;
1969
1975
  subject?: string | undefined;
1970
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1976
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1971
1977
  custom?: Record<string, unknown> | undefined;
1972
1978
  } | {
1973
1979
  vertices: {
@@ -1998,7 +2004,7 @@ export declare function useAnnotations(): {
1998
2004
  contents?: string | undefined;
1999
2005
  inReplyTo?: string | undefined;
2000
2006
  subject?: string | undefined;
2001
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2007
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2002
2008
  custom?: Record<string, unknown> | undefined;
2003
2009
  } | {
2004
2010
  inklist: {
@@ -2027,7 +2033,7 @@ export declare function useAnnotations(): {
2027
2033
  contents?: string | undefined;
2028
2034
  inReplyTo?: string | undefined;
2029
2035
  subject?: string | undefined;
2030
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2036
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2031
2037
  custom?: Record<string, unknown> | undefined;
2032
2038
  } | {
2033
2039
  rect: {
@@ -2051,7 +2057,7 @@ export declare function useAnnotations(): {
2051
2057
  contents?: string | undefined;
2052
2058
  inReplyTo?: string | undefined;
2053
2059
  subject?: string | undefined;
2054
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2060
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2055
2061
  custom?: Record<string, unknown> | undefined;
2056
2062
  } | {
2057
2063
  rect: {
@@ -2075,7 +2081,7 @@ export declare function useAnnotations(): {
2075
2081
  contents?: string | undefined;
2076
2082
  inReplyTo?: string | undefined;
2077
2083
  subject?: string | undefined;
2078
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2084
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2079
2085
  custom?: Record<string, unknown> | undefined;
2080
2086
  } | {
2081
2087
  rect: {
@@ -2099,7 +2105,7 @@ export declare function useAnnotations(): {
2099
2105
  contents?: string | undefined;
2100
2106
  inReplyTo?: string | undefined;
2101
2107
  subject?: string | undefined;
2102
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2108
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2103
2109
  custom?: Record<string, unknown> | undefined;
2104
2110
  } | {
2105
2111
  interiorColor: string;
@@ -2141,7 +2147,7 @@ export declare function useAnnotations(): {
2141
2147
  contents?: string | undefined;
2142
2148
  inReplyTo?: string | undefined;
2143
2149
  subject?: string | undefined;
2144
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2150
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2145
2151
  custom?: Record<string, unknown> | undefined;
2146
2152
  })[];
2147
2153
  /** Replies in creation order for a note id. */
@@ -2183,7 +2189,7 @@ export declare function useAnnotations(): {
2183
2189
  contents?: string | undefined;
2184
2190
  inReplyTo?: string | undefined;
2185
2191
  subject?: string | undefined;
2186
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2192
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2187
2193
  custom?: Record<string, unknown> | undefined;
2188
2194
  } | {
2189
2195
  rect: {
@@ -2206,7 +2212,7 @@ export declare function useAnnotations(): {
2206
2212
  contents?: string | undefined;
2207
2213
  inReplyTo?: string | undefined;
2208
2214
  subject?: string | undefined;
2209
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2215
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2210
2216
  custom?: Record<string, unknown> | undefined;
2211
2217
  } | {
2212
2218
  defaultStyle: {
@@ -2256,7 +2262,7 @@ export declare function useAnnotations(): {
2256
2262
  author?: string | undefined;
2257
2263
  inReplyTo?: string | undefined;
2258
2264
  subject?: string | undefined;
2259
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2265
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2260
2266
  custom?: Record<string, unknown> | undefined;
2261
2267
  } | {
2262
2268
  rect: {
@@ -2282,7 +2288,7 @@ export declare function useAnnotations(): {
2282
2288
  contents?: string | undefined;
2283
2289
  inReplyTo?: string | undefined;
2284
2290
  subject?: string | undefined;
2285
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2291
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2286
2292
  custom?: Record<string, unknown> | undefined;
2287
2293
  } | {
2288
2294
  rect: {
@@ -2308,7 +2314,7 @@ export declare function useAnnotations(): {
2308
2314
  contents?: string | undefined;
2309
2315
  inReplyTo?: string | undefined;
2310
2316
  subject?: string | undefined;
2311
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2317
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2312
2318
  custom?: Record<string, unknown> | undefined;
2313
2319
  } | {
2314
2320
  start: {
@@ -2342,7 +2348,7 @@ export declare function useAnnotations(): {
2342
2348
  contents?: string | undefined;
2343
2349
  inReplyTo?: string | undefined;
2344
2350
  subject?: string | undefined;
2345
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2351
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2346
2352
  custom?: Record<string, unknown> | undefined;
2347
2353
  } | {
2348
2354
  vertices: {
@@ -2373,7 +2379,7 @@ export declare function useAnnotations(): {
2373
2379
  contents?: string | undefined;
2374
2380
  inReplyTo?: string | undefined;
2375
2381
  subject?: string | undefined;
2376
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2382
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2377
2383
  custom?: Record<string, unknown> | undefined;
2378
2384
  } | {
2379
2385
  vertices: {
@@ -2404,7 +2410,7 @@ export declare function useAnnotations(): {
2404
2410
  contents?: string | undefined;
2405
2411
  inReplyTo?: string | undefined;
2406
2412
  subject?: string | undefined;
2407
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2413
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2408
2414
  custom?: Record<string, unknown> | undefined;
2409
2415
  } | {
2410
2416
  inklist: {
@@ -2433,7 +2439,7 @@ export declare function useAnnotations(): {
2433
2439
  contents?: string | undefined;
2434
2440
  inReplyTo?: string | undefined;
2435
2441
  subject?: string | undefined;
2436
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2442
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2437
2443
  custom?: Record<string, unknown> | undefined;
2438
2444
  } | {
2439
2445
  rect: {
@@ -2457,7 +2463,7 @@ export declare function useAnnotations(): {
2457
2463
  contents?: string | undefined;
2458
2464
  inReplyTo?: string | undefined;
2459
2465
  subject?: string | undefined;
2460
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2466
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2461
2467
  custom?: Record<string, unknown> | undefined;
2462
2468
  } | {
2463
2469
  rect: {
@@ -2481,7 +2487,7 @@ export declare function useAnnotations(): {
2481
2487
  contents?: string | undefined;
2482
2488
  inReplyTo?: string | undefined;
2483
2489
  subject?: string | undefined;
2484
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2490
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2485
2491
  custom?: Record<string, unknown> | undefined;
2486
2492
  } | {
2487
2493
  rect: {
@@ -2505,7 +2511,7 @@ export declare function useAnnotations(): {
2505
2511
  contents?: string | undefined;
2506
2512
  inReplyTo?: string | undefined;
2507
2513
  subject?: string | undefined;
2508
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2514
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2509
2515
  custom?: Record<string, unknown> | undefined;
2510
2516
  } | {
2511
2517
  interiorColor: string;
@@ -2547,7 +2553,7 @@ export declare function useAnnotations(): {
2547
2553
  contents?: string | undefined;
2548
2554
  inReplyTo?: string | undefined;
2549
2555
  subject?: string | undefined;
2550
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2556
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2551
2557
  custom?: Record<string, unknown> | undefined;
2552
2558
  })[];
2553
2559
  };
@@ -2670,6 +2676,23 @@ interface CommandHandle {
2670
2676
  */
2671
2677
  export declare function useCommand(id: string): CommandHandle;
2672
2678
  //#endregion
2679
+ //#region src/hooks/useForm.d.ts
2680
+ interface FormHandle {
2681
+ /** The open document's form fields; empty while none is open or it has none. */
2682
+ fields: readonly FormField[];
2683
+ /** What the fields hold now, keyed by full name. */
2684
+ values: FieldValues;
2685
+ /**
2686
+ * Commits values as a person would: scripts run, and the call is one undo step. Returns the
2687
+ * names applied and rejected, or `undefined` while no document is open.
2688
+ */
2689
+ set: (values: FieldValues) => FormSetResult | undefined;
2690
+ /** Restores the PDF's default values of `names`, or of every field. */
2691
+ reset: (names?: string[]) => void;
2692
+ }
2693
+ /** The open document's form: its fields, their values, and `set` and `reset`. */
2694
+ export declare function useForm(): FormHandle;
2695
+ //#endregion
2673
2696
  //#region src/components/InkRoot.d.ts
2674
2697
  interface InkRootHandle {
2675
2698
  readonly document: InkDocument | null;
@@ -2692,6 +2715,21 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
2692
2715
  annotations?: Annotation[] | undefined;
2693
2716
  onAnnotationsChange?: ((next: Annotation[]) => void) | undefined;
2694
2717
  onChange?: ((change: AnnotationChange) => void) | undefined;
2718
+ /**
2719
+ * Pass (with `onFieldsChange`) to put the form's field values under the host's control. A
2720
+ * commit shows at once and is reported after; the host's push wins. The mode is fixed when
2721
+ * a document opens, as for `annotations`.
2722
+ */
2723
+ fields?: FieldValues | undefined;
2724
+ /**
2725
+ * Committed field values, in full, with what changed them, one microtask after the commit.
2726
+ * Called only while the fields are controlled.
2727
+ */
2728
+ onFieldsChange?: ((next: FieldValues, change: FieldsChange) => void) | undefined;
2729
+ /** The form asked to submit, open a link, send mail, print or prompt. Inkbar does none. */
2730
+ onFormAction?: ((action: FormAction) => void) | undefined;
2731
+ /** Tints fillable form fields. Default true. A change applies to the open document in place. */
2732
+ formHighlight?: boolean | undefined;
2695
2733
  tool?: ToolId | undefined;
2696
2734
  onToolChange?: ((tool: ToolId) => void) | undefined;
2697
2735
  /**
@@ -2733,6 +2771,12 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
2733
2771
  history?: boolean | undefined;
2734
2772
  asChild?: boolean | undefined;
2735
2773
  onReady?: ((doc: InkDocument) => void) | undefined;
2774
+ /**
2775
+ * Opening failed, or later: a form script failed (`FormScriptError`; the form stays
2776
+ * fillable), or a signature field refused its signing (`FieldSigned`, `FieldReadOnly`).
2777
+ * A later error arrives one microtask after it happened, as `onFieldsChange` does; one from
2778
+ * while the document opened arrives after `onReady`.
2779
+ */
2736
2780
  onError?: ((error: InkError) => void) | undefined;
2737
2781
  onActivate?: ((id: string) => void) | undefined;
2738
2782
  children?: ReactNode | ((props: {
@@ -2741,7 +2785,7 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
2741
2785
  }) => ReactNode);
2742
2786
  ref?: Ref<InkRootHandle>;
2743
2787
  }
2744
- export declare function InkRoot({ src, assets, password, defaults, annotations, onAnnotationsChange, onChange, tool, onToolChange, tools: hostTools, plugins: pluginsProp, decorateAnnotation, fonts: fontsProp, signatures: signatureStore, signatureFonts: signatureFontsProp, page, onPageChange, zoom, onZoomChange, history, asChild, onReady, onError, onActivate, children, ref, ...rest }: InkRootProps): import("react").JSX.Element;
2788
+ export declare function InkRoot({ src, assets, password, defaults, annotations, onAnnotationsChange, onChange, fields, onFieldsChange, onFormAction, formHighlight, tool, onToolChange, tools: hostTools, plugins: pluginsProp, decorateAnnotation, fonts: fontsProp, signatures: signatureStore, signatureFonts: signatureFontsProp, page, onPageChange, zoom, onZoomChange, history, asChild, onReady, onError, onActivate, children, ref, ...rest }: InkRootProps): import("react").JSX.Element;
2745
2789
  //#endregion
2746
2790
  //#region src/components/InkViewport.d.ts
2747
2791
  interface InkViewportProps extends ComponentPropsWithoutRef<'div'> {
@@ -2958,13 +3002,18 @@ interface InkSignatureDialogProps {
2958
3002
  onOpenChange: (open: boolean) => void;
2959
3003
  /** The fonts the Type tab offers. Default: InkRoot's `signatureFonts`. */
2960
3004
  fonts?: readonly string[] | undefined;
2961
- /** Called with the new template once it is saved and selected. */
3005
+ /**
3006
+ * Whether saving selects the new signature for the `signature` tool. Default true. False
3007
+ * leaves the tool alone, for a dialog that signs a field with it through `onSave`.
3008
+ */
3009
+ select?: boolean | undefined;
3010
+ /** Called with the new template once it is saved (and selected, with `select`). */
2962
3011
  onSave?: ((template: SignatureTemplate) => void) | undefined;
2963
3012
  /** Where focus goes on close; by default, back to what had it before. */
2964
3013
  onCloseAutoFocus?: ((event: Event) => void) | undefined;
2965
3014
  className?: string | undefined;
2966
3015
  }
2967
- export declare function InkSignatureDialog({ open, onOpenChange, fonts, onSave, onCloseAutoFocus, className }: InkSignatureDialogProps): import("react").JSX.Element;
3016
+ export declare function InkSignatureDialog({ open, onOpenChange, fonts, select, onSave, onCloseAutoFocus, className }: InkSignatureDialogProps): import("react").JSX.Element;
2968
3017
  //#endregion
2969
3018
  //#region src/components/InkHighlightMenu.d.ts
2970
3019
  interface InkHighlightMenuProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
@@ -2991,5 +3040,5 @@ interface InkThreadPopoverProps {
2991
3040
  }
2992
3041
  export declare function InkThreadPopover({ children }: InkThreadPopoverProps): import("react").JSX.Element;
2993
3042
  //#endregion
2994
- export type { AnnotationDecoration, AnnotationSlotProps, AnnotationState, CommandHandle, DecorateAnnotation, InkAnnotationProps, InkColorMenuProps, InkCommandProps, InkContext, InkFindBarProps, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkPlugin, InkRootHandle, InkRootProps, InkSearchButtonProps, InkShapeMenuProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkTextStyleMenuProps, InkThreadPopoverProps, InkToolButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, ThreadPopoverSlotProps, ToolStyleHandle };
3043
+ export type { AnnotationDecoration, AnnotationSlotProps, AnnotationState, CommandHandle, DecorateAnnotation, FormHandle, InkAnnotationProps, InkColorMenuProps, InkCommandProps, InkContext, InkFindBarProps, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkPlugin, InkRootHandle, InkRootProps, InkSearchButtonProps, InkShapeMenuProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkTextStyleMenuProps, InkThreadPopoverProps, InkToolButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, ThreadPopoverSlotProps, ToolStyleHandle };
2995
3044
  //# sourceMappingURL=index.d.mts.map