@trieb.work/nextjs-turbo-redis-cache 1.18.0 → 1.18.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trieb.work/nextjs-turbo-redis-cache",
-  "version": "1.18.0",
+  "version": "1.18.1",
   "homepage": "https://trwk.de/case-studies/nextjs-turbo-redis-cache",
   "repository": {
     "type": "git",
@@ -32,6 +32,11 @@
     "require": "./dist/index.js",
     "import": "./dist/index.mjs"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "keywords": [
     "nextjs",
     "redis",

package/.cursor/skills/testing/SKILL.md

@@ -1,121 +0,0 @@
----
-name: testing
-description: >-
-  Run tests and add Next.js version coverage for the cache handler. Use when
-  running tests, adding a new Next.js version to the test matrix, creating test
-  apps, or debugging CI failures.
----
-
-# Testing
-
-## Running Tests
-
-```bash
-# Unit tests (fast, no Redis needed)
-pnpm test:unit
-pnpm test:unit:watch          # watch mode
-pnpm test:unit:coverage       # with coverage
-
-# Integration tests (needs Redis + pre-built Next.js app)
-pnpm test:integration
-pnpm test:integration:build-id-prefix
-pnpm test:integration:cache-components
-
-# E2E / Playwright for cached components (needs Redis, auto-starts Next.js app)
-pnpm test:e2e
-```
-
-## Test Structure
-
-```
-test/
-├── playwright/              # E2E (Playwright browser tests)
-├── vitest/
-│   ├── unit/                # Unit tests (no external deps)
-│   └── integration/         # Integration tests (Redis + Next.js)
-│       └── cache-components/
-└── nextjs-test-projects/    # Shared Next.js app fixtures
-```
-
-For details on each layer, see `test/README.md`.
-
-## Adding a New Next.js Version
-
-### 1. Standard Integration Test App
-
-For testing the core cache handler against a new Next.js version (e.g. 16.5.0):
-
-```bash
-cp -r test/nextjs-test-projects/next-app-16-2-6 test/nextjs-test-projects/next-app-16-5-0
-rm -rf test/nextjs-test-projects/next-app-16-5-0/{node_modules,.next,pnpm-lock.yaml}
-```
-
-Edit `test/nextjs-test-projects/next-app-16-5-0/package.json`:
-
-- Change `"name"` to `"next-app-16-5-0"`
-- Change `"next"` version to `"16.5.0"`
-- Change `"eslint-config-next"` version to `"16.5.0"`
-
-Then add the app to the CI integration matrix in `.github/workflows/ci.yml`:
-
-```yaml
-# In the `integration` job → strategy.matrix.next-test-app
-- next-app-16-5-0
-```
-
-### 2. Cache Components Test App (Next.js 16+ only)
-
-If the new version supports `use cache` / `cacheTag` / `cacheLife`:
-
-```bash
-cp -r test/nextjs-test-projects/next-app-16-2-6-cache-components test/nextjs-test-projects/next-app-16-5-0-cache-components
-rm -rf test/nextjs-test-projects/next-app-16-5-0-cache-components/{node_modules,.next,pnpm-lock.yaml}
-```
-
-Edit the `package.json`:
-
-- Change `"name"` to `"next-app-16-5-0-cache-components"`
-- Change `"next"` to `"16.5.0"`
-- Change `"eslint-config-next"` to `"16.5.0"`
-
-Then add it to both CI matrix jobs in `.github/workflows/ci.yml`:
-
-```yaml
-# In `integration-cache-components` → strategy.matrix.cache-components-app
-- next-app-16-5-0-cache-components
-
-# In `e2e` → strategy.matrix.cache-components-app
-- next-app-16-5-0-cache-components
-```
-
-### 3. Checklist After Adding
-
-- [ ] `package.json` has correct Next.js version + matching `eslint-config-next`
-- [ ] `"@trieb.work/nextjs-turbo-redis-cache": "file:../../../"` path is correct
-- [ ] No leftover `node_modules/`, `.next/`, or `pnpm-lock.yaml` from the copy
-- [ ] CI matrix updated (integration and/or cache-components + e2e)
-- [ ] `test/README.md` → "Next.js Test Projects" table updated
-- [ ] Run `cd test/nextjs-test-projects/next-app-16-5-0 && pnpm install && pnpm build` to verify it builds
-
-### 4. Removing a Version
-
-Remove the folder, remove it from the CI matrix entries, and update `test/README.md`.
-
-## Environment Variables
-
-| Variable               | Default                            | Purpose                                   |
-| ---------------------- | ---------------------------------- | ----------------------------------------- |
-| `NEXT_TEST_APP`        | `next-app-15-4-11`                 | Which app for `pnpm test:integration`     |
-| `CACHE_COMPONENTS_APP` | `next-app-16-2-6-cache-components` | Which app for cache-components tests      |
-| `PLAYWRIGHT_TEST_APP`  | `next-app-16-2-6-cache-components` | Which app Playwright starts               |
-| `PLAYWRIGHT_BASE_URL`  | `http://localhost:3101`            | Override to use an already-running server |
-| `SKIP_BUILD`           | —                                  | Skip Next.js build in integration tests   |
-| `DEBUG_INTEGRATION`    | —                                  | Print child process output                |
-
-## Writing New Tests
-
-- **Unit tests**: Add `*.test.ts` in `test/vitest/unit/`. No Redis, no Next.js. Use mocks.
-- **Integration tests**: Add `*.test.ts` in `test/vitest/integration/`. Spawn Next.js, use `fetch()`, check Redis.
-- **E2E tests**: Add `*.spec.ts` in `test/playwright/`. Use Playwright browser automation.
-
-Unit tests use `.test.ts` extension. Playwright tests use `.spec.ts` extension.

package/.github/workflows/ci.yml

@@ -1,309 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-
-permissions:
-  contents: read
-
-jobs:
-  lint-and-unit:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pull-requests: write
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Install pnpm
-        run: corepack enable
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --ignore-scripts
-
-      - name: Run lint
-        run: pnpm lint
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Run unit tests
-        run: pnpm test:unit:coverage
-
-      - name: Code Coverage Comments
-        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
-        uses: kcjpop/coverage-comments@v2.2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          coverage-file: './coverage/lcov.info'
-
-      - name: Dry run the release
-        if: github.event_name == 'pull_request'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release --dry-run
-
-  integration:
-    runs-on: ubuntu-latest
-    needs: lint-and-unit
-    strategy:
-      matrix:
-        next-test-app:
-          - next-app-15-4-11
-          - next-app-16-0-11
-          - next-app-16-2-6
-          - next-app-16-3-0
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Install pnpm
-        run: corepack enable
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --ignore-scripts
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Start Redis
-        uses: supercharge/redis-github-action@1.8.0
-        with:
-          redis-version: '7'
-          redis-port: 6379
-
-      - name: Install redis-cli
-        run: sudo apt-get update && sudo apt-get install -y redis-tools
-
-      - name: Configure Redis Keyspace Notifications
-        run: redis-cli config set notify-keyspace-events Exe
-
-      - name: Install test project
-        run: cd test/nextjs-test-projects/${{ matrix.next-test-app }} && pnpm install
-
-      - name: Build test project
-        run: cd test/nextjs-test-projects/${{ matrix.next-test-app }} && pnpm build
-
-      - name: Run integration tests
-        run: pnpm test:integration
-        env:
-          SKIP_BUILD: true
-          NEXT_TEST_APP: ${{ matrix.next-test-app }}
-
-  integration-pages:
-    runs-on: ubuntu-latest
-    needs: lint-and-unit
-    strategy:
-      matrix:
-        pages-test-app:
-          - next-pages-16-2-6
-          - next-pages-16-3-0
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Install pnpm
-        run: corepack enable
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --ignore-scripts
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Start Redis
-        uses: supercharge/redis-github-action@1.8.0
-        with:
-          redis-version: '7'
-          redis-port: 6379
-
-      - name: Install redis-cli
-        run: sudo apt-get update && sudo apt-get install -y redis-tools
-
-      - name: Configure Redis Keyspace Notifications
-        run: redis-cli config set notify-keyspace-events Exe
-
-      - name: Install test project
-        run: cd test/nextjs-test-projects/${{ matrix.pages-test-app }} && pnpm install
-
-      - name: Build test project
-        run: cd test/nextjs-test-projects/${{ matrix.pages-test-app }} && pnpm build
-
-      - name: Run Pages Router integration tests
-        run: pnpm test:integration:pages
-        env:
-          SKIP_BUILD: true
-          NEXT_PAGES_TEST_APP: ${{ matrix.pages-test-app }}
-
-  integration-build-id-prefix:
-    runs-on: ubuntu-latest
-    needs: lint-and-unit
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Install pnpm
-        run: corepack enable
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --ignore-scripts
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Start Redis
-        uses: supercharge/redis-github-action@1.8.0
-        with:
-          redis-version: '7'
-          redis-port: 6379
-
-      - name: Install redis-cli
-        run: sudo apt-get update && sudo apt-get install -y redis-tools
-
-      - name: Configure Redis Keyspace Notifications
-        run: redis-cli config set notify-keyspace-events Exe
-
-      - name: Install test project
-        run: cd test/nextjs-test-projects/next-app-15-4-11 && pnpm install
-
-      - name: Build test project
-        run: cd test/nextjs-test-projects/next-app-15-4-11 && pnpm build
-
-      - name: Run BUILD_ID prefix integration test
-        run: pnpm test:integration:build-id-prefix
-
-  integration-cache-components:
-    runs-on: ubuntu-latest
-    needs: lint-and-unit
-    strategy:
-      matrix:
-        cache-components-app:
-          - next-app-16-0-11-cache-components
-          - next-app-16-2-6-cache-components
-          - next-app-16-3-0-cache-components
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Install pnpm
-        run: corepack enable
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --ignore-scripts
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Start Redis
-        uses: supercharge/redis-github-action@1.8.0
-        with:
-          redis-version: '7'
-          redis-port: 6379
-
-      - name: Install redis-cli
-        run: sudo apt-get update && sudo apt-get install -y redis-tools
-
-      - name: Configure Redis Keyspace Notifications
-        run: redis-cli config set notify-keyspace-events Exe
-
-      - name: Install test project
-        run: cd test/nextjs-test-projects/${{ matrix.cache-components-app }} && pnpm install
-
-      - name: Build test project
-        run: cd test/nextjs-test-projects/${{ matrix.cache-components-app }} && pnpm build
-
-      - name: Run cache-components integration tests
-        run: pnpm test:integration:cache-components
-        env:
-          CACHE_COMPONENTS_APP: ${{ matrix.cache-components-app }}
-
-  e2e:
-    runs-on: ubuntu-latest
-    needs: lint-and-unit
-    strategy:
-      matrix:
-        cache-components-app:
-          - next-app-16-0-11-cache-components
-          - next-app-16-2-6-cache-components
-          - next-app-16-3-0-cache-components
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Install pnpm
-        run: corepack enable
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '22'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --ignore-scripts
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Start Redis
-        uses: supercharge/redis-github-action@1.8.0
-        with:
-          redis-version: '7'
-          redis-port: 6379
-
-      - name: Install redis-cli
-        run: sudo apt-get update && sudo apt-get install -y redis-tools
-
-      - name: Configure Redis Keyspace Notifications
-        run: redis-cli config set notify-keyspace-events Exe
-
-      - name: Install test project
-        run: cd test/nextjs-test-projects/${{ matrix.cache-components-app }} && pnpm install
-
-      - name: Build test project
-        run: cd test/nextjs-test-projects/${{ matrix.cache-components-app }} && pnpm build
-
-      - name: Install Playwright browsers
-        run: pnpm exec playwright install --with-deps
-
-      - name: Run Playwright E2E tests
-        run: pnpm test:e2e
-        env:
-          PLAYWRIGHT_TEST_APP: ${{ matrix.cache-components-app }}

package/.github/workflows/pages.yml

@@ -1,38 +0,0 @@
-name: Deploy GitHub Pages
-
-on:
-  push:
-    branches:
-      - main
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: pages
-  cancel-in-progress: true
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-
-      - name: Upload static site artifact
-        uses: actions/upload-pages-artifact@v4
-        with:
-          path: docs
-
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4

package/.github/workflows/release.yml

@@ -1,58 +0,0 @@
-name: Release
-
-on:
-  push:
-    branches:
-      - main
-      - beta
-
-# semantic-release: git tag + GitHub Release + npm publish (OIDC via @semantic-release/npm)
-permissions:
-  contents: write
-  issues: write
-  pull-requests: write
-  id-token: write
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6
-        with:
-          fetch-depth: 0
-
-      - name: Install pnpm
-        run: corepack enable
-
-      # Node 22 ships npm 10.x; OIDC trusted publishing needs npm >=11.5.1 at publish time.
-      # Keep CI on 22; only the release job needs the newer runtime for @semantic-release/npm.
-      - name: Setup Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: '24'
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile --ignore-scripts
-
-      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
-        run: npm audit signatures
-
-      - name: Build project
-        run: pnpm build
-
-      - name: Verify working tree is clean before release
-        run: |
-          if [ -n "$(git status --porcelain)" ]; then
-            echo "::error::Working tree is dirty before semantic-release. Aborting."
-            git status --short
-            git diff --stat
-            exit 1
-          fi
-
-      - name: Run semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: pnpm exec semantic-release

package/.prettierrc.json

@@ -1,6 +0,0 @@
-{
-  "semi": true,
-  "singleQuote": true,
-  "printWidth": 80,
-  "trailingComma": "all"
-}

package/.vscode/settings.json

@@ -1,10 +0,0 @@
-{
-  "cSpell.words": [
-    "EJSON",
-    "Keyevent",
-    "keyspace",
-    "postboned",
-    "REDISHOST",
-    "REDISPORT"
-  ]
-}