chore: Add bugs and author info & update readme (#254)

- Adds [bugs](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bugs) and [author](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#people-fields-author-contributors) fields to `package.json`. - Link the NPM version badge to the NPM package page. - Extand the arcjet-next readme with examples for rate limiting and Shield.
arcjet · Feb 27, 2024 · 9b0d2fc · 9b0d2fc
1 parent f8ebbdc
commit 9b0d2fc
Show file tree

Hide file tree

Showing 21 changed files with 208 additions and 44 deletions.
diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -22,15 +22,15 @@ lint:
     - shfmt@3.6.0
     - trivy@0.49.1
     - yamllint@1.35.1
-    - semgrep@1.61.1
+    - semgrep@1.62.0
     - gitleaks@8.18.2
     - actionlint@1.6.26
     - git-diff-check
     - markdownlint@0.39.0
     - osv-scanner@1.6.2
     - prettier@3.2.5
     - svgo@3.2.0
-    - trufflehog@3.67.6
+    - trufflehog@3.68.0
   disabled:
     # tfsec and checkov are replaced by Trivy
     - tfsec

diff --git a/analyze/README.md b/analyze/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/analyze`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fanalyze?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fanalyze?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/analyze">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fanalyze?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fanalyze?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 [Arcjet][arcjet] helps developers protect their apps in just a few lines of

diff --git a/analyze/package.json b/analyze/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "analyze"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/arcjet-next/README.md b/arcjet-next/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/next`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fnext?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fnext?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/next">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fnext?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fnext?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 [Arcjet][arcjet] helps developers protect their apps in just a few lines of
@@ -31,7 +33,61 @@ started.
 npm install -S @arcjet/next
 ```
 
-## Example
+## Rate limit example
+
+The [Arcjet rate
+limit](https://docs.arcjet.com/rate-limiting/concepts) example below
+applies a token bucket rate limit rule to a route where we identify the user
+based on their ID e.g. if they are logged in. The bucket is configured with a
+maximum capacity of 10 tokens and refills by 5 tokens every 10 seconds. Each
+request consumes 5 tokens.
+
+See the [Arcjet rate limit
+documentation](https://docs.arcjet.com/rate-limiting/quick-start/nextjs) for
+details.
+
+```ts
+import arcjet, { tokenBucket } from "@arcjet/next";
+import { NextResponse } from "next/server";
+
+const aj = arcjet({
+  key: process.env.ARCJET_KEY!, // Get your site key from https://app.arcjet.com
+  rules: [
+    // Create a token bucket rate limit. Other algorithms are supported.
+    tokenBucket({
+      mode: "LIVE", // will block requests. Use "DRY_RUN" to log only
+      characteristics: ["userId"], // track requests by a custom user ID
+      refillRate: 5, // refill 5 tokens per interval
+      interval: 10, // refill every 10 seconds
+      capacity: 10, // bucket maximum capacity of 10 tokens
+    }),
+  ],
+});
+
+export async function GET(req: Request) {
+  const userId = "user123"; // Replace with your authenticated user ID
+  const decision = await aj.protect(req, { userId, requested: 5 }); // Deduct 5 tokens from the bucket
+  console.log("Arcjet decision", decision);
+
+  if (decision.isDenied()) {
+    return NextResponse.json(
+      { error: "Too Many Requests", reason: decision.reason },
+      { status: 429 },
+    );
+  }
+
+  return NextResponse.json({ message: "Hello world" });
+}
+```
+
+## Shield example
+
+[Arcjet Shield](https://docs.arcjet.com/shield/concepts) protects your
+application against common attacks, including the OWASP Top 10. It’s enabled by
+default and runs on every request with negligible performance impact.
+
+See the [Arcjet Shield
+documentation](https://docs.arcjet.com/shield/quick-start/nextjs) for details.
 
 ```ts
 import arcjet from "@arcjet/next";
@@ -42,7 +98,7 @@ const aj = arcjet({
   // and set it as an environment variable rather than hard coding.
   // See: https://nextjs.org/docs/app/building-your-application/configuring/environment-variables
   key: process.env.ARCJET_KEY,
-  rules: [],
+  rules: [], // Shield requires no rule configuration
 });
 
 export async function GET(req: Request) {

diff --git a/arcjet-next/package.json b/arcjet-next/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "arcjet-next"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/arcjet/README.md b/arcjet/README.md
@@ -8,10 +8,12 @@
 # `arcjet`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/arcjet?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/arcjet?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/arcjet">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/arcjet?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/arcjet?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 [Arcjet][arcjet] helps developers protect their apps in just a few lines of

diff --git a/arcjet/package.json b/arcjet/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "arcjet"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/duration/README.md b/duration/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/ip`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fip?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fip?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/duration">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fduration?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fduration?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 [Arcjet][arcjet] utilities for parsing duration strings.

diff --git a/duration/package.json b/duration/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "ip"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/eslint-config/README.md b/eslint-config/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/eslint-config`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Feslint-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Feslint-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/eslint-config">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Feslint-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Feslint-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 Custom eslint config for [Arcjet][arcjet] projects.

diff --git a/eslint-config/package.json b/eslint-config/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "eslint-config"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/ip/README.md b/ip/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/ip`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fip?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fip?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/ip">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fip?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fip?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 [Arcjet][arcjet] utilities for finding the originating IP of a request.

diff --git a/ip/package.json b/ip/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "ip"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/logger/README.md b/logger/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/logger`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Flogger?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Flogger?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/logger">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Flogger?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Flogger?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 [Arcjet][arcjet] logging interface which mirrors the `console` interface but

diff --git a/logger/package.json b/logger/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "logger"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/protocol/README.md b/protocol/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/protocol`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fprotocol?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fprotocol?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/protocol">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fprotocol?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fprotocol?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 The TypeScript & JavaScript interface into the [Arcjet][arcjet] protocol.

diff --git a/protocol/package.json b/protocol/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "protocol"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },

diff --git a/rollup-config/README.md b/rollup-config/README.md
@@ -8,10 +8,12 @@
 # `@arcjet/rollup-config`
 
 <p>
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Frollup-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
-    <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Frollup-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
-  </picture>
+  <a href="https://www.npmjs.com/package/@arcjet/rollup-config">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Frollup-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866">
+      <img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Frollup-config?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0">
+    </picture>
+  </a>
 </p>
 
 Custom rollup config for [Arcjet][arcjet] projects.

diff --git a/rollup-config/package.json b/rollup-config/package.json
@@ -9,6 +9,15 @@
     "url": "git+https://github.com/arcjet/arcjet-js.git",
     "directory": "rollup-config"
   },
+  "bugs": {
+    "url": "https://github.com/arcjet/arcjet-js/issues",
+    "email": "support@arcjet.com"
+  },
+  "author": {
+    "name": "Arcjet",
+    "email": "support@arcjet.com",
+    "url": "https://arcjet.com"
+  },
   "engines": {
     "node": ">=18"
   },