@inkbar/react 0.4.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.
package/dist/index.d.mts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { ComponentPropsWithoutRef, ReactNode, Ref } from "react";
2
- import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, ConfidenceBucket, CurrentStyle, DocumentSource, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, Readable, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps } from "@inkbar/core";
3
- import { AnnotationSlotProps, AnnotationSlotProps as AnnotationSlotProps$1, AnnotationState, ColorProperty, LayoutMode, PageMount, SuggestionCardSlotProps, SuggestionCardSlotProps as SuggestionCardSlotProps$1, ThreadPopoverSlotProps, ThreadPopoverSlotProps as ThreadPopoverSlotProps$1, Tool, ToolController, ToolId, ToolOptions, ToolStyle, ViewRotation, Viewport, ZoomValue } from "@inkbar/core/dom";
2
+ import { Annotation, AnnotationChange, AnnotationDefaults, AnnotationDocument, AnnotationInput, AnnotationPatch, CurrentStyle, DocumentSource, ImportOptions, InkDocument, InkError, InkStatus, PageInfo, PdfAssets, Readable, SignatureLibrary, SignatureStore, SignatureTemplate, StyleGroup, StyleKey, StyleProps } from "@inkbar/core";
3
+ import { AnnotationDecoration, AnnotationSlotProps, AnnotationSlotProps as AnnotationSlotProps$1, AnnotationState, ColorProperty, DecorateAnnotation, DecorateAnnotation as DecorateAnnotation$1, LayoutMode, PageMount, ThreadPopoverSlotProps, ThreadPopoverSlotProps as ThreadPopoverSlotProps$1, Tool, ToolController, ToolId, ToolOptions, ToolStyle, ViewRotation, Viewport, ZoomValue } from "@inkbar/core/dom";
4
4
  import { Select } from "radix-ui";
5
5
  import { IconNode } from "@inkbar/icons";
6
6
  //#region src/context.d.ts
