equalweb-sdk 1.0.1 → 1.0.2
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 +14 -5
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
|
-
# equalweb-
|
|
1
|
+
# equalweb-sdk
|
|
2
2
|
|
|
3
3
|
Official SDK for the EqualWeb V2 API - Document accessibility auditing and PDF remediation.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/equalweb-sdk)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
|
|
5
8
|
## Requirements
|
|
6
9
|
|
|
7
10
|
- Node.js >= 18.0.0
|
|
@@ -10,13 +13,19 @@ Official SDK for the EqualWeb V2 API - Document accessibility auditing and PDF r
|
|
|
10
13
|
## Installation
|
|
11
14
|
|
|
12
15
|
```bash
|
|
13
|
-
npm install equalweb-
|
|
16
|
+
npm install equalweb-sdk
|
|
14
17
|
```
|
|
15
18
|
|
|
19
|
+
## Documentation
|
|
20
|
+
|
|
21
|
+
- 📚 **Full API Documentation**: [https://login.equalweb.com/api/v2/documentation](https://login.equalweb.com/api/v2/documentation)
|
|
22
|
+
- 🏠 **EqualWeb Website**: [https://equalweb.com](https://equalweb.com)
|
|
23
|
+
- 📦 **npm Package**: [equalweb-sdk](https://www.npmjs.com/package/equalweb-sdk)
|
|
24
|
+
|
|
16
25
|
## Quick Start
|
|
17
26
|
|
|
18
27
|
```typescript
|
|
19
|
-
import { EqualWeb } from "equalweb-
|
|
28
|
+
import { EqualWeb } from "equalweb-sdk";
|
|
20
29
|
|
|
21
30
|
const client = new EqualWeb({ apiKey: "your-api-key" });
|
|
22
31
|
|
|
@@ -160,7 +169,7 @@ const zip = await client.downloads.zipped(["id1", "id2", "id3"]);
|
|
|
160
169
|
## Error Handling
|
|
161
170
|
|
|
162
171
|
```typescript
|
|
163
|
-
import { EqualWeb, EqualWebError, RateLimitError, AuthenticationError } from "equalweb-
|
|
172
|
+
import { EqualWeb, EqualWebError, RateLimitError, AuthenticationError } from "equalweb-sdk";
|
|
164
173
|
|
|
165
174
|
try {
|
|
166
175
|
await client.documents.getAll();
|
|
@@ -186,7 +195,7 @@ import type {
|
|
|
186
195
|
ReportResponse,
|
|
187
196
|
UploadResponse,
|
|
188
197
|
EqualWebConfig,
|
|
189
|
-
} from "equalweb-
|
|
198
|
+
} from "equalweb-sdk";
|
|
190
199
|
```
|
|
191
200
|
|
|
192
201
|
## Supported File Formats
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "equalweb-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Official SDK for the EqualWeb V2 API - Accessibility as a Service platform.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -33,7 +33,11 @@
|
|
|
33
33
|
],
|
|
34
34
|
"author": "EqualWeb Team <support@equalweb.com>",
|
|
35
35
|
"license": "MIT",
|
|
36
|
-
"homepage": "https://
|
|
36
|
+
"homepage": "https://equalweb.com",
|
|
37
|
+
"bugs": {
|
|
38
|
+
"url": "https://login.equalweb.com"
|
|
39
|
+
},
|
|
40
|
+
"documentation": "https://login.equalweb.com/api/v2/documentation",
|
|
37
41
|
"devDependencies": {
|
|
38
42
|
"@types/node": "^25.0.3",
|
|
39
43
|
"tsup": "^8.0.0",
|