@websitescreenshotworld/sdk 0.0.0-stage → 0.1.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/CHANGELOG.md +37 -0
- package/LICENSE +21 -0
- package/README.md +399 -2
- package/dist/cjs/auto-schedule.d.ts +20 -0
- package/dist/cjs/auto-schedule.js +34 -0
- package/dist/cjs/client.d.ts +41 -0
- package/dist/cjs/client.js +58 -0
- package/dist/cjs/error-codes.d.ts +54 -0
- package/dist/cjs/error-codes.js +94 -0
- package/dist/cjs/errors.d.ts +56 -0
- package/dist/cjs/errors.js +112 -0
- package/dist/cjs/files.d.ts +6 -0
- package/dist/cjs/files.js +45 -0
- package/dist/cjs/index.d.ts +16 -0
- package/dist/cjs/index.js +37 -0
- package/dist/cjs/instant-snap.d.ts +99 -0
- package/dist/cjs/instant-snap.js +205 -0
- package/dist/cjs/models/capture-file.d.ts +35 -0
- package/dist/cjs/models/capture-file.js +34 -0
- package/dist/cjs/models/capture-options.d.ts +144 -0
- package/dist/cjs/models/capture-options.js +2 -0
- package/dist/cjs/models/capture.d.ts +108 -0
- package/dist/cjs/models/capture.js +63 -0
- package/dist/cjs/models/defaults.d.ts +82 -0
- package/dist/cjs/models/defaults.js +46 -0
- package/dist/cjs/models/tokens.d.ts +92 -0
- package/dist/cjs/models/tokens.js +85 -0
- package/dist/cjs/models/trigger-result.d.ts +20 -0
- package/dist/cjs/models/trigger-result.js +13 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/transport.d.ts +55 -0
- package/dist/cjs/transport.js +206 -0
- package/dist/cjs/version.d.ts +2 -0
- package/dist/cjs/version.js +5 -0
- package/dist/cjs/webhooks/events.d.ts +128 -0
- package/dist/cjs/webhooks/events.js +13 -0
- package/dist/cjs/webhooks/parse-event.d.ts +10 -0
- package/dist/cjs/webhooks/parse-event.js +149 -0
- package/dist/cjs/webhooks/webhook.d.ts +26 -0
- package/dist/cjs/webhooks/webhook.js +78 -0
- package/dist/cjs/wire.d.ts +15 -0
- package/dist/cjs/wire.js +71 -0
- package/dist/esm/auto-schedule.d.ts +20 -0
- package/dist/esm/auto-schedule.js +30 -0
- package/dist/esm/client.d.ts +41 -0
- package/dist/esm/client.js +54 -0
- package/dist/esm/error-codes.d.ts +54 -0
- package/dist/esm/error-codes.js +91 -0
- package/dist/esm/errors.d.ts +56 -0
- package/dist/esm/errors.js +98 -0
- package/dist/esm/files.d.ts +6 -0
- package/dist/esm/files.js +41 -0
- package/dist/esm/index.d.ts +16 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/instant-snap.d.ts +99 -0
- package/dist/esm/instant-snap.js +201 -0
- package/dist/esm/models/capture-file.d.ts +35 -0
- package/dist/esm/models/capture-file.js +31 -0
- package/dist/esm/models/capture-options.d.ts +144 -0
- package/dist/esm/models/capture-options.js +1 -0
- package/dist/esm/models/capture.d.ts +108 -0
- package/dist/esm/models/capture.js +57 -0
- package/dist/esm/models/defaults.d.ts +82 -0
- package/dist/esm/models/defaults.js +42 -0
- package/dist/esm/models/tokens.d.ts +92 -0
- package/dist/esm/models/tokens.js +82 -0
- package/dist/esm/models/trigger-result.d.ts +20 -0
- package/dist/esm/models/trigger-result.js +10 -0
- package/dist/esm/transport.d.ts +55 -0
- package/dist/esm/transport.js +201 -0
- package/dist/esm/version.d.ts +2 -0
- package/dist/esm/version.js +2 -0
- package/dist/esm/webhooks/events.d.ts +128 -0
- package/dist/esm/webhooks/events.js +10 -0
- package/dist/esm/webhooks/parse-event.d.ts +10 -0
- package/dist/esm/webhooks/parse-event.js +146 -0
- package/dist/esm/webhooks/webhook.d.ts +26 -0
- package/dist/esm/webhooks/webhook.js +75 -0
- package/dist/esm/wire.d.ts +15 -0
- package/dist/esm/wire.js +66 -0
- package/package.json +68 -4
package/dist/esm/wire.js
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/** Maps whose keys are data, not field names, and so are never re-cased. */
|
|
2
|
+
const VERBATIM_KEYS = new Set(["headers", "cookies"]);
|
|
3
|
+
function isPlainObject(value) {
|
|
4
|
+
return (typeof value === "object" &&
|
|
5
|
+
value !== null &&
|
|
6
|
+
!Array.isArray(value) &&
|
|
7
|
+
!(value instanceof Date));
|
|
8
|
+
}
|
|
9
|
+
function snakeCase(key) {
|
|
10
|
+
return key.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
|
|
11
|
+
}
|
|
12
|
+
function camelCase(key) {
|
|
13
|
+
return key.replace(/_([a-z0-9])/g, (_, letter) => letter.toUpperCase());
|
|
14
|
+
}
|
|
15
|
+
function withoutUnset(map) {
|
|
16
|
+
return Object.fromEntries(Object.entries(map).filter(([, value]) => value !== undefined));
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Turns camelCase options into the API's snake_case body. Options left `undefined` or `null` are not
|
|
20
|
+
* sent; `false`, `0` and `""` are.
|
|
21
|
+
*/
|
|
22
|
+
export function toWire(options) {
|
|
23
|
+
const body = {};
|
|
24
|
+
for (const [key, value] of Object.entries(options)) {
|
|
25
|
+
if (value === undefined || value === null)
|
|
26
|
+
continue;
|
|
27
|
+
if (VERBATIM_KEYS.has(key) && isPlainObject(value)) {
|
|
28
|
+
body[snakeCase(key)] = withoutUnset(value);
|
|
29
|
+
}
|
|
30
|
+
else if (isPlainObject(value)) {
|
|
31
|
+
body[snakeCase(key)] = toWire(value);
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
body[snakeCase(key)] = value;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
return body;
|
|
38
|
+
}
|
|
39
|
+
/** Re-cases the keys of an object the library does not model field by field. */
|
|
40
|
+
export function camelCaseKeys(value) {
|
|
41
|
+
if (Array.isArray(value))
|
|
42
|
+
return value.map(camelCaseKeys);
|
|
43
|
+
if (!isPlainObject(value))
|
|
44
|
+
return value;
|
|
45
|
+
return Object.fromEntries(Object.entries(value).map(([key, inner]) => [
|
|
46
|
+
camelCase(key),
|
|
47
|
+
camelCaseKeys(inner),
|
|
48
|
+
]));
|
|
49
|
+
}
|
|
50
|
+
const ISO_DATE_TIME = /^(\d{4}-\d{2}-\d{2})[T ](\d{2}:\d{2}:\d{2})(?:[.,](\d+))?(Z|[+-]\d{2}(?::?\d{2})?)$/i;
|
|
51
|
+
export function parseDate(value) {
|
|
52
|
+
if (value === null || value === undefined)
|
|
53
|
+
return null;
|
|
54
|
+
const match = ISO_DATE_TIME.exec(value);
|
|
55
|
+
if (match === null)
|
|
56
|
+
return new Date(value);
|
|
57
|
+
const [, date = "", time = "", fraction = "", zone = ""] = match;
|
|
58
|
+
const milliseconds = fraction.padEnd(3, "0").slice(0, 3);
|
|
59
|
+
return new Date(`${date}T${time}.${milliseconds}${normalizeZone(zone.toUpperCase())}`);
|
|
60
|
+
}
|
|
61
|
+
function normalizeZone(zone) {
|
|
62
|
+
if (zone === "Z")
|
|
63
|
+
return zone;
|
|
64
|
+
const digits = zone.slice(1).replace(":", "");
|
|
65
|
+
return `${zone[0] ?? "+"}${digits.slice(0, 2)}:${digits.slice(2, 4).padEnd(2, "0")}`;
|
|
66
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,70 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@websitescreenshotworld/sdk",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Node.js client for the Website Screenshot World Instant Snap and Auto Schedule APIs, with webhook verification",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"screenshot",
|
|
7
|
+
"website-screenshot",
|
|
8
|
+
"web-capture",
|
|
9
|
+
"pdf",
|
|
10
|
+
"video",
|
|
11
|
+
"webhooks",
|
|
12
|
+
"websitescreenshotworld"
|
|
13
|
+
],
|
|
14
|
+
"homepage": "https://github.com/websitescreenshotworld/websitescreenshotworld-node#readme",
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/websitescreenshotworld/websitescreenshotworld-node/issues"
|
|
17
|
+
},
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+https://github.com/websitescreenshotworld/websitescreenshotworld-node.git"
|
|
21
|
+
},
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"author": "Silhouettec Solutions Private Limited <support@websitescreenshotworld.com>",
|
|
24
|
+
"type": "module",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"import": {
|
|
28
|
+
"types": "./dist/esm/index.d.ts",
|
|
29
|
+
"default": "./dist/esm/index.js"
|
|
30
|
+
},
|
|
31
|
+
"require": {
|
|
32
|
+
"types": "./dist/cjs/index.d.ts",
|
|
33
|
+
"default": "./dist/cjs/index.js"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
"./package.json": "./package.json"
|
|
37
|
+
},
|
|
38
|
+
"main": "./dist/cjs/index.js",
|
|
39
|
+
"types": "./dist/cjs/index.d.ts",
|
|
40
|
+
"files": [
|
|
41
|
+
"dist/esm",
|
|
42
|
+
"dist/cjs",
|
|
43
|
+
"CHANGELOG.md"
|
|
44
|
+
],
|
|
45
|
+
"sideEffects": false,
|
|
46
|
+
"engines": {
|
|
47
|
+
"node": ">=22"
|
|
48
|
+
},
|
|
49
|
+
"scripts": {
|
|
50
|
+
"build": "npm run clean && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && node scripts/mark-cjs.js",
|
|
51
|
+
"clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
|
|
52
|
+
"lint": "eslint . && prettier --check . && tsc --noEmit",
|
|
53
|
+
"format": "prettier --write .",
|
|
54
|
+
"pretest": "npm run build && tsc -p tsconfig.test.json",
|
|
55
|
+
"test": "node --test dist/test/test/*.test.js",
|
|
56
|
+
"prepack": "npm run build"
|
|
57
|
+
},
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"@eslint/js": "10.0.1",
|
|
60
|
+
"@types/node": "22.20.5",
|
|
61
|
+
"eslint": "10.11.0",
|
|
62
|
+
"prettier": "3.9.9",
|
|
63
|
+
"typescript": "5.9.3",
|
|
64
|
+
"typescript-eslint": "8.70.1"
|
|
65
|
+
},
|
|
66
|
+
"publishConfig": {
|
|
67
|
+
"access": "public",
|
|
68
|
+
"provenance": true
|
|
69
|
+
}
|
|
70
|
+
}
|