chore(examples): Reorganize examples for clarity and decoupling from …

…Next.js version (#2017) This reorganizes our examples so they don't mention Next.js 14 unless they need to be locked to that version. It also updates Next.js to v15 where possible. Since I needed to update the dependabot, ci, and merge queue configs, I also took the opportunity to update `-rl` to `-rate-limit` throughout for clarity.
arcjet · Oct 23, 2024 · 8568bf2 · 8568bf2
1 parent 1704da8
commit 8568bf2
Show file tree

Hide file tree

Showing 350 changed files with 26,515 additions and 20,677 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
diff --git a/.github/workflows/reusable-examples.yml b/.github/workflows/reusable-examples.yml
@@ -165,9 +165,11 @@ jobs:
         working-directory: examples/nestjs-launchdarkly
         run: npm run build
 
-  nextjs-14-app-dir-rl:
-    name: Next.js 14 + App Router + Rate Limit
+  nextjs-14-nextauth-4:
+    name: Next.js 14 + NextAuth 4
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       # Environment security
       - name: Harden Runner
@@ -198,15 +200,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-app-dir-rl
+        working-directory: examples/nextjs-14-nextauth-4
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-app-dir-rl
+        working-directory: examples/nextjs-14-nextauth-4
         run: npm run build
 
-  nextjs-14-app-dir-validate-email:
-    name: Next.js 14 + App Router + Validate Email
+  nextjs-app-dir-rate-limit:
+    name: Next.js + App Router + Rate Limit
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -240,15 +242,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-app-dir-validate-email
+        working-directory: examples/nextjs-app-dir-rate-limit
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-app-dir-validate-email
+        working-directory: examples/nextjs-app-dir-rate-limit
         run: npm run build
 
-  nextjs-14-authjs-5:
-    name: Next.js 14 + Auth.js 5
+  nextjs-app-dir-validate-email:
+    name: Next.js + App Router + Validate Email
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -282,17 +284,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-authjs-5
+        working-directory: examples/nextjs-app-dir-validate-email
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-authjs-5
-        env:
-          AUTH_SECRET: TEST_SECRET
+        working-directory: examples/nextjs-app-dir-validate-email
         run: npm run build
 
-  nextjs-14-bot-categories:
-    name: Next.js 14 + Bot categories
+  nextjs-authjs-5:
+    name: Next.js + Auth.js 5
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -326,15 +326,17 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-bot-categories
+        working-directory: examples/nextjs-authjs-5
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-bot-categories
+        working-directory: examples/nextjs-authjs-5
+        env:
+          AUTH_SECRET: TEST_SECRET
         run: npm run build
 
-  nextjs-14-clerk-rl:
-    name: Next.js 14 + Clerk + Rate Limit
+  nextjs-bot-categories:
+    name: Next.js + Bot categories
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -368,15 +370,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-clerk-rl
+        working-directory: examples/nextjs-bot-categories
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-clerk-rl
+        working-directory: examples/nextjs-bot-categories
         run: npm run build
 
-  nextjs-14-clerk-shield:
-    name: Next.js 14 + Clerk + Shield
+  nextjs-clerk-rate-limit:
+    name: Next.js + Clerk + Rate Limit
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -410,15 +412,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-clerk-shield
+        working-directory: examples/nextjs-clerk-rate-limit
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-clerk-shield
+        working-directory: examples/nextjs-clerk-rate-limit
         run: npm run build
 
-  nextjs-14-decorate:
-    name: Next.js 14 + Decorate
+  nextjs-clerk-shield:
+    name: Next.js + Clerk + Shield
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -452,15 +454,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-decorate
+        working-directory: examples/nextjs-clerk-shield
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-decorate
+        working-directory: examples/nextjs-clerk-shield
         run: npm run build
 
-  nextjs-14-ip-details:
-    name: Next.js 14 + IP Details
+  nextjs-decorate:
+    name: Next.js + Decorate
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -494,15 +496,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-ip-details
+        working-directory: examples/nextjs-decorate
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-ip-details
+        working-directory: examples/nextjs-decorate
         run: npm run build
 
-  nextjs-14-nextauth-4:
-    name: Next.js 14 + NextAuth 4
+  nextjs-ip-details:
+    name: Next.js + IP Details
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -536,15 +538,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-nextauth-4
+        working-directory: examples/nextjs-ip-details
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-nextauth-4
+        working-directory: examples/nextjs-ip-details
         run: npm run build
 
-  nextjs-14-openai:
-    name: Next.js 14 + OpenAI
+  nextjs-openai:
+    name: Next.js + OpenAI
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -578,15 +580,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-openai
+        working-directory: examples/nextjs-openai
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-openai
+        working-directory: examples/nextjs-openai
         run: npm run build
 
-  nextjs-14-pages-wrap:
-    name: Next.js 14 + Page Router + withArcjet
+  nextjs-pages-wrap:
+    name: Next.js + Page Router + withArcjet
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -620,15 +622,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-pages-wrap
+        working-directory: examples/nextjs-pages-wrap
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-pages-wrap
+        working-directory: examples/nextjs-pages-wrap
         run: npm run build
 
-  nextjs-14-permit:
-    name: Next.js 14 + Permit
+  nextjs-permit:
+    name: Next.js + Permit
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -662,15 +664,15 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-permit
+        working-directory: examples/nextjs-permit
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-permit
+        working-directory: examples/nextjs-permit
         run: npm run build
 
-  nextjs-14-sensitive-info:
-    name: Next.js 14 + Sensitive Info
+  nextjs-sensitive-info:
+    name: Next.js + Sensitive Info
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -704,11 +706,11 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nextjs-14-sensitive-info
+        working-directory: examples/nextjs-sensitive-info
         run: npm ci
 
       - name: Build
-        working-directory: examples/nextjs-14-sensitive-info
+        working-directory: examples/nextjs-sensitive-info
         run: npm run build
 
   nextjs-server-actions:
@@ -753,7 +755,7 @@ jobs:
         working-directory: examples/nextjs-server-actions
         run: npm run build
 
-  nodejs-hono-rl:
+  nodejs-hono-rate-limit:
     name: Node.js + Hono + Rate Limit
     runs-on: ubuntu-latest
     permissions:
@@ -786,11 +788,11 @@ jobs:
         run: npm ci
 
       - name: Install example dependencies
-        working-directory: examples/nodejs-hono-rl
+        working-directory: examples/nodejs-hono-rate-limit
         run: npm ci
 
       - name: Build
-        working-directory: examples/nodejs-hono-rl
+        working-directory: examples/nodejs-hono-rate-limit
         run: npm run build
 
   remix-express:

diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml
@@ -60,13 +60,24 @@ merge:
     - Trunk Check
     - "Run tests / Run tests (OS: ubuntu-latest, Node: 18)"
     - "Run tests / Run tests (OS: ubuntu-latest, Node: 20)"
-    - Build examples / Next.js 14 + App Router + Rate Limit
-    - Build examples / Next.js 14 + App Router + Validate Email
-    - Build examples / Next.js 14 + Clerk + Rate Limit
-    - Build examples / Next.js 14 + Clerk + Shield
-    - Build examples / Next.js 14 + Decorate
+    - Build examples / NestJS
+    - Build examples / NestJS + Fastify
+    - Build examples / NestJS + GraphQL
+    - Build examples / NestJS + LaunchDarkly
     - Build examples / Next.js 14 + NextAuth 4
-    - Build examples / Next.js 14 + OpenAI
-    - Build examples / Next.js 14 + Page Router + withArcjet
+    - Build examples / Next.js + App Router + Rate Limit
+    - Build examples / Next.js + App Router + Validate Email
+    - Build examples / Next.js + Auth.js 5
+    - Build examples / Next.js + Bot categories
+    - Build examples / Next.js + Clerk + Rate Limit
+    - Build examples / Next.js + Clerk + Shield
+    - Build examples / Next.js + Decorate
+    - Build examples / Next.js + IP Details
+    - Build examples / Next.js + OpenAI
+    - Build examples / Next.js + Page Router + withArcjet
+    - Build examples / Next.js + Permit
+    - Build examples / Next.js + Sensitive Info
+    - Build examples / Next.js + Server Actions
     - Build examples / Node.js + Hono + Rate Limit
+    - Build examples / Remix + Express
     - Build examples / SvelteKit
diff --git a/README.md b/README.md
@@ -42,12 +42,12 @@ for JS.
 
 ## Examples
 
-- [Next.js rate limits](./examples/nextjs-14-app-dir-rl)
-- [Next.js email validation](./examples/nextjs-14-app-dir-validate-email)
-- [Bun rate limits](./examples/bun-rl)
+- [Next.js rate limits](./examples/nextjs-app-dir-rate-limit)
+- [Next.js email validation](./examples/nextjs-app-dir-validate-email)
+- [Bun rate limits](./examples/bun-rate-limit)
 - [Protect NextAuth login routes](./examples/nextjs-14-nextauth-4)
-- [OpenAI chatbot protection](./examples/nextjs-14-openai)
-- [Express.js rate limits](./examples/nodejs-express-rl)
+- [OpenAI chatbot protection](./examples/nextjs-openai)
+- [Express.js rate limits](./examples/nodejs-express-rate-limit)
 - [SvelteKit](./examples/sveltekit)
 - ... [more examples](./examples)
 

diff --git a/examples/bun-hono-rl/.env.local.example → ...es/bun-hono-rate-limit/.env.local.example b/examples/bun-hono-rl/.env.local.example → ...es/bun-hono-rate-limit/.env.local.example
diff --git a/examples/bun-hono-rl/.gitignore → examples/bun-hono-rate-limit/.gitignore b/examples/bun-hono-rl/.gitignore → examples/bun-hono-rate-limit/.gitignore
diff --git a/examples/bun-hono-rl/README.md → examples/bun-hono-rate-limit/README.md b/examples/bun-hono-rl/README.md → examples/bun-hono-rate-limit/README.md
@@ -21,7 +21,7 @@ This example shows how to use Arcjet with a Bun.sh
 2. Enter this directory and install the example's dependencies.
 
    ```bash
-   cd examples/bun-hono-rl
+   cd examples/bun-hono-rate-limit
    bun install
    ```
 

diff --git a/examples/bun-hono-rl/bun.lockb → examples/bun-hono-rate-limit/bun.lockb b/examples/bun-hono-rl/bun.lockb → examples/bun-hono-rate-limit/bun.lockb
diff --git a/examples/bun-hono-rl/index.ts → examples/bun-hono-rate-limit/index.ts b/examples/bun-hono-rl/index.ts → examples/bun-hono-rate-limit/index.ts
diff --git a/examples/bun-hono-rl/package.json → examples/bun-hono-rate-limit/package.json b/examples/bun-hono-rl/package.json → examples/bun-hono-rate-limit/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "bun-hono-rl",
+  "name": "bun-hono-rate-limit",
   "private": true,
   "module": "index.ts",
   "type": "module",

diff --git a/examples/bun-hono-rl/tsconfig.json → examples/bun-hono-rate-limit/tsconfig.json b/examples/bun-hono-rl/tsconfig.json → examples/bun-hono-rate-limit/tsconfig.json
diff --git a/examples/bun-rl/.env.local.example → examples/bun-rate-limit/.env.local.example b/examples/bun-rl/.env.local.example → examples/bun-rate-limit/.env.local.example
diff --git a/examples/bun-rl/.gitignore → examples/bun-rate-limit/.gitignore b/examples/bun-rl/.gitignore → examples/bun-rate-limit/.gitignore
diff --git a/examples/bun-rl/README.md → examples/bun-rate-limit/README.md b/examples/bun-rl/README.md → examples/bun-rate-limit/README.md
@@ -21,7 +21,7 @@ This example shows how to use Arcjet with a
 2. Enter this directory and install the example's dependencies.
 
    ```bash
-   cd examples/bun-rl
+   cd examples/bun-rate-limit
    bun install
    ```
 

diff --git a/examples/bun-rl/bun.lockb → examples/bun-rate-limit/bun.lockb b/examples/bun-rl/bun.lockb → examples/bun-rate-limit/bun.lockb
diff --git a/examples/bun-rl/bunfig.toml → examples/bun-rate-limit/bunfig.toml b/examples/bun-rl/bunfig.toml → examples/bun-rate-limit/bunfig.toml
diff --git a/examples/bun-rl/index.ts → examples/bun-rate-limit/index.ts b/examples/bun-rl/index.ts → examples/bun-rate-limit/index.ts
diff --git a/examples/bun-rl/package.json → examples/bun-rate-limit/package.json b/examples/bun-rl/package.json → examples/bun-rate-limit/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "bun-rl",
+  "name": "bun-rate-limit",
   "private": true,
   "module": "index.ts",
   "type": "module",

diff --git a/examples/bun-rl/tsconfig.json → examples/bun-rate-limit/tsconfig.json b/examples/bun-rl/tsconfig.json → examples/bun-rate-limit/tsconfig.json