@inkbar/svelte 0.3.0 → 0.5.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.
Files changed (66) hide show
  1. package/README.md +17 -12
  2. package/dist/components/InkAnnotation.svelte +0 -12
  3. package/dist/components/InkAnnotation.svelte.d.ts.map +1 -1
  4. package/dist/components/InkColorMenu.svelte +247 -0
  5. package/dist/components/InkColorMenu.svelte.d.ts +35 -0
  6. package/dist/components/InkColorMenu.svelte.d.ts.map +1 -0
  7. package/dist/components/InkHighlightMenu.svelte +175 -0
  8. package/dist/components/InkHighlightMenu.svelte.d.ts +16 -0
  9. package/dist/components/InkHighlightMenu.svelte.d.ts.map +1 -0
  10. package/dist/components/InkLineStyleMenu.svelte +141 -0
  11. package/dist/components/InkLineStyleMenu.svelte.d.ts +15 -0
  12. package/dist/components/InkLineStyleMenu.svelte.d.ts.map +1 -0
  13. package/dist/components/InkRoot.svelte +90 -3
  14. package/dist/components/InkRoot.svelte.d.ts +27 -2
  15. package/dist/components/InkRoot.svelte.d.ts.map +1 -1
  16. package/dist/components/InkShapeMenu.svelte +161 -0
  17. package/dist/components/InkShapeMenu.svelte.d.ts +15 -0
  18. package/dist/components/InkShapeMenu.svelte.d.ts.map +1 -0
  19. package/dist/components/InkSignatureDialog.svelte +70 -0
  20. package/dist/components/InkSignatureDialog.svelte.d.ts +22 -0
  21. package/dist/components/InkSignatureDialog.svelte.d.ts.map +1 -0
  22. package/dist/components/InkSignatureMenu.svelte +267 -0
  23. package/dist/components/InkSignatureMenu.svelte.d.ts +18 -0
  24. package/dist/components/InkSignatureMenu.svelte.d.ts.map +1 -0
  25. package/dist/components/InkTextStyleMenu.svelte +225 -0
  26. package/dist/components/InkTextStyleMenu.svelte.d.ts +15 -0
  27. package/dist/components/InkTextStyleMenu.svelte.d.ts.map +1 -0
  28. package/dist/components/{InkNotePopover.svelte → InkThreadPopover.svelte} +44 -32
  29. package/dist/components/InkThreadPopover.svelte.d.ts +9 -0
  30. package/dist/components/InkThreadPopover.svelte.d.ts.map +1 -0
  31. package/dist/components/InkToolButton.svelte +23 -7
  32. package/dist/components/InkToolButton.svelte.d.ts.map +1 -1
  33. package/dist/components/InkViewport.svelte +26 -2
  34. package/dist/components/InkViewport.svelte.d.ts.map +1 -1
  35. package/dist/components/SignatureForm.svelte +219 -0
  36. package/dist/components/SignatureForm.svelte.d.ts +10 -0
  37. package/dist/components/SignatureForm.svelte.d.ts.map +1 -0
  38. package/dist/components/ThreadForm.svelte +4 -2
  39. package/dist/components/ThreadForm.svelte.d.ts +1 -0
  40. package/dist/components/ThreadForm.svelte.d.ts.map +1 -1
  41. package/dist/components/child-snippet.d.ts +8 -0
  42. package/dist/components/child-snippet.d.ts.map +1 -1
  43. package/dist/components/child-snippet.js +15 -0
  44. package/dist/components/popover-focus.d.ts +16 -2
  45. package/dist/components/popover-focus.d.ts.map +1 -1
  46. package/dist/components/popover-focus.js +24 -3
  47. package/dist/context.d.ts +21 -2
  48. package/dist/context.d.ts.map +1 -1
  49. package/dist/hooks/useAnnotations.svelte.d.ts +1333 -578
  50. package/dist/hooks/useAnnotations.svelte.d.ts.map +1 -1
  51. package/dist/hooks/useAnnotations.svelte.js +1 -7
  52. package/dist/hooks/useToolOptions.svelte.d.ts +11 -0
  53. package/dist/hooks/useToolOptions.svelte.d.ts.map +1 -0
  54. package/dist/hooks/useToolOptions.svelte.js +19 -0
  55. package/dist/hooks/useToolStyle.svelte.d.ts +33 -0
  56. package/dist/hooks/useToolStyle.svelte.d.ts.map +1 -0
  57. package/dist/hooks/useToolStyle.svelte.js +33 -0
  58. package/dist/index.d.ts +21 -6
  59. package/dist/index.d.ts.map +1 -1
  60. package/dist/index.js +10 -2
  61. package/package.json +5 -5
  62. package/dist/components/InkNotePopover.svelte.d.ts +0 -9
  63. package/dist/components/InkNotePopover.svelte.d.ts.map +0 -1
  64. package/dist/components/InkSuggestionCard.svelte +0 -121
  65. package/dist/components/InkSuggestionCard.svelte.d.ts +0 -9
  66. package/dist/components/InkSuggestionCard.svelte.d.ts.map +0 -1
