afpp 2.1.2 → 2.1.3
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/README.md +73 -1
- package/dist/core.d.ts +8 -2
- package/dist/core.js.map +1 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -3,10 +3,11 @@
|
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
[](https://codecov.io/github/l2ysho/afpp)
|
|
6
|
-
|
|
7
7
|
|
|
8
8
|
|
|
9
9
|
|
|
10
|
+
|
|
10
11
|
|
|
11
12
|
Another f\*cking PDF parser. Because parsing PDFs in Node.js should be easy. Live long and parse PDFs. 🖖
|
|
12
13
|
|
|
@@ -106,3 +107,74 @@ import { parsePdf } from 'afpp';
|
|
|
106
107
|
console.log('Parsed PDF:', result);
|
|
107
108
|
})();
|
|
108
109
|
```
|
|
110
|
+
|
|
111
|
+
## Interface: AfppParseOptions
|
|
112
|
+
|
|
113
|
+
Common properties of all afpp functions.
|
|
114
|
+
Example usage
|
|
115
|
+
|
|
116
|
+
```javascript
|
|
117
|
+
const result = await parsePdf(buffer, {
|
|
118
|
+
concurrency: 5,
|
|
119
|
+
imageEncoding: 'jpeg',
|
|
120
|
+
password: 'STRONG_PASS',
|
|
121
|
+
scale: 4,
|
|
122
|
+
});
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Properties
|
|
126
|
+
|
|
127
|
+
### concurrency?
|
|
128
|
+
|
|
129
|
+
> `optional` **concurrency**: `number`
|
|
130
|
+
|
|
131
|
+
Concurrency level for page processing. Defaults to 1.
|
|
132
|
+
Higher values may improve performance but increase memory usage.
|
|
133
|
+
|
|
134
|
+
#### Default
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
1;
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
### imageEncoding?
|
|
143
|
+
|
|
144
|
+
> `optional` **imageEncoding**: [`ImageEncoding`](../type-aliases/ImageEncoding.md)
|
|
145
|
+
|
|
146
|
+
Image encoding format when rendering non-text pages. Defaults to 'png'.
|
|
147
|
+
Supported formats: 'avif', 'jpeg', 'png', 'webp'.
|
|
148
|
+
|
|
149
|
+
#### Default
|
|
150
|
+
|
|
151
|
+
```ts
|
|
152
|
+
'png';
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
### password?
|
|
158
|
+
|
|
159
|
+
> `optional` **password**: `string`
|
|
160
|
+
|
|
161
|
+
Password for encrypted pdf files.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
### scale?
|
|
166
|
+
|
|
167
|
+
> `optional` **scale**: `number`
|
|
168
|
+
|
|
169
|
+
Scale of a page if content is not text (or pdf2image is used). Defaults to 2.0.
|
|
170
|
+
Higher values increase image resolution but also memory usage.
|
|
171
|
+
|
|
172
|
+
#### Default
|
|
173
|
+
|
|
174
|
+
```ts
|
|
175
|
+
2.0;
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## License
|
|
179
|
+
|
|
180
|
+
This project is licensed under the terms of the [MIT License](./LICENSE).
|
package/dist/core.d.ts
CHANGED
|
@@ -6,11 +6,15 @@ export declare enum PROCESSING_TYPE {
|
|
|
6
6
|
import { Canvas, CanvasRenderingContext2D } from '@napi-rs/canvas';
|
|
7
7
|
export interface AfppParseOptions {
|
|
8
8
|
/**
|
|
9
|
-
* Concurrency level for page processing.
|
|
9
|
+
* Concurrency level for page processing. Defaults to 1.
|
|
10
|
+
* Higher values may improve performance but increase memory usage.
|
|
11
|
+
* @default 1
|
|
10
12
|
*/
|
|
11
13
|
concurrency?: number;
|
|
12
14
|
/**
|
|
13
15
|
* Image encoding format when rendering non-text pages. Defaults to 'png'.
|
|
16
|
+
* Supported formats: 'avif', 'jpeg', 'png', 'webp'.
|
|
17
|
+
* @default 'png'
|
|
14
18
|
*/
|
|
15
19
|
imageEncoding?: ImageEncoding;
|
|
16
20
|
/**
|
|
@@ -18,7 +22,9 @@ export interface AfppParseOptions {
|
|
|
18
22
|
*/
|
|
19
23
|
password?: string;
|
|
20
24
|
/**
|
|
21
|
-
* Scale of a page if content is not text.
|
|
25
|
+
* Scale of a page if content is not text. Defaults to 2.0.
|
|
26
|
+
* Higher values increase image resolution but also memory usage.
|
|
27
|
+
* @default 2.0
|
|
22
28
|
*/
|
|
23
29
|
scale?: number;
|
|
24
30
|
}
|
package/dist/core.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;AAyMA,oCAgFC;AAzRD,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,gCAAa,CAAA;AACf,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAED,+CAA4C;AAG5C,sDAA6B;AAC7B,6DAA8E;AAyD9E,MAAM,uBAAuB,GAAG,KAAK,EACnC,IAAkB,EAClB,aAA+B,EAC/B,UAAkB,EAClB,SAAiB,EACjB,KAAa,EACb,QAAuB,EACvB,QAA0B,EACd,EAAE;IACd,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAC5C,oBAAoB,EAAE,KAAK;KAC5B,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,WAAW,CAAC,KAAmB,CAAC;IAE9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAE7C,MAAM,gBAAgB,GAAG,aAAa,CAAC,MAAM,CAC3C,QAAQ,CAAC,KAAK,EACd,QAAQ,CAAC,MAAM,CAChB,CAAC;QAEF,MAAM,IAAI,CAAC,MAAM,CAAC;YAChB,MAAM,EAAE,gBAAgB,CAAC,MAAM;YAC/B,aAAa,EAAE,gBAAgB,CAAC,OAAO;YACvC,QAAQ;SACT,CAAC,CAAC,OAAO,CAAC;QACX,kDAAkD;QAClD,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnE,aAAa,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/D,OAAO,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IAC1D,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAC5C,oBAAoB,EAAE,KAAK;KAC5B,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,WAAW,CAAC,KAAmB,CAAC;IAE9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,KAAK,EACnC,IAAkB,EAClB,aAA+B,EAC/B,UAAkB,EAClB,SAAiB,EACjB,KAAa,EACb,QAAuB,EACvB,EAAE;IACF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAE7C,MAAM,gBAAgB,GAAG,aAAa,CAAC,MAAM,CAC3C,QAAQ,CAAC,KAAK,EACd,QAAQ,CAAC,MAAM,CAChB,CAAC;IAEF,MAAM,IAAI,CAAC,MAAM,CAAC;QAChB,MAAM,EAAE,gBAAgB,CAAC,MAAM;QAC/B,aAAa,EAAE,gBAAgB,CAAC,OAAO;QACvC,QAAQ;KACT,CAAC,CAAC,OAAO,CAAC;IACX,kDAAkD;IAClD,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnE,aAAa,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACxC,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAC9B,KAAyC,EACzC,OAA0B,EAC1B,EAAE;IACF,MAAM,sBAAsB,GAA2B,EAAE,CAAC;IAE1D,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO,KAAK,KAAK,QAAQ;YAC5B,sBAAsB,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,CAAC;YACpE,MAAM;QACR,KAAK,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YACzB,sBAAsB,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM;QACR,KAAK,KAAK,YAAY,UAAU;YAC9B,sBAAsB,CAAC,IAAI,GAAG,KAAK,CAAC;YACpC,MAAM;QACR,KAAK,KAAK,YAAY,GAAG;YACvB,sBAAsB,CAAC,GAAG,GAAG,KAAK,CAAC;YACnC,MAAM;QACR;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,KAAK,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,sBAAsB,CAAC,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;IACpD,sBAAsB,CAAC,SAAS,GAAG,wBAAc,CAAC,MAAM,CAAC;IAEzD,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,GAAG,CAAC;IACpC,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,OAAO,EAAE,aAAa,IAAI,KAAK,CAAC;IAEjD,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,GAAG,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAClE,CAAC,CAAC;AAuBK,KAAK,UAAU,YAAY,CAChC,IAAqB,EACrB,KAAyC,EACzC,OAA0B,EAC1B,QAA2B;IAE3B,MAAM,EAAE,WAAW,EAAE,sBAAsB,EAAE,QAAQ,EAAE,KAAK,EAAE,GAC5D,MAAM,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAE3C,MAAM,KAAK,GAAG,IAAA,iBAAM,EAAC,WAAW,CAAC,CAAC;IAClC,MAAM,WAAW,GAAG,IAAA,qBAAW,EAAC,sBAAsB,CAAC,CAAC;IACxD,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC;IAC9C,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;IAEjC,IAAI,IAAI,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,QAAQ,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,OAAO,GAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEzC,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1D,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YACtB,OAAO,KAAK,CAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,aAAa,GAAG,WAAW,CAAC,aAAiC,CAAC;gBAEpE,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAC1C,IAAI,EACJ,aAAa,EACb,OAAO,EACP,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,QAAQ,CACT,CAAC;gBACF,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YACtB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,KAAK,eAAe,CAAC,IAAI,EAAE,CAAC;QAClC,MAAM,OAAO,GAAa,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1D,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YACtB,OAAO,KAAK,CAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAChD,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,sBAAsB,CAAC,IAAI,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC;QACnC,MAAM,OAAO,GAAa,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1D,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YACtB,OAAO,KAAK,CAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,aAAa,GAAG,WAAW,CAAC,aAAiC,CAAC;gBACpE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,uBAAuB,CACxC,IAAI,EACJ,aAAa,EACb,OAAO,EACP,QAAQ,EACR,KAAK,EACL,QAAQ,CACT,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAC7C,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "afpp",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.3",
|
|
4
4
|
"description": "another f*cking pdf parser",
|
|
5
5
|
"types": "./dist/index.d.ts",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -48,25 +48,25 @@
|
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@commitlint/cli": "19.8.1",
|
|
50
50
|
"@commitlint/config-conventional": "19.8.1",
|
|
51
|
-
"@types/node": "24.0
|
|
51
|
+
"@types/node": "24.2.0",
|
|
52
52
|
"@voxpelli/node-test-pretty-reporter": "1.1.2",
|
|
53
53
|
"c8": "10.1.3",
|
|
54
54
|
"commitizen": "4.3.1",
|
|
55
55
|
"cz-conventional-changelog": "3.3.0",
|
|
56
|
-
"eslint": "9.
|
|
56
|
+
"eslint": "9.32.0",
|
|
57
57
|
"eslint-config-prettier": "10.1.8",
|
|
58
58
|
"eslint-plugin-import": "2.32.0",
|
|
59
59
|
"eslint-plugin-perfectionist": "4.15.0",
|
|
60
|
-
"eslint-plugin-prettier": "5.5.
|
|
60
|
+
"eslint-plugin-prettier": "5.5.3",
|
|
61
61
|
"eslint-plugin-promise": "7.2.1",
|
|
62
62
|
"husky": "9.1.7",
|
|
63
|
-
"lint-staged": "
|
|
63
|
+
"lint-staged": "16.1.4",
|
|
64
64
|
"prettier": "3.6.2",
|
|
65
65
|
"semantic-release": "24.2.7",
|
|
66
66
|
"tsc-alias": "1.8.16",
|
|
67
67
|
"tsx": "4.20.3",
|
|
68
|
-
"typescript": "5.
|
|
69
|
-
"typescript-eslint": "8.
|
|
68
|
+
"typescript": "5.9.2",
|
|
69
|
+
"typescript-eslint": "8.39.0"
|
|
70
70
|
},
|
|
71
71
|
"dependencies": {
|
|
72
72
|
"p-limit": "6.2.0",
|