@arcjet/decorate 1.0.0-beta.1 → 1.0.0-beta.10
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 +50 -24
- package/package.json +21 -17
package/README.md
CHANGED
|
@@ -18,53 +18,79 @@
|
|
|
18
18
|
|
|
19
19
|
[Arcjet][arcjet] utilities for decorating responses with information.
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
- [npm package (`@arcjet/decorate`)](https://www.npmjs.com/package/@arcjet/decorate)
|
|
22
|
+
- [GitHub source code (`decorate/` in `arcjet/arcjet-js`)](https://github.com/arcjet/arcjet-js/tree/main/decorate)
|
|
22
23
|
|
|
23
|
-
|
|
24
|
-
|
|
24
|
+
## What is this?
|
|
25
|
+
|
|
26
|
+
This is a utility that lets you decorate responses based on Arcjet decisions.
|
|
27
|
+
It currently supports experimental rate limit headers.
|
|
28
|
+
|
|
29
|
+
## When should I use this?
|
|
30
|
+
|
|
31
|
+
You can use this package if you use the rate limit rule and want to set
|
|
32
|
+
experimental `RateLimit-Policy` and `RateLimit` headers.
|
|
33
|
+
See [_RateLimit header fields for HTTP_ on `ietf.org`][ietf-rate-limit] for
|
|
34
|
+
more info.
|
|
35
|
+
|
|
36
|
+
## Install
|
|
37
|
+
|
|
38
|
+
This package is ESM only.
|
|
39
|
+
Install with npm in Node.js:
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
npm install @arcjet/decorate
|
|
25
43
|
```
|
|
26
44
|
|
|
27
45
|
## Example
|
|
28
46
|
|
|
29
47
|
```ts
|
|
30
|
-
import
|
|
48
|
+
import http from "node:http";
|
|
31
49
|
import { setRateLimitHeaders } from "@arcjet/decorate";
|
|
32
|
-
import {
|
|
50
|
+
import arcjet, { shield } from "@arcjet/node";
|
|
51
|
+
|
|
52
|
+
// Get your Arcjet key at <https://app.arcjet.com>.
|
|
53
|
+
// Set it as an environment variable instead of hard coding it.
|
|
54
|
+
const arcjetKey = process.env.ARCJET_KEY;
|
|
55
|
+
|
|
56
|
+
if (!arcjetKey) {
|
|
57
|
+
throw new Error("Cannot find `ARCJET_KEY` environment variable");
|
|
58
|
+
}
|
|
33
59
|
|
|
34
60
|
const aj = arcjet({
|
|
35
|
-
key:
|
|
61
|
+
key: arcjetKey,
|
|
36
62
|
rules: [
|
|
37
|
-
//
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
window: "1m", // 1 min fixed window
|
|
41
|
-
max: 1, // allow a single request
|
|
42
|
-
}),
|
|
63
|
+
// Shield protects your app from common attacks.
|
|
64
|
+
// Use `DRY_RUN` instead of `LIVE` to only log.
|
|
65
|
+
shield({ mode: "LIVE" }),
|
|
43
66
|
],
|
|
44
67
|
});
|
|
45
68
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
69
|
+
const server = http.createServer(async function (
|
|
70
|
+
request: http.IncomingMessage,
|
|
71
|
+
response: http.ServerResponse,
|
|
49
72
|
) {
|
|
50
|
-
const decision = await aj.protect(
|
|
73
|
+
const decision = await aj.protect(request);
|
|
51
74
|
|
|
52
|
-
setRateLimitHeaders(
|
|
75
|
+
setRateLimitHeaders(response, decision);
|
|
53
76
|
|
|
54
77
|
if (decision.isDenied()) {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
});
|
|
78
|
+
response.writeHead(403, { "Content-Type": "application/json" });
|
|
79
|
+
response.end(JSON.stringify({ message: "Forbidden" }));
|
|
80
|
+
return;
|
|
59
81
|
}
|
|
60
82
|
|
|
61
|
-
|
|
62
|
-
}
|
|
83
|
+
response.writeHead(200, { "Content-Type": "application/json" });
|
|
84
|
+
response.end(JSON.stringify({ message: "Hello world" }));
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
server.listen(8000);
|
|
63
88
|
```
|
|
64
89
|
|
|
65
90
|
## License
|
|
66
91
|
|
|
67
|
-
|
|
92
|
+
[Apache License, Version 2.0][apache-license] © [Arcjet Labs, Inc.][arcjet]
|
|
68
93
|
|
|
69
94
|
[arcjet]: https://arcjet.com
|
|
70
95
|
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0
|
|
96
|
+
[ietf-rate-limit]: https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers-08
|
package/package.json
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arcjet/decorate",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.10",
|
|
4
4
|
"description": "Arcjet utilities for decorating responses with information",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"arcjet",
|
|
7
|
+
"decore",
|
|
8
|
+
"utility",
|
|
9
|
+
"util"
|
|
10
|
+
],
|
|
5
11
|
"license": "Apache-2.0",
|
|
6
12
|
"homepage": "https://arcjet.com",
|
|
7
13
|
"repository": {
|
|
@@ -25,31 +31,29 @@
|
|
|
25
31
|
"main": "./index.js",
|
|
26
32
|
"types": "./index.d.ts",
|
|
27
33
|
"files": [
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
"*.js",
|
|
31
|
-
"*.d.ts",
|
|
32
|
-
"!*.config.js"
|
|
34
|
+
"index.d.ts",
|
|
35
|
+
"index.js"
|
|
33
36
|
],
|
|
34
37
|
"scripts": {
|
|
35
|
-
"prepublishOnly": "npm run build",
|
|
36
38
|
"build": "rollup --config rollup.config.js",
|
|
37
39
|
"lint": "eslint .",
|
|
38
|
-
"
|
|
39
|
-
"test": "node --test
|
|
40
|
+
"prepublishOnly": "npm run build",
|
|
41
|
+
"test-api": "node --test",
|
|
42
|
+
"test-coverage": "node --experimental-test-coverage --test",
|
|
43
|
+
"test": "npm run build && npm run lint && npm run test-coverage"
|
|
40
44
|
},
|
|
41
45
|
"dependencies": {
|
|
42
|
-
"@arcjet/protocol": "1.0.0-beta.
|
|
43
|
-
"@arcjet/sprintf": "1.0.0-beta.
|
|
46
|
+
"@arcjet/protocol": "1.0.0-beta.10",
|
|
47
|
+
"@arcjet/sprintf": "1.0.0-beta.10"
|
|
44
48
|
},
|
|
45
49
|
"devDependencies": {
|
|
46
|
-
"@arcjet/eslint-config": "1.0.0-beta.
|
|
47
|
-
"@arcjet/rollup-config": "1.0.0-beta.
|
|
48
|
-
"@arcjet/tsconfig": "1.0.0-beta.
|
|
49
|
-
"@rollup/wasm-node": "4.
|
|
50
|
+
"@arcjet/eslint-config": "1.0.0-beta.10",
|
|
51
|
+
"@arcjet/rollup-config": "1.0.0-beta.10",
|
|
52
|
+
"@arcjet/tsconfig": "1.0.0-beta.10",
|
|
53
|
+
"@rollup/wasm-node": "4.46.2",
|
|
50
54
|
"@types/node": "18.18.0",
|
|
51
|
-
"
|
|
52
|
-
"typescript": "5.
|
|
55
|
+
"eslint": "9.32.0",
|
|
56
|
+
"typescript": "5.9.2"
|
|
53
57
|
},
|
|
54
58
|
"publishConfig": {
|
|
55
59
|
"access": "public",
|