package/dist/hooks/useAnnotations.svelte.d.ts CHANGED
@@ -1,19 +1,6 @@
1
- import type { Annotation, AnnotationInput } from '@inkbar/core';
1
+ import type { AnnotationInput, AnnotationPatch } from '@inkbar/core';
2
2
  export declare function useAnnotations(): {
3
3
  readonly annotations: readonly ({
4
- id: string;
5
- page: number;
6
- rect: {
7
- x: number;
8
- y: number;
9
- width: number;
10
- height: number;
11
- };
12
- color: string;
13
- opacity: number;
14
- createdAt: string;
15
- modifiedAt: string;
16
- source: "session" | "pdf";
17
4
  type: "highlight" | "underline" | "strikeout" | "squiggly";
18
5
  quads: {
19
6
  p1: {
@@ -33,14 +20,27 @@ export declare function useAnnotations(): {
33
20
  y: number;
34
21
  };
35
22
  }[];
23
+ rect: {
24
+ x: number;
25
+ y: number;
26
+ width: number;
27
+ height: number;
28
+ };
29
+ color: string;
30
+ opacity: number;
31
+ createdAt: string;
32
+ modifiedAt: string;
33
+ source: "session" | "pdf";
34
+ id: string;
35
+ page: number;
36
+ locked?: boolean | undefined;
36
37
  author?: string | undefined;
37
38
  contents?: string | undefined;
38
39
  inReplyTo?: string | undefined;
39
- locked?: boolean | undefined;
40
+ subject?: string | undefined;
41
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
40
42
  custom?: Record<string, unknown> | undefined;
41
43
  } | {
42
- id: string;
43
- page: number;
44
44
  rect: {
45
45
  x: number;
46
46
  y: number;
@@ -52,43 +52,68 @@ export declare function useAnnotations(): {
52
52
  createdAt: string;
53
53
  modifiedAt: string;
54
54
  source: "session" | "pdf";
55
+ icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
56
+ id: string;
57
+ page: number;
55
58
  type: "text";
56
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
59
+ locked?: boolean | undefined;
57
60
  author?: string | undefined;
58
61
  contents?: string | undefined;
59
62
  inReplyTo?: string | undefined;
60
- locked?: boolean | undefined;
63
+ subject?: string | undefined;
64
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
61
65
  custom?: Record<string, unknown> | undefined;
62
66
  } | {
63
- id: string;
64
- page: number;
67
+ defaultStyle: {
68
+ color: string;
69
+ fontFamily: string;
70
+ fontSize: number;
71
+ textAlign: "left" | "right" | "center" | "justify";
72
+ align?: undefined;
73
+ fontWeight?: "bold" | undefined;
74
+ fontStyle?: "italic" | undefined;
75
+ textDecoration?: "underline" | undefined;
76
+ };
65
77
  rect: {
66
78
  x: number;
67
79
  y: number;
68
80
  width: number;
69
81
  height: number;
70
82
  };
71
- color: string;
72
83
  opacity: number;
73
84
  createdAt: string;
74
85
  modifiedAt: string;
75
86
  source: "session" | "pdf";
76
- type: "freetext";
77
87
  contents: string;
78
- fontSize: number;
79
- fontFamily: string;
80
- align: "left" | "center" | "right";
81
- author?: string | undefined;
82
- inReplyTo?: string | undefined;
83
- locked?: boolean | undefined;
84
- custom?: Record<string, unknown> | undefined;
88
+ width: number;
89
+ id: string;
90
+ page: number;
91
+ type: "freetext";
92
+ color?: string | undefined;
93
+ borderColor?: string | undefined;
94
+ fringe?: {
95
+ left: number;
96
+ top: number;
97
+ right: number;
98
+ bottom: number;
99
+ } | undefined;
85
100
  callout?: {
86
101
  x: number;
87
102
  y: number;
88
103
  }[] | undefined;
104
+ fontFamily?: undefined;
105
+ fontSize?: undefined;
106
+ align?: undefined;
107
+ locked?: boolean | undefined;
108
+ dashes?: number[] | undefined;
109
+ cornerRadius?: number | undefined;
110
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
111
+ author?: string | undefined;
112
+ inReplyTo?: string | undefined;
113
+ subject?: string | undefined;
114
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
115
+ custom?: Record<string, unknown> | undefined;
89
116
  } | {
90
- id: string;
91
- page: number;
92
117
  rect: {
93
118
  x: number;
94
119
  y: number;
@@ -100,17 +125,21 @@ export declare function useAnnotations(): {
100
125
  createdAt: string;
101
126
  modifiedAt: string;
102
127
  source: "session" | "pdf";
103
- type: "square" | "circle";
104
128
  width: number;
129
+ id: string;
130
+ page: number;
131
+ type: "square";
132
+ locked?: boolean | undefined;
133
+ dashes?: number[] | undefined;
134
+ interiorColor?: string | undefined;
135
+ cornerRadius?: number | undefined;
105
136
  author?: string | undefined;
106
137
  contents?: string | undefined;
107
138
  inReplyTo?: string | undefined;
108
- locked?: boolean | undefined;
139
+ subject?: string | undefined;
140
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
109
141
  custom?: Record<string, unknown> | undefined;
110
- interiorColor?: string | undefined;
111
142
  } | {
112
- id: string;
113
- page: number;
114
143
  rect: {
115
144
  x: number;
116
145
  y: number;
@@ -122,7 +151,21 @@ export declare function useAnnotations(): {
122
151
  createdAt: string;
123
152
  modifiedAt: string;
124
153
  source: "session" | "pdf";
125
- type: "line";
154
+ width: number;
155
+ id: string;
156
+ page: number;
157
+ type: "circle";
158
+ cornerRadius?: undefined;
159
+ locked?: boolean | undefined;
160
+ dashes?: number[] | undefined;
161
+ interiorColor?: string | undefined;
162
+ author?: string | undefined;
163
+ contents?: string | undefined;
164
+ inReplyTo?: string | undefined;
165
+ subject?: string | undefined;
166
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
167
+ custom?: Record<string, unknown> | undefined;
168
+ } | {
126
169
  start: {
127
170
  x: number;
128
171
  y: number;
@@ -131,17 +174,36 @@ export declare function useAnnotations(): {
131
174
  x: number;
132
175
  y: number;
133
176
  };
177
+ rect: {
178
+ x: number;
179
+ y: number;
180
+ width: number;
181
+ height: number;
182
+ };
183
+ color: string;
184
+ opacity: number;
185
+ createdAt: string;
186
+ modifiedAt: string;
187
+ source: "session" | "pdf";
134
188
  width: number;
189
+ id: string;
190
+ page: number;
191
+ type: "line";
192
+ locked?: boolean | undefined;
193
+ dashes?: number[] | undefined;
194
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
195
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
135
196
  author?: string | undefined;
136
197
  contents?: string | undefined;
137
198
  inReplyTo?: string | undefined;
138
- locked?: boolean | undefined;
199
+ subject?: string | undefined;
200
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
139
201
  custom?: Record<string, unknown> | undefined;
140
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
141
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
142
202
  } | {
143
- id: string;
144
- page: number;
203
+ vertices: {
204
+ x: number;
205
+ y: number;
206
+ }[];
145
207
  rect: {
146
208
  x: number;
147
209
  y: number;
@@ -153,21 +215,57 @@ export declare function useAnnotations(): {
153
215
  createdAt: string;
154
216
  modifiedAt: string;
155
217
  source: "session" | "pdf";
156
- type: "polyline" | "polygon";
218
+ width: number;
219
+ id: string;
220
+ page: number;
221
+ type: "polyline";
222
+ locked?: boolean | undefined;
223
+ dashes?: number[] | undefined;
224
+ interiorColor?: string | undefined;
225
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
226
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
227
+ author?: string | undefined;
228
+ contents?: string | undefined;
229
+ inReplyTo?: string | undefined;
230
+ subject?: string | undefined;
231
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
232
+ custom?: Record<string, unknown> | undefined;
233
+ } | {
157
234
  vertices: {
158
235
  x: number;
159
236
  y: number;
160
237
  }[];
238
+ rect: {
239
+ x: number;
240
+ y: number;
241
+ width: number;
242
+ height: number;
243
+ };
244
+ color: string;
245
+ opacity: number;
246
+ createdAt: string;
247
+ modifiedAt: string;
248
+ source: "session" | "pdf";
161
249
  width: number;
250
+ id: string;
251
+ page: number;
252
+ type: "polygon";
253
+ head?: undefined;
254
+ tail?: undefined;
255
+ locked?: boolean | undefined;
256
+ dashes?: number[] | undefined;
257
+ interiorColor?: string | undefined;
162
258
  author?: string | undefined;
163
259
  contents?: string | undefined;
164
260
  inReplyTo?: string | undefined;
165
- locked?: boolean | undefined;
261
+ subject?: string | undefined;
262
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
166
263
  custom?: Record<string, unknown> | undefined;
167
- interiorColor?: string | undefined;
168
264
  } | {
169
- id: string;
170
- page: number;
265
+ inklist: {
266
+ x: number;
267
+ y: number;
268
+ }[][];
171
269
  rect: {
172
270
  x: number;
173
271
  y: number;
@@ -179,20 +277,68 @@ export declare function useAnnotations(): {
179
277
  createdAt: string;
180
278
  modifiedAt: string;
181
279
  source: "session" | "pdf";
280
+ width: number;
281
+ id: string;
282
+ page: number;
182
283
  type: "ink";
183
- inklist: {
284
+ pressure?: number[][] | undefined;
285
+ locked?: boolean | undefined;
286
+ dashes?: number[] | undefined;
287
+ author?: string | undefined;
288
+ contents?: string | undefined;
289
+ inReplyTo?: string | undefined;
290
+ subject?: string | undefined;
291
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
292
+ custom?: Record<string, unknown> | undefined;
293
+ } | {
294
+ rect: {
184
295
  x: number;
185
296
  y: number;
186
- }[][];
187
- width: number;
297
+ width: number;
298
+ height: number;
299
+ };
300
+ color: string;
301
+ opacity: number;
302
+ createdAt: string;
303
+ modifiedAt: string;
304
+ source: "session" | "pdf";
305
+ imagedata: string;
306
+ id: string;
307
+ page: number;
308
+ type: "stamp";
309
+ locked?: boolean | undefined;
310
+ rotation?: 0 | 90 | 180 | 270 | undefined;
188
311
  author?: string | undefined;
189
312
  contents?: string | undefined;
190
313
  inReplyTo?: string | undefined;
191
- locked?: boolean | undefined;
314
+ subject?: string | undefined;
315
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
192
316
  custom?: Record<string, unknown> | undefined;
193
317
  } | {
318
+ rect: {
319
+ x: number;
320
+ y: number;
321
+ width: number;
322
+ height: number;
323
+ };
324
+ color: string;
325
+ opacity: number;
326
+ createdAt: string;
327
+ modifiedAt: string;
328
+ source: "session" | "pdf";
329
+ magnification: number;
330
+ width: number;
194
331
  id: string;
195
332
  page: number;
333
+ type: "loupe";
334
+ locked?: boolean | undefined;
335
+ author?: string | undefined;
336
+ contents?: string | undefined;
337
+ inReplyTo?: string | undefined;
338
+ subject?: string | undefined;
339
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
340
+ custom?: Record<string, unknown> | undefined;
341
+ } | {
196
342
  rect: {
197
343
  x: number;
198
344
  y: number;
@@ -204,14 +350,34 @@ export declare function useAnnotations(): {
204
350
  createdAt: string;
205
351
  modifiedAt: string;
206
352
  source: "session" | "pdf";
207
- type: "redact";
208
- origin: "user" | "suggested";
209
- interiorColor: string;
353
+ shape: "rect" | "ellipse";
354
+ dim: number;
355
+ id: string;
356
+ page: number;
357
+ type: "mask";
358
+ locked?: boolean | undefined;
210
359
  author?: string | undefined;
211
360
  contents?: string | undefined;
212
361
  inReplyTo?: string | undefined;
213
- locked?: boolean | undefined;
362
+ subject?: string | undefined;
363
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
214
364
  custom?: Record<string, unknown> | undefined;
365
+ } | {
366
+ interiorColor: string;
367
+ rect: {
368
+ x: number;
369
+ y: number;
370
+ width: number;
371
+ height: number;
372
+ };
373
+ color: string;
374
+ opacity: number;
375
+ createdAt: string;
376
+ modifiedAt: string;
377
+ source: "session" | "pdf";
378
+ id: string;
379
+ page: number;
380
+ type: "redact";
215
381
  quads?: {
216
382
  p1: {
217
383
  x: number;
@@ -230,30 +396,17 @@ export declare function useAnnotations(): {
230
396
  y: number;
231
397
  };
232
398
  }[] | undefined;
233
- suggestion?: {
234
- confidence: number;
235
- jobId?: string | undefined;
236
- reason?: string | undefined;
237
- explanation?: string | undefined;
238
- recommendation?: "redact" | "review" | "keep" | undefined;
239
- } | undefined;
399
+ locked?: boolean | undefined;
240
400
  overlayText?: string | undefined;
401
+ author?: string | undefined;
402
+ contents?: string | undefined;
403
+ inReplyTo?: string | undefined;
404
+ subject?: string | undefined;
405
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
406
+ custom?: Record<string, unknown> | undefined;
241
407
  })[];
242
408
  readonly selection: readonly string[];
243
409
  readonly selected: ({
244
- id: string;
245
- page: number;
246
- rect: {
247
- x: number;
248
- y: number;
249
- width: number;
250
- height: number;
251
- };
252
- color: string;
253
- opacity: number;
254
- createdAt: string;
255
- modifiedAt: string;
256
- source: "session" | "pdf";
257
410
  type: "highlight" | "underline" | "strikeout" | "squiggly";
258
411
  quads: {
259
412
  p1: {
@@ -273,14 +426,27 @@ export declare function useAnnotations(): {
273
426
  y: number;
274
427
  };
275
428
  }[];
429
+ rect: {
430
+ x: number;
431
+ y: number;
432
+ width: number;
433
+ height: number;
434
+ };
435
+ color: string;
436
+ opacity: number;
437
+ createdAt: string;
438
+ modifiedAt: string;
439
+ source: "session" | "pdf";
440
+ id: string;
441
+ page: number;
442
+ locked?: boolean | undefined;
276
443
  author?: string | undefined;
277
444
  contents?: string | undefined;
278
445
  inReplyTo?: string | undefined;
279
- locked?: boolean | undefined;
446
+ subject?: string | undefined;
447
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
280
448
  custom?: Record<string, unknown> | undefined;
281
449
  } | {
282
- id: string;
283
- page: number;
284
450
  rect: {
285
451
  x: number;
286
452
  y: number;
@@ -292,43 +458,68 @@ export declare function useAnnotations(): {
292
458
  createdAt: string;
293
459
  modifiedAt: string;
294
460
  source: "session" | "pdf";
461
+ icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
462
+ id: string;
463
+ page: number;
295
464
  type: "text";
296
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
465
+ locked?: boolean | undefined;
297
466
  author?: string | undefined;
298
467
  contents?: string | undefined;
299
468
  inReplyTo?: string | undefined;
300
- locked?: boolean | undefined;
469
+ subject?: string | undefined;
470
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
301
471
  custom?: Record<string, unknown> | undefined;
302
472
  } | {
303
- id: string;
304
- page: number;
473
+ defaultStyle: {
474
+ color: string;
475
+ fontFamily: string;
476
+ fontSize: number;
477
+ textAlign: "left" | "right" | "center" | "justify";
478
+ align?: undefined;
479
+ fontWeight?: "bold" | undefined;
480
+ fontStyle?: "italic" | undefined;
481
+ textDecoration?: "underline" | undefined;
482
+ };
305
483
  rect: {
306
484
  x: number;
307
485
  y: number;
308
486
  width: number;
309
487
  height: number;
310
488
  };
311
- color: string;
312
489
  opacity: number;
313
490
  createdAt: string;
314
491
  modifiedAt: string;
315
492
  source: "session" | "pdf";
316
- type: "freetext";
317
493
  contents: string;
318
- fontSize: number;
319
- fontFamily: string;
320
- align: "left" | "center" | "right";
321
- author?: string | undefined;
322
- inReplyTo?: string | undefined;
323
- locked?: boolean | undefined;
324
- custom?: Record<string, unknown> | undefined;
494
+ width: number;
495
+ id: string;
496
+ page: number;
497
+ type: "freetext";
498
+ color?: string | undefined;
499
+ borderColor?: string | undefined;
500
+ fringe?: {
501
+ left: number;
502
+ top: number;
503
+ right: number;
504
+ bottom: number;
505
+ } | undefined;
325
506
  callout?: {
326
507
  x: number;
327
508
  y: number;
328
509
  }[] | undefined;
510
+ fontFamily?: undefined;
511
+ fontSize?: undefined;
512
+ align?: undefined;
513
+ locked?: boolean | undefined;
514
+ dashes?: number[] | undefined;
515
+ cornerRadius?: number | undefined;
516
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
517
+ author?: string | undefined;
518
+ inReplyTo?: string | undefined;
519
+ subject?: string | undefined;
520
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
521
+ custom?: Record<string, unknown> | undefined;
329
522
  } | {
330
- id: string;
331
- page: number;
332
523
  rect: {
333
524
  x: number;
334
525
  y: number;
@@ -340,17 +531,21 @@ export declare function useAnnotations(): {
340
531
  createdAt: string;
341
532
  modifiedAt: string;
342
533
  source: "session" | "pdf";
343
- type: "square" | "circle";
344
534
  width: number;
345
- author?: string | undefined;
346
- contents?: string | undefined;
347
- inReplyTo?: string | undefined;
535
+ id: string;
536
+ page: number;
537
+ type: "square";
348
538
  locked?: boolean | undefined;
349
- custom?: Record<string, unknown> | undefined;
539
+ dashes?: number[] | undefined;
350
540
  interiorColor?: string | undefined;
541
+ cornerRadius?: number | undefined;
542
+ author?: string | undefined;
543
+ contents?: string | undefined;
544
+ inReplyTo?: string | undefined;
545
+ subject?: string | undefined;
546
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
547
+ custom?: Record<string, unknown> | undefined;
351
548
  } | {
352
- id: string;
353
- page: number;
354
549
  rect: {
355
550
  x: number;
356
551
  y: number;
@@ -362,7 +557,21 @@ export declare function useAnnotations(): {
362
557
  createdAt: string;
363
558
  modifiedAt: string;
364
559
  source: "session" | "pdf";
365
- type: "line";
560
+ width: number;
561
+ id: string;
562
+ page: number;
563
+ type: "circle";
564
+ cornerRadius?: undefined;
565
+ locked?: boolean | undefined;
566
+ dashes?: number[] | undefined;
567
+ interiorColor?: string | undefined;
568
+ author?: string | undefined;
569
+ contents?: string | undefined;
570
+ inReplyTo?: string | undefined;
571
+ subject?: string | undefined;
572
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
573
+ custom?: Record<string, unknown> | undefined;
574
+ } | {
366
575
  start: {
367
576
  x: number;
368
577
  y: number;
@@ -371,17 +580,36 @@ export declare function useAnnotations(): {
371
580
  x: number;
372
581
  y: number;
373
582
  };
583
+ rect: {
584
+ x: number;
585
+ y: number;
586
+ width: number;
587
+ height: number;
588
+ };
589
+ color: string;
590
+ opacity: number;
591
+ createdAt: string;
592
+ modifiedAt: string;
593
+ source: "session" | "pdf";
374
594
  width: number;
595
+ id: string;
596
+ page: number;
597
+ type: "line";
598
+ locked?: boolean | undefined;
599
+ dashes?: number[] | undefined;
600
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
601
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
375
602
  author?: string | undefined;
376
603
  contents?: string | undefined;
377
604
  inReplyTo?: string | undefined;
378
- locked?: boolean | undefined;
605
+ subject?: string | undefined;
606
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
379
607
  custom?: Record<string, unknown> | undefined;
380
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
381
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
382
608
  } | {
383
- id: string;
384
- page: number;
609
+ vertices: {
610
+ x: number;
611
+ y: number;
612
+ }[];
385
613
  rect: {
386
614
  x: number;
387
615
  y: number;
@@ -393,21 +621,57 @@ export declare function useAnnotations(): {
393
621
  createdAt: string;
394
622
  modifiedAt: string;
395
623
  source: "session" | "pdf";
396
- type: "polyline" | "polygon";
624
+ width: number;
625
+ id: string;
626
+ page: number;
627
+ type: "polyline";
628
+ locked?: boolean | undefined;
629
+ dashes?: number[] | undefined;
630
+ interiorColor?: string | undefined;
631
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
632
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
633
+ author?: string | undefined;
634
+ contents?: string | undefined;
635
+ inReplyTo?: string | undefined;
636
+ subject?: string | undefined;
637
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
638
+ custom?: Record<string, unknown> | undefined;
639
+ } | {
397
640
  vertices: {
398
641
  x: number;
399
642
  y: number;
400
643
  }[];
644
+ rect: {
645
+ x: number;
646
+ y: number;
647
+ width: number;
648
+ height: number;
649
+ };
650
+ color: string;
651
+ opacity: number;
652
+ createdAt: string;
653
+ modifiedAt: string;
654
+ source: "session" | "pdf";
401
655
  width: number;
656
+ id: string;
657
+ page: number;
658
+ type: "polygon";
659
+ head?: undefined;
660
+ tail?: undefined;
661
+ locked?: boolean | undefined;
662
+ dashes?: number[] | undefined;
663
+ interiorColor?: string | undefined;
402
664
  author?: string | undefined;
403
665
  contents?: string | undefined;
404
666
  inReplyTo?: string | undefined;
405
- locked?: boolean | undefined;
667
+ subject?: string | undefined;
668
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
406
669
  custom?: Record<string, unknown> | undefined;
407
- interiorColor?: string | undefined;
408
670
  } | {
409
- id: string;
410
- page: number;
671
+ inklist: {
672
+ x: number;
673
+ y: number;
674
+ }[][];
411
675
  rect: {
412
676
  x: number;
413
677
  y: number;
@@ -419,20 +683,68 @@ export declare function useAnnotations(): {
419
683
  createdAt: string;
420
684
  modifiedAt: string;
421
685
  source: "session" | "pdf";
686
+ width: number;
687
+ id: string;
688
+ page: number;
422
689
  type: "ink";
423
- inklist: {
690
+ pressure?: number[][] | undefined;
691
+ locked?: boolean | undefined;
692
+ dashes?: number[] | undefined;
693
+ author?: string | undefined;
694
+ contents?: string | undefined;
695
+ inReplyTo?: string | undefined;
696
+ subject?: string | undefined;
697
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
698
+ custom?: Record<string, unknown> | undefined;
699
+ } | {
700
+ rect: {
424
701
  x: number;
425
702
  y: number;
426
- }[][];
427
- width: number;
703
+ width: number;
704
+ height: number;
705
+ };
706
+ color: string;
707
+ opacity: number;
708
+ createdAt: string;
709
+ modifiedAt: string;
710
+ source: "session" | "pdf";
711
+ imagedata: string;
712
+ id: string;
713
+ page: number;
714
+ type: "stamp";
715
+ locked?: boolean | undefined;
716
+ rotation?: 0 | 90 | 180 | 270 | undefined;
428
717
  author?: string | undefined;
429
718
  contents?: string | undefined;
430
719
  inReplyTo?: string | undefined;
431
- locked?: boolean | undefined;
720
+ subject?: string | undefined;
721
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
432
722
  custom?: Record<string, unknown> | undefined;
433
723
  } | {
724
+ rect: {
725
+ x: number;
726
+ y: number;
727
+ width: number;
728
+ height: number;
729
+ };
730
+ color: string;
731
+ opacity: number;
732
+ createdAt: string;
733
+ modifiedAt: string;
734
+ source: "session" | "pdf";
735
+ magnification: number;
736
+ width: number;
434
737
  id: string;
435
738
  page: number;
739
+ type: "loupe";
740
+ locked?: boolean | undefined;
741
+ author?: string | undefined;
742
+ contents?: string | undefined;
743
+ inReplyTo?: string | undefined;
744
+ subject?: string | undefined;
745
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
746
+ custom?: Record<string, unknown> | undefined;
747
+ } | {
436
748
  rect: {
437
749
  x: number;
438
750
  y: number;
@@ -444,14 +756,34 @@ export declare function useAnnotations(): {
444
756
  createdAt: string;
445
757
  modifiedAt: string;
446
758
  source: "session" | "pdf";
447
- type: "redact";
448
- origin: "user" | "suggested";
449
- interiorColor: string;
759
+ shape: "rect" | "ellipse";
760
+ dim: number;
761
+ id: string;
762
+ page: number;
763
+ type: "mask";
764
+ locked?: boolean | undefined;
450
765
  author?: string | undefined;
451
766
  contents?: string | undefined;
452
767
  inReplyTo?: string | undefined;
453
- locked?: boolean | undefined;
768
+ subject?: string | undefined;
769
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
454
770
  custom?: Record<string, unknown> | undefined;
771
+ } | {
772
+ interiorColor: string;
773
+ rect: {
774
+ x: number;
775
+ y: number;
776
+ width: number;
777
+ height: number;
778
+ };
779
+ color: string;
780
+ opacity: number;
781
+ createdAt: string;
782
+ modifiedAt: string;
783
+ source: "session" | "pdf";
784
+ id: string;
785
+ page: number;
786
+ type: "redact";
455
787
  quads?: {
456
788
  p1: {
457
789
  x: number;
@@ -470,29 +802,16 @@ export declare function useAnnotations(): {
470
802
  y: number;
471
803
  };
472
804
  }[] | undefined;
473
- suggestion?: {
474
- confidence: number;
475
- jobId?: string | undefined;
476
- reason?: string | undefined;
477
- explanation?: string | undefined;
478
- recommendation?: "redact" | "review" | "keep" | undefined;
479
- } | undefined;
805
+ locked?: boolean | undefined;
480
806
  overlayText?: string | undefined;
807
+ author?: string | undefined;
808
+ contents?: string | undefined;
809
+ inReplyTo?: string | undefined;
810
+ subject?: string | undefined;
811
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
812
+ custom?: Record<string, unknown> | undefined;
481
813
  })[];
482
814
  byPage: (page: number) => ({
483
- id: string;
484
- page: number;
485
- rect: {
486
- x: number;
487
- y: number;
488
- width: number;
489
- height: number;
490
- };
491
- color: string;
492
- opacity: number;
493
- createdAt: string;
494
- modifiedAt: string;
495
- source: "session" | "pdf";
496
815
  type: "highlight" | "underline" | "strikeout" | "squiggly";
497
816
  quads: {
498
817
  p1: {
@@ -512,14 +831,27 @@ export declare function useAnnotations(): {
512
831
  y: number;
513
832
  };
514
833
  }[];
834
+ rect: {
835
+ x: number;
836
+ y: number;
837
+ width: number;
838
+ height: number;
839
+ };
840
+ color: string;
841
+ opacity: number;
842
+ createdAt: string;
843
+ modifiedAt: string;
844
+ source: "session" | "pdf";
845
+ id: string;
846
+ page: number;
847
+ locked?: boolean | undefined;
515
848
  author?: string | undefined;
516
849
  contents?: string | undefined;
517
850
  inReplyTo?: string | undefined;
518
- locked?: boolean | undefined;
851
+ subject?: string | undefined;
852
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
519
853
  custom?: Record<string, unknown> | undefined;
520
854
  } | {
521
- id: string;
522
- page: number;
523
855
  rect: {
524
856
  x: number;
525
857
  y: number;
@@ -531,43 +863,68 @@ export declare function useAnnotations(): {
531
863
  createdAt: string;
532
864
  modifiedAt: string;
533
865
  source: "session" | "pdf";
866
+ icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
867
+ id: string;
868
+ page: number;
534
869
  type: "text";
535
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
870
+ locked?: boolean | undefined;
536
871
  author?: string | undefined;
537
872
  contents?: string | undefined;
538
873
  inReplyTo?: string | undefined;
539
- locked?: boolean | undefined;
874
+ subject?: string | undefined;
875
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
540
876
  custom?: Record<string, unknown> | undefined;
541
877
  } | {
542
- id: string;
543
- page: number;
878
+ defaultStyle: {
879
+ color: string;
880
+ fontFamily: string;
881
+ fontSize: number;
882
+ textAlign: "left" | "right" | "center" | "justify";
883
+ align?: undefined;
884
+ fontWeight?: "bold" | undefined;
885
+ fontStyle?: "italic" | undefined;
886
+ textDecoration?: "underline" | undefined;
887
+ };
544
888
  rect: {
545
889
  x: number;
546
890
  y: number;
547
891
  width: number;
548
892
  height: number;
549
893
  };
550
- color: string;
551
894
  opacity: number;
552
895
  createdAt: string;
553
896
  modifiedAt: string;
554
897
  source: "session" | "pdf";
555
- type: "freetext";
556
898
  contents: string;
557
- fontSize: number;
558
- fontFamily: string;
559
- align: "left" | "center" | "right";
560
- author?: string | undefined;
561
- inReplyTo?: string | undefined;
562
- locked?: boolean | undefined;
563
- custom?: Record<string, unknown> | undefined;
899
+ width: number;
900
+ id: string;
901
+ page: number;
902
+ type: "freetext";
903
+ color?: string | undefined;
904
+ borderColor?: string | undefined;
905
+ fringe?: {
906
+ left: number;
907
+ top: number;
908
+ right: number;
909
+ bottom: number;
910
+ } | undefined;
564
911
  callout?: {
565
912
  x: number;
566
913
  y: number;
567
914
  }[] | undefined;
915
+ fontFamily?: undefined;
916
+ fontSize?: undefined;
917
+ align?: undefined;
918
+ locked?: boolean | undefined;
919
+ dashes?: number[] | undefined;
920
+ cornerRadius?: number | undefined;
921
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
922
+ author?: string | undefined;
923
+ inReplyTo?: string | undefined;
924
+ subject?: string | undefined;
925
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
926
+ custom?: Record<string, unknown> | undefined;
568
927
  } | {
569
- id: string;
570
- page: number;
571
928
  rect: {
572
929
  x: number;
573
930
  y: number;
@@ -579,17 +936,21 @@ export declare function useAnnotations(): {
579
936
  createdAt: string;
580
937
  modifiedAt: string;
581
938
  source: "session" | "pdf";
582
- type: "square" | "circle";
583
939
  width: number;
940
+ id: string;
941
+ page: number;
942
+ type: "square";
943
+ locked?: boolean | undefined;
944
+ dashes?: number[] | undefined;
945
+ interiorColor?: string | undefined;
946
+ cornerRadius?: number | undefined;
584
947
  author?: string | undefined;
585
948
  contents?: string | undefined;
586
949
  inReplyTo?: string | undefined;
587
- locked?: boolean | undefined;
950
+ subject?: string | undefined;
951
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
588
952
  custom?: Record<string, unknown> | undefined;
589
- interiorColor?: string | undefined;
590
953
  } | {
591
- id: string;
592
- page: number;
593
954
  rect: {
594
955
  x: number;
595
956
  y: number;
@@ -601,7 +962,21 @@ export declare function useAnnotations(): {
601
962
  createdAt: string;
602
963
  modifiedAt: string;
603
964
  source: "session" | "pdf";
604
- type: "line";
965
+ width: number;
966
+ id: string;
967
+ page: number;
968
+ type: "circle";
969
+ cornerRadius?: undefined;
970
+ locked?: boolean | undefined;
971
+ dashes?: number[] | undefined;
972
+ interiorColor?: string | undefined;
973
+ author?: string | undefined;
974
+ contents?: string | undefined;
975
+ inReplyTo?: string | undefined;
976
+ subject?: string | undefined;
977
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
978
+ custom?: Record<string, unknown> | undefined;
979
+ } | {
605
980
  start: {
606
981
  x: number;
607
982
  y: number;
@@ -610,17 +985,6 @@ export declare function useAnnotations(): {
610
985
  x: number;
611
986
  y: number;
612
987
  };
613
- width: number;
614
- author?: string | undefined;
615
- contents?: string | undefined;
616
- inReplyTo?: string | undefined;
617
- locked?: boolean | undefined;
618
- custom?: Record<string, unknown> | undefined;
619
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
620
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
621
- } | {
622
- id: string;
623
- page: number;
624
988
  rect: {
625
989
  x: number;
626
990
  y: number;
@@ -632,21 +996,25 @@ export declare function useAnnotations(): {
632
996
  createdAt: string;
633
997
  modifiedAt: string;
634
998
  source: "session" | "pdf";
635
- type: "polyline" | "polygon";
636
- vertices: {
637
- x: number;
638
- y: number;
639
- }[];
640
999
  width: number;
1000
+ id: string;
1001
+ page: number;
1002
+ type: "line";
1003
+ locked?: boolean | undefined;
1004
+ dashes?: number[] | undefined;
1005
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1006
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
641
1007
  author?: string | undefined;
642
1008
  contents?: string | undefined;
643
1009
  inReplyTo?: string | undefined;
644
- locked?: boolean | undefined;
1010
+ subject?: string | undefined;
1011
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
645
1012
  custom?: Record<string, unknown> | undefined;
646
- interiorColor?: string | undefined;
647
1013
  } | {
648
- id: string;
649
- page: number;
1014
+ vertices: {
1015
+ x: number;
1016
+ y: number;
1017
+ }[];
650
1018
  rect: {
651
1019
  x: number;
652
1020
  y: number;
@@ -658,70 +1026,26 @@ export declare function useAnnotations(): {
658
1026
  createdAt: string;
659
1027
  modifiedAt: string;
660
1028
  source: "session" | "pdf";
661
- type: "ink";
662
- inklist: {
663
- x: number;
664
- y: number;
665
- }[][];
666
1029
  width: number;
1030
+ id: string;
1031
+ page: number;
1032
+ type: "polyline";
1033
+ locked?: boolean | undefined;
1034
+ dashes?: number[] | undefined;
1035
+ interiorColor?: string | undefined;
1036
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1037
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
667
1038
  author?: string | undefined;
668
1039
  contents?: string | undefined;
669
1040
  inReplyTo?: string | undefined;
670
- locked?: boolean | undefined;
1041
+ subject?: string | undefined;
1042
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
671
1043
  custom?: Record<string, unknown> | undefined;
672
1044
  } | {
673
- id: string;
674
- page: number;
675
- rect: {
1045
+ vertices: {
676
1046
  x: number;
677
1047
  y: number;
678
- width: number;
679
- height: number;
680
- };
681
- color: string;
682
- opacity: number;
683
- createdAt: string;
684
- modifiedAt: string;
685
- source: "session" | "pdf";
686
- type: "redact";
687
- origin: "user" | "suggested";
688
- interiorColor: string;
689
- author?: string | undefined;
690
- contents?: string | undefined;
691
- inReplyTo?: string | undefined;
692
- locked?: boolean | undefined;
693
- custom?: Record<string, unknown> | undefined;
694
- quads?: {
695
- p1: {
696
- x: number;
697
- y: number;
698
- };
699
- p2: {
700
- x: number;
701
- y: number;
702
- };
703
- p3: {
704
- x: number;
705
- y: number;
706
- };
707
- p4: {
708
- x: number;
709
- y: number;
710
- };
711
- }[] | undefined;
712
- suggestion?: {
713
- confidence: number;
714
- jobId?: string | undefined;
715
- reason?: string | undefined;
716
- explanation?: string | undefined;
717
- recommendation?: "redact" | "review" | "keep" | undefined;
718
- } | undefined;
719
- overlayText?: string | undefined;
720
- })[];
721
- /** Replies in creation order for a note id. */
722
- replies: (id: string) => ({
723
- id: string;
724
- page: number;
1048
+ }[];
725
1049
  rect: {
726
1050
  x: number;
727
1051
  y: number;
@@ -733,81 +1057,26 @@ export declare function useAnnotations(): {
733
1057
  createdAt: string;
734
1058
  modifiedAt: string;
735
1059
  source: "session" | "pdf";
736
- type: "highlight" | "underline" | "strikeout" | "squiggly";
737
- quads: {
738
- p1: {
739
- x: number;
740
- y: number;
741
- };
742
- p2: {
743
- x: number;
744
- y: number;
745
- };
746
- p3: {
747
- x: number;
748
- y: number;
749
- };
750
- p4: {
751
- x: number;
752
- y: number;
753
- };
754
- }[];
755
- author?: string | undefined;
756
- contents?: string | undefined;
757
- inReplyTo?: string | undefined;
758
- locked?: boolean | undefined;
759
- custom?: Record<string, unknown> | undefined;
760
- } | {
1060
+ width: number;
761
1061
  id: string;
762
1062
  page: number;
763
- rect: {
764
- x: number;
765
- y: number;
766
- width: number;
767
- height: number;
768
- };
769
- color: string;
770
- opacity: number;
771
- createdAt: string;
772
- modifiedAt: string;
773
- source: "session" | "pdf";
774
- type: "text";
775
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
1063
+ type: "polygon";
1064
+ head?: undefined;
1065
+ tail?: undefined;
1066
+ locked?: boolean | undefined;
1067
+ dashes?: number[] | undefined;
1068
+ interiorColor?: string | undefined;
776
1069
  author?: string | undefined;
777
1070
  contents?: string | undefined;
778
1071
  inReplyTo?: string | undefined;
779
- locked?: boolean | undefined;
1072
+ subject?: string | undefined;
1073
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
780
1074
  custom?: Record<string, unknown> | undefined;
781
1075
  } | {
782
- id: string;
783
- page: number;
784
- rect: {
785
- x: number;
786
- y: number;
787
- width: number;
788
- height: number;
789
- };
790
- color: string;
791
- opacity: number;
792
- createdAt: string;
793
- modifiedAt: string;
794
- source: "session" | "pdf";
795
- type: "freetext";
796
- contents: string;
797
- fontSize: number;
798
- fontFamily: string;
799
- align: "left" | "center" | "right";
800
- author?: string | undefined;
801
- inReplyTo?: string | undefined;
802
- locked?: boolean | undefined;
803
- custom?: Record<string, unknown> | undefined;
804
- callout?: {
1076
+ inklist: {
805
1077
  x: number;
806
1078
  y: number;
807
- }[] | undefined;
808
- } | {
809
- id: string;
810
- page: number;
1079
+ }[][];
811
1080
  rect: {
812
1081
  x: number;
813
1082
  y: number;
@@ -819,17 +1088,20 @@ export declare function useAnnotations(): {
819
1088
  createdAt: string;
820
1089
  modifiedAt: string;
821
1090
  source: "session" | "pdf";
822
- type: "square" | "circle";
823
1091
  width: number;
1092
+ id: string;
1093
+ page: number;
1094
+ type: "ink";
1095
+ pressure?: number[][] | undefined;
1096
+ locked?: boolean | undefined;
1097
+ dashes?: number[] | undefined;
824
1098
  author?: string | undefined;
825
1099
  contents?: string | undefined;
826
1100
  inReplyTo?: string | undefined;
827
- locked?: boolean | undefined;
1101
+ subject?: string | undefined;
1102
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
828
1103
  custom?: Record<string, unknown> | undefined;
829
- interiorColor?: string | undefined;
830
1104
  } | {
831
- id: string;
832
- page: number;
833
1105
  rect: {
834
1106
  x: number;
835
1107
  y: number;
@@ -841,26 +1113,19 @@ export declare function useAnnotations(): {
841
1113
  createdAt: string;
842
1114
  modifiedAt: string;
843
1115
  source: "session" | "pdf";
844
- type: "line";
845
- start: {
846
- x: number;
847
- y: number;
848
- };
849
- end: {
850
- x: number;
851
- y: number;
852
- };
853
- width: number;
1116
+ imagedata: string;
1117
+ id: string;
1118
+ page: number;
1119
+ type: "stamp";
1120
+ locked?: boolean | undefined;
1121
+ rotation?: 0 | 90 | 180 | 270 | undefined;
854
1122
  author?: string | undefined;
855
1123
  contents?: string | undefined;
856
1124
  inReplyTo?: string | undefined;
857
- locked?: boolean | undefined;
1125
+ subject?: string | undefined;
1126
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
858
1127
  custom?: Record<string, unknown> | undefined;
859
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
860
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
861
1128
  } | {
862
- id: string;
863
- page: number;
864
1129
  rect: {
865
1130
  x: number;
866
1131
  y: number;
@@ -872,21 +1137,19 @@ export declare function useAnnotations(): {
872
1137
  createdAt: string;
873
1138
  modifiedAt: string;
874
1139
  source: "session" | "pdf";
875
- type: "polyline" | "polygon";
876
- vertices: {
877
- x: number;
878
- y: number;
879
- }[];
1140
+ magnification: number;
880
1141
  width: number;
1142
+ id: string;
1143
+ page: number;
1144
+ type: "loupe";
1145
+ locked?: boolean | undefined;
881
1146
  author?: string | undefined;
882
1147
  contents?: string | undefined;
883
1148
  inReplyTo?: string | undefined;
884
- locked?: boolean | undefined;
1149
+ subject?: string | undefined;
1150
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
885
1151
  custom?: Record<string, unknown> | undefined;
886
- interiorColor?: string | undefined;
887
1152
  } | {
888
- id: string;
889
- page: number;
890
1153
  rect: {
891
1154
  x: number;
892
1155
  y: number;
@@ -898,20 +1161,20 @@ export declare function useAnnotations(): {
898
1161
  createdAt: string;
899
1162
  modifiedAt: string;
900
1163
  source: "session" | "pdf";
901
- type: "ink";
902
- inklist: {
903
- x: number;
904
- y: number;
905
- }[][];
906
- width: number;
1164
+ shape: "rect" | "ellipse";
1165
+ dim: number;
1166
+ id: string;
1167
+ page: number;
1168
+ type: "mask";
1169
+ locked?: boolean | undefined;
907
1170
  author?: string | undefined;
908
1171
  contents?: string | undefined;
909
1172
  inReplyTo?: string | undefined;
910
- locked?: boolean | undefined;
1173
+ subject?: string | undefined;
1174
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
911
1175
  custom?: Record<string, unknown> | undefined;
912
1176
  } | {
913
- id: string;
914
- page: number;
1177
+ interiorColor: string;
915
1178
  rect: {
916
1179
  x: number;
917
1180
  y: number;
@@ -923,14 +1186,9 @@ export declare function useAnnotations(): {
923
1186
  createdAt: string;
924
1187
  modifiedAt: string;
925
1188
  source: "session" | "pdf";
1189
+ id: string;
1190
+ page: number;
926
1191
  type: "redact";
927
- origin: "user" | "suggested";
928
- interiorColor: string;
929
- author?: string | undefined;
930
- contents?: string | undefined;
931
- inReplyTo?: string | undefined;
932
- locked?: boolean | undefined;
933
- custom?: Record<string, unknown> | undefined;
934
1192
  quads?: {
935
1193
  p1: {
936
1194
  x: number;
@@ -949,29 +1207,17 @@ export declare function useAnnotations(): {
949
1207
  y: number;
950
1208
  };
951
1209
  }[] | undefined;
952
- suggestion?: {
953
- confidence: number;
954
- jobId?: string | undefined;
955
- reason?: string | undefined;
956
- explanation?: string | undefined;
957
- recommendation?: "redact" | "review" | "keep" | undefined;
958
- } | undefined;
1210
+ locked?: boolean | undefined;
959
1211
  overlayText?: string | undefined;
1212
+ author?: string | undefined;
1213
+ contents?: string | undefined;
1214
+ inReplyTo?: string | undefined;
1215
+ subject?: string | undefined;
1216
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1217
+ custom?: Record<string, unknown> | undefined;
960
1218
  })[];
961
- add: (input: AnnotationInput) => {
962
- id: string;
963
- page: number;
964
- rect: {
965
- x: number;
966
- y: number;
967
- width: number;
968
- height: number;
969
- };
970
- color: string;
971
- opacity: number;
972
- createdAt: string;
973
- modifiedAt: string;
974
- source: "session" | "pdf";
1219
+ /** Replies in creation order for a note id. */
1220
+ replies: (id: string) => ({
975
1221
  type: "highlight" | "underline" | "strikeout" | "squiggly";
976
1222
  quads: {
977
1223
  p1: {
@@ -991,14 +1237,6 @@ export declare function useAnnotations(): {
991
1237
  y: number;
992
1238
  };
993
1239
  }[];
994
- author?: string | undefined;
995
- contents?: string | undefined;
996
- inReplyTo?: string | undefined;
997
- locked?: boolean | undefined;
998
- custom?: Record<string, unknown> | undefined;
999
- } | {
1000
- id: string;
1001
- page: number;
1002
1240
  rect: {
1003
1241
  x: number;
1004
1242
  y: number;
@@ -1010,16 +1248,16 @@ export declare function useAnnotations(): {
1010
1248
  createdAt: string;
1011
1249
  modifiedAt: string;
1012
1250
  source: "session" | "pdf";
1013
- type: "text";
1014
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
1251
+ id: string;
1252
+ page: number;
1253
+ locked?: boolean | undefined;
1015
1254
  author?: string | undefined;
1016
1255
  contents?: string | undefined;
1017
1256
  inReplyTo?: string | undefined;
1018
- locked?: boolean | undefined;
1257
+ subject?: string | undefined;
1258
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1019
1259
  custom?: Record<string, unknown> | undefined;
1020
1260
  } | {
1021
- id: string;
1022
- page: number;
1023
1261
  rect: {
1024
1262
  x: number;
1025
1263
  y: number;
@@ -1031,44 +1269,68 @@ export declare function useAnnotations(): {
1031
1269
  createdAt: string;
1032
1270
  modifiedAt: string;
1033
1271
  source: "session" | "pdf";
1034
- type: "freetext";
1035
- contents: string;
1036
- fontSize: number;
1037
- fontFamily: string;
1038
- align: "left" | "center" | "right";
1272
+ icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
1273
+ id: string;
1274
+ page: number;
1275
+ type: "text";
1276
+ locked?: boolean | undefined;
1039
1277
  author?: string | undefined;
1278
+ contents?: string | undefined;
1040
1279
  inReplyTo?: string | undefined;
1041
- locked?: boolean | undefined;
1280
+ subject?: string | undefined;
1281
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1042
1282
  custom?: Record<string, unknown> | undefined;
1043
- callout?: {
1044
- x: number;
1045
- y: number;
1046
- }[] | undefined;
1047
1283
  } | {
1048
- id: string;
1049
- page: number;
1284
+ defaultStyle: {
1285
+ color: string;
1286
+ fontFamily: string;
1287
+ fontSize: number;
1288
+ textAlign: "left" | "right" | "center" | "justify";
1289
+ align?: undefined;
1290
+ fontWeight?: "bold" | undefined;
1291
+ fontStyle?: "italic" | undefined;
1292
+ textDecoration?: "underline" | undefined;
1293
+ };
1050
1294
  rect: {
1051
1295
  x: number;
1052
1296
  y: number;
1053
1297
  width: number;
1054
1298
  height: number;
1055
1299
  };
1056
- color: string;
1057
1300
  opacity: number;
1058
1301
  createdAt: string;
1059
1302
  modifiedAt: string;
1060
1303
  source: "session" | "pdf";
1061
- type: "square" | "circle";
1304
+ contents: string;
1062
1305
  width: number;
1306
+ id: string;
1307
+ page: number;
1308
+ type: "freetext";
1309
+ color?: string | undefined;
1310
+ borderColor?: string | undefined;
1311
+ fringe?: {
1312
+ left: number;
1313
+ top: number;
1314
+ right: number;
1315
+ bottom: number;
1316
+ } | undefined;
1317
+ callout?: {
1318
+ x: number;
1319
+ y: number;
1320
+ }[] | undefined;
1321
+ fontFamily?: undefined;
1322
+ fontSize?: undefined;
1323
+ align?: undefined;
1324
+ locked?: boolean | undefined;
1325
+ dashes?: number[] | undefined;
1326
+ cornerRadius?: number | undefined;
1327
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1063
1328
  author?: string | undefined;
1064
- contents?: string | undefined;
1065
1329
  inReplyTo?: string | undefined;
1066
- locked?: boolean | undefined;
1330
+ subject?: string | undefined;
1331
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1067
1332
  custom?: Record<string, unknown> | undefined;
1068
- interiorColor?: string | undefined;
1069
1333
  } | {
1070
- id: string;
1071
- page: number;
1072
1334
  rect: {
1073
1335
  x: number;
1074
1336
  y: number;
@@ -1080,26 +1342,21 @@ export declare function useAnnotations(): {
1080
1342
  createdAt: string;
1081
1343
  modifiedAt: string;
1082
1344
  source: "session" | "pdf";
1083
- type: "line";
1084
- start: {
1085
- x: number;
1086
- y: number;
1087
- };
1088
- end: {
1089
- x: number;
1090
- y: number;
1091
- };
1092
1345
  width: number;
1346
+ id: string;
1347
+ page: number;
1348
+ type: "square";
1349
+ locked?: boolean | undefined;
1350
+ dashes?: number[] | undefined;
1351
+ interiorColor?: string | undefined;
1352
+ cornerRadius?: number | undefined;
1093
1353
  author?: string | undefined;
1094
1354
  contents?: string | undefined;
1095
1355
  inReplyTo?: string | undefined;
1096
- locked?: boolean | undefined;
1356
+ subject?: string | undefined;
1357
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1097
1358
  custom?: Record<string, unknown> | undefined;
1098
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
1099
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
1100
1359
  } | {
1101
- id: string;
1102
- page: number;
1103
1360
  rect: {
1104
1361
  x: number;
1105
1362
  y: number;
@@ -1111,21 +1368,90 @@ export declare function useAnnotations(): {
1111
1368
  createdAt: string;
1112
1369
  modifiedAt: string;
1113
1370
  source: "session" | "pdf";
1114
- type: "polyline" | "polygon";
1115
- vertices: {
1116
- x: number;
1117
- y: number;
1118
- }[];
1119
1371
  width: number;
1120
- author?: string | undefined;
1121
- contents?: string | undefined;
1372
+ id: string;
1373
+ page: number;
1374
+ type: "circle";
1375
+ cornerRadius?: undefined;
1376
+ locked?: boolean | undefined;
1377
+ dashes?: number[] | undefined;
1378
+ interiorColor?: string | undefined;
1379
+ author?: string | undefined;
1380
+ contents?: string | undefined;
1122
1381
  inReplyTo?: string | undefined;
1382
+ subject?: string | undefined;
1383
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1384
+ custom?: Record<string, unknown> | undefined;
1385
+ } | {
1386
+ start: {
1387
+ x: number;
1388
+ y: number;
1389
+ };
1390
+ end: {
1391
+ x: number;
1392
+ y: number;
1393
+ };
1394
+ rect: {
1395
+ x: number;
1396
+ y: number;
1397
+ width: number;
1398
+ height: number;
1399
+ };
1400
+ color: string;
1401
+ opacity: number;
1402
+ createdAt: string;
1403
+ modifiedAt: string;
1404
+ source: "session" | "pdf";
1405
+ width: number;
1406
+ id: string;
1407
+ page: number;
1408
+ type: "line";
1123
1409
  locked?: boolean | undefined;
1410
+ dashes?: number[] | undefined;
1411
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1412
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1413
+ author?: string | undefined;
1414
+ contents?: string | undefined;
1415
+ inReplyTo?: string | undefined;
1416
+ subject?: string | undefined;
1417
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1124
1418
  custom?: Record<string, unknown> | undefined;
1125
- interiorColor?: string | undefined;
1126
1419
  } | {
1420
+ vertices: {
1421
+ x: number;
1422
+ y: number;
1423
+ }[];
1424
+ rect: {
1425
+ x: number;
1426
+ y: number;
1427
+ width: number;
1428
+ height: number;
1429
+ };
1430
+ color: string;
1431
+ opacity: number;
1432
+ createdAt: string;
1433
+ modifiedAt: string;
1434
+ source: "session" | "pdf";
1435
+ width: number;
1127
1436
  id: string;
1128
1437
  page: number;
1438
+ type: "polyline";
1439
+ locked?: boolean | undefined;
1440
+ dashes?: number[] | undefined;
1441
+ interiorColor?: string | undefined;
1442
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1443
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1444
+ author?: string | undefined;
1445
+ contents?: string | undefined;
1446
+ inReplyTo?: string | undefined;
1447
+ subject?: string | undefined;
1448
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1449
+ custom?: Record<string, unknown> | undefined;
1450
+ } | {
1451
+ vertices: {
1452
+ x: number;
1453
+ y: number;
1454
+ }[];
1129
1455
  rect: {
1130
1456
  x: number;
1131
1457
  y: number;
@@ -1137,20 +1463,75 @@ export declare function useAnnotations(): {
1137
1463
  createdAt: string;
1138
1464
  modifiedAt: string;
1139
1465
  source: "session" | "pdf";
1140
- type: "ink";
1466
+ width: number;
1467
+ id: string;
1468
+ page: number;
1469
+ type: "polygon";
1470
+ head?: undefined;
1471
+ tail?: undefined;
1472
+ locked?: boolean | undefined;
1473
+ dashes?: number[] | undefined;
1474
+ interiorColor?: string | undefined;
1475
+ author?: string | undefined;
1476
+ contents?: string | undefined;
1477
+ inReplyTo?: string | undefined;
1478
+ subject?: string | undefined;
1479
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1480
+ custom?: Record<string, unknown> | undefined;
1481
+ } | {
1141
1482
  inklist: {
1142
1483
  x: number;
1143
1484
  y: number;
1144
1485
  }[][];
1486
+ rect: {
1487
+ x: number;
1488
+ y: number;
1489
+ width: number;
1490
+ height: number;
1491
+ };
1492
+ color: string;
1493
+ opacity: number;
1494
+ createdAt: string;
1495
+ modifiedAt: string;
1496
+ source: "session" | "pdf";
1145
1497
  width: number;
1498
+ id: string;
1499
+ page: number;
1500
+ type: "ink";
1501
+ pressure?: number[][] | undefined;
1502
+ locked?: boolean | undefined;
1503
+ dashes?: number[] | undefined;
1146
1504
  author?: string | undefined;
1147
1505
  contents?: string | undefined;
1148
1506
  inReplyTo?: string | undefined;
1149
- locked?: boolean | undefined;
1507
+ subject?: string | undefined;
1508
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1150
1509
  custom?: Record<string, unknown> | undefined;
1151
1510
  } | {
1511
+ rect: {
1512
+ x: number;
1513
+ y: number;
1514
+ width: number;
1515
+ height: number;
1516
+ };
1517
+ color: string;
1518
+ opacity: number;
1519
+ createdAt: string;
1520
+ modifiedAt: string;
1521
+ source: "session" | "pdf";
1522
+ imagedata: string;
1152
1523
  id: string;
1153
1524
  page: number;
1525
+ type: "stamp";
1526
+ locked?: boolean | undefined;
1527
+ rotation?: 0 | 90 | 180 | 270 | undefined;
1528
+ author?: string | undefined;
1529
+ contents?: string | undefined;
1530
+ inReplyTo?: string | undefined;
1531
+ subject?: string | undefined;
1532
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1533
+ custom?: Record<string, unknown> | undefined;
1534
+ } | {
1154
1535
  rect: {
1155
1536
  x: number;
1156
1537
  y: number;
@@ -1162,14 +1543,58 @@ export declare function useAnnotations(): {
1162
1543
  createdAt: string;
1163
1544
  modifiedAt: string;
1164
1545
  source: "session" | "pdf";
1165
- type: "redact";
1166
- origin: "user" | "suggested";
1167
- interiorColor: string;
1546
+ magnification: number;
1547
+ width: number;
1548
+ id: string;
1549
+ page: number;
1550
+ type: "loupe";
1551
+ locked?: boolean | undefined;
1168
1552
  author?: string | undefined;
1169
1553
  contents?: string | undefined;
1170
1554
  inReplyTo?: string | undefined;
1555
+ subject?: string | undefined;
1556
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1557
+ custom?: Record<string, unknown> | undefined;
1558
+ } | {
1559
+ rect: {
1560
+ x: number;
1561
+ y: number;
1562
+ width: number;
1563
+ height: number;
1564
+ };
1565
+ color: string;
1566
+ opacity: number;
1567
+ createdAt: string;
1568
+ modifiedAt: string;
1569
+ source: "session" | "pdf";
1570
+ shape: "rect" | "ellipse";
1571
+ dim: number;
1572
+ id: string;
1573
+ page: number;
1574
+ type: "mask";
1171
1575
  locked?: boolean | undefined;
1576
+ author?: string | undefined;
1577
+ contents?: string | undefined;
1578
+ inReplyTo?: string | undefined;
1579
+ subject?: string | undefined;
1580
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1172
1581
  custom?: Record<string, unknown> | undefined;
1582
+ } | {
1583
+ interiorColor: string;
1584
+ rect: {
1585
+ x: number;
1586
+ y: number;
1587
+ width: number;
1588
+ height: number;
1589
+ };
1590
+ color: string;
1591
+ opacity: number;
1592
+ createdAt: string;
1593
+ modifiedAt: string;
1594
+ source: "session" | "pdf";
1595
+ id: string;
1596
+ page: number;
1597
+ type: "redact";
1173
1598
  quads?: {
1174
1599
  p1: {
1175
1600
  x: number;
@@ -1188,29 +1613,16 @@ export declare function useAnnotations(): {
1188
1613
  y: number;
1189
1614
  };
1190
1615
  }[] | undefined;
1191
- suggestion?: {
1192
- confidence: number;
1193
- jobId?: string | undefined;
1194
- reason?: string | undefined;
1195
- explanation?: string | undefined;
1196
- recommendation?: "redact" | "review" | "keep" | undefined;
1197
- } | undefined;
1616
+ locked?: boolean | undefined;
1198
1617
  overlayText?: string | undefined;
1199
- } | undefined;
1200
- update: (id: string, patch: Partial<Annotation>) => {
1201
- id: string;
1202
- page: number;
1203
- rect: {
1204
- x: number;
1205
- y: number;
1206
- width: number;
1207
- height: number;
1208
- };
1209
- color: string;
1210
- opacity: number;
1211
- createdAt: string;
1212
- modifiedAt: string;
1213
- source: "session" | "pdf";
1618
+ author?: string | undefined;
1619
+ contents?: string | undefined;
1620
+ inReplyTo?: string | undefined;
1621
+ subject?: string | undefined;
1622
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1623
+ custom?: Record<string, unknown> | undefined;
1624
+ })[];
1625
+ add: (input: AnnotationInput) => {
1214
1626
  type: "highlight" | "underline" | "strikeout" | "squiggly";
1215
1627
  quads: {
1216
1628
  p1: {
@@ -1230,14 +1642,27 @@ export declare function useAnnotations(): {
1230
1642
  y: number;
1231
1643
  };
1232
1644
  }[];
1645
+ rect: {
1646
+ x: number;
1647
+ y: number;
1648
+ width: number;
1649
+ height: number;
1650
+ };
1651
+ color: string;
1652
+ opacity: number;
1653
+ createdAt: string;
1654
+ modifiedAt: string;
1655
+ source: "session" | "pdf";
1656
+ id: string;
1657
+ page: number;
1658
+ locked?: boolean | undefined;
1233
1659
  author?: string | undefined;
1234
1660
  contents?: string | undefined;
1235
1661
  inReplyTo?: string | undefined;
1236
- locked?: boolean | undefined;
1662
+ subject?: string | undefined;
1663
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1237
1664
  custom?: Record<string, unknown> | undefined;
1238
1665
  } | {
1239
- id: string;
1240
- page: number;
1241
1666
  rect: {
1242
1667
  x: number;
1243
1668
  y: number;
@@ -1249,16 +1674,68 @@ export declare function useAnnotations(): {
1249
1674
  createdAt: string;
1250
1675
  modifiedAt: string;
1251
1676
  source: "session" | "pdf";
1677
+ icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
1678
+ id: string;
1679
+ page: number;
1252
1680
  type: "text";
1253
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
1681
+ locked?: boolean | undefined;
1254
1682
  author?: string | undefined;
1255
1683
  contents?: string | undefined;
1256
1684
  inReplyTo?: string | undefined;
1257
- locked?: boolean | undefined;
1685
+ subject?: string | undefined;
1686
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1258
1687
  custom?: Record<string, unknown> | undefined;
1259
1688
  } | {
1689
+ defaultStyle: {
1690
+ color: string;
1691
+ fontFamily: string;
1692
+ fontSize: number;
1693
+ textAlign: "left" | "right" | "center" | "justify";
1694
+ align?: undefined;
1695
+ fontWeight?: "bold" | undefined;
1696
+ fontStyle?: "italic" | undefined;
1697
+ textDecoration?: "underline" | undefined;
1698
+ };
1699
+ rect: {
1700
+ x: number;
1701
+ y: number;
1702
+ width: number;
1703
+ height: number;
1704
+ };
1705
+ opacity: number;
1706
+ createdAt: string;
1707
+ modifiedAt: string;
1708
+ source: "session" | "pdf";
1709
+ contents: string;
1710
+ width: number;
1260
1711
  id: string;
1261
1712
  page: number;
1713
+ type: "freetext";
1714
+ color?: string | undefined;
1715
+ borderColor?: string | undefined;
1716
+ fringe?: {
1717
+ left: number;
1718
+ top: number;
1719
+ right: number;
1720
+ bottom: number;
1721
+ } | undefined;
1722
+ callout?: {
1723
+ x: number;
1724
+ y: number;
1725
+ }[] | undefined;
1726
+ fontFamily?: undefined;
1727
+ fontSize?: undefined;
1728
+ align?: undefined;
1729
+ locked?: boolean | undefined;
1730
+ dashes?: number[] | undefined;
1731
+ cornerRadius?: number | undefined;
1732
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1733
+ author?: string | undefined;
1734
+ inReplyTo?: string | undefined;
1735
+ subject?: string | undefined;
1736
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1737
+ custom?: Record<string, unknown> | undefined;
1738
+ } | {
1262
1739
  rect: {
1263
1740
  x: number;
1264
1741
  y: number;
@@ -1270,22 +1747,55 @@ export declare function useAnnotations(): {
1270
1747
  createdAt: string;
1271
1748
  modifiedAt: string;
1272
1749
  source: "session" | "pdf";
1273
- type: "freetext";
1274
- contents: string;
1275
- fontSize: number;
1276
- fontFamily: string;
1277
- align: "left" | "center" | "right";
1750
+ width: number;
1751
+ id: string;
1752
+ page: number;
1753
+ type: "square";
1754
+ locked?: boolean | undefined;
1755
+ dashes?: number[] | undefined;
1756
+ interiorColor?: string | undefined;
1757
+ cornerRadius?: number | undefined;
1278
1758
  author?: string | undefined;
1759
+ contents?: string | undefined;
1279
1760
  inReplyTo?: string | undefined;
1280
- locked?: boolean | undefined;
1761
+ subject?: string | undefined;
1762
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1281
1763
  custom?: Record<string, unknown> | undefined;
1282
- callout?: {
1764
+ } | {
1765
+ rect: {
1283
1766
  x: number;
1284
1767
  y: number;
1285
- }[] | undefined;
1286
- } | {
1768
+ width: number;
1769
+ height: number;
1770
+ };
1771
+ color: string;
1772
+ opacity: number;
1773
+ createdAt: string;
1774
+ modifiedAt: string;
1775
+ source: "session" | "pdf";
1776
+ width: number;
1287
1777
  id: string;
1288
1778
  page: number;
1779
+ type: "circle";
1780
+ cornerRadius?: undefined;
1781
+ locked?: boolean | undefined;
1782
+ dashes?: number[] | undefined;
1783
+ interiorColor?: string | undefined;
1784
+ author?: string | undefined;
1785
+ contents?: string | undefined;
1786
+ inReplyTo?: string | undefined;
1787
+ subject?: string | undefined;
1788
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1789
+ custom?: Record<string, unknown> | undefined;
1790
+ } | {
1791
+ start: {
1792
+ x: number;
1793
+ y: number;
1794
+ };
1795
+ end: {
1796
+ x: number;
1797
+ y: number;
1798
+ };
1289
1799
  rect: {
1290
1800
  x: number;
1291
1801
  y: number;
@@ -1297,17 +1807,56 @@ export declare function useAnnotations(): {
1297
1807
  createdAt: string;
1298
1808
  modifiedAt: string;
1299
1809
  source: "session" | "pdf";
1300
- type: "square" | "circle";
1301
1810
  width: number;
1811
+ id: string;
1812
+ page: number;
1813
+ type: "line";
1814
+ locked?: boolean | undefined;
1815
+ dashes?: number[] | undefined;
1816
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1817
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1302
1818
  author?: string | undefined;
1303
1819
  contents?: string | undefined;
1304
1820
  inReplyTo?: string | undefined;
1305
- locked?: boolean | undefined;
1821
+ subject?: string | undefined;
1822
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1306
1823
  custom?: Record<string, unknown> | undefined;
1307
- interiorColor?: string | undefined;
1308
1824
  } | {
1825
+ vertices: {
1826
+ x: number;
1827
+ y: number;
1828
+ }[];
1829
+ rect: {
1830
+ x: number;
1831
+ y: number;
1832
+ width: number;
1833
+ height: number;
1834
+ };
1835
+ color: string;
1836
+ opacity: number;
1837
+ createdAt: string;
1838
+ modifiedAt: string;
1839
+ source: "session" | "pdf";
1840
+ width: number;
1309
1841
  id: string;
1310
1842
  page: number;
1843
+ type: "polyline";
1844
+ locked?: boolean | undefined;
1845
+ dashes?: number[] | undefined;
1846
+ interiorColor?: string | undefined;
1847
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1848
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1849
+ author?: string | undefined;
1850
+ contents?: string | undefined;
1851
+ inReplyTo?: string | undefined;
1852
+ subject?: string | undefined;
1853
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1854
+ custom?: Record<string, unknown> | undefined;
1855
+ } | {
1856
+ vertices: {
1857
+ x: number;
1858
+ y: number;
1859
+ }[];
1311
1860
  rect: {
1312
1861
  x: number;
1313
1862
  y: number;
@@ -1319,26 +1868,75 @@ export declare function useAnnotations(): {
1319
1868
  createdAt: string;
1320
1869
  modifiedAt: string;
1321
1870
  source: "session" | "pdf";
1322
- type: "line";
1323
- start: {
1871
+ width: number;
1872
+ id: string;
1873
+ page: number;
1874
+ type: "polygon";
1875
+ head?: undefined;
1876
+ tail?: undefined;
1877
+ locked?: boolean | undefined;
1878
+ dashes?: number[] | undefined;
1879
+ interiorColor?: string | undefined;
1880
+ author?: string | undefined;
1881
+ contents?: string | undefined;
1882
+ inReplyTo?: string | undefined;
1883
+ subject?: string | undefined;
1884
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1885
+ custom?: Record<string, unknown> | undefined;
1886
+ } | {
1887
+ inklist: {
1324
1888
  x: number;
1325
1889
  y: number;
1890
+ }[][];
1891
+ rect: {
1892
+ x: number;
1893
+ y: number;
1894
+ width: number;
1895
+ height: number;
1326
1896
  };
1327
- end: {
1897
+ color: string;
1898
+ opacity: number;
1899
+ createdAt: string;
1900
+ modifiedAt: string;
1901
+ source: "session" | "pdf";
1902
+ width: number;
1903
+ id: string;
1904
+ page: number;
1905
+ type: "ink";
1906
+ pressure?: number[][] | undefined;
1907
+ locked?: boolean | undefined;
1908
+ dashes?: number[] | undefined;
1909
+ author?: string | undefined;
1910
+ contents?: string | undefined;
1911
+ inReplyTo?: string | undefined;
1912
+ subject?: string | undefined;
1913
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1914
+ custom?: Record<string, unknown> | undefined;
1915
+ } | {
1916
+ rect: {
1328
1917
  x: number;
1329
1918
  y: number;
1919
+ width: number;
1920
+ height: number;
1330
1921
  };
1331
- width: number;
1922
+ color: string;
1923
+ opacity: number;
1924
+ createdAt: string;
1925
+ modifiedAt: string;
1926
+ source: "session" | "pdf";
1927
+ imagedata: string;
1928
+ id: string;
1929
+ page: number;
1930
+ type: "stamp";
1931
+ locked?: boolean | undefined;
1932
+ rotation?: 0 | 90 | 180 | 270 | undefined;
1332
1933
  author?: string | undefined;
1333
1934
  contents?: string | undefined;
1334
1935
  inReplyTo?: string | undefined;
1335
- locked?: boolean | undefined;
1936
+ subject?: string | undefined;
1937
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1336
1938
  custom?: Record<string, unknown> | undefined;
1337
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
1338
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
1339
1939
  } | {
1340
- id: string;
1341
- page: number;
1342
1940
  rect: {
1343
1941
  x: number;
1344
1942
  y: number;
@@ -1350,21 +1948,19 @@ export declare function useAnnotations(): {
1350
1948
  createdAt: string;
1351
1949
  modifiedAt: string;
1352
1950
  source: "session" | "pdf";
1353
- type: "polyline" | "polygon";
1354
- vertices: {
1355
- x: number;
1356
- y: number;
1357
- }[];
1951
+ magnification: number;
1358
1952
  width: number;
1953
+ id: string;
1954
+ page: number;
1955
+ type: "loupe";
1956
+ locked?: boolean | undefined;
1359
1957
  author?: string | undefined;
1360
1958
  contents?: string | undefined;
1361
1959
  inReplyTo?: string | undefined;
1362
- locked?: boolean | undefined;
1960
+ subject?: string | undefined;
1961
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1363
1962
  custom?: Record<string, unknown> | undefined;
1364
- interiorColor?: string | undefined;
1365
1963
  } | {
1366
- id: string;
1367
- page: number;
1368
1964
  rect: {
1369
1965
  x: number;
1370
1966
  y: number;
@@ -1376,20 +1972,20 @@ export declare function useAnnotations(): {
1376
1972
  createdAt: string;
1377
1973
  modifiedAt: string;
1378
1974
  source: "session" | "pdf";
1379
- type: "ink";
1380
- inklist: {
1381
- x: number;
1382
- y: number;
1383
- }[][];
1384
- width: number;
1975
+ shape: "rect" | "ellipse";
1976
+ dim: number;
1977
+ id: string;
1978
+ page: number;
1979
+ type: "mask";
1980
+ locked?: boolean | undefined;
1385
1981
  author?: string | undefined;
1386
1982
  contents?: string | undefined;
1387
1983
  inReplyTo?: string | undefined;
1388
- locked?: boolean | undefined;
1984
+ subject?: string | undefined;
1985
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1389
1986
  custom?: Record<string, unknown> | undefined;
1390
1987
  } | {
1391
- id: string;
1392
- page: number;
1988
+ interiorColor: string;
1393
1989
  rect: {
1394
1990
  x: number;
1395
1991
  y: number;
@@ -1401,14 +1997,9 @@ export declare function useAnnotations(): {
1401
1997
  createdAt: string;
1402
1998
  modifiedAt: string;
1403
1999
  source: "session" | "pdf";
2000
+ id: string;
2001
+ page: number;
1404
2002
  type: "redact";
1405
- origin: "user" | "suggested";
1406
- interiorColor: string;
1407
- author?: string | undefined;
1408
- contents?: string | undefined;
1409
- inReplyTo?: string | undefined;
1410
- locked?: boolean | undefined;
1411
- custom?: Record<string, unknown> | undefined;
1412
2003
  quads?: {
1413
2004
  p1: {
1414
2005
  x: number;
@@ -1427,32 +2018,16 @@ export declare function useAnnotations(): {
1427
2018
  y: number;
1428
2019
  };
1429
2020
  }[] | undefined;
1430
- suggestion?: {
1431
- confidence: number;
1432
- jobId?: string | undefined;
1433
- reason?: string | undefined;
1434
- explanation?: string | undefined;
1435
- recommendation?: "redact" | "review" | "keep" | undefined;
1436
- } | undefined;
2021
+ locked?: boolean | undefined;
1437
2022
  overlayText?: string | undefined;
2023
+ author?: string | undefined;
2024
+ contents?: string | undefined;
2025
+ inReplyTo?: string | undefined;
2026
+ subject?: string | undefined;
2027
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2028
+ custom?: Record<string, unknown> | undefined;
1438
2029
  } | undefined;
1439
- remove: (id: string) => boolean;
1440
- select: (ids: string[]) => void | undefined;
1441
- /** Keeps a suggested redaction as the user's own, in the default redaction colour. */
1442
- accept: (id: string) => {
1443
- id: string;
1444
- page: number;
1445
- rect: {
1446
- x: number;
1447
- y: number;
1448
- width: number;
1449
- height: number;
1450
- };
1451
- color: string;
1452
- opacity: number;
1453
- createdAt: string;
1454
- modifiedAt: string;
1455
- source: "session" | "pdf";
2030
+ update: (id: string, patch: AnnotationPatch) => {
1456
2031
  type: "highlight" | "underline" | "strikeout" | "squiggly";
1457
2032
  quads: {
1458
2033
  p1: {
@@ -1472,14 +2047,27 @@ export declare function useAnnotations(): {
1472
2047
  y: number;
1473
2048
  };
1474
2049
  }[];
2050
+ rect: {
2051
+ x: number;
2052
+ y: number;
2053
+ width: number;
2054
+ height: number;
2055
+ };
2056
+ color: string;
2057
+ opacity: number;
2058
+ createdAt: string;
2059
+ modifiedAt: string;
2060
+ source: "session" | "pdf";
2061
+ id: string;
2062
+ page: number;
2063
+ locked?: boolean | undefined;
1475
2064
  author?: string | undefined;
1476
2065
  contents?: string | undefined;
1477
2066
  inReplyTo?: string | undefined;
1478
- locked?: boolean | undefined;
2067
+ subject?: string | undefined;
2068
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1479
2069
  custom?: Record<string, unknown> | undefined;
1480
2070
  } | {
1481
- id: string;
1482
- page: number;
1483
2071
  rect: {
1484
2072
  x: number;
1485
2073
  y: number;
@@ -1491,43 +2079,68 @@ export declare function useAnnotations(): {
1491
2079
  createdAt: string;
1492
2080
  modifiedAt: string;
1493
2081
  source: "session" | "pdf";
2082
+ icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
2083
+ id: string;
2084
+ page: number;
1494
2085
  type: "text";
1495
- icon: "comment" | "note" | "help" | "insert" | "key" | "paragraph";
2086
+ locked?: boolean | undefined;
1496
2087
  author?: string | undefined;
1497
2088
  contents?: string | undefined;
1498
2089
  inReplyTo?: string | undefined;
1499
- locked?: boolean | undefined;
2090
+ subject?: string | undefined;
2091
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1500
2092
  custom?: Record<string, unknown> | undefined;
1501
2093
  } | {
1502
- id: string;
1503
- page: number;
2094
+ defaultStyle: {
2095
+ color: string;
2096
+ fontFamily: string;
2097
+ fontSize: number;
2098
+ textAlign: "left" | "right" | "center" | "justify";
2099
+ align?: undefined;
2100
+ fontWeight?: "bold" | undefined;
2101
+ fontStyle?: "italic" | undefined;
2102
+ textDecoration?: "underline" | undefined;
2103
+ };
1504
2104
  rect: {
1505
2105
  x: number;
1506
2106
  y: number;
1507
2107
  width: number;
1508
2108
  height: number;
1509
2109
  };
1510
- color: string;
1511
2110
  opacity: number;
1512
2111
  createdAt: string;
1513
2112
  modifiedAt: string;
1514
2113
  source: "session" | "pdf";
1515
- type: "freetext";
1516
2114
  contents: string;
1517
- fontSize: number;
1518
- fontFamily: string;
1519
- align: "left" | "center" | "right";
1520
- author?: string | undefined;
1521
- inReplyTo?: string | undefined;
1522
- locked?: boolean | undefined;
1523
- custom?: Record<string, unknown> | undefined;
2115
+ width: number;
2116
+ id: string;
2117
+ page: number;
2118
+ type: "freetext";
2119
+ color?: string | undefined;
2120
+ borderColor?: string | undefined;
2121
+ fringe?: {
2122
+ left: number;
2123
+ top: number;
2124
+ right: number;
2125
+ bottom: number;
2126
+ } | undefined;
1524
2127
  callout?: {
1525
2128
  x: number;
1526
2129
  y: number;
1527
2130
  }[] | undefined;
2131
+ fontFamily?: undefined;
2132
+ fontSize?: undefined;
2133
+ align?: undefined;
2134
+ locked?: boolean | undefined;
2135
+ dashes?: number[] | undefined;
2136
+ cornerRadius?: number | undefined;
2137
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2138
+ author?: string | undefined;
2139
+ inReplyTo?: string | undefined;
2140
+ subject?: string | undefined;
2141
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2142
+ custom?: Record<string, unknown> | undefined;
1528
2143
  } | {
1529
- id: string;
1530
- page: number;
1531
2144
  rect: {
1532
2145
  x: number;
1533
2146
  y: number;
@@ -1539,17 +2152,21 @@ export declare function useAnnotations(): {
1539
2152
  createdAt: string;
1540
2153
  modifiedAt: string;
1541
2154
  source: "session" | "pdf";
1542
- type: "square" | "circle";
1543
2155
  width: number;
2156
+ id: string;
2157
+ page: number;
2158
+ type: "square";
2159
+ locked?: boolean | undefined;
2160
+ dashes?: number[] | undefined;
2161
+ interiorColor?: string | undefined;
2162
+ cornerRadius?: number | undefined;
1544
2163
  author?: string | undefined;
1545
2164
  contents?: string | undefined;
1546
2165
  inReplyTo?: string | undefined;
1547
- locked?: boolean | undefined;
2166
+ subject?: string | undefined;
2167
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1548
2168
  custom?: Record<string, unknown> | undefined;
1549
- interiorColor?: string | undefined;
1550
2169
  } | {
1551
- id: string;
1552
- page: number;
1553
2170
  rect: {
1554
2171
  x: number;
1555
2172
  y: number;
@@ -1561,7 +2178,21 @@ export declare function useAnnotations(): {
1561
2178
  createdAt: string;
1562
2179
  modifiedAt: string;
1563
2180
  source: "session" | "pdf";
1564
- type: "line";
2181
+ width: number;
2182
+ id: string;
2183
+ page: number;
2184
+ type: "circle";
2185
+ cornerRadius?: undefined;
2186
+ locked?: boolean | undefined;
2187
+ dashes?: number[] | undefined;
2188
+ interiorColor?: string | undefined;
2189
+ author?: string | undefined;
2190
+ contents?: string | undefined;
2191
+ inReplyTo?: string | undefined;
2192
+ subject?: string | undefined;
2193
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2194
+ custom?: Record<string, unknown> | undefined;
2195
+ } | {
1565
2196
  start: {
1566
2197
  x: number;
1567
2198
  y: number;
@@ -1570,17 +2201,36 @@ export declare function useAnnotations(): {
1570
2201
  x: number;
1571
2202
  y: number;
1572
2203
  };
2204
+ rect: {
2205
+ x: number;
2206
+ y: number;
2207
+ width: number;
2208
+ height: number;
2209
+ };
2210
+ color: string;
2211
+ opacity: number;
2212
+ createdAt: string;
2213
+ modifiedAt: string;
2214
+ source: "session" | "pdf";
1573
2215
  width: number;
2216
+ id: string;
2217
+ page: number;
2218
+ type: "line";
2219
+ locked?: boolean | undefined;
2220
+ dashes?: number[] | undefined;
2221
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2222
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1574
2223
  author?: string | undefined;
1575
2224
  contents?: string | undefined;
1576
2225
  inReplyTo?: string | undefined;
1577
- locked?: boolean | undefined;
2226
+ subject?: string | undefined;
2227
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1578
2228
  custom?: Record<string, unknown> | undefined;
1579
- head?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
1580
- tail?: "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash" | undefined;
1581
2229
  } | {
1582
- id: string;
1583
- page: number;
2230
+ vertices: {
2231
+ x: number;
2232
+ y: number;
2233
+ }[];
1584
2234
  rect: {
1585
2235
  x: number;
1586
2236
  y: number;
@@ -1592,21 +2242,57 @@ export declare function useAnnotations(): {
1592
2242
  createdAt: string;
1593
2243
  modifiedAt: string;
1594
2244
  source: "session" | "pdf";
1595
- type: "polyline" | "polygon";
2245
+ width: number;
2246
+ id: string;
2247
+ page: number;
2248
+ type: "polyline";
2249
+ locked?: boolean | undefined;
2250
+ dashes?: number[] | undefined;
2251
+ interiorColor?: string | undefined;
2252
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2253
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2254
+ author?: string | undefined;
2255
+ contents?: string | undefined;
2256
+ inReplyTo?: string | undefined;
2257
+ subject?: string | undefined;
2258
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2259
+ custom?: Record<string, unknown> | undefined;
2260
+ } | {
1596
2261
  vertices: {
1597
2262
  x: number;
1598
2263
  y: number;
1599
2264
  }[];
2265
+ rect: {
2266
+ x: number;
2267
+ y: number;
2268
+ width: number;
2269
+ height: number;
2270
+ };
2271
+ color: string;
2272
+ opacity: number;
2273
+ createdAt: string;
2274
+ modifiedAt: string;
2275
+ source: "session" | "pdf";
1600
2276
  width: number;
2277
+ id: string;
2278
+ page: number;
2279
+ type: "polygon";
2280
+ head?: undefined;
2281
+ tail?: undefined;
2282
+ locked?: boolean | undefined;
2283
+ dashes?: number[] | undefined;
2284
+ interiorColor?: string | undefined;
1601
2285
  author?: string | undefined;
1602
2286
  contents?: string | undefined;
1603
2287
  inReplyTo?: string | undefined;
1604
- locked?: boolean | undefined;
2288
+ subject?: string | undefined;
2289
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1605
2290
  custom?: Record<string, unknown> | undefined;
1606
- interiorColor?: string | undefined;
1607
2291
  } | {
1608
- id: string;
1609
- page: number;
2292
+ inklist: {
2293
+ x: number;
2294
+ y: number;
2295
+ }[][];
1610
2296
  rect: {
1611
2297
  x: number;
1612
2298
  y: number;
@@ -1618,20 +2304,68 @@ export declare function useAnnotations(): {
1618
2304
  createdAt: string;
1619
2305
  modifiedAt: string;
1620
2306
  source: "session" | "pdf";
2307
+ width: number;
2308
+ id: string;
2309
+ page: number;
1621
2310
  type: "ink";
1622
- inklist: {
2311
+ pressure?: number[][] | undefined;
2312
+ locked?: boolean | undefined;
2313
+ dashes?: number[] | undefined;
2314
+ author?: string | undefined;
2315
+ contents?: string | undefined;
2316
+ inReplyTo?: string | undefined;
2317
+ subject?: string | undefined;
2318
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2319
+ custom?: Record<string, unknown> | undefined;
2320
+ } | {
2321
+ rect: {
1623
2322
  x: number;
1624
2323
  y: number;
1625
- }[][];
1626
- width: number;
2324
+ width: number;
2325
+ height: number;
2326
+ };
2327
+ color: string;
2328
+ opacity: number;
2329
+ createdAt: string;
2330
+ modifiedAt: string;
2331
+ source: "session" | "pdf";
2332
+ imagedata: string;
2333
+ id: string;
2334
+ page: number;
2335
+ type: "stamp";
2336
+ locked?: boolean | undefined;
2337
+ rotation?: 0 | 90 | 180 | 270 | undefined;
1627
2338
  author?: string | undefined;
1628
2339
  contents?: string | undefined;
1629
2340
  inReplyTo?: string | undefined;
1630
- locked?: boolean | undefined;
2341
+ subject?: string | undefined;
2342
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1631
2343
  custom?: Record<string, unknown> | undefined;
1632
2344
  } | {
2345
+ rect: {
2346
+ x: number;
2347
+ y: number;
2348
+ width: number;
2349
+ height: number;
2350
+ };
2351
+ color: string;
2352
+ opacity: number;
2353
+ createdAt: string;
2354
+ modifiedAt: string;
2355
+ source: "session" | "pdf";
2356
+ magnification: number;
2357
+ width: number;
1633
2358
  id: string;
1634
2359
  page: number;
2360
+ type: "loupe";
2361
+ locked?: boolean | undefined;
2362
+ author?: string | undefined;
2363
+ contents?: string | undefined;
2364
+ inReplyTo?: string | undefined;
2365
+ subject?: string | undefined;
2366
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2367
+ custom?: Record<string, unknown> | undefined;
2368
+ } | {
1635
2369
  rect: {
1636
2370
  x: number;
1637
2371
  y: number;
@@ -1643,14 +2377,34 @@ export declare function useAnnotations(): {
1643
2377
  createdAt: string;
1644
2378
  modifiedAt: string;
1645
2379
  source: "session" | "pdf";
1646
- type: "redact";
1647
- origin: "user" | "suggested";
1648
- interiorColor: string;
2380
+ shape: "rect" | "ellipse";
2381
+ dim: number;
2382
+ id: string;
2383
+ page: number;
2384
+ type: "mask";
2385
+ locked?: boolean | undefined;
1649
2386
  author?: string | undefined;
1650
2387
  contents?: string | undefined;
1651
2388
  inReplyTo?: string | undefined;
1652
- locked?: boolean | undefined;
2389
+ subject?: string | undefined;
2390
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1653
2391
  custom?: Record<string, unknown> | undefined;
2392
+ } | {
2393
+ interiorColor: string;
2394
+ rect: {
2395
+ x: number;
2396
+ y: number;
2397
+ width: number;
2398
+ height: number;
2399
+ };
2400
+ color: string;
2401
+ opacity: number;
2402
+ createdAt: string;
2403
+ modifiedAt: string;
2404
+ source: "session" | "pdf";
2405
+ id: string;
2406
+ page: number;
2407
+ type: "redact";
1654
2408
  quads?: {
1655
2409
  p1: {
1656
2410
  x: number;
@@ -1669,15 +2423,16 @@ export declare function useAnnotations(): {
1669
2423
  y: number;
1670
2424
  };
1671
2425
  }[] | undefined;
1672
- suggestion?: {
1673
- confidence: number;
1674
- jobId?: string | undefined;
1675
- reason?: string | undefined;
1676
- explanation?: string | undefined;
1677
- recommendation?: "redact" | "review" | "keep" | undefined;
1678
- } | undefined;
2426
+ locked?: boolean | undefined;
1679
2427
  overlayText?: string | undefined;
2428
+ author?: string | undefined;
2429
+ contents?: string | undefined;
2430
+ inReplyTo?: string | undefined;
2431
+ subject?: string | undefined;
2432
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2433
+ custom?: Record<string, unknown> | undefined;
1680
2434
  } | undefined;
1681
- dismiss: (id: string) => boolean;
2435
+ remove: (id: string) => boolean;
2436
+ select: (ids: string[]) => void | undefined;
1682
2437
  };
1683
2438
  //# sourceMappingURL=useAnnotations.svelte.d.ts.map