-
-
Notifications
You must be signed in to change notification settings - Fork 253
Expand file tree
/
Copy pathpdf.ts
More file actions
4188 lines (3898 loc) · 93.6 KB
/
pdf.ts
File metadata and controls
4188 lines (3898 loc) · 93.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { Size, Rect, Position, Rotation } from './geometry';
import { Task, TaskError } from './task';
/**
* Representation of pdf page
*
* @public
*/
export interface PdfPageObject {
/**
* Index of this page, starts from 0
*/
index: number;
/**
* Orignal size of this page
*/
size: Size;
/**
* Rotation of this page
*/
rotation: Rotation;
}
/**
* Representation of pdf page with rotated size
*
* @public
*/
export interface PdfPageObjectWithRotatedSize extends PdfPageObject {
/**
* Rotated size of this page
*/
rotatedSize: Size;
}
/**
* Representation of pdf document
*
* @public
*/
export interface PdfDocumentObject {
/**
* Identity of document
*/
id: string;
/**
* Count of pages in this document
*/
pageCount: number;
/**
* Pages in this document
*/
pages: PdfPageObject[];
/**
* Whether the document is encrypted
*/
isEncrypted: boolean;
/**
* Whether owner permissions are currently unlocked
*/
isOwnerUnlocked: boolean;
/**
* Raw permission flags from FPDF_GetDocPermissions.
* Use PdfPermissionFlag to check individual permissions.
*/
permissions: number;
/**
* Whether page rotation was normalized when opening the document.
* When true, all page coordinates are in 0° space regardless of original rotation.
*/
normalizedRotation: boolean;
}
/**
* metadata of pdf document
*
* @public
*/
export interface PdfMetadataObject {
/**
* title of the document
*/
title: string | null;
/**
* author of the document
*/
author: string | null;
/**
* subject of the document
*/
subject: string | null;
/**
* keywords of the document
*/
keywords: string | null;
/**
* producer of the document
*/
producer: string | null;
/**
* creator of the document
*/
creator: string | null;
/**
* creation date of the document
*/
creationDate: Date | null;
/**
* modification date of the document
*/
modificationDate: Date | null;
/**
* trapped status of the document
*/
trapped: PdfTrappedStatus | null;
/**
* Non-predefined Info dictionary entries.
*/
custom?: Record<string, string | null>;
}
/**
* Unicode **soft-hyphen** marker (`U+00AD`).
* Often embedded by PDF generators as discretionary hyphens.
*
* @public
*/
export const PdfSoftHyphenMarker = '\u00AD';
/**
* Unicode **zero-width space** (`U+200B`).
*
* @public
*/
export const PdfZeroWidthSpace = '\u200B';
/**
* Unicode **word-joiner** (`U+2060`) – zero-width no-break.
*
* @public
*/
export const PdfWordJoiner = '\u2060';
/**
* Unicode **byte-order mark / zero-width no-break space** (`U+FEFF`).
*
* @public
*/
export const PdfBomOrZwnbsp = '\uFEFF';
/**
* Unicode non-character `U+FFFE`.
*
* @public
*/
export const PdfNonCharacterFFFE = '\uFFFE';
/**
* Unicode non-character `U+FFFF`.
*
* @public
*/
export const PdfNonCharacterFFFF = '\uFFFF';
/**
* **Frozen list** of all unwanted markers in canonical order.
*
* @public
*/
export const PdfUnwantedTextMarkers = Object.freeze([
PdfSoftHyphenMarker,
PdfZeroWidthSpace,
PdfWordJoiner,
PdfBomOrZwnbsp,
PdfNonCharacterFFFE,
PdfNonCharacterFFFF,
] as const);
/**
* Compiled regular expression that matches any unwanted marker.
*
* @public
*/
export const PdfUnwantedTextRegex = new RegExp(`[${PdfUnwantedTextMarkers.join('')}]`, 'g');
/**
* Remove all {@link PdfUnwantedTextMarkers | unwanted markers} from *text*.
*
* @param text - raw text extracted from PDF
* @returns cleaned text
*
* @public
*/
export function stripPdfUnwantedMarkers(text: string): string {
return text.replace(PdfUnwantedTextRegex, '');
}
/**
* Zoom mode
*
* @public
*/
export enum PdfZoomMode {
Unknown = 0,
/**
* Zoom level with specified offset.
*/
XYZ = 1,
/**
* Fit both the width and height of the page (whichever smaller).
*/
FitPage = 2,
/**
* Fit the entire page width to the window.
*/
FitHorizontal = 3,
/**
* Fit the entire page height to the window.
*/
FitVertical = 4,
/**
* Fit a specific rectangle area within the window.
*/
FitRectangle = 5,
/**
* Fit bounding box of the entire page (including annotations).
*/
FitBoundingBox = 6,
/**
* Fit the bounding box width of the page.
*/
FitBoundingBoxHorizontal = 7,
/**
* Fit the bounding box height of the page.
*/
FitBoundingBoxVertical = 8,
}
/**
* Trapped status of the document.
*
* @public
*/
export enum PdfTrappedStatus {
/**
* No /Trapped key
*/
NotSet = 0,
/**
* Explicitly /Trapped /True
*/
True = 1,
/**
* Explicitly /Trapped /False
*/
False = 2,
/**
* Explicitly /Trapped /Unknown or invalid
*/
Unknown = 3,
}
/**
* 12 default fonts for PDF
*/
export enum PdfStandardFont {
Unknown = -1,
Courier = 0,
Courier_Bold = 1,
Courier_BoldOblique = 2,
Courier_Oblique = 3,
Helvetica = 4,
Helvetica_Bold = 5,
Helvetica_BoldOblique = 6,
Helvetica_Oblique = 7,
Times_Roman = 8,
Times_Bold = 9,
Times_BoldItalic = 10,
Times_Italic = 11,
Symbol = 12,
ZapfDingbats = 13,
}
/**
* Text alignment
*/
export enum PdfTextAlignment {
Left = 0,
Center = 1,
Right = 2,
}
/**
* Vertical alignment
*/
export enum PdfVerticalAlignment {
Top = 0,
Middle = 1,
Bottom = 2,
}
/**
* Blend mode
*
* @public
*/
export enum PdfBlendMode {
Normal = 0,
Multiply = 1,
Screen = 2,
Overlay = 3,
Darken = 4,
Lighten = 5,
ColorDodge = 6,
ColorBurn = 7,
HardLight = 8,
SoftLight = 9,
Difference = 10,
Exclusion = 11,
Hue = 12,
Saturation = 13,
Color = 14,
Luminosity = 15,
}
/**
* Stamp fit
*/
export enum PdfStampFit {
Contain = 0,
Cover = 1,
Stretch = 2,
}
/**
* Representation of the linked destination
*
* @public
*/
export interface PdfDestinationObject {
/**
* Index of target page
*/
pageIndex: number;
/**
* zoom config for target destination
*/
zoom:
| {
mode: PdfZoomMode.Unknown;
}
| { mode: PdfZoomMode.XYZ; params: { x: number; y: number; zoom: number } }
| {
mode: PdfZoomMode.FitPage;
}
| {
mode: PdfZoomMode.FitHorizontal;
}
| {
mode: PdfZoomMode.FitVertical;
}
| {
mode: PdfZoomMode.FitRectangle;
}
| {
mode: PdfZoomMode.FitBoundingBox;
}
| {
mode: PdfZoomMode.FitBoundingBoxHorizontal;
}
| {
mode: PdfZoomMode.FitBoundingBoxVertical;
};
view: number[];
}
/**
* Type of pdf action
*
* @public
*/
export enum PdfActionType {
Unsupported = 0,
/**
* Goto specified position in this document
*/
Goto = 1,
/**
* Goto specified position in another document
*/
RemoteGoto = 2,
/**
* Goto specified URI
*/
URI = 3,
/**
* Launch specifed application
*/
LaunchAppOrOpenFile = 4,
}
export type PdfImage = {
data: Uint8ClampedArray<ArrayBuffer>;
width: number;
height: number;
};
/**
* Image data type that matches both browser's ImageData and plain objects.
* Used for raw rendering output that may include colorSpace from browser APIs.
*
* @public
*/
export type ImageDataLike = {
data: Uint8ClampedArray<ArrayBuffer>;
width: number;
height: number;
colorSpace?: PredefinedColorSpace;
};
/**
* Bitmask constants for annotation appearance stream modes.
* @public
*/
export const AP_MODE_NORMAL = 1; // bit 0
export const AP_MODE_ROLLOVER = 2; // bit 1
export const AP_MODE_DOWN = 4; // bit 2
/**
* A rendered appearance stream image for a single mode of an annotation.
* @public
*/
export interface AnnotationAppearanceImage<TImage = ImageDataLike> {
data: TImage;
rect: Rect;
}
/**
* All available appearance stream images for one annotation,
* keyed by mode (normal, rollover, down).
* @public
*/
export interface AnnotationAppearances<TImage = ImageDataLike> {
normal?: AnnotationAppearanceImage<TImage>;
rollover?: AnnotationAppearanceImage<TImage>;
down?: AnnotationAppearanceImage<TImage>;
}
/**
* Map of annotation ID to its rendered appearance stream images.
* @public
*/
export type AnnotationAppearanceMap<TImage = ImageDataLike> = Record<
string,
AnnotationAppearances<TImage>
>;
/**
* Representation of pdf action
*
* @public
*/
export type PdfActionObject =
| {
type: PdfActionType.Unsupported;
}
| {
type: PdfActionType.Goto;
destination: PdfDestinationObject;
}
| {
type: PdfActionType.RemoteGoto;
destination: PdfDestinationObject;
}
| {
type: PdfActionType.URI;
uri: string;
}
| {
type: PdfActionType.LaunchAppOrOpenFile;
path: string;
};
/**
* target of pdf link
*
* @public
*/
export type PdfLinkTarget =
| {
type: 'action';
action: PdfActionObject;
}
| {
type: 'destination';
destination: PdfDestinationObject;
};
/**
* PDF bookmark
*
* @public
*/
export interface PdfBookmarkObject {
/**
* title of bookmark
*/
title: string;
/**
* target of bookmark
*/
target?: PdfLinkTarget | undefined;
/**
* bookmarks in the next level
*/
children?: PdfBookmarkObject[];
}
/**
* Pdf Signature
*
* @public
*/
export interface PdfSignatureObject {
/**
* contents of signature
*/
contents: ArrayBuffer;
/**
* byte range of signature
*/
byteRange: ArrayBuffer;
/**
* sub filters of signature
*/
subFilter: ArrayBuffer;
/**
* reason of signature
*/
reason: string;
/**
* creation time of signature
*/
time: string;
/**
* MDP
*/
docMDP: number;
}
/**
* Bookmark tree of pdf
*
* @public
*/
export interface PdfBookmarksObject {
bookmarks: PdfBookmarkObject[];
}
/**
* Text rectangle in pdf page
*
* @public
*/
export interface PdfTextRectObject {
/**
* Font of the text
*/
font: {
/**
* font family
*/
family: string;
/**
* font size
*/
size: number;
};
/**
* content in this rectangle area
*/
content: string;
/**
* rectangle of the text
*/
rect: Rect;
}
/**
* Color
*
* @public
*/
export interface PdfAlphaColor {
/**
* red
*/
red: number;
/**
* green
*/
green: number;
/**
* blue
*/
blue: number;
/**
* alpha
*/
alpha: number;
}
/**
* Color
*
* @public
*/
export interface PdfColor {
red: number;
green: number;
blue: number;
}
/**
* Annotation type
*
* @public
*/
export enum PdfAnnotationSubtype {
UNKNOWN = 0,
TEXT,
LINK,
FREETEXT,
LINE,
SQUARE,
CIRCLE,
POLYGON,
POLYLINE,
HIGHLIGHT,
UNDERLINE,
SQUIGGLY,
STRIKEOUT,
STAMP,
CARET,
INK,
POPUP,
FILEATTACHMENT,
SOUND,
MOVIE,
WIDGET,
SCREEN,
PRINTERMARK,
TRAPNET,
WATERMARK,
THREED,
RICHMEDIA,
XFAWIDGET,
REDACT,
}
/**
* Name of annotation type
*
* @public
*/
export const PdfAnnotationSubtypeName: Record<PdfAnnotationSubtype, string> = {
[PdfAnnotationSubtype.UNKNOWN]: 'unknow',
[PdfAnnotationSubtype.TEXT]: 'text',
[PdfAnnotationSubtype.LINK]: 'link',
[PdfAnnotationSubtype.FREETEXT]: 'freetext',
[PdfAnnotationSubtype.LINE]: 'line',
[PdfAnnotationSubtype.SQUARE]: 'square',
[PdfAnnotationSubtype.CIRCLE]: 'circle',
[PdfAnnotationSubtype.POLYGON]: 'polygon',
[PdfAnnotationSubtype.POLYLINE]: 'polyline',
[PdfAnnotationSubtype.HIGHLIGHT]: 'highlight',
[PdfAnnotationSubtype.UNDERLINE]: 'underline',
[PdfAnnotationSubtype.SQUIGGLY]: 'squiggly',
[PdfAnnotationSubtype.STRIKEOUT]: 'strikeout',
[PdfAnnotationSubtype.STAMP]: 'stamp',
[PdfAnnotationSubtype.CARET]: 'caret',
[PdfAnnotationSubtype.INK]: 'ink',
[PdfAnnotationSubtype.POPUP]: 'popup',
[PdfAnnotationSubtype.FILEATTACHMENT]: 'fileattachment',
[PdfAnnotationSubtype.SOUND]: 'sound',
[PdfAnnotationSubtype.MOVIE]: 'movie',
[PdfAnnotationSubtype.WIDGET]: 'widget',
[PdfAnnotationSubtype.SCREEN]: 'screen',
[PdfAnnotationSubtype.PRINTERMARK]: 'printermark',
[PdfAnnotationSubtype.TRAPNET]: 'trapnet',
[PdfAnnotationSubtype.WATERMARK]: 'watermark',
[PdfAnnotationSubtype.THREED]: 'threed',
[PdfAnnotationSubtype.RICHMEDIA]: 'richmedia',
[PdfAnnotationSubtype.XFAWIDGET]: 'xfawidget',
[PdfAnnotationSubtype.REDACT]: 'redact',
};
/**
* Context map for annotation subtypes
*
* @public
*/
export interface AnnotationContextMap {
[PdfAnnotationSubtype.STAMP]:
| {
data: ArrayBuffer;
mimeType?: import('./image-metadata').ImageMimeType;
imageData?: never;
appearance?: never;
}
| { imageData: ImageData; data?: never; mimeType?: never; appearance?: never }
/** @deprecated Use `{ data: ArrayBuffer }` instead. */
| { appearance: ArrayBuffer; imageData?: never; data?: never; mimeType?: never };
}
/**
* Context type for annotation subtypes
*
* @public
*/
export type AnnotationCreateContext<A extends PdfAnnotationObject> =
A['type'] extends keyof AnnotationContextMap ? AnnotationContextMap[A['type']] : undefined;
/**
* Status of pdf annotation
*
* @public
*/
export enum PdfAnnotationObjectStatus {
/**
* Annotation is created
*/
Created,
/**
* Annotation is committed to PDF file
*/
Committed,
}
/**
* Appearance mode
*
* @public
*/
export enum AppearanceMode {
Normal = 0,
Rollover = 1,
Down = 2,
}
/**
* State of pdf annotation
*
* @public
*/
export enum PdfAnnotationState {
/**
* Annotation is active
*/
Marked = 'Marked',
/**
* Annotation is unmarked
*/
Unmarked = 'Unmarked',
/**
* Annotation is ink
*/
Accepted = 'Accepted',
/**
* Annotation is rejected
*/
Rejected = 'Rejected',
/**
* Annotation is complete
*/
Completed = 'Completed',
/**
* Annotation is cancelled
*/
Cancelled = 'Cancelled',
/**
* Annotation is none
*/
None = 'None',
}
/**
* State model of pdf annotation
*
* @public
*/
export enum PdfAnnotationStateModel {
/**
* Annotation is marked
*/
Marked = 'Marked',
/**
* Annotation is reviewed
*/
Review = 'Review',
}
/**
* Name (/Name entry) of a pdf annotation — identifies the icon for text/sound/file
* annotations and the stamp type for stamp annotations.
*
* @public
*/
export enum PdfAnnotationName {
Unknown = -1,
Comment = 0,
Key = 1,
Note = 2,
Help = 3,
NewParagraph = 4,
Paragraph = 5,
Insert = 6,
Graph = 7,
PushPin = 8,
Paperclip = 9,
Tag = 10,
Speaker = 11,
Mic = 12,
Approved = 13,
Experimental = 14,
NotApproved = 15,
AsIs = 16,
Expired = 17,
NotForPublicRelease = 18,
Confidential = 19,
Final = 20,
Sold = 21,
Departmental = 22,
ForComment = 23,
TopSecret = 24,
Draft = 25,
ForPublicRelease = 26,
Completed = 27,
Void = 28,
PreliminaryResults = 29,
InformationOnly = 30,
Rejected = 31,
Witness = 32,
InitialHere = 33,
SignHere = 34,
Accepted = 35,
Custom = 36,
Image = 37,
}
/** @deprecated Use PdfAnnotationName instead */
export type PdfAnnotationIcon = PdfAnnotationName;
/** @deprecated Use PdfAnnotationName instead */
export const PdfAnnotationIcon = PdfAnnotationName;
/**
* Line ending of annotation
*/
export enum PdfAnnotationLineEnding {
/**
* No line ending
*/
None = 0,
/**
* Square line ending
*/
Square = 1,
/**
* Circle line ending
*/
Circle = 2,
/**
* Diamond line ending
*/
Diamond = 3,
/**
* Open arrow line ending
*/
OpenArrow = 4,
/**
* Closed arrow line ending
*/
ClosedArrow = 5,
/**
* Butt line ending
*/
Butt = 6,
/**
* Right open arrow line ending
*/
ROpenArrow = 7,
/**
* Right closed arrow line ending
*/
RClosedArrow = 8,
/**
* Slash line ending
*/
Slash = 9,
/**
* Unknown line ending
*/
Unknown = 10,
}
/**
* Reply type of annotation (RT property per ISO 32000-2)
*
* Specifies how an annotation relates to another annotation when it is
* a reply (via IRT - In Reply To). Valid values are:
* - Reply (/R): Normal comment reply (default if RT is missing)
* - Group (/Group): Logical grouping of annotations
*
* @public
*/
export enum PdfAnnotationReplyType {
/**
* Unknown or invalid reply type
*/
Unknown = 0,
/**
* /R - Comment reply (default if RT is missing)
* The annotation is a child comment of the annotation referenced by IRT.
* Used for comment threads, reviewer discussions, sticky-note replies.
*/
Reply = 1,
/**
* /Group - Logical grouping
* The annotation is grouped with the annotation referenced by IRT.
* They represent the same logical object. Used when multiple annotations
* act as one unit (e.g., visual shape + metadata/label).
*/
Group = 2,
}
/**
* Rectangle differences (/RD) defining the inset between an annotation's
* /Rect and the actual drawn appearance.
*
* @public
*/
export interface PdfRectDifferences {
left: number;
top: number;
right: number;
bottom: number;
}
/**
* Basic information of pdf annotation
*
* @public
*/
export interface PdfAnnotationObjectBase {
/**
* Author of the annotation
*/
author?: string;
/**
* Modified date of the annotation
*/
modified?: Date;
/**
* Created date of the annotation
*/
created?: Date;
/**
* blend mode of annotation
*/
blendMode?: PdfBlendMode;
/**
* intent of annotation
*/
intent?: string;
/**
* Sub type of annotation