@@ -34,6 +34,16 @@ interface InkContext {
34
34
  setTool: (id: ToolId) => void;
35
35
  /** Host tools from InkRoot's `tools` prop; InkViewport registers them. */
36
36
  hostTools: Tool[] | undefined;
37
+ /**
38
+ * Calls InkRoot's current `decorateAnnotation` prop. The function itself stays the same
39
+ * across renders, so a new prop does not re-render the context's consumers.
40
+ */
41
+ decorateAnnotation: DecorateAnnotation$1;
42
+ /**
43
+ * Calls `listener` after InkRoot's `decorateAnnotation` prop changes; InkViewport re-applies
44
+ * the decorations then. Returns the unsubscribe.
45
+ */
46
+ onDecorateAnnotationChange: (listener: () => void) => () => void;
37
47
  /** The font families text boxes offer: InkRoot's `fonts`, else `FONT_FAMILIES`. */
38
48
  fonts: readonly string[];
39
49
  /** The tools' options for InkRoot's life, so they persist across documents. */
@@ -51,6 +61,11 @@ interface InkContext {
51
61
  reportPage: (p: number) => void;
52
62
  /** Last activated annotation (Enter, click with the note tool, etc.). Popovers key off this. */
53
63
  activated: string | null;
64
+ /**
65
+ * Activates annotation `id`, or clears the activation with `null`. This is the context's
66
+ * own: unlike core's `Viewer.setActivated`, it calls InkRoot's `onActivate` for an id, and
67
+ * it does not check that the id is in the document.
68
+ */
54
69
  setActivated: (id: string | null) => void;
55
70
  history: InkHistory;
56
71
  rootEl: HTMLElement | null;
@@ -85,19 +100,6 @@ export declare function useDocument(): {
85
100
  //#region src/hooks/useAnnotations.d.ts
86
101
  export declare function useAnnotations(): {
87
102
  add: (input: AnnotationInput) => {
88
- id: string;
89
- page: number;
90
- rect: {
91
- x: number;
92
- y: number;
93
- width: number;
94
- height: number;
95
- };
96
- color: string;
97
- opacity: number;
98
- createdAt: string;
99
- modifiedAt: string;
100
- source: "session" | "pdf";
101
103
  type: "highlight" | "underline" | "strikeout" | "squiggly";
102
104
  quads: {
103
105
  p1: {
@@ -117,16 +119,27 @@ export declare function useAnnotations(): {
117
119
  y: number;
118
120
  };
119
121
  }[];
122
+ rect: {
123
+ x: number;
124
+ y: number;
125
+ width: number;
126
+ height: number;
127
+ };
128
+ color: string;
129
+ opacity: number;
130
+ createdAt: string;
131
+ modifiedAt: string;
132
+ source: "session" | "pdf";
133
+ id: string;
134
+ page: number;
135
+ locked?: boolean | undefined;
120
136
  author?: string | undefined;
121
137
  contents?: string | undefined;
122
138
  inReplyTo?: string | undefined;
123
- locked?: boolean | undefined;
124
139
  subject?: string | undefined;
125
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
140
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
126
141
  custom?: Record<string, unknown> | undefined;
127
142
  } | {
128
- id: string;
129
- page: number;
130
143
  rect: {
131
144
  x: number;
132
145
  y: number;
@@ -138,18 +151,28 @@ export declare function useAnnotations(): {
138
151
  createdAt: string;
139
152
  modifiedAt: string;
140
153
  source: "session" | "pdf";
141
- type: "text";
142
154
  icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
155
+ id: string;
156
+ page: number;
157
+ type: "text";
158
+ locked?: boolean | undefined;
143
159
  author?: string | undefined;
144
160
  contents?: string | undefined;
145
161
  inReplyTo?: string | undefined;
146
- locked?: boolean | undefined;
147
162
  subject?: string | undefined;
148
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
163
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
149
164
  custom?: Record<string, unknown> | undefined;
150
165
  } | {
151
- id: string;
152
- page: number;
166
+ defaultStyle: {
167
+ color: string;
168
+ fontFamily: string;
169
+ fontSize: number;
170
+ textAlign: "left" | "right" | "center" | "justify";
171
+ align?: undefined;
172
+ fontWeight?: "bold" | undefined;
173
+ fontStyle?: "italic" | undefined;
174
+ textDecoration?: "underline" | undefined;
175
+ };
153
176
  rect: {
154
177
  x: number;
155
178
  y: number;
@@ -160,29 +183,13 @@ export declare function useAnnotations(): {
160
183
  createdAt: string;
161
184
  modifiedAt: string;
162
185
  source: "session" | "pdf";
163
- type: "freetext";
164
186
  contents: string;
165
187
  width: number;
166
- defaultStyle: {
167
- fontFamily: string;
168
- fontSize: number;
169
- color: string;
170
- textAlign: "left" | "right" | "center" | "justify";
171
- fontWeight?: "bold" | undefined;
172
- fontStyle?: "italic" | undefined;
173
- textDecoration?: "underline" | undefined;
174
- align?: undefined;
175
- };
176
- author?: string | undefined;
177
- inReplyTo?: string | undefined;
178
- locked?: boolean | undefined;
179
- subject?: string | undefined;
180
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
181
- custom?: Record<string, unknown> | undefined;
188
+ id: string;
189
+ page: number;
190
+ type: "freetext";
182
191
  color?: string | undefined;
183
192
  borderColor?: string | undefined;
184
- dashes?: number[] | undefined;
185
- cornerRadius?: number | undefined;
186
193
  fringe?: {
187
194
  left: number;
188
195
  top: number;
@@ -193,13 +200,19 @@ export declare function useAnnotations(): {
193
200
  x: number;
194
201
  y: number;
195
202
  }[] | undefined;
196
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
197
203
  fontFamily?: undefined;
198
204
  fontSize?: undefined;
199
205
  align?: undefined;
206
+ locked?: boolean | undefined;
207
+ dashes?: number[] | undefined;
208
+ cornerRadius?: number | undefined;
209
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
210
+ author?: string | undefined;
211
+ inReplyTo?: string | undefined;
212
+ subject?: string | undefined;
213
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
214
+ custom?: Record<string, unknown> | undefined;
200
215
  } | {
201
- id: string;
202
- page: number;
203
216
  rect: {
204
217
  x: number;
205
218
  y: number;
@@ -212,20 +225,20 @@ export declare function useAnnotations(): {
212
225
  modifiedAt: string;
213
226
  source: "session" | "pdf";
214
227
  width: number;
228
+ id: string;
229
+ page: number;
215
230
  type: "square";
231
+ locked?: boolean | undefined;
232
+ dashes?: number[] | undefined;
233
+ interiorColor?: string | undefined;
234
+ cornerRadius?: number | undefined;
216
235
  author?: string | undefined;
217
236
  contents?: string | undefined;
218
237
  inReplyTo?: string | undefined;
219
- locked?: boolean | undefined;
220
238
  subject?: string | undefined;
221
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
239
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
222
240
  custom?: Record<string, unknown> | undefined;
223
- cornerRadius?: number | undefined;
224
- dashes?: number[] | undefined;
225
- interiorColor?: string | undefined;
226
241
  } | {
227
- id: string;
228
- page: number;
229
242
  rect: {
230
243
  x: number;
231
244
  y: number;
@@ -238,20 +251,28 @@ export declare function useAnnotations(): {
238
251
  modifiedAt: string;
239
252
  source: "session" | "pdf";
240
253
  width: number;
254
+ id: string;
255
+ page: number;
241
256
  type: "circle";
257
+ cornerRadius?: undefined;
258
+ locked?: boolean | undefined;
259
+ dashes?: number[] | undefined;
260
+ interiorColor?: string | undefined;
242
261
  author?: string | undefined;
243
262
  contents?: string | undefined;
244
263
  inReplyTo?: string | undefined;
245
- locked?: boolean | undefined;
246
264
  subject?: string | undefined;
247
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
265
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
248
266
  custom?: Record<string, unknown> | undefined;
249
- cornerRadius?: undefined;
250
- dashes?: number[] | undefined;
251
- interiorColor?: string | undefined;
252
267
  } | {
253
- id: string;
254
- page: number;
268
+ start: {
269
+ x: number;
270
+ y: number;
271
+ };
272
+ end: {
273
+ x: number;
274
+ y: number;
275
+ };
255
276
  rect: {
256
277
  x: number;
257
278
  y: number;
@@ -263,29 +284,25 @@ export declare function useAnnotations(): {
263
284
  createdAt: string;
264
285
  modifiedAt: string;
265
286
  source: "session" | "pdf";
266
- type: "line";
267
- start: {
268
- x: number;
269
- y: number;
270
- };
271
- end: {
272
- x: number;
273
- y: number;
274
- };
275
287
  width: number;
288
+ id: string;
289
+ page: number;
290
+ type: "line";
291
+ locked?: boolean | undefined;
292
+ dashes?: number[] | undefined;
293
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
294
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
276
295
  author?: string | undefined;
277
296
  contents?: string | undefined;
278
297
  inReplyTo?: string | undefined;
279
- locked?: boolean | undefined;
280
298
  subject?: string | undefined;
281
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
299
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
282
300
  custom?: Record<string, unknown> | undefined;
283
- dashes?: number[] | undefined;
284
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
285
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
286
301
  } | {
287
- id: string;
288
- page: number;
302
+ vertices: {
303
+ x: number;
304
+ y: number;
305
+ }[];
289
306
  rect: {
290
307
  x: number;
291
308
  y: number;
@@ -297,26 +314,26 @@ export declare function useAnnotations(): {
297
314
  createdAt: string;
298
315
  modifiedAt: string;
299
316
  source: "session" | "pdf";
300
- vertices: {
301
- x: number;
302
- y: number;
303
- }[];
304
317
  width: number;
318
+ id: string;
319
+ page: number;
305
320
  type: "polyline";
321
+ locked?: boolean | undefined;
322
+ dashes?: number[] | undefined;
323
+ interiorColor?: string | undefined;
324
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
325
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
306
326
  author?: string | undefined;
307
327
  contents?: string | undefined;
308
328
  inReplyTo?: string | undefined;
309
- locked?: boolean | undefined;
310
329
  subject?: string | undefined;
311
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
330
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
312
331
  custom?: Record<string, unknown> | undefined;
313
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
314
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
315
- dashes?: number[] | undefined;
316
- interiorColor?: string | undefined;
317
332
  } | {
318
- id: string;
319
- page: number;
333
+ vertices: {
334
+ x: number;
335
+ y: number;
336
+ }[];
320
337
  rect: {
321
338
  x: number;
322
339
  y: number;
@@ -328,26 +345,26 @@ export declare function useAnnotations(): {
328
345
  createdAt: string;
329
346
  modifiedAt: string;
330
347
  source: "session" | "pdf";
331
- vertices: {
332
- x: number;
333
- y: number;
334
- }[];
335
348
  width: number;
349
+ id: string;
350
+ page: number;
336
351
  type: "polygon";
352
+ head?: undefined;
353
+ tail?: undefined;
354
+ locked?: boolean | undefined;
355
+ dashes?: number[] | undefined;
356
+ interiorColor?: string | undefined;
337
357
  author?: string | undefined;
338
358
  contents?: string | undefined;
339
359
  inReplyTo?: string | undefined;
340
- locked?: boolean | undefined;
341
360
  subject?: string | undefined;
342
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
361
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
343
362
  custom?: Record<string, unknown> | undefined;
344
- head?: undefined;
345
- tail?: undefined;
346
- dashes?: number[] | undefined;
347
- interiorColor?: string | undefined;
348
363
  } | {
349
- id: string;
350
- page: number;
364
+ inklist: {
365
+ x: number;
366
+ y: number;
367
+ }[][];
351
368
  rect: {
352
369
  x: number;
353
370
  y: number;
@@ -359,24 +376,20 @@ export declare function useAnnotations(): {
359
376
  createdAt: string;
360
377
  modifiedAt: string;
361
378
  source: "session" | "pdf";
362
- type: "ink";
363
- inklist: {
364
- x: number;
365
- y: number;
366
- }[][];
367
379
  width: number;
380
+ id: string;
381
+ page: number;
382
+ type: "ink";
383
+ pressure?: number[][] | undefined;
384
+ locked?: boolean | undefined;
385
+ dashes?: number[] | undefined;
368
386
  author?: string | undefined;
369
387
  contents?: string | undefined;
370
388
  inReplyTo?: string | undefined;
371
- locked?: boolean | undefined;
372
389
  subject?: string | undefined;
373
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
390
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
374
391
  custom?: Record<string, unknown> | undefined;
375
- pressure?: number[][] | undefined;
376
- dashes?: number[] | undefined;
377
392
  } | {
378
- id: string;
379
- page: number;
380
393
  rect: {
381
394
  x: number;
382
395
  y: number;
@@ -388,19 +401,19 @@ export declare function useAnnotations(): {
388
401
  createdAt: string;
389
402
  modifiedAt: string;
390
403
  source: "session" | "pdf";
391
- type: "stamp";
392
404
  imagedata: string;
405
+ id: string;
406
+ page: number;
407
+ type: "stamp";
408
+ locked?: boolean | undefined;
409
+ rotation?: 0 | 90 | 180 | 270 | undefined;
393
410
  author?: string | undefined;
394
411
  contents?: string | undefined;
395
412
  inReplyTo?: string | undefined;
396
- locked?: boolean | undefined;
397
413
  subject?: string | undefined;
398
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
414
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
399
415
  custom?: Record<string, unknown> | undefined;
400
- rotation?: 0 | 90 | 180 | 270 | undefined;
401
416
  } | {
402
- id: string;
403
- page: number;
404
417
  rect: {
405
418
  x: number;
406
419
  y: number;
@@ -412,19 +425,19 @@ export declare function useAnnotations(): {
412
425
  createdAt: string;
413
426
  modifiedAt: string;
414
427
  source: "session" | "pdf";
415
- type: "loupe";
416
428
  magnification: number;
417
429
  width: number;
430
+ id: string;
431
+ page: number;
432
+ type: "loupe";
433
+ locked?: boolean | undefined;
418
434
  author?: string | undefined;
419
435
  contents?: string | undefined;
420
436
  inReplyTo?: string | undefined;
421
- locked?: boolean | undefined;
422
437
  subject?: string | undefined;
423
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
438
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
424
439
  custom?: Record<string, unknown> | undefined;
425
440
  } | {
426
- id: string;
427
- page: number;
428
441
  rect: {
429
442
  x: number;
430
443
  y: number;
@@ -436,19 +449,20 @@ export declare function useAnnotations(): {
436
449
  createdAt: string;
437
450
  modifiedAt: string;
438
451
  source: "session" | "pdf";
439
- type: "mask";
440
452
  shape: "rect" | "ellipse";
441
453
  dim: number;
454
+ id: string;
455
+ page: number;
456
+ type: "mask";
457
+ locked?: boolean | undefined;
442
458
  author?: string | undefined;
443
459
  contents?: string | undefined;
444
460
  inReplyTo?: string | undefined;
445
- locked?: boolean | undefined;
446
461
  subject?: string | undefined;
447
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
462
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
448
463
  custom?: Record<string, unknown> | undefined;
449
464
  } | {
450
- id: string;
451
- page: number;
465
+ interiorColor: string;
452
466
  rect: {
453
467
  x: number;
454
468
  y: number;
@@ -460,16 +474,9 @@ export declare function useAnnotations(): {
460
474
  createdAt: string;
461
475
  modifiedAt: string;
462
476
  source: "session" | "pdf";
477
+ id: string;
478
+ page: number;
463
479
  type: "redact";
464
- origin: "user" | "suggested";
465
- interiorColor: string;
466
- author?: string | undefined;
467
- contents?: string | undefined;
468
- inReplyTo?: string | undefined;
469
- locked?: boolean | undefined;
470
- subject?: string | undefined;
471
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
472
- custom?: Record<string, unknown> | undefined;
473
480
  quads?: {
474
481
  p1: {
475
482
  x: number;
@@ -488,29 +495,16 @@ export declare function useAnnotations(): {
488
495
  y: number;
489
496
  };
490
497
  }[] | undefined;
491
- suggestion?: {
492
- confidence: number;
493
- jobId?: string | undefined;
494
- reason?: string | undefined;
495
- explanation?: string | undefined;
496
- recommendation?: "redact" | "review" | "keep" | undefined;
497
- } | undefined;
498
+ locked?: boolean | undefined;
498
499
  overlayText?: string | undefined;
500
+ author?: string | undefined;
501
+ contents?: string | undefined;
502
+ inReplyTo?: string | undefined;
503
+ subject?: string | undefined;
504
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
505
+ custom?: Record<string, unknown> | undefined;
499
506
  } | undefined;
500
507
  update: (id: string, patch: AnnotationPatch) => {
501
- id: string;
502
- page: number;
503
- rect: {
504
- x: number;
505
- y: number;
506
- width: number;
507
- height: number;
508
- };
509
- color: string;
510
- opacity: number;
511
- createdAt: string;
512
- modifiedAt: string;
513
- source: "session" | "pdf";
514
508
  type: "highlight" | "underline" | "strikeout" | "squiggly";
515
509
  quads: {
516
510
  p1: {
@@ -530,16 +524,27 @@ export declare function useAnnotations(): {
530
524
  y: number;
531
525
  };
532
526
  }[];
527
+ rect: {
528
+ x: number;
529
+ y: number;
530
+ width: number;
531
+ height: number;
532
+ };
533
+ color: string;
534
+ opacity: number;
535
+ createdAt: string;
536
+ modifiedAt: string;
537
+ source: "session" | "pdf";
538
+ id: string;
539
+ page: number;
540
+ locked?: boolean | undefined;
533
541
  author?: string | undefined;
534
542
  contents?: string | undefined;
535
543
  inReplyTo?: string | undefined;
536
- locked?: boolean | undefined;
537
544
  subject?: string | undefined;
538
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
545
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
539
546
  custom?: Record<string, unknown> | undefined;
540
547
  } | {
541
- id: string;
542
- page: number;
543
548
  rect: {
544
549
  x: number;
545
550
  y: number;
@@ -551,18 +556,28 @@ export declare function useAnnotations(): {
551
556
  createdAt: string;
552
557
  modifiedAt: string;
553
558
  source: "session" | "pdf";
554
- type: "text";
555
559
  icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
560
+ id: string;
561
+ page: number;
562
+ type: "text";
563
+ locked?: boolean | undefined;
556
564
  author?: string | undefined;
557
565
  contents?: string | undefined;
558
566
  inReplyTo?: string | undefined;
559
- locked?: boolean | undefined;
560
567
  subject?: string | undefined;
561
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
568
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
562
569
  custom?: Record<string, unknown> | undefined;
563
570
  } | {
564
- id: string;
565
- page: number;
571
+ defaultStyle: {
572
+ color: string;
573
+ fontFamily: string;
574
+ fontSize: number;
575
+ textAlign: "left" | "right" | "center" | "justify";
576
+ align?: undefined;
577
+ fontWeight?: "bold" | undefined;
578
+ fontStyle?: "italic" | undefined;
579
+ textDecoration?: "underline" | undefined;
580
+ };
566
581
  rect: {
567
582
  x: number;
568
583
  y: number;
@@ -573,29 +588,13 @@ export declare function useAnnotations(): {
573
588
  createdAt: string;
574
589
  modifiedAt: string;
575
590
  source: "session" | "pdf";
576
- type: "freetext";
577
591
  contents: string;
578
592
  width: number;
579
- defaultStyle: {
580
- fontFamily: string;
581
- fontSize: number;
582
- color: string;
583
- textAlign: "left" | "right" | "center" | "justify";
584
- fontWeight?: "bold" | undefined;
585
- fontStyle?: "italic" | undefined;
586
- textDecoration?: "underline" | undefined;
587
- align?: undefined;
588
- };
589
- author?: string | undefined;
590
- inReplyTo?: string | undefined;
591
- locked?: boolean | undefined;
592
- subject?: string | undefined;
593
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
594
- custom?: Record<string, unknown> | undefined;
593
+ id: string;
594
+ page: number;
595
+ type: "freetext";
595
596
  color?: string | undefined;
596
597
  borderColor?: string | undefined;
597
- dashes?: number[] | undefined;
598
- cornerRadius?: number | undefined;
599
598
  fringe?: {
600
599
  left: number;
601
600
  top: number;
@@ -606,13 +605,19 @@ export declare function useAnnotations(): {
606
605
  x: number;
607
606
  y: number;
608
607
  }[] | undefined;
609
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
610
608
  fontFamily?: undefined;
611
609
  fontSize?: undefined;
612
610
  align?: undefined;
611
+ locked?: boolean | undefined;
612
+ dashes?: number[] | undefined;
613
+ cornerRadius?: number | undefined;
614
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
615
+ author?: string | undefined;
616
+ inReplyTo?: string | undefined;
617
+ subject?: string | undefined;
618
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
619
+ custom?: Record<string, unknown> | undefined;
613
620
  } | {
614
- id: string;
615
- page: number;
616
621
  rect: {
617
622
  x: number;
618
623
  y: number;
@@ -625,20 +630,20 @@ export declare function useAnnotations(): {
625
630
  modifiedAt: string;
626
631
  source: "session" | "pdf";
627
632
  width: number;
633
+ id: string;
634
+ page: number;
628
635
  type: "square";
636
+ locked?: boolean | undefined;
637
+ dashes?: number[] | undefined;
638
+ interiorColor?: string | undefined;
639
+ cornerRadius?: number | undefined;
629
640
  author?: string | undefined;
630
641
  contents?: string | undefined;
631
642
  inReplyTo?: string | undefined;
632
- locked?: boolean | undefined;
633
643
  subject?: string | undefined;
634
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
644
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
635
645
  custom?: Record<string, unknown> | undefined;
636
- cornerRadius?: number | undefined;
637
- dashes?: number[] | undefined;
638
- interiorColor?: string | undefined;
639
646
  } | {
640
- id: string;
641
- page: number;
642
647
  rect: {
643
648
  x: number;
644
649
  y: number;
@@ -651,20 +656,28 @@ export declare function useAnnotations(): {
651
656
  modifiedAt: string;
652
657
  source: "session" | "pdf";
653
658
  width: number;
659
+ id: string;
660
+ page: number;
654
661
  type: "circle";
662
+ cornerRadius?: undefined;
663
+ locked?: boolean | undefined;
664
+ dashes?: number[] | undefined;
665
+ interiorColor?: string | undefined;
655
666
  author?: string | undefined;
656
667
  contents?: string | undefined;
657
668
  inReplyTo?: string | undefined;
658
- locked?: boolean | undefined;
659
669
  subject?: string | undefined;
660
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
670
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
661
671
  custom?: Record<string, unknown> | undefined;
662
- cornerRadius?: undefined;
663
- dashes?: number[] | undefined;
664
- interiorColor?: string | undefined;
665
672
  } | {
666
- id: string;
667
- page: number;
673
+ start: {
674
+ x: number;
675
+ y: number;
676
+ };
677
+ end: {
678
+ x: number;
679
+ y: number;
680
+ };
668
681
  rect: {
669
682
  x: number;
670
683
  y: number;
@@ -676,29 +689,25 @@ export declare function useAnnotations(): {
676
689
  createdAt: string;
677
690
  modifiedAt: string;
678
691
  source: "session" | "pdf";
679
- type: "line";
680
- start: {
681
- x: number;
682
- y: number;
683
- };
684
- end: {
685
- x: number;
686
- y: number;
687
- };
688
692
  width: number;
693
+ id: string;
694
+ page: number;
695
+ type: "line";
696
+ locked?: boolean | undefined;
697
+ dashes?: number[] | undefined;
698
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
699
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
689
700
  author?: string | undefined;
690
701
  contents?: string | undefined;
691
702
  inReplyTo?: string | undefined;
692
- locked?: boolean | undefined;
693
703
  subject?: string | undefined;
694
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
704
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
695
705
  custom?: Record<string, unknown> | undefined;
696
- dashes?: number[] | undefined;
697
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
698
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
699
706
  } | {
700
- id: string;
701
- page: number;
707
+ vertices: {
708
+ x: number;
709
+ y: number;
710
+ }[];
702
711
  rect: {
703
712
  x: number;
704
713
  y: number;
@@ -710,26 +719,26 @@ export declare function useAnnotations(): {
710
719
  createdAt: string;
711
720
  modifiedAt: string;
712
721
  source: "session" | "pdf";
713
- vertices: {
714
- x: number;
715
- y: number;
716
- }[];
717
722
  width: number;
723
+ id: string;
724
+ page: number;
718
725
  type: "polyline";
726
+ locked?: boolean | undefined;
727
+ dashes?: number[] | undefined;
728
+ interiorColor?: string | undefined;
729
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
730
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
719
731
  author?: string | undefined;
720
732
  contents?: string | undefined;
721
733
  inReplyTo?: string | undefined;
722
- locked?: boolean | undefined;
723
734
  subject?: string | undefined;
724
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
735
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
725
736
  custom?: Record<string, unknown> | undefined;
726
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
727
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
728
- dashes?: number[] | undefined;
729
- interiorColor?: string | undefined;
730
737
  } | {
731
- id: string;
732
- page: number;
738
+ vertices: {
739
+ x: number;
740
+ y: number;
741
+ }[];
733
742
  rect: {
734
743
  x: number;
735
744
  y: number;
@@ -741,26 +750,26 @@ export declare function useAnnotations(): {
741
750
  createdAt: string;
742
751
  modifiedAt: string;
743
752
  source: "session" | "pdf";
744
- vertices: {
745
- x: number;
746
- y: number;
747
- }[];
748
753
  width: number;
754
+ id: string;
755
+ page: number;
749
756
  type: "polygon";
757
+ head?: undefined;
758
+ tail?: undefined;
759
+ locked?: boolean | undefined;
760
+ dashes?: number[] | undefined;
761
+ interiorColor?: string | undefined;
750
762
  author?: string | undefined;
751
763
  contents?: string | undefined;
752
764
  inReplyTo?: string | undefined;
753
- locked?: boolean | undefined;
754
765
  subject?: string | undefined;
755
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
766
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
756
767
  custom?: Record<string, unknown> | undefined;
757
- head?: undefined;
758
- tail?: undefined;
759
- dashes?: number[] | undefined;
760
- interiorColor?: string | undefined;
761
768
  } | {
762
- id: string;
763
- page: number;
769
+ inklist: {
770
+ x: number;
771
+ y: number;
772
+ }[][];
764
773
  rect: {
765
774
  x: number;
766
775
  y: number;
@@ -772,24 +781,20 @@ export declare function useAnnotations(): {
772
781
  createdAt: string;
773
782
  modifiedAt: string;
774
783
  source: "session" | "pdf";
775
- type: "ink";
776
- inklist: {
777
- x: number;
778
- y: number;
779
- }[][];
780
784
  width: number;
785
+ id: string;
786
+ page: number;
787
+ type: "ink";
788
+ pressure?: number[][] | undefined;
789
+ locked?: boolean | undefined;
790
+ dashes?: number[] | undefined;
781
791
  author?: string | undefined;
782
792
  contents?: string | undefined;
783
793
  inReplyTo?: string | undefined;
784
- locked?: boolean | undefined;
785
794
  subject?: string | undefined;
786
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
795
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
787
796
  custom?: Record<string, unknown> | undefined;
788
- pressure?: number[][] | undefined;
789
- dashes?: number[] | undefined;
790
797
  } | {
791
- id: string;
792
- page: number;
793
798
  rect: {
794
799
  x: number;
795
800
  y: number;
@@ -801,19 +806,19 @@ export declare function useAnnotations(): {
801
806
  createdAt: string;
802
807
  modifiedAt: string;
803
808
  source: "session" | "pdf";
804
- type: "stamp";
805
809
  imagedata: string;
810
+ id: string;
811
+ page: number;
812
+ type: "stamp";
813
+ locked?: boolean | undefined;
814
+ rotation?: 0 | 90 | 180 | 270 | undefined;
806
815
  author?: string | undefined;
807
816
  contents?: string | undefined;
808
817
  inReplyTo?: string | undefined;
809
- locked?: boolean | undefined;
810
818
  subject?: string | undefined;
811
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
819
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
812
820
  custom?: Record<string, unknown> | undefined;
813
- rotation?: 0 | 90 | 180 | 270 | undefined;
814
821
  } | {
815
- id: string;
816
- page: number;
817
822
  rect: {
818
823
  x: number;
819
824
  y: number;
@@ -825,19 +830,19 @@ export declare function useAnnotations(): {
825
830
  createdAt: string;
826
831
  modifiedAt: string;
827
832
  source: "session" | "pdf";
828
- type: "loupe";
829
833
  magnification: number;
830
834
  width: number;
835
+ id: string;
836
+ page: number;
837
+ type: "loupe";
838
+ locked?: boolean | undefined;
831
839
  author?: string | undefined;
832
840
  contents?: string | undefined;
833
841
  inReplyTo?: string | undefined;
834
- locked?: boolean | undefined;
835
842
  subject?: string | undefined;
836
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
843
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
837
844
  custom?: Record<string, unknown> | undefined;
838
845
  } | {
839
- id: string;
840
- page: number;
841
846
  rect: {
842
847
  x: number;
843
848
  y: number;
@@ -849,19 +854,20 @@ export declare function useAnnotations(): {
849
854
  createdAt: string;
850
855
  modifiedAt: string;
851
856
  source: "session" | "pdf";
852
- type: "mask";
853
857
  shape: "rect" | "ellipse";
854
858
  dim: number;
859
+ id: string;
860
+ page: number;
861
+ type: "mask";
862
+ locked?: boolean | undefined;
855
863
  author?: string | undefined;
856
864
  contents?: string | undefined;
857
865
  inReplyTo?: string | undefined;
858
- locked?: boolean | undefined;
859
866
  subject?: string | undefined;
860
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
867
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
861
868
  custom?: Record<string, unknown> | undefined;
862
869
  } | {
863
- id: string;
864
- page: number;
870
+ interiorColor: string;
865
871
  rect: {
866
872
  x: number;
867
873
  y: number;
@@ -873,16 +879,9 @@ export declare function useAnnotations(): {
873
879
  createdAt: string;
874
880
  modifiedAt: string;
875
881
  source: "session" | "pdf";
882
+ id: string;
883
+ page: number;
876
884
  type: "redact";
877
- origin: "user" | "suggested";
878
- interiorColor: string;
879
- author?: string | undefined;
880
- contents?: string | undefined;
881
- inReplyTo?: string | undefined;
882
- locked?: boolean | undefined;
883
- subject?: string | undefined;
884
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
885
- custom?: Record<string, unknown> | undefined;
886
885
  quads?: {
887
886
  p1: {
888
887
  x: number;
@@ -901,32 +900,18 @@ export declare function useAnnotations(): {
901
900
  y: number;
902
901
  };
903
902
  }[] | undefined;
904
- suggestion?: {
905
- confidence: number;
906
- jobId?: string | undefined;
907
- reason?: string | undefined;
908
- explanation?: string | undefined;
909
- recommendation?: "redact" | "review" | "keep" | undefined;
910
- } | undefined;
903
+ locked?: boolean | undefined;
911
904
  overlayText?: string | undefined;
905
+ author?: string | undefined;
906
+ contents?: string | undefined;
907
+ inReplyTo?: string | undefined;
908
+ subject?: string | undefined;
909
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
910
+ custom?: Record<string, unknown> | undefined;
912
911
  } | undefined;
913
912
  remove: (id: string) => boolean;
914
913
  select: (ids: string[]) => void | undefined;
915
- /** Keeps a suggested redaction as the user's own, in the default redaction colour. */
916
- accept: (id: string) => {
917
- id: string;
918
- page: number;
919
- rect: {
920
- x: number;
921
- y: number;
922
- width: number;
923
- height: number;
924
- };
925
- color: string;
926
- opacity: number;
927
- createdAt: string;
928
- modifiedAt: string;
929
- source: "session" | "pdf";
914
+ annotations: readonly ({
930
915
  type: "highlight" | "underline" | "strikeout" | "squiggly";
931
916
  quads: {
932
917
  p1: {
@@ -946,16 +931,6 @@ export declare function useAnnotations(): {
946
931
  y: number;
947
932
  };
948
933
  }[];
949
- author?: string | undefined;
950
- contents?: string | undefined;
951
- inReplyTo?: string | undefined;
952
- locked?: boolean | undefined;
953
- subject?: string | undefined;
954
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
955
- custom?: Record<string, unknown> | undefined;
956
- } | {
957
- id: string;
958
- page: number;
959
934
  rect: {
960
935
  x: number;
961
936
  y: number;
@@ -967,409 +942,16 @@ export declare function useAnnotations(): {
967
942
  createdAt: string;
968
943
  modifiedAt: string;
969
944
  source: "session" | "pdf";
970
- type: "text";
971
- icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
972
- author?: string | undefined;
973
- contents?: string | undefined;
974
- inReplyTo?: string | undefined;
975
- locked?: boolean | undefined;
976
- subject?: string | undefined;
977
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
978
- custom?: Record<string, unknown> | undefined;
979
- } | {
980
- id: string;
981
- page: number;
982
- rect: {
983
- x: number;
984
- y: number;
985
- width: number;
986
- height: number;
987
- };
988
- opacity: number;
989
- createdAt: string;
990
- modifiedAt: string;
991
- source: "session" | "pdf";
992
- type: "freetext";
993
- contents: string;
994
- width: number;
995
- defaultStyle: {
996
- fontFamily: string;
997
- fontSize: number;
998
- color: string;
999
- textAlign: "left" | "right" | "center" | "justify";
1000
- fontWeight?: "bold" | undefined;
1001
- fontStyle?: "italic" | undefined;
1002
- textDecoration?: "underline" | undefined;
1003
- align?: undefined;
1004
- };
1005
- author?: string | undefined;
1006
- inReplyTo?: string | undefined;
1007
- locked?: boolean | undefined;
1008
- subject?: string | undefined;
1009
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1010
- custom?: Record<string, unknown> | undefined;
1011
- color?: string | undefined;
1012
- borderColor?: string | undefined;
1013
- dashes?: number[] | undefined;
1014
- cornerRadius?: number | undefined;
1015
- fringe?: {
1016
- left: number;
1017
- top: number;
1018
- right: number;
1019
- bottom: number;
1020
- } | undefined;
1021
- callout?: {
1022
- x: number;
1023
- y: number;
1024
- }[] | undefined;
1025
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1026
- fontFamily?: undefined;
1027
- fontSize?: undefined;
1028
- align?: undefined;
1029
- } | {
1030
- id: string;
1031
- page: number;
1032
- rect: {
1033
- x: number;
1034
- y: number;
1035
- width: number;
1036
- height: number;
1037
- };
1038
- color: string;
1039
- opacity: number;
1040
- createdAt: string;
1041
- modifiedAt: string;
1042
- source: "session" | "pdf";
1043
- width: number;
1044
- type: "square";
1045
- author?: string | undefined;
1046
- contents?: string | undefined;
1047
- inReplyTo?: string | undefined;
1048
- locked?: boolean | undefined;
1049
- subject?: string | undefined;
1050
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1051
- custom?: Record<string, unknown> | undefined;
1052
- cornerRadius?: number | undefined;
1053
- dashes?: number[] | undefined;
1054
- interiorColor?: string | undefined;
1055
- } | {
1056
- id: string;
1057
- page: number;
1058
- rect: {
1059
- x: number;
1060
- y: number;
1061
- width: number;
1062
- height: number;
1063
- };
1064
- color: string;
1065
- opacity: number;
1066
- createdAt: string;
1067
- modifiedAt: string;
1068
- source: "session" | "pdf";
1069
- width: number;
1070
- type: "circle";
1071
- author?: string | undefined;
1072
- contents?: string | undefined;
1073
- inReplyTo?: string | undefined;
1074
- locked?: boolean | undefined;
1075
- subject?: string | undefined;
1076
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1077
- custom?: Record<string, unknown> | undefined;
1078
- cornerRadius?: undefined;
1079
- dashes?: number[] | undefined;
1080
- interiorColor?: string | undefined;
1081
- } | {
1082
- id: string;
1083
- page: number;
1084
- rect: {
1085
- x: number;
1086
- y: number;
1087
- width: number;
1088
- height: number;
1089
- };
1090
- color: string;
1091
- opacity: number;
1092
- createdAt: string;
1093
- modifiedAt: string;
1094
- source: "session" | "pdf";
1095
- type: "line";
1096
- start: {
1097
- x: number;
1098
- y: number;
1099
- };
1100
- end: {
1101
- x: number;
1102
- y: number;
1103
- };
1104
- width: number;
1105
- author?: string | undefined;
1106
- contents?: string | undefined;
1107
- inReplyTo?: string | undefined;
1108
- locked?: boolean | undefined;
1109
- subject?: string | undefined;
1110
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1111
- custom?: Record<string, unknown> | undefined;
1112
- dashes?: number[] | undefined;
1113
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1114
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1115
- } | {
1116
- id: string;
1117
- page: number;
1118
- rect: {
1119
- x: number;
1120
- y: number;
1121
- width: number;
1122
- height: number;
1123
- };
1124
- color: string;
1125
- opacity: number;
1126
- createdAt: string;
1127
- modifiedAt: string;
1128
- source: "session" | "pdf";
1129
- vertices: {
1130
- x: number;
1131
- y: number;
1132
- }[];
1133
- width: number;
1134
- type: "polyline";
1135
- author?: string | undefined;
1136
- contents?: string | undefined;
1137
- inReplyTo?: string | undefined;
1138
- locked?: boolean | undefined;
1139
- subject?: string | undefined;
1140
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1141
- custom?: Record<string, unknown> | undefined;
1142
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1143
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1144
- dashes?: number[] | undefined;
1145
- interiorColor?: string | undefined;
1146
- } | {
1147
- id: string;
1148
- page: number;
1149
- rect: {
1150
- x: number;
1151
- y: number;
1152
- width: number;
1153
- height: number;
1154
- };
1155
- color: string;
1156
- opacity: number;
1157
- createdAt: string;
1158
- modifiedAt: string;
1159
- source: "session" | "pdf";
1160
- vertices: {
1161
- x: number;
1162
- y: number;
1163
- }[];
1164
- width: number;
1165
- type: "polygon";
1166
- author?: string | undefined;
1167
- contents?: string | undefined;
1168
- inReplyTo?: string | undefined;
1169
- locked?: boolean | undefined;
1170
- subject?: string | undefined;
1171
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1172
- custom?: Record<string, unknown> | undefined;
1173
- head?: undefined;
1174
- tail?: undefined;
1175
- dashes?: number[] | undefined;
1176
- interiorColor?: string | undefined;
1177
- } | {
1178
- id: string;
1179
- page: number;
1180
- rect: {
1181
- x: number;
1182
- y: number;
1183
- width: number;
1184
- height: number;
1185
- };
1186
- color: string;
1187
- opacity: number;
1188
- createdAt: string;
1189
- modifiedAt: string;
1190
- source: "session" | "pdf";
1191
- type: "ink";
1192
- inklist: {
1193
- x: number;
1194
- y: number;
1195
- }[][];
1196
- width: number;
1197
- author?: string | undefined;
1198
- contents?: string | undefined;
1199
- inReplyTo?: string | undefined;
1200
- locked?: boolean | undefined;
1201
- subject?: string | undefined;
1202
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1203
- custom?: Record<string, unknown> | undefined;
1204
- pressure?: number[][] | undefined;
1205
- dashes?: number[] | undefined;
1206
- } | {
1207
- id: string;
1208
- page: number;
1209
- rect: {
1210
- x: number;
1211
- y: number;
1212
- width: number;
1213
- height: number;
1214
- };
1215
- color: string;
1216
- opacity: number;
1217
- createdAt: string;
1218
- modifiedAt: string;
1219
- source: "session" | "pdf";
1220
- type: "stamp";
1221
- imagedata: string;
1222
- author?: string | undefined;
1223
- contents?: string | undefined;
1224
- inReplyTo?: string | undefined;
1225
- locked?: boolean | undefined;
1226
- subject?: string | undefined;
1227
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1228
- custom?: Record<string, unknown> | undefined;
1229
- rotation?: 0 | 90 | 180 | 270 | undefined;
1230
- } | {
1231
- id: string;
1232
- page: number;
1233
- rect: {
1234
- x: number;
1235
- y: number;
1236
- width: number;
1237
- height: number;
1238
- };
1239
- color: string;
1240
- opacity: number;
1241
- createdAt: string;
1242
- modifiedAt: string;
1243
- source: "session" | "pdf";
1244
- type: "loupe";
1245
- magnification: number;
1246
- width: number;
1247
- author?: string | undefined;
1248
- contents?: string | undefined;
1249
- inReplyTo?: string | undefined;
1250
- locked?: boolean | undefined;
1251
- subject?: string | undefined;
1252
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1253
- custom?: Record<string, unknown> | undefined;
1254
- } | {
1255
- id: string;
1256
- page: number;
1257
- rect: {
1258
- x: number;
1259
- y: number;
1260
- width: number;
1261
- height: number;
1262
- };
1263
- color: string;
1264
- opacity: number;
1265
- createdAt: string;
1266
- modifiedAt: string;
1267
- source: "session" | "pdf";
1268
- type: "mask";
1269
- shape: "rect" | "ellipse";
1270
- dim: number;
1271
- author?: string | undefined;
1272
- contents?: string | undefined;
1273
- inReplyTo?: string | undefined;
1274
- locked?: boolean | undefined;
1275
- subject?: string | undefined;
1276
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1277
- custom?: Record<string, unknown> | undefined;
1278
- } | {
1279
945
  id: string;
1280
946
  page: number;
1281
- rect: {
1282
- x: number;
1283
- y: number;
1284
- width: number;
1285
- height: number;
1286
- };
1287
- color: string;
1288
- opacity: number;
1289
- createdAt: string;
1290
- modifiedAt: string;
1291
- source: "session" | "pdf";
1292
- type: "redact";
1293
- origin: "user" | "suggested";
1294
- interiorColor: string;
1295
- author?: string | undefined;
1296
- contents?: string | undefined;
1297
- inReplyTo?: string | undefined;
1298
947
  locked?: boolean | undefined;
1299
- subject?: string | undefined;
1300
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1301
- custom?: Record<string, unknown> | undefined;
1302
- quads?: {
1303
- p1: {
1304
- x: number;
1305
- y: number;
1306
- };
1307
- p2: {
1308
- x: number;
1309
- y: number;
1310
- };
1311
- p3: {
1312
- x: number;
1313
- y: number;
1314
- };
1315
- p4: {
1316
- x: number;
1317
- y: number;
1318
- };
1319
- }[] | undefined;
1320
- suggestion?: {
1321
- confidence: number;
1322
- jobId?: string | undefined;
1323
- reason?: string | undefined;
1324
- explanation?: string | undefined;
1325
- recommendation?: "redact" | "review" | "keep" | undefined;
1326
- } | undefined;
1327
- overlayText?: string | undefined;
1328
- } | undefined;
1329
- dismiss: (id: string) => boolean;
1330
- annotations: readonly ({
1331
- id: string;
1332
- page: number;
1333
- rect: {
1334
- x: number;
1335
- y: number;
1336
- width: number;
1337
- height: number;
1338
- };
1339
- color: string;
1340
- opacity: number;
1341
- createdAt: string;
1342
- modifiedAt: string;
1343
- source: "session" | "pdf";
1344
- type: "highlight" | "underline" | "strikeout" | "squiggly";
1345
- quads: {
1346
- p1: {
1347
- x: number;
1348
- y: number;
1349
- };
1350
- p2: {
1351
- x: number;
1352
- y: number;
1353
- };
1354
- p3: {
1355
- x: number;
1356
- y: number;
1357
- };
1358
- p4: {
1359
- x: number;
1360
- y: number;
1361
- };
1362
- }[];
1363
948
  author?: string | undefined;
1364
949
  contents?: string | undefined;
1365
950
  inReplyTo?: string | undefined;
1366
- locked?: boolean | undefined;
1367
951
  subject?: string | undefined;
1368
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
952
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1369
953
  custom?: Record<string, unknown> | undefined;
1370
954
  } | {
1371
- id: string;
1372
- page: number;
1373
955
  rect: {
1374
956
  x: number;
1375
957
  y: number;
@@ -1381,18 +963,28 @@ export declare function useAnnotations(): {
1381
963
  createdAt: string;
1382
964
  modifiedAt: string;
1383
965
  source: "session" | "pdf";
1384
- type: "text";
1385
966
  icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
967
+ id: string;
968
+ page: number;
969
+ type: "text";
970
+ locked?: boolean | undefined;
1386
971
  author?: string | undefined;
1387
972
  contents?: string | undefined;
1388
973
  inReplyTo?: string | undefined;
1389
- locked?: boolean | undefined;
1390
974
  subject?: string | undefined;
1391
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
975
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1392
976
  custom?: Record<string, unknown> | undefined;
1393
977
  } | {
1394
- id: string;
1395
- page: number;
978
+ defaultStyle: {
979
+ color: string;
980
+ fontFamily: string;
981
+ fontSize: number;
982
+ textAlign: "left" | "right" | "center" | "justify";
983
+ align?: undefined;
984
+ fontWeight?: "bold" | undefined;
985
+ fontStyle?: "italic" | undefined;
986
+ textDecoration?: "underline" | undefined;
987
+ };
1396
988
  rect: {
1397
989
  x: number;
1398
990
  y: number;
@@ -1403,29 +995,13 @@ export declare function useAnnotations(): {
1403
995
  createdAt: string;
1404
996
  modifiedAt: string;
1405
997
  source: "session" | "pdf";
1406
- type: "freetext";
1407
998
  contents: string;
1408
999
  width: number;
1409
- defaultStyle: {
1410
- fontFamily: string;
1411
- fontSize: number;
1412
- color: string;
1413
- textAlign: "left" | "right" | "center" | "justify";
1414
- fontWeight?: "bold" | undefined;
1415
- fontStyle?: "italic" | undefined;
1416
- textDecoration?: "underline" | undefined;
1417
- align?: undefined;
1418
- };
1419
- author?: string | undefined;
1420
- inReplyTo?: string | undefined;
1421
- locked?: boolean | undefined;
1422
- subject?: string | undefined;
1423
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1424
- custom?: Record<string, unknown> | undefined;
1000
+ id: string;
1001
+ page: number;
1002
+ type: "freetext";
1425
1003
  color?: string | undefined;
1426
1004
  borderColor?: string | undefined;
1427
- dashes?: number[] | undefined;
1428
- cornerRadius?: number | undefined;
1429
1005
  fringe?: {
1430
1006
  left: number;
1431
1007
  top: number;
@@ -1436,13 +1012,19 @@ export declare function useAnnotations(): {
1436
1012
  x: number;
1437
1013
  y: number;
1438
1014
  }[] | undefined;
1439
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1440
1015
  fontFamily?: undefined;
1441
1016
  fontSize?: undefined;
1442
1017
  align?: undefined;
1018
+ locked?: boolean | undefined;
1019
+ dashes?: number[] | undefined;
1020
+ cornerRadius?: number | undefined;
1021
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1022
+ author?: string | undefined;
1023
+ inReplyTo?: string | undefined;
1024
+ subject?: string | undefined;
1025
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1026
+ custom?: Record<string, unknown> | undefined;
1443
1027
  } | {
1444
- id: string;
1445
- page: number;
1446
1028
  rect: {
1447
1029
  x: number;
1448
1030
  y: number;
@@ -1455,20 +1037,20 @@ export declare function useAnnotations(): {
1455
1037
  modifiedAt: string;
1456
1038
  source: "session" | "pdf";
1457
1039
  width: number;
1040
+ id: string;
1041
+ page: number;
1458
1042
  type: "square";
1043
+ locked?: boolean | undefined;
1044
+ dashes?: number[] | undefined;
1045
+ interiorColor?: string | undefined;
1046
+ cornerRadius?: number | undefined;
1459
1047
  author?: string | undefined;
1460
1048
  contents?: string | undefined;
1461
1049
  inReplyTo?: string | undefined;
1462
- locked?: boolean | undefined;
1463
1050
  subject?: string | undefined;
1464
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1051
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1465
1052
  custom?: Record<string, unknown> | undefined;
1466
- cornerRadius?: number | undefined;
1467
- dashes?: number[] | undefined;
1468
- interiorColor?: string | undefined;
1469
1053
  } | {
1470
- id: string;
1471
- page: number;
1472
1054
  rect: {
1473
1055
  x: number;
1474
1056
  y: number;
@@ -1481,20 +1063,28 @@ export declare function useAnnotations(): {
1481
1063
  modifiedAt: string;
1482
1064
  source: "session" | "pdf";
1483
1065
  width: number;
1066
+ id: string;
1067
+ page: number;
1484
1068
  type: "circle";
1069
+ cornerRadius?: undefined;
1070
+ locked?: boolean | undefined;
1071
+ dashes?: number[] | undefined;
1072
+ interiorColor?: string | undefined;
1485
1073
  author?: string | undefined;
1486
1074
  contents?: string | undefined;
1487
1075
  inReplyTo?: string | undefined;
1488
- locked?: boolean | undefined;
1489
1076
  subject?: string | undefined;
1490
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1077
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1491
1078
  custom?: Record<string, unknown> | undefined;
1492
- cornerRadius?: undefined;
1493
- dashes?: number[] | undefined;
1494
- interiorColor?: string | undefined;
1495
1079
  } | {
1496
- id: string;
1497
- page: number;
1080
+ start: {
1081
+ x: number;
1082
+ y: number;
1083
+ };
1084
+ end: {
1085
+ x: number;
1086
+ y: number;
1087
+ };
1498
1088
  rect: {
1499
1089
  x: number;
1500
1090
  y: number;
@@ -1506,29 +1096,25 @@ export declare function useAnnotations(): {
1506
1096
  createdAt: string;
1507
1097
  modifiedAt: string;
1508
1098
  source: "session" | "pdf";
1509
- type: "line";
1510
- start: {
1511
- x: number;
1512
- y: number;
1513
- };
1514
- end: {
1515
- x: number;
1516
- y: number;
1517
- };
1518
1099
  width: number;
1100
+ id: string;
1101
+ page: number;
1102
+ type: "line";
1103
+ locked?: boolean | undefined;
1104
+ dashes?: number[] | undefined;
1105
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1106
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1519
1107
  author?: string | undefined;
1520
1108
  contents?: string | undefined;
1521
1109
  inReplyTo?: string | undefined;
1522
- locked?: boolean | undefined;
1523
1110
  subject?: string | undefined;
1524
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1111
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1525
1112
  custom?: Record<string, unknown> | undefined;
1526
- dashes?: number[] | undefined;
1527
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1528
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1529
1113
  } | {
1530
- id: string;
1531
- page: number;
1114
+ vertices: {
1115
+ x: number;
1116
+ y: number;
1117
+ }[];
1532
1118
  rect: {
1533
1119
  x: number;
1534
1120
  y: number;
@@ -1540,26 +1126,26 @@ export declare function useAnnotations(): {
1540
1126
  createdAt: string;
1541
1127
  modifiedAt: string;
1542
1128
  source: "session" | "pdf";
1543
- vertices: {
1544
- x: number;
1545
- y: number;
1546
- }[];
1547
1129
  width: number;
1130
+ id: string;
1131
+ page: number;
1548
1132
  type: "polyline";
1133
+ locked?: boolean | undefined;
1134
+ dashes?: number[] | undefined;
1135
+ interiorColor?: string | undefined;
1136
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1137
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1549
1138
  author?: string | undefined;
1550
1139
  contents?: string | undefined;
1551
1140
  inReplyTo?: string | undefined;
1552
- locked?: boolean | undefined;
1553
1141
  subject?: string | undefined;
1554
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1142
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1555
1143
  custom?: Record<string, unknown> | undefined;
1556
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1557
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1558
- dashes?: number[] | undefined;
1559
- interiorColor?: string | undefined;
1560
1144
  } | {
1561
- id: string;
1562
- page: number;
1145
+ vertices: {
1146
+ x: number;
1147
+ y: number;
1148
+ }[];
1563
1149
  rect: {
1564
1150
  x: number;
1565
1151
  y: number;
@@ -1571,26 +1157,26 @@ export declare function useAnnotations(): {
1571
1157
  createdAt: string;
1572
1158
  modifiedAt: string;
1573
1159
  source: "session" | "pdf";
1574
- vertices: {
1575
- x: number;
1576
- y: number;
1577
- }[];
1578
1160
  width: number;
1161
+ id: string;
1162
+ page: number;
1579
1163
  type: "polygon";
1164
+ head?: undefined;
1165
+ tail?: undefined;
1166
+ locked?: boolean | undefined;
1167
+ dashes?: number[] | undefined;
1168
+ interiorColor?: string | undefined;
1580
1169
  author?: string | undefined;
1581
1170
  contents?: string | undefined;
1582
1171
  inReplyTo?: string | undefined;
1583
- locked?: boolean | undefined;
1584
1172
  subject?: string | undefined;
1585
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1173
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1586
1174
  custom?: Record<string, unknown> | undefined;
1587
- head?: undefined;
1588
- tail?: undefined;
1589
- dashes?: number[] | undefined;
1590
- interiorColor?: string | undefined;
1591
1175
  } | {
1592
- id: string;
1593
- page: number;
1176
+ inklist: {
1177
+ x: number;
1178
+ y: number;
1179
+ }[][];
1594
1180
  rect: {
1595
1181
  x: number;
1596
1182
  y: number;
@@ -1602,24 +1188,20 @@ export declare function useAnnotations(): {
1602
1188
  createdAt: string;
1603
1189
  modifiedAt: string;
1604
1190
  source: "session" | "pdf";
1605
- type: "ink";
1606
- inklist: {
1607
- x: number;
1608
- y: number;
1609
- }[][];
1610
1191
  width: number;
1192
+ id: string;
1193
+ page: number;
1194
+ type: "ink";
1195
+ pressure?: number[][] | undefined;
1196
+ locked?: boolean | undefined;
1197
+ dashes?: number[] | undefined;
1611
1198
  author?: string | undefined;
1612
1199
  contents?: string | undefined;
1613
1200
  inReplyTo?: string | undefined;
1614
- locked?: boolean | undefined;
1615
1201
  subject?: string | undefined;
1616
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1202
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1617
1203
  custom?: Record<string, unknown> | undefined;
1618
- pressure?: number[][] | undefined;
1619
- dashes?: number[] | undefined;
1620
1204
  } | {
1621
- id: string;
1622
- page: number;
1623
1205
  rect: {
1624
1206
  x: number;
1625
1207
  y: number;
@@ -1631,19 +1213,19 @@ export declare function useAnnotations(): {
1631
1213
  createdAt: string;
1632
1214
  modifiedAt: string;
1633
1215
  source: "session" | "pdf";
1634
- type: "stamp";
1635
1216
  imagedata: string;
1217
+ id: string;
1218
+ page: number;
1219
+ type: "stamp";
1220
+ locked?: boolean | undefined;
1221
+ rotation?: 0 | 90 | 180 | 270 | undefined;
1636
1222
  author?: string | undefined;
1637
1223
  contents?: string | undefined;
1638
1224
  inReplyTo?: string | undefined;
1639
- locked?: boolean | undefined;
1640
1225
  subject?: string | undefined;
1641
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1226
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1642
1227
  custom?: Record<string, unknown> | undefined;
1643
- rotation?: 0 | 90 | 180 | 270 | undefined;
1644
1228
  } | {
1645
- id: string;
1646
- page: number;
1647
1229
  rect: {
1648
1230
  x: number;
1649
1231
  y: number;
@@ -1655,19 +1237,19 @@ export declare function useAnnotations(): {
1655
1237
  createdAt: string;
1656
1238
  modifiedAt: string;
1657
1239
  source: "session" | "pdf";
1658
- type: "loupe";
1659
1240
  magnification: number;
1660
1241
  width: number;
1242
+ id: string;
1243
+ page: number;
1244
+ type: "loupe";
1245
+ locked?: boolean | undefined;
1661
1246
  author?: string | undefined;
1662
1247
  contents?: string | undefined;
1663
1248
  inReplyTo?: string | undefined;
1664
- locked?: boolean | undefined;
1665
1249
  subject?: string | undefined;
1666
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1250
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1667
1251
  custom?: Record<string, unknown> | undefined;
1668
1252
  } | {
1669
- id: string;
1670
- page: number;
1671
1253
  rect: {
1672
1254
  x: number;
1673
1255
  y: number;
@@ -1679,19 +1261,20 @@ export declare function useAnnotations(): {
1679
1261
  createdAt: string;
1680
1262
  modifiedAt: string;
1681
1263
  source: "session" | "pdf";
1682
- type: "mask";
1683
1264
  shape: "rect" | "ellipse";
1684
1265
  dim: number;
1266
+ id: string;
1267
+ page: number;
1268
+ type: "mask";
1269
+ locked?: boolean | undefined;
1685
1270
  author?: string | undefined;
1686
1271
  contents?: string | undefined;
1687
1272
  inReplyTo?: string | undefined;
1688
- locked?: boolean | undefined;
1689
1273
  subject?: string | undefined;
1690
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1274
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1691
1275
  custom?: Record<string, unknown> | undefined;
1692
1276
  } | {
1693
- id: string;
1694
- page: number;
1277
+ interiorColor: string;
1695
1278
  rect: {
1696
1279
  x: number;
1697
1280
  y: number;
@@ -1703,16 +1286,9 @@ export declare function useAnnotations(): {
1703
1286
  createdAt: string;
1704
1287
  modifiedAt: string;
1705
1288
  source: "session" | "pdf";
1289
+ id: string;
1290
+ page: number;
1706
1291
  type: "redact";
1707
- origin: "user" | "suggested";
1708
- interiorColor: string;
1709
- author?: string | undefined;
1710
- contents?: string | undefined;
1711
- inReplyTo?: string | undefined;
1712
- locked?: boolean | undefined;
1713
- subject?: string | undefined;
1714
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1715
- custom?: Record<string, unknown> | undefined;
1716
1292
  quads?: {
1717
1293
  p1: {
1718
1294
  x: number;
@@ -1731,30 +1307,17 @@ export declare function useAnnotations(): {
1731
1307
  y: number;
1732
1308
  };
1733
1309
  }[] | undefined;
1734
- suggestion?: {
1735
- confidence: number;
1736
- jobId?: string | undefined;
1737
- reason?: string | undefined;
1738
- explanation?: string | undefined;
1739
- recommendation?: "redact" | "review" | "keep" | undefined;
1740
- } | undefined;
1310
+ locked?: boolean | undefined;
1741
1311
  overlayText?: string | undefined;
1312
+ author?: string | undefined;
1313
+ contents?: string | undefined;
1314
+ inReplyTo?: string | undefined;
1315
+ subject?: string | undefined;
1316
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1317
+ custom?: Record<string, unknown> | undefined;
1742
1318
  })[];
1743
1319
  selection: readonly string[];
1744
1320
  selected: ({
1745
- id: string;
1746
- page: number;
1747
- rect: {
1748
- x: number;
1749
- y: number;
1750
- width: number;
1751
- height: number;
1752
- };
1753
- color: string;
1754
- opacity: number;
1755
- createdAt: string;
1756
- modifiedAt: string;
1757
- source: "session" | "pdf";
1758
1321
  type: "highlight" | "underline" | "strikeout" | "squiggly";
1759
1322
  quads: {
1760
1323
  p1: {
@@ -1774,16 +1337,27 @@ export declare function useAnnotations(): {
1774
1337
  y: number;
1775
1338
  };
1776
1339
  }[];
1340
+ rect: {
1341
+ x: number;
1342
+ y: number;
1343
+ width: number;
1344
+ height: number;
1345
+ };
1346
+ color: string;
1347
+ opacity: number;
1348
+ createdAt: string;
1349
+ modifiedAt: string;
1350
+ source: "session" | "pdf";
1351
+ id: string;
1352
+ page: number;
1353
+ locked?: boolean | undefined;
1777
1354
  author?: string | undefined;
1778
1355
  contents?: string | undefined;
1779
1356
  inReplyTo?: string | undefined;
1780
- locked?: boolean | undefined;
1781
1357
  subject?: string | undefined;
1782
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1358
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1783
1359
  custom?: Record<string, unknown> | undefined;
1784
1360
  } | {
1785
- id: string;
1786
- page: number;
1787
1361
  rect: {
1788
1362
  x: number;
1789
1363
  y: number;
@@ -1795,18 +1369,28 @@ export declare function useAnnotations(): {
1795
1369
  createdAt: string;
1796
1370
  modifiedAt: string;
1797
1371
  source: "session" | "pdf";
1798
- type: "text";
1799
1372
  icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
1373
+ id: string;
1374
+ page: number;
1375
+ type: "text";
1376
+ locked?: boolean | undefined;
1800
1377
  author?: string | undefined;
1801
1378
  contents?: string | undefined;
1802
1379
  inReplyTo?: string | undefined;
1803
- locked?: boolean | undefined;
1804
1380
  subject?: string | undefined;
1805
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1381
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1806
1382
  custom?: Record<string, unknown> | undefined;
1807
1383
  } | {
1808
- id: string;
1809
- page: number;
1384
+ defaultStyle: {
1385
+ color: string;
1386
+ fontFamily: string;
1387
+ fontSize: number;
1388
+ textAlign: "left" | "right" | "center" | "justify";
1389
+ align?: undefined;
1390
+ fontWeight?: "bold" | undefined;
1391
+ fontStyle?: "italic" | undefined;
1392
+ textDecoration?: "underline" | undefined;
1393
+ };
1810
1394
  rect: {
1811
1395
  x: number;
1812
1396
  y: number;
@@ -1817,29 +1401,13 @@ export declare function useAnnotations(): {
1817
1401
  createdAt: string;
1818
1402
  modifiedAt: string;
1819
1403
  source: "session" | "pdf";
1820
- type: "freetext";
1821
1404
  contents: string;
1822
1405
  width: number;
1823
- defaultStyle: {
1824
- fontFamily: string;
1825
- fontSize: number;
1826
- color: string;
1827
- textAlign: "left" | "right" | "center" | "justify";
1828
- fontWeight?: "bold" | undefined;
1829
- fontStyle?: "italic" | undefined;
1830
- textDecoration?: "underline" | undefined;
1831
- align?: undefined;
1832
- };
1833
- author?: string | undefined;
1834
- inReplyTo?: string | undefined;
1835
- locked?: boolean | undefined;
1836
- subject?: string | undefined;
1837
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1838
- custom?: Record<string, unknown> | undefined;
1406
+ id: string;
1407
+ page: number;
1408
+ type: "freetext";
1839
1409
  color?: string | undefined;
1840
1410
  borderColor?: string | undefined;
1841
- dashes?: number[] | undefined;
1842
- cornerRadius?: number | undefined;
1843
1411
  fringe?: {
1844
1412
  left: number;
1845
1413
  top: number;
@@ -1850,13 +1418,19 @@ export declare function useAnnotations(): {
1850
1418
  x: number;
1851
1419
  y: number;
1852
1420
  }[] | undefined;
1853
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1854
1421
  fontFamily?: undefined;
1855
1422
  fontSize?: undefined;
1856
1423
  align?: undefined;
1424
+ locked?: boolean | undefined;
1425
+ dashes?: number[] | undefined;
1426
+ cornerRadius?: number | undefined;
1427
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1428
+ author?: string | undefined;
1429
+ inReplyTo?: string | undefined;
1430
+ subject?: string | undefined;
1431
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1432
+ custom?: Record<string, unknown> | undefined;
1857
1433
  } | {
1858
- id: string;
1859
- page: number;
1860
1434
  rect: {
1861
1435
  x: number;
1862
1436
  y: number;
@@ -1869,20 +1443,20 @@ export declare function useAnnotations(): {
1869
1443
  modifiedAt: string;
1870
1444
  source: "session" | "pdf";
1871
1445
  width: number;
1446
+ id: string;
1447
+ page: number;
1872
1448
  type: "square";
1449
+ locked?: boolean | undefined;
1450
+ dashes?: number[] | undefined;
1451
+ interiorColor?: string | undefined;
1452
+ cornerRadius?: number | undefined;
1873
1453
  author?: string | undefined;
1874
1454
  contents?: string | undefined;
1875
1455
  inReplyTo?: string | undefined;
1876
- locked?: boolean | undefined;
1877
1456
  subject?: string | undefined;
1878
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1457
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1879
1458
  custom?: Record<string, unknown> | undefined;
1880
- cornerRadius?: number | undefined;
1881
- dashes?: number[] | undefined;
1882
- interiorColor?: string | undefined;
1883
1459
  } | {
1884
- id: string;
1885
- page: number;
1886
1460
  rect: {
1887
1461
  x: number;
1888
1462
  y: number;
@@ -1895,20 +1469,28 @@ export declare function useAnnotations(): {
1895
1469
  modifiedAt: string;
1896
1470
  source: "session" | "pdf";
1897
1471
  width: number;
1472
+ id: string;
1473
+ page: number;
1898
1474
  type: "circle";
1475
+ cornerRadius?: undefined;
1476
+ locked?: boolean | undefined;
1477
+ dashes?: number[] | undefined;
1478
+ interiorColor?: string | undefined;
1899
1479
  author?: string | undefined;
1900
1480
  contents?: string | undefined;
1901
1481
  inReplyTo?: string | undefined;
1902
- locked?: boolean | undefined;
1903
1482
  subject?: string | undefined;
1904
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1483
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1905
1484
  custom?: Record<string, unknown> | undefined;
1906
- cornerRadius?: undefined;
1907
- dashes?: number[] | undefined;
1908
- interiorColor?: string | undefined;
1909
1485
  } | {
1910
- id: string;
1911
- page: number;
1486
+ start: {
1487
+ x: number;
1488
+ y: number;
1489
+ };
1490
+ end: {
1491
+ x: number;
1492
+ y: number;
1493
+ };
1912
1494
  rect: {
1913
1495
  x: number;
1914
1496
  y: number;
@@ -1920,29 +1502,25 @@ export declare function useAnnotations(): {
1920
1502
  createdAt: string;
1921
1503
  modifiedAt: string;
1922
1504
  source: "session" | "pdf";
1923
- type: "line";
1924
- start: {
1925
- x: number;
1926
- y: number;
1927
- };
1928
- end: {
1929
- x: number;
1930
- y: number;
1931
- };
1932
1505
  width: number;
1506
+ id: string;
1507
+ page: number;
1508
+ type: "line";
1509
+ locked?: boolean | undefined;
1510
+ dashes?: number[] | undefined;
1511
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1512
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1933
1513
  author?: string | undefined;
1934
1514
  contents?: string | undefined;
1935
1515
  inReplyTo?: string | undefined;
1936
- locked?: boolean | undefined;
1937
1516
  subject?: string | undefined;
1938
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1517
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1939
1518
  custom?: Record<string, unknown> | undefined;
1940
- dashes?: number[] | undefined;
1941
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1942
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1943
1519
  } | {
1944
- id: string;
1945
- page: number;
1520
+ vertices: {
1521
+ x: number;
1522
+ y: number;
1523
+ }[];
1946
1524
  rect: {
1947
1525
  x: number;
1948
1526
  y: number;
@@ -1954,26 +1532,26 @@ export declare function useAnnotations(): {
1954
1532
  createdAt: string;
1955
1533
  modifiedAt: string;
1956
1534
  source: "session" | "pdf";
1957
- vertices: {
1958
- x: number;
1959
- y: number;
1960
- }[];
1961
1535
  width: number;
1536
+ id: string;
1537
+ page: number;
1962
1538
  type: "polyline";
1539
+ locked?: boolean | undefined;
1540
+ dashes?: number[] | undefined;
1541
+ interiorColor?: string | undefined;
1542
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1543
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1963
1544
  author?: string | undefined;
1964
1545
  contents?: string | undefined;
1965
1546
  inReplyTo?: string | undefined;
1966
- locked?: boolean | undefined;
1967
1547
  subject?: string | undefined;
1968
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1548
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1969
1549
  custom?: Record<string, unknown> | undefined;
1970
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1971
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1972
- dashes?: number[] | undefined;
1973
- interiorColor?: string | undefined;
1974
1550
  } | {
1975
- id: string;
1976
- page: number;
1551
+ vertices: {
1552
+ x: number;
1553
+ y: number;
1554
+ }[];
1977
1555
  rect: {
1978
1556
  x: number;
1979
1557
  y: number;
@@ -1985,26 +1563,26 @@ export declare function useAnnotations(): {
1985
1563
  createdAt: string;
1986
1564
  modifiedAt: string;
1987
1565
  source: "session" | "pdf";
1988
- vertices: {
1989
- x: number;
1990
- y: number;
1991
- }[];
1992
1566
  width: number;
1567
+ id: string;
1568
+ page: number;
1993
1569
  type: "polygon";
1570
+ head?: undefined;
1571
+ tail?: undefined;
1572
+ locked?: boolean | undefined;
1573
+ dashes?: number[] | undefined;
1574
+ interiorColor?: string | undefined;
1994
1575
  author?: string | undefined;
1995
1576
  contents?: string | undefined;
1996
1577
  inReplyTo?: string | undefined;
1997
- locked?: boolean | undefined;
1998
1578
  subject?: string | undefined;
1999
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1579
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2000
1580
  custom?: Record<string, unknown> | undefined;
2001
- head?: undefined;
2002
- tail?: undefined;
2003
- dashes?: number[] | undefined;
2004
- interiorColor?: string | undefined;
2005
1581
  } | {
2006
- id: string;
2007
- page: number;
1582
+ inklist: {
1583
+ x: number;
1584
+ y: number;
1585
+ }[][];
2008
1586
  rect: {
2009
1587
  x: number;
2010
1588
  y: number;
@@ -2016,24 +1594,20 @@ export declare function useAnnotations(): {
2016
1594
  createdAt: string;
2017
1595
  modifiedAt: string;
2018
1596
  source: "session" | "pdf";
2019
- type: "ink";
2020
- inklist: {
2021
- x: number;
2022
- y: number;
2023
- }[][];
2024
1597
  width: number;
1598
+ id: string;
1599
+ page: number;
1600
+ type: "ink";
1601
+ pressure?: number[][] | undefined;
1602
+ locked?: boolean | undefined;
1603
+ dashes?: number[] | undefined;
2025
1604
  author?: string | undefined;
2026
1605
  contents?: string | undefined;
2027
1606
  inReplyTo?: string | undefined;
2028
- locked?: boolean | undefined;
2029
1607
  subject?: string | undefined;
2030
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1608
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2031
1609
  custom?: Record<string, unknown> | undefined;
2032
- pressure?: number[][] | undefined;
2033
- dashes?: number[] | undefined;
2034
1610
  } | {
2035
- id: string;
2036
- page: number;
2037
1611
  rect: {
2038
1612
  x: number;
2039
1613
  y: number;
@@ -2045,19 +1619,19 @@ export declare function useAnnotations(): {
2045
1619
  createdAt: string;
2046
1620
  modifiedAt: string;
2047
1621
  source: "session" | "pdf";
2048
- type: "stamp";
2049
1622
  imagedata: string;
1623
+ id: string;
1624
+ page: number;
1625
+ type: "stamp";
1626
+ locked?: boolean | undefined;
1627
+ rotation?: 0 | 90 | 180 | 270 | undefined;
2050
1628
  author?: string | undefined;
2051
1629
  contents?: string | undefined;
2052
1630
  inReplyTo?: string | undefined;
2053
- locked?: boolean | undefined;
2054
1631
  subject?: string | undefined;
2055
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1632
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2056
1633
  custom?: Record<string, unknown> | undefined;
2057
- rotation?: 0 | 90 | 180 | 270 | undefined;
2058
1634
  } | {
2059
- id: string;
2060
- page: number;
2061
1635
  rect: {
2062
1636
  x: number;
2063
1637
  y: number;
@@ -2069,19 +1643,19 @@ export declare function useAnnotations(): {
2069
1643
  createdAt: string;
2070
1644
  modifiedAt: string;
2071
1645
  source: "session" | "pdf";
2072
- type: "loupe";
2073
1646
  magnification: number;
2074
1647
  width: number;
1648
+ id: string;
1649
+ page: number;
1650
+ type: "loupe";
1651
+ locked?: boolean | undefined;
2075
1652
  author?: string | undefined;
2076
1653
  contents?: string | undefined;
2077
1654
  inReplyTo?: string | undefined;
2078
- locked?: boolean | undefined;
2079
1655
  subject?: string | undefined;
2080
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1656
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2081
1657
  custom?: Record<string, unknown> | undefined;
2082
1658
  } | {
2083
- id: string;
2084
- page: number;
2085
1659
  rect: {
2086
1660
  x: number;
2087
1661
  y: number;
@@ -2093,19 +1667,20 @@ export declare function useAnnotations(): {
2093
1667
  createdAt: string;
2094
1668
  modifiedAt: string;
2095
1669
  source: "session" | "pdf";
2096
- type: "mask";
2097
1670
  shape: "rect" | "ellipse";
2098
1671
  dim: number;
1672
+ id: string;
1673
+ page: number;
1674
+ type: "mask";
1675
+ locked?: boolean | undefined;
2099
1676
  author?: string | undefined;
2100
1677
  contents?: string | undefined;
2101
1678
  inReplyTo?: string | undefined;
2102
- locked?: boolean | undefined;
2103
1679
  subject?: string | undefined;
2104
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1680
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2105
1681
  custom?: Record<string, unknown> | undefined;
2106
1682
  } | {
2107
- id: string;
2108
- page: number;
1683
+ interiorColor: string;
2109
1684
  rect: {
2110
1685
  x: number;
2111
1686
  y: number;
@@ -2117,16 +1692,9 @@ export declare function useAnnotations(): {
2117
1692
  createdAt: string;
2118
1693
  modifiedAt: string;
2119
1694
  source: "session" | "pdf";
1695
+ id: string;
1696
+ page: number;
2120
1697
  type: "redact";
2121
- origin: "user" | "suggested";
2122
- interiorColor: string;
2123
- author?: string | undefined;
2124
- contents?: string | undefined;
2125
- inReplyTo?: string | undefined;
2126
- locked?: boolean | undefined;
2127
- subject?: string | undefined;
2128
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2129
- custom?: Record<string, unknown> | undefined;
2130
1698
  quads?: {
2131
1699
  p1: {
2132
1700
  x: number;
@@ -2145,29 +1713,16 @@ export declare function useAnnotations(): {
2145
1713
  y: number;
2146
1714
  };
2147
1715
  }[] | undefined;
2148
- suggestion?: {
2149
- confidence: number;
2150
- jobId?: string | undefined;
2151
- reason?: string | undefined;
2152
- explanation?: string | undefined;
2153
- recommendation?: "redact" | "review" | "keep" | undefined;
2154
- } | undefined;
1716
+ locked?: boolean | undefined;
2155
1717
  overlayText?: string | undefined;
1718
+ author?: string | undefined;
1719
+ contents?: string | undefined;
1720
+ inReplyTo?: string | undefined;
1721
+ subject?: string | undefined;
1722
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1723
+ custom?: Record<string, unknown> | undefined;
2156
1724
  })[];
2157
1725
  byPage: (page: number) => ({
2158
- id: string;
2159
- page: number;
2160
- rect: {
2161
- x: number;
2162
- y: number;
2163
- width: number;
2164
- height: number;
2165
- };
2166
- color: string;
2167
- opacity: number;
2168
- createdAt: string;
2169
- modifiedAt: string;
2170
- source: "session" | "pdf";
2171
1726
  type: "highlight" | "underline" | "strikeout" | "squiggly";
2172
1727
  quads: {
2173
1728
  p1: {
@@ -2187,16 +1742,27 @@ export declare function useAnnotations(): {
2187
1742
  y: number;
2188
1743
  };
2189
1744
  }[];
1745
+ rect: {
1746
+ x: number;
1747
+ y: number;
1748
+ width: number;
1749
+ height: number;
1750
+ };
1751
+ color: string;
1752
+ opacity: number;
1753
+ createdAt: string;
1754
+ modifiedAt: string;
1755
+ source: "session" | "pdf";
1756
+ id: string;
1757
+ page: number;
1758
+ locked?: boolean | undefined;
2190
1759
  author?: string | undefined;
2191
1760
  contents?: string | undefined;
2192
1761
  inReplyTo?: string | undefined;
2193
- locked?: boolean | undefined;
2194
1762
  subject?: string | undefined;
2195
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1763
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2196
1764
  custom?: Record<string, unknown> | undefined;
2197
1765
  } | {
2198
- id: string;
2199
- page: number;
2200
1766
  rect: {
2201
1767
  x: number;
2202
1768
  y: number;
@@ -2208,18 +1774,28 @@ export declare function useAnnotations(): {
2208
1774
  createdAt: string;
2209
1775
  modifiedAt: string;
2210
1776
  source: "session" | "pdf";
2211
- type: "text";
2212
1777
  icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
1778
+ id: string;
1779
+ page: number;
1780
+ type: "text";
1781
+ locked?: boolean | undefined;
2213
1782
  author?: string | undefined;
2214
1783
  contents?: string | undefined;
2215
1784
  inReplyTo?: string | undefined;
2216
- locked?: boolean | undefined;
2217
1785
  subject?: string | undefined;
2218
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1786
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2219
1787
  custom?: Record<string, unknown> | undefined;
2220
1788
  } | {
2221
- id: string;
2222
- page: number;
1789
+ defaultStyle: {
1790
+ color: string;
1791
+ fontFamily: string;
1792
+ fontSize: number;
1793
+ textAlign: "left" | "right" | "center" | "justify";
1794
+ align?: undefined;
1795
+ fontWeight?: "bold" | undefined;
1796
+ fontStyle?: "italic" | undefined;
1797
+ textDecoration?: "underline" | undefined;
1798
+ };
2223
1799
  rect: {
2224
1800
  x: number;
2225
1801
  y: number;
@@ -2230,29 +1806,13 @@ export declare function useAnnotations(): {
2230
1806
  createdAt: string;
2231
1807
  modifiedAt: string;
2232
1808
  source: "session" | "pdf";
2233
- type: "freetext";
2234
1809
  contents: string;
2235
1810
  width: number;
2236
- defaultStyle: {
2237
- fontFamily: string;
2238
- fontSize: number;
2239
- color: string;
2240
- textAlign: "left" | "right" | "center" | "justify";
2241
- fontWeight?: "bold" | undefined;
2242
- fontStyle?: "italic" | undefined;
2243
- textDecoration?: "underline" | undefined;
2244
- align?: undefined;
2245
- };
2246
- author?: string | undefined;
2247
- inReplyTo?: string | undefined;
2248
- locked?: boolean | undefined;
2249
- subject?: string | undefined;
2250
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2251
- custom?: Record<string, unknown> | undefined;
1811
+ id: string;
1812
+ page: number;
1813
+ type: "freetext";
2252
1814
  color?: string | undefined;
2253
1815
  borderColor?: string | undefined;
2254
- dashes?: number[] | undefined;
2255
- cornerRadius?: number | undefined;
2256
1816
  fringe?: {
2257
1817
  left: number;
2258
1818
  top: number;
@@ -2263,13 +1823,19 @@ export declare function useAnnotations(): {
2263
1823
  x: number;
2264
1824
  y: number;
2265
1825
  }[] | undefined;
2266
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2267
1826
  fontFamily?: undefined;
2268
1827
  fontSize?: undefined;
2269
1828
  align?: undefined;
1829
+ locked?: boolean | undefined;
1830
+ dashes?: number[] | undefined;
1831
+ cornerRadius?: number | undefined;
1832
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1833
+ author?: string | undefined;
1834
+ inReplyTo?: string | undefined;
1835
+ subject?: string | undefined;
1836
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
1837
+ custom?: Record<string, unknown> | undefined;
2270
1838
  } | {
2271
- id: string;
2272
- page: number;
2273
1839
  rect: {
2274
1840
  x: number;
2275
1841
  y: number;
@@ -2282,20 +1848,20 @@ export declare function useAnnotations(): {
2282
1848
  modifiedAt: string;
2283
1849
  source: "session" | "pdf";
2284
1850
  width: number;
1851
+ id: string;
1852
+ page: number;
2285
1853
  type: "square";
1854
+ locked?: boolean | undefined;
1855
+ dashes?: number[] | undefined;
1856
+ interiorColor?: string | undefined;
1857
+ cornerRadius?: number | undefined;
2286
1858
  author?: string | undefined;
2287
1859
  contents?: string | undefined;
2288
1860
  inReplyTo?: string | undefined;
2289
- locked?: boolean | undefined;
2290
1861
  subject?: string | undefined;
2291
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1862
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2292
1863
  custom?: Record<string, unknown> | undefined;
2293
- cornerRadius?: number | undefined;
2294
- dashes?: number[] | undefined;
2295
- interiorColor?: string | undefined;
2296
1864
  } | {
2297
- id: string;
2298
- page: number;
2299
1865
  rect: {
2300
1866
  x: number;
2301
1867
  y: number;
@@ -2308,20 +1874,28 @@ export declare function useAnnotations(): {
2308
1874
  modifiedAt: string;
2309
1875
  source: "session" | "pdf";
2310
1876
  width: number;
1877
+ id: string;
1878
+ page: number;
2311
1879
  type: "circle";
1880
+ cornerRadius?: undefined;
1881
+ locked?: boolean | undefined;
1882
+ dashes?: number[] | undefined;
1883
+ interiorColor?: string | undefined;
2312
1884
  author?: string | undefined;
2313
1885
  contents?: string | undefined;
2314
1886
  inReplyTo?: string | undefined;
2315
- locked?: boolean | undefined;
2316
1887
  subject?: string | undefined;
2317
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1888
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2318
1889
  custom?: Record<string, unknown> | undefined;
2319
- cornerRadius?: undefined;
2320
- dashes?: number[] | undefined;
2321
- interiorColor?: string | undefined;
2322
1890
  } | {
2323
- id: string;
2324
- page: number;
1891
+ start: {
1892
+ x: number;
1893
+ y: number;
1894
+ };
1895
+ end: {
1896
+ x: number;
1897
+ y: number;
1898
+ };
2325
1899
  rect: {
2326
1900
  x: number;
2327
1901
  y: number;
@@ -2333,29 +1907,25 @@ export declare function useAnnotations(): {
2333
1907
  createdAt: string;
2334
1908
  modifiedAt: string;
2335
1909
  source: "session" | "pdf";
2336
- type: "line";
2337
- start: {
2338
- x: number;
2339
- y: number;
2340
- };
2341
- end: {
2342
- x: number;
2343
- y: number;
2344
- };
2345
1910
  width: number;
1911
+ id: string;
1912
+ page: number;
1913
+ type: "line";
1914
+ locked?: boolean | undefined;
1915
+ dashes?: number[] | undefined;
1916
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1917
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2346
1918
  author?: string | undefined;
2347
1919
  contents?: string | undefined;
2348
1920
  inReplyTo?: string | undefined;
2349
- locked?: boolean | undefined;
2350
1921
  subject?: string | undefined;
2351
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1922
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2352
1923
  custom?: Record<string, unknown> | undefined;
2353
- dashes?: number[] | undefined;
2354
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2355
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2356
1924
  } | {
2357
- id: string;
2358
- page: number;
1925
+ vertices: {
1926
+ x: number;
1927
+ y: number;
1928
+ }[];
2359
1929
  rect: {
2360
1930
  x: number;
2361
1931
  y: number;
@@ -2367,26 +1937,26 @@ export declare function useAnnotations(): {
2367
1937
  createdAt: string;
2368
1938
  modifiedAt: string;
2369
1939
  source: "session" | "pdf";
2370
- vertices: {
2371
- x: number;
2372
- y: number;
2373
- }[];
2374
1940
  width: number;
1941
+ id: string;
1942
+ page: number;
2375
1943
  type: "polyline";
1944
+ locked?: boolean | undefined;
1945
+ dashes?: number[] | undefined;
1946
+ interiorColor?: string | undefined;
1947
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
1948
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2376
1949
  author?: string | undefined;
2377
1950
  contents?: string | undefined;
2378
1951
  inReplyTo?: string | undefined;
2379
- locked?: boolean | undefined;
2380
1952
  subject?: string | undefined;
2381
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1953
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2382
1954
  custom?: Record<string, unknown> | undefined;
2383
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2384
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2385
- dashes?: number[] | undefined;
2386
- interiorColor?: string | undefined;
2387
1955
  } | {
2388
- id: string;
2389
- page: number;
1956
+ vertices: {
1957
+ x: number;
1958
+ y: number;
1959
+ }[];
2390
1960
  rect: {
2391
1961
  x: number;
2392
1962
  y: number;
@@ -2398,26 +1968,26 @@ export declare function useAnnotations(): {
2398
1968
  createdAt: string;
2399
1969
  modifiedAt: string;
2400
1970
  source: "session" | "pdf";
2401
- vertices: {
2402
- x: number;
2403
- y: number;
2404
- }[];
2405
1971
  width: number;
1972
+ id: string;
1973
+ page: number;
2406
1974
  type: "polygon";
1975
+ head?: undefined;
1976
+ tail?: undefined;
1977
+ locked?: boolean | undefined;
1978
+ dashes?: number[] | undefined;
1979
+ interiorColor?: string | undefined;
2407
1980
  author?: string | undefined;
2408
1981
  contents?: string | undefined;
2409
1982
  inReplyTo?: string | undefined;
2410
- locked?: boolean | undefined;
2411
1983
  subject?: string | undefined;
2412
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
1984
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2413
1985
  custom?: Record<string, unknown> | undefined;
2414
- head?: undefined;
2415
- tail?: undefined;
2416
- dashes?: number[] | undefined;
2417
- interiorColor?: string | undefined;
2418
1986
  } | {
2419
- id: string;
2420
- page: number;
1987
+ inklist: {
1988
+ x: number;
1989
+ y: number;
1990
+ }[][];
2421
1991
  rect: {
2422
1992
  x: number;
2423
1993
  y: number;
@@ -2429,24 +1999,20 @@ export declare function useAnnotations(): {
2429
1999
  createdAt: string;
2430
2000
  modifiedAt: string;
2431
2001
  source: "session" | "pdf";
2432
- type: "ink";
2433
- inklist: {
2434
- x: number;
2435
- y: number;
2436
- }[][];
2437
2002
  width: number;
2003
+ id: string;
2004
+ page: number;
2005
+ type: "ink";
2006
+ pressure?: number[][] | undefined;
2007
+ locked?: boolean | undefined;
2008
+ dashes?: number[] | undefined;
2438
2009
  author?: string | undefined;
2439
2010
  contents?: string | undefined;
2440
2011
  inReplyTo?: string | undefined;
2441
- locked?: boolean | undefined;
2442
2012
  subject?: string | undefined;
2443
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2013
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2444
2014
  custom?: Record<string, unknown> | undefined;
2445
- pressure?: number[][] | undefined;
2446
- dashes?: number[] | undefined;
2447
2015
  } | {
2448
- id: string;
2449
- page: number;
2450
2016
  rect: {
2451
2017
  x: number;
2452
2018
  y: number;
@@ -2458,19 +2024,19 @@ export declare function useAnnotations(): {
2458
2024
  createdAt: string;
2459
2025
  modifiedAt: string;
2460
2026
  source: "session" | "pdf";
2461
- type: "stamp";
2462
2027
  imagedata: string;
2028
+ id: string;
2029
+ page: number;
2030
+ type: "stamp";
2031
+ locked?: boolean | undefined;
2032
+ rotation?: 0 | 90 | 180 | 270 | undefined;
2463
2033
  author?: string | undefined;
2464
2034
  contents?: string | undefined;
2465
2035
  inReplyTo?: string | undefined;
2466
- locked?: boolean | undefined;
2467
2036
  subject?: string | undefined;
2468
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2037
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2469
2038
  custom?: Record<string, unknown> | undefined;
2470
- rotation?: 0 | 90 | 180 | 270 | undefined;
2471
2039
  } | {
2472
- id: string;
2473
- page: number;
2474
2040
  rect: {
2475
2041
  x: number;
2476
2042
  y: number;
@@ -2482,19 +2048,19 @@ export declare function useAnnotations(): {
2482
2048
  createdAt: string;
2483
2049
  modifiedAt: string;
2484
2050
  source: "session" | "pdf";
2485
- type: "loupe";
2486
2051
  magnification: number;
2487
2052
  width: number;
2053
+ id: string;
2054
+ page: number;
2055
+ type: "loupe";
2056
+ locked?: boolean | undefined;
2488
2057
  author?: string | undefined;
2489
2058
  contents?: string | undefined;
2490
2059
  inReplyTo?: string | undefined;
2491
- locked?: boolean | undefined;
2492
2060
  subject?: string | undefined;
2493
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2061
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2494
2062
  custom?: Record<string, unknown> | undefined;
2495
2063
  } | {
2496
- id: string;
2497
- page: number;
2498
2064
  rect: {
2499
2065
  x: number;
2500
2066
  y: number;
@@ -2506,19 +2072,20 @@ export declare function useAnnotations(): {
2506
2072
  createdAt: string;
2507
2073
  modifiedAt: string;
2508
2074
  source: "session" | "pdf";
2509
- type: "mask";
2510
2075
  shape: "rect" | "ellipse";
2511
2076
  dim: number;
2077
+ id: string;
2078
+ page: number;
2079
+ type: "mask";
2080
+ locked?: boolean | undefined;
2512
2081
  author?: string | undefined;
2513
2082
  contents?: string | undefined;
2514
2083
  inReplyTo?: string | undefined;
2515
- locked?: boolean | undefined;
2516
2084
  subject?: string | undefined;
2517
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2085
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2518
2086
  custom?: Record<string, unknown> | undefined;
2519
2087
  } | {
2520
- id: string;
2521
- page: number;
2088
+ interiorColor: string;
2522
2089
  rect: {
2523
2090
  x: number;
2524
2091
  y: number;
@@ -2529,17 +2096,10 @@ export declare function useAnnotations(): {
2529
2096
  opacity: number;
2530
2097
  createdAt: string;
2531
2098
  modifiedAt: string;
2532
- source: "session" | "pdf";
2533
- type: "redact";
2534
- origin: "user" | "suggested";
2535
- interiorColor: string;
2536
- author?: string | undefined;
2537
- contents?: string | undefined;
2538
- inReplyTo?: string | undefined;
2539
- locked?: boolean | undefined;
2540
- subject?: string | undefined;
2541
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2542
- custom?: Record<string, unknown> | undefined;
2099
+ source: "session" | "pdf";
2100
+ id: string;
2101
+ page: number;
2102
+ type: "redact";
2543
2103
  quads?: {
2544
2104
  p1: {
2545
2105
  x: number;
@@ -2558,30 +2118,17 @@ export declare function useAnnotations(): {
2558
2118
  y: number;
2559
2119
  };
2560
2120
  }[] | undefined;
2561
- suggestion?: {
2562
- confidence: number;
2563
- jobId?: string | undefined;
2564
- reason?: string | undefined;
2565
- explanation?: string | undefined;
2566
- recommendation?: "redact" | "review" | "keep" | undefined;
2567
- } | undefined;
2121
+ locked?: boolean | undefined;
2568
2122
  overlayText?: string | undefined;
2123
+ author?: string | undefined;
2124
+ contents?: string | undefined;
2125
+ inReplyTo?: string | undefined;
2126
+ subject?: string | undefined;
2127
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2128
+ custom?: Record<string, unknown> | undefined;
2569
2129
  })[];
2570
2130
  /** Replies in creation order for a note id. */
2571
2131
  replies: (id: string) => ({
2572
- id: string;
2573
- page: number;
2574
- rect: {
2575
- x: number;
2576
- y: number;
2577
- width: number;
2578
- height: number;
2579
- };
2580
- color: string;
2581
- opacity: number;
2582
- createdAt: string;
2583
- modifiedAt: string;
2584
- source: "session" | "pdf";
2585
2132
  type: "highlight" | "underline" | "strikeout" | "squiggly";
2586
2133
  quads: {
2587
2134
  p1: {
@@ -2601,16 +2148,27 @@ export declare function useAnnotations(): {
2601
2148
  y: number;
2602
2149
  };
2603
2150
  }[];
2151
+ rect: {
2152
+ x: number;
2153
+ y: number;
2154
+ width: number;
2155
+ height: number;
2156
+ };
2157
+ color: string;
2158
+ opacity: number;
2159
+ createdAt: string;
2160
+ modifiedAt: string;
2161
+ source: "session" | "pdf";
2162
+ id: string;
2163
+ page: number;
2164
+ locked?: boolean | undefined;
2604
2165
  author?: string | undefined;
2605
2166
  contents?: string | undefined;
2606
2167
  inReplyTo?: string | undefined;
2607
- locked?: boolean | undefined;
2608
2168
  subject?: string | undefined;
2609
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2169
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2610
2170
  custom?: Record<string, unknown> | undefined;
2611
2171
  } | {
2612
- id: string;
2613
- page: number;
2614
2172
  rect: {
2615
2173
  x: number;
2616
2174
  y: number;
@@ -2622,18 +2180,28 @@ export declare function useAnnotations(): {
2622
2180
  createdAt: string;
2623
2181
  modifiedAt: string;
2624
2182
  source: "session" | "pdf";
2625
- type: "text";
2626
2183
  icon: (string & {}) | "Comment" | "Note" | "Help" | "Insert" | "Key" | "NewParagraph" | "Paragraph";
2184
+ id: string;
2185
+ page: number;
2186
+ type: "text";
2187
+ locked?: boolean | undefined;
2627
2188
  author?: string | undefined;
2628
2189
  contents?: string | undefined;
2629
2190
  inReplyTo?: string | undefined;
2630
- locked?: boolean | undefined;
2631
2191
  subject?: string | undefined;
2632
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2192
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2633
2193
  custom?: Record<string, unknown> | undefined;
2634
2194
  } | {
2635
- id: string;
2636
- page: number;
2195
+ defaultStyle: {
2196
+ color: string;
2197
+ fontFamily: string;
2198
+ fontSize: number;
2199
+ textAlign: "left" | "right" | "center" | "justify";
2200
+ align?: undefined;
2201
+ fontWeight?: "bold" | undefined;
2202
+ fontStyle?: "italic" | undefined;
2203
+ textDecoration?: "underline" | undefined;
2204
+ };
2637
2205
  rect: {
2638
2206
  x: number;
2639
2207
  y: number;
@@ -2644,29 +2212,13 @@ export declare function useAnnotations(): {
2644
2212
  createdAt: string;
2645
2213
  modifiedAt: string;
2646
2214
  source: "session" | "pdf";
2647
- type: "freetext";
2648
2215
  contents: string;
2649
2216
  width: number;
2650
- defaultStyle: {
2651
- fontFamily: string;
2652
- fontSize: number;
2653
- color: string;
2654
- textAlign: "left" | "right" | "center" | "justify";
2655
- fontWeight?: "bold" | undefined;
2656
- fontStyle?: "italic" | undefined;
2657
- textDecoration?: "underline" | undefined;
2658
- align?: undefined;
2659
- };
2660
- author?: string | undefined;
2661
- inReplyTo?: string | undefined;
2662
- locked?: boolean | undefined;
2663
- subject?: string | undefined;
2664
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2665
- custom?: Record<string, unknown> | undefined;
2217
+ id: string;
2218
+ page: number;
2219
+ type: "freetext";
2666
2220
  color?: string | undefined;
2667
2221
  borderColor?: string | undefined;
2668
- dashes?: number[] | undefined;
2669
- cornerRadius?: number | undefined;
2670
2222
  fringe?: {
2671
2223
  left: number;
2672
2224
  top: number;
@@ -2677,13 +2229,19 @@ export declare function useAnnotations(): {
2677
2229
  x: number;
2678
2230
  y: number;
2679
2231
  }[] | undefined;
2680
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2681
2232
  fontFamily?: undefined;
2682
2233
  fontSize?: undefined;
2683
2234
  align?: undefined;
2235
+ locked?: boolean | undefined;
2236
+ dashes?: number[] | undefined;
2237
+ cornerRadius?: number | undefined;
2238
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2239
+ author?: string | undefined;
2240
+ inReplyTo?: string | undefined;
2241
+ subject?: string | undefined;
2242
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2243
+ custom?: Record<string, unknown> | undefined;
2684
2244
  } | {
2685
- id: string;
2686
- page: number;
2687
2245
  rect: {
2688
2246
  x: number;
2689
2247
  y: number;
@@ -2696,20 +2254,20 @@ export declare function useAnnotations(): {
2696
2254
  modifiedAt: string;
2697
2255
  source: "session" | "pdf";
2698
2256
  width: number;
2257
+ id: string;
2258
+ page: number;
2699
2259
  type: "square";
2260
+ locked?: boolean | undefined;
2261
+ dashes?: number[] | undefined;
2262
+ interiorColor?: string | undefined;
2263
+ cornerRadius?: number | undefined;
2700
2264
  author?: string | undefined;
2701
2265
  contents?: string | undefined;
2702
2266
  inReplyTo?: string | undefined;
2703
- locked?: boolean | undefined;
2704
2267
  subject?: string | undefined;
2705
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2268
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2706
2269
  custom?: Record<string, unknown> | undefined;
2707
- cornerRadius?: number | undefined;
2708
- dashes?: number[] | undefined;
2709
- interiorColor?: string | undefined;
2710
2270
  } | {
2711
- id: string;
2712
- page: number;
2713
2271
  rect: {
2714
2272
  x: number;
2715
2273
  y: number;
@@ -2722,20 +2280,28 @@ export declare function useAnnotations(): {
2722
2280
  modifiedAt: string;
2723
2281
  source: "session" | "pdf";
2724
2282
  width: number;
2283
+ id: string;
2284
+ page: number;
2725
2285
  type: "circle";
2286
+ cornerRadius?: undefined;
2287
+ locked?: boolean | undefined;
2288
+ dashes?: number[] | undefined;
2289
+ interiorColor?: string | undefined;
2726
2290
  author?: string | undefined;
2727
2291
  contents?: string | undefined;
2728
2292
  inReplyTo?: string | undefined;
2729
- locked?: boolean | undefined;
2730
2293
  subject?: string | undefined;
2731
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2294
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2732
2295
  custom?: Record<string, unknown> | undefined;
2733
- cornerRadius?: undefined;
2734
- dashes?: number[] | undefined;
2735
- interiorColor?: string | undefined;
2736
2296
  } | {
2737
- id: string;
2738
- page: number;
2297
+ start: {
2298
+ x: number;
2299
+ y: number;
2300
+ };
2301
+ end: {
2302
+ x: number;
2303
+ y: number;
2304
+ };
2739
2305
  rect: {
2740
2306
  x: number;
2741
2307
  y: number;
@@ -2747,29 +2313,25 @@ export declare function useAnnotations(): {
2747
2313
  createdAt: string;
2748
2314
  modifiedAt: string;
2749
2315
  source: "session" | "pdf";
2750
- type: "line";
2751
- start: {
2752
- x: number;
2753
- y: number;
2754
- };
2755
- end: {
2756
- x: number;
2757
- y: number;
2758
- };
2759
2316
  width: number;
2317
+ id: string;
2318
+ page: number;
2319
+ type: "line";
2320
+ locked?: boolean | undefined;
2321
+ dashes?: number[] | undefined;
2322
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2323
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2760
2324
  author?: string | undefined;
2761
2325
  contents?: string | undefined;
2762
2326
  inReplyTo?: string | undefined;
2763
- locked?: boolean | undefined;
2764
2327
  subject?: string | undefined;
2765
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2328
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2766
2329
  custom?: Record<string, unknown> | undefined;
2767
- dashes?: number[] | undefined;
2768
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2769
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2770
2330
  } | {
2771
- id: string;
2772
- page: number;
2331
+ vertices: {
2332
+ x: number;
2333
+ y: number;
2334
+ }[];
2773
2335
  rect: {
2774
2336
  x: number;
2775
2337
  y: number;
@@ -2781,26 +2343,26 @@ export declare function useAnnotations(): {
2781
2343
  createdAt: string;
2782
2344
  modifiedAt: string;
2783
2345
  source: "session" | "pdf";
2784
- vertices: {
2785
- x: number;
2786
- y: number;
2787
- }[];
2788
2346
  width: number;
2347
+ id: string;
2348
+ page: number;
2789
2349
  type: "polyline";
2350
+ locked?: boolean | undefined;
2351
+ dashes?: number[] | undefined;
2352
+ interiorColor?: string | undefined;
2353
+ head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2354
+ tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2790
2355
  author?: string | undefined;
2791
2356
  contents?: string | undefined;
2792
2357
  inReplyTo?: string | undefined;
2793
- locked?: boolean | undefined;
2794
2358
  subject?: string | undefined;
2795
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2359
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2796
2360
  custom?: Record<string, unknown> | undefined;
2797
- head?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2798
- tail?: (string & {}) | "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash" | undefined;
2799
- dashes?: number[] | undefined;
2800
- interiorColor?: string | undefined;
2801
2361
  } | {
2802
- id: string;
2803
- page: number;
2362
+ vertices: {
2363
+ x: number;
2364
+ y: number;
2365
+ }[];
2804
2366
  rect: {
2805
2367
  x: number;
2806
2368
  y: number;
@@ -2812,26 +2374,26 @@ export declare function useAnnotations(): {
2812
2374
  createdAt: string;
2813
2375
  modifiedAt: string;
2814
2376
  source: "session" | "pdf";
2815
- vertices: {
2816
- x: number;
2817
- y: number;
2818
- }[];
2819
2377
  width: number;
2378
+ id: string;
2379
+ page: number;
2820
2380
  type: "polygon";
2381
+ head?: undefined;
2382
+ tail?: undefined;
2383
+ locked?: boolean | undefined;
2384
+ dashes?: number[] | undefined;
2385
+ interiorColor?: string | undefined;
2821
2386
  author?: string | undefined;
2822
2387
  contents?: string | undefined;
2823
2388
  inReplyTo?: string | undefined;
2824
- locked?: boolean | undefined;
2825
2389
  subject?: string | undefined;
2826
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2390
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2827
2391
  custom?: Record<string, unknown> | undefined;
2828
- head?: undefined;
2829
- tail?: undefined;
2830
- dashes?: number[] | undefined;
2831
- interiorColor?: string | undefined;
2832
2392
  } | {
2833
- id: string;
2834
- page: number;
2393
+ inklist: {
2394
+ x: number;
2395
+ y: number;
2396
+ }[][];
2835
2397
  rect: {
2836
2398
  x: number;
2837
2399
  y: number;
@@ -2843,24 +2405,20 @@ export declare function useAnnotations(): {
2843
2405
  createdAt: string;
2844
2406
  modifiedAt: string;
2845
2407
  source: "session" | "pdf";
2846
- type: "ink";
2847
- inklist: {
2848
- x: number;
2849
- y: number;
2850
- }[][];
2851
2408
  width: number;
2409
+ id: string;
2410
+ page: number;
2411
+ type: "ink";
2412
+ pressure?: number[][] | undefined;
2413
+ locked?: boolean | undefined;
2414
+ dashes?: number[] | undefined;
2852
2415
  author?: string | undefined;
2853
2416
  contents?: string | undefined;
2854
2417
  inReplyTo?: string | undefined;
2855
- locked?: boolean | undefined;
2856
2418
  subject?: string | undefined;
2857
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2419
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2858
2420
  custom?: Record<string, unknown> | undefined;
2859
- pressure?: number[][] | undefined;
2860
- dashes?: number[] | undefined;
2861
2421
  } | {
2862
- id: string;
2863
- page: number;
2864
2422
  rect: {
2865
2423
  x: number;
2866
2424
  y: number;
@@ -2872,19 +2430,19 @@ export declare function useAnnotations(): {
2872
2430
  createdAt: string;
2873
2431
  modifiedAt: string;
2874
2432
  source: "session" | "pdf";
2875
- type: "stamp";
2876
2433
  imagedata: string;
2434
+ id: string;
2435
+ page: number;
2436
+ type: "stamp";
2437
+ locked?: boolean | undefined;
2438
+ rotation?: 0 | 90 | 180 | 270 | undefined;
2877
2439
  author?: string | undefined;
2878
2440
  contents?: string | undefined;
2879
2441
  inReplyTo?: string | undefined;
2880
- locked?: boolean | undefined;
2881
2442
  subject?: string | undefined;
2882
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2443
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2883
2444
  custom?: Record<string, unknown> | undefined;
2884
- rotation?: 0 | 90 | 180 | 270 | undefined;
2885
2445
  } | {
2886
- id: string;
2887
- page: number;
2888
2446
  rect: {
2889
2447
  x: number;
2890
2448
  y: number;
@@ -2896,19 +2454,19 @@ export declare function useAnnotations(): {
2896
2454
  createdAt: string;
2897
2455
  modifiedAt: string;
2898
2456
  source: "session" | "pdf";
2899
- type: "loupe";
2900
2457
  magnification: number;
2901
2458
  width: number;
2459
+ id: string;
2460
+ page: number;
2461
+ type: "loupe";
2462
+ locked?: boolean | undefined;
2902
2463
  author?: string | undefined;
2903
2464
  contents?: string | undefined;
2904
2465
  inReplyTo?: string | undefined;
2905
- locked?: boolean | undefined;
2906
2466
  subject?: string | undefined;
2907
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2467
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2908
2468
  custom?: Record<string, unknown> | undefined;
2909
2469
  } | {
2910
- id: string;
2911
- page: number;
2912
2470
  rect: {
2913
2471
  x: number;
2914
2472
  y: number;
@@ -2920,19 +2478,20 @@ export declare function useAnnotations(): {
2920
2478
  createdAt: string;
2921
2479
  modifiedAt: string;
2922
2480
  source: "session" | "pdf";
2923
- type: "mask";
2924
2481
  shape: "rect" | "ellipse";
2925
2482
  dim: number;
2483
+ id: string;
2484
+ page: number;
2485
+ type: "mask";
2486
+ locked?: boolean | undefined;
2926
2487
  author?: string | undefined;
2927
2488
  contents?: string | undefined;
2928
2489
  inReplyTo?: string | undefined;
2929
- locked?: boolean | undefined;
2930
2490
  subject?: string | undefined;
2931
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2491
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2932
2492
  custom?: Record<string, unknown> | undefined;
2933
2493
  } | {
2934
- id: string;
2935
- page: number;
2494
+ interiorColor: string;
2936
2495
  rect: {
2937
2496
  x: number;
2938
2497
  y: number;
@@ -2944,16 +2503,9 @@ export declare function useAnnotations(): {
2944
2503
  createdAt: string;
2945
2504
  modifiedAt: string;
2946
2505
  source: "session" | "pdf";
2506
+ id: string;
2507
+ page: number;
2947
2508
  type: "redact";
2948
- origin: "user" | "suggested";
2949
- interiorColor: string;
2950
- author?: string | undefined;
2951
- contents?: string | undefined;
2952
- inReplyTo?: string | undefined;
2953
- locked?: boolean | undefined;
2954
- subject?: string | undefined;
2955
- intent?: (string & {}) | "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | undefined;
2956
- custom?: Record<string, unknown> | undefined;
2957
2509
  quads?: {
2958
2510
  p1: {
2959
2511
  x: number;
@@ -2972,14 +2524,14 @@ export declare function useAnnotations(): {
2972
2524
  y: number;
2973
2525
  };
2974
2526
  }[] | undefined;
2975
- suggestion?: {
2976
- confidence: number;
2977
- jobId?: string | undefined;
2978
- reason?: string | undefined;
2979
- explanation?: string | undefined;
2980
- recommendation?: "redact" | "review" | "keep" | undefined;
2981
- } | undefined;
2527
+ locked?: boolean | undefined;
2982
2528
  overlayText?: string | undefined;
2529
+ author?: string | undefined;
2530
+ contents?: string | undefined;
2531
+ inReplyTo?: string | undefined;
2532
+ subject?: string | undefined;
2533
+ intent?: "FreeText" | "FreeTextCallout" | "FreeTextTypeWriter" | "LineArrow" | "LineDimension" | "PolygonCloud" | "PolygonDimension" | "PolyLineDimension" | (string & {}) | undefined;
2534
+ custom?: Record<string, unknown> | undefined;
2983
2535
  })[];
2984
2536
  };
2985
2537
  //#endregion
@@ -3097,6 +2649,13 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
3097
2649
  * document opens.
3098
2650
  */
3099
2651
  tools?: Tool[] | undefined;
2652
+ /**
2653
+ * Adds `data-*` attributes, classes and a screen-reader description to each annotation's
2654
+ * element (see `DecorateAnnotation`). Decorations re-apply whenever the annotations change
2655
+ * and when this prop changes, without rebuilding the viewer. Pass a new function when its
2656
+ * output would change for any other reason.
2657
+ */
2658
+ decorateAnnotation?: DecorateAnnotation$1 | undefined;
3100
2659
  /**
3101
2660
  * The font families text boxes offer, replacing the PDF standard families
3102
2661
  * (`FONT_FAMILIES`). Fonts beyond those are the PDF writer's to embed.
@@ -3126,7 +2685,7 @@ interface InkRootProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'
3126
2685
  }) => ReactNode);
3127
2686
  ref?: Ref<InkRootHandle>;
3128
2687
  }
3129
- export declare function InkRoot({ src, assets, password, defaults, annotations, onAnnotationsChange, onChange, tool, onToolChange, tools: hostTools, fonts: fontsProp, signatures: signatureStore, signatureFonts: signatureFontsProp, page, onPageChange, zoom, onZoomChange, history, asChild, onReady, onError, onActivate, children, ref, ...rest }: InkRootProps): import("react").JSX.Element;
2688
+ export declare function InkRoot({ src, assets, password, defaults, annotations, onAnnotationsChange, onChange, tool, onToolChange, tools: hostTools, decorateAnnotation, fonts: fontsProp, signatures: signatureStore, signatureFonts: signatureFontsProp, page, onPageChange, zoom, onZoomChange, history, asChild, onReady, onError, onActivate, children, ref, ...rest }: InkRootProps): import("react").JSX.Element;
3130
2689
  //#endregion
3131
2690
  //#region src/components/InkViewport.d.ts
3132
2691
  interface InkViewportProps extends ComponentPropsWithoutRef<'div'> {
@@ -3279,8 +2838,10 @@ interface InkColorMenuProps extends Omit<ComponentPropsWithoutRef<'button'>, 'ch
3279
2838
  * is active, and recolours the selection only when it is all in the group.
3280
2839
  */
3281
2840
  group?: StyleGroup;
2841
+ /** The colour new annotations get while the style leaves it unset; the swatch shows it. */
2842
+ fallback?: string | undefined;
3282
2843
  }
3283
- export declare function InkColorMenu({ property, label, className, children, standalone, group, disabled, ...rest }: InkColorMenuProps): import("react").JSX.Element;
2844
+ export declare function InkColorMenu({ property, label, className, children, standalone, group, fallback, disabled, ...rest }: InkColorMenuProps): import("react").JSX.Element;
3284
2845
  //#endregion
3285
2846
  //#region src/components/InkShapeMenu.d.ts
3286
2847
  interface InkShapeMenuProps extends Omit<ComponentPropsWithoutRef<'div'>, 'children'> {
@@ -3337,11 +2898,5 @@ interface InkThreadPopoverProps {
3337
2898
  }
3338
2899
  export declare function InkThreadPopover({ children }: InkThreadPopoverProps): import("react").JSX.Element;
3339
2900
  //#endregion
3340
- //#region src/components/InkSuggestionCard.d.ts
3341
- interface InkSuggestionCardProps {
3342
- children?: ((props: SuggestionCardSlotProps$1) => ReactNode) | undefined;
3343
- }
3344
- export declare function InkSuggestionCard({ children }: InkSuggestionCardProps): import("react").JSX.Element;
3345
- //#endregion
3346
- export type { AnnotationSlotProps, AnnotationState, ConfidenceBucket, InkAnnotationProps, InkColorMenuProps, InkContext, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkRootHandle, InkRootProps, InkShapeMenuProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkSuggestionCardProps, InkTextStyleMenuProps, InkThreadPopoverProps, InkToolButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, SuggestionCardSlotProps, ThreadPopoverSlotProps, ToolStyleHandle };
2901
+ export type { AnnotationDecoration, AnnotationSlotProps, AnnotationState, DecorateAnnotation, InkAnnotationProps, InkColorMenuProps, InkContext, InkHighlightMenuProps, InkHistory, InkHistoryButtonProps, InkIconProps, InkLineStyleMenuProps, InkPageButtonProps, InkPageInputProps, InkPageProps, InkRootHandle, InkRootProps, InkShapeMenuProps, InkSignatureDialogProps, InkSignatureMenuProps, InkStatus, InkTextStyleMenuProps, InkThreadPopoverProps, InkToolButtonProps, InkToolbarProps, InkToolbarSeparatorProps, InkViewportProps, InkZoomButtonProps, InkZoomSelectProps, ScopedToolStyleHandle, ThreadPopoverSlotProps, ToolStyleHandle };
3347
2902
  //# sourceMappingURL=index.d.mts.map