Continue

Co-authored-by: Samy Pessé <samypesse@gmail.com>

.changeset/big-gorillas-perform.md

@@ -0,0 +1,9 @@
+---
+"gitbook": patch
+---
+
+Fix three small visual issues
+
+- Fix sidebar showing on `no-toc` pages in the gradient theme
+- Fix variant selector truncating incorrectly in header when sections are present
+- Fix page cover alignment on `lg` screens without TOC

.changeset/breezy-falcons-drop.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Respect fullWidth and defaultWidth for images

.changeset/cold-buckets-divide.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+fix nested a tag causing hydration error

.changeset/cool-jars-matter.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+fix href being empty in TOC

.changeset/cool-seas-approve.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix navigation between sections/variants when previewing a site in v2

.changeset/fair-crews-wink.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Add circular corners and depth styling

.changeset/fast-trees-battle.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Add authorization header for OAuth2

.changeset/forty-readers-mix.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Support dark-mode specific page cover image

.changeset/gorgeous-cycles-cheat.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+add a force-revalidate api route to force bust the cache in case of errors

.changeset/nasty-moles-visit.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+fix ISR on preview env

.changeset/nervous-students-judge.md

@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Fix concurrent execution in Vercel causing pages to not be attached to the proper tags.

.changeset/orange-hounds-sparkle.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Generate a llms-full.txt version of the docs site

.changeset/rotten-seals-rush.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Indent JSON python code sample

.changeset/sharp-hats-applaud.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix missing title on button to close the announcement banner.

.changeset/slow-lizards-obey.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Make TOC height dynamic based on visible header and footer elements

.changeset/strong-poets-move.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix bold header links hover color

.changeset/stupid-plums-perform.md

@@ -0,0 +1,6 @@
+---
+"gitbook": patch
+"gitbook-v2": patch
+---
+
+cache fonts and static image used in OGImage in memory

.changeset/thick-chefs-repeat.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Handle nested deprecated properties in generateSchemaExample

.changeset/thin-buckets-grow.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Add `urlObject.hash` to `linker.toLinkForContent` to pass through URL fragment identifiers, used in search

.changeset/violet-schools-care.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Deduplicate path parameters from OpenAPI spec

.changeset/wise-gifts-smash.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+remove trailing slash from linker

.github/CONTRIBUTING.md

@@ -63,9 +63,9 @@ To start your local version of GitBook, run the command `bun dev`.
 
 When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.
 
-For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/docs.gitbook.com` after running the development server.
+For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/gitbook.com/docs` after running the development server.
 
-You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://docs.gitbook.com/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
+You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
 
 ### Commit your update
 

.github/actions/gradual-deploy-cloudflare/action.yaml

@@ -0,0 +1,83 @@
+name: Gradual Deploy to Cloudflare
+description: Use gradual deployment to deploy to Cloudflare. This action will upload the middleware and server versions to Cloudflare and kept them bound together
+inputs:
+  apiToken:
+    description: 'Cloudflare API token'
+    required: true
+  accountId:
+    description: 'Cloudflare account ID'
+    required: true
+  environment:
+    description: 'Cloudflare environment to deploy to (staging, production, preview)'
+    required: true
+  middlewareVersionId:
+    description: 'Middleware version ID to deploy'
+    required: true
+  serverVersionId:
+    description: 'Server version ID to deploy'
+    required: true
+outputs:
+  deployment-url: 
+    description: "Deployment URL"
+    value: ${{ steps.deploy_middleware.outputs.deployment-url }}
+runs:
+  using: 'composite'
+  steps:
+      - id: wrangler_status
+        name: Check wrangler deployment status
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: deployments status --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+
+      # This step is used to get the version ID that is currently deployed to Cloudflare.
+      - id: extract_current_version
+        name: Extract current version
+        shell: bash
+        run: |
+          version_id=$(echo "${{ steps.wrangler_status.outputs.command-output }}" | grep -A 3 "(100%)" | grep -oP '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
+          echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+      - id: deploy_server
+        name: Deploy server to Cloudflare at 0%
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+
+      # Since we use version overrides headers, we can directly deploy the middleware to 100%.
+      - id: deploy_middleware
+        name: Deploy middleware to Cloudflare at 100%
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc
+
+      - name: Deploy server to Cloudflare at 100%
+        uses: cloudflare/wrangler-action@v3.14.0
+        with:
+            apiToken: ${{ inputs.apiToken }}
+            accountId: ${{ inputs.accountId }}
+            workingDirectory: ./
+            wranglerVersion: '4.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+
+      - name: Outputs
+        shell: bash
+        env:
+          DEPLOYMENT_URL: ${{ steps.deploy_middleware.outputs.deployment-url }}
+        run: |
+            echo "URL: ${{ steps.deploy_middleware.outputs.deployment-url }}"

.github/composite/deploy-cloudflare/action.yaml

@@ -19,10 +19,16 @@ inputs:
   deploy:
     description: 'Deploy as main version for all traffic instead of uploading versions'
     required: true
+  commitTag:
+    description: 'Commit branch to associate with the deployment'
+    required: true
+  commitMessage:
+    description: 'Commit message to associate with the deployment'
+    required: true
 outputs:
     deployment-url: 
       description: "Deployment URL"
-      value: ${{ steps.deploy.outputs.deployment-url }}
+      value: ${{ steps.upload_middleware.outputs.deployment-url }}
 runs:
     using: 'composite'
     steps:
@@ -49,24 +55,84 @@ runs:
             GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
             GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
             GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
+            GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
             GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build worker
           run: bun run turbo build:v2:cloudflare
+          env:
+            GITBOOK_RUNTIME: cloudflare
           shell: bash
-        - id: deploy
-          name: Deploy to Cloudflare
+
+        - name: Upload the DO worker
           uses: cloudflare/wrangler-action@v3.14.0
           with:
               apiToken: ${{ inputs.apiToken }}
               accountId: ${{ inputs.accountId }}
               workingDirectory: ./
-              wranglerVersion: '3.112.0'
+              wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
+              command: deploy --config ./packages/gitbook-v2/openNext/customWorkers/doWrangler.jsonc
+
+        - id: upload_server
+          name: Upload server to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.10.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+
+        - name: Extract server version worker ID
+          shell: bash
+          id: extract_server_version_id
+          run: |
+              version_id=$(echo '${{ steps.upload_server.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - name: Run updateWrangler scripts
+          shell: bash
+          run: |
+              bun run ./packages/gitbook-v2/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
+
+        - id: upload_middleware
+          name: Upload middleware to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '4.10.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc
+        
+        - name: Extract middleware version worker ID
+          shell: bash
+          id: extract_middleware_version_id
+          run: |
+              version_id=$(echo '${{ steps.upload_middleware.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
+              echo "version_id=$version_id" >> $GITHUB_OUTPUT
+
+        - name: Deploy server and middleware to Cloudflare
+          if: ${{ inputs.deploy == 'true' }}
+          uses: ./.github/actions/gradual-deploy-cloudflare
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              opServiceAccount: ${{ inputs.opServiceAccount }}
+              opItem: ${{ inputs.opItem }}
+              environment: ${{ inputs.environment }}
+              serverVersionId: ${{ steps.extract_server_version_id.outputs.version_id }}
+              middlewareVersionId: ${{ steps.extract_middleware_version_id.outputs.version_id }}
+              deploy: ${{ inputs.deploy }}
+
+
         - name: Outputs
           shell: bash
           env:
-            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+            DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
           run: |
-              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
+              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"

.github/composite/deploy-vercel/action.yaml

@@ -54,6 +54,7 @@ runs:
             GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
             GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
             GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
+            GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
             GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build Project Artifacts
@@ -62,6 +63,7 @@ runs:
           env:
             VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
             VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+            GITBOOK_RUNTIME: vercel
         - name: Deploy Project Artifacts to Vercel
           id: deploy
           shell: bash

.github/workflows/deploy-preview.yaml

@@ -10,7 +10,7 @@ jobs:
     deploy-v1-cloudflare:
         name: Deploy v1 to Cloudflare Pages
         runs-on: ubuntu-latest
-        environment: 
+        environment:
           name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
           url: ${{ steps.deploy.outputs.deployment-url }}
         permissions:
@@ -40,6 +40,7 @@ jobs:
               run: bun run turbo gitbook#build:cloudflare
               env:
                   NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  GITBOOK_RUNTIME: cloudflare
             - id: deploy
               name: Deploy to Cloudflare
               uses: cloudflare/wrangler-action@v3.14.0
@@ -56,7 +57,7 @@ jobs:
     deploy-v2-vercel:
         name: Deploy v2 to Vercel (preview)
         runs-on: ubuntu-latest
-        environment: 
+        environment:
           name: 2v-preview
           url: ${{ steps.deploy.outputs.deployment-url }}
         outputs:
@@ -77,11 +78,11 @@ jobs:
     deploy-v2-cloudflare:
         name: Deploy v2 to Cloudflare Worker (preview)
         runs-on: ubuntu-latest
-        environment: 
+        environment:
           name: 2c-preview
           url: ${{ steps.deploy.outputs.deployment-url }}
         outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-url: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -95,9 +96,19 @@ jobs:
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   opItem: op://gitbook-open/2c-preview
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: ${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+                  commitMessage: ${{ github.sha }}
+            - name: Extract Worker ID
+              id: extract-worker-id
+              if: ${{ !steps.deploy.outputs.deployment-url }}
+              run: |
+                if [[ "${{ steps.deploy.outputs.command-output }}" =~ Worker\ Version\ ID:\ ([0-9a-f]{8})-([0-9a-f-]+) ]]; then
+                  WORKER_ID_FIRST_PART="${BASH_REMATCH[1]}"
+                  echo "worker-url=https://${WORKER_ID_FIRST_PART}-gitbook-open-v2-preview.gitbook.workers.dev/" >> $GITHUB_OUTPUT
+                fi
             - name: Outputs
               run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}"
     comment-deployments:
         runs-on: ubuntu-latest
         name: Comment Deployments (preview)
@@ -123,14 +134,14 @@ jobs:
                   body: |
                       Summary of the deployments:
 
-                      ### Version 1 (production)
+                      ### Version 1
 
                       | Version | URL | Status |
                       | --- | --- | --- |
                       | Latest commit | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
                       | PR | [${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
 
-                      ### Version 2 (experimental)
+                      ### Version 2
 
                       | Version | URL | Status |
                       | --- | --- | --- |
@@ -139,10 +150,10 @@ jobs:
 
                       ### Test content
 
-                      | Site | v1 | v2 |
-                      | --- | --- | --- |
-                      | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) |
-                      | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
+                      | Site | `v1` | `2v` | `2c` |
+                      | --- | --- | --- | --- |
+                      | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.com/docs](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.com/docs) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) |
+                      | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
                   edit-mode: replace
     visual-testing-v1:
         runs-on: ubuntu-latest
@@ -184,11 +195,32 @@ jobs:
                   SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                   ARGOS_BUILD_NAME: 'v2-vercel'
+    visual-testing-v2-cloudflare:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2 (Cloudflare)
+        needs: deploy-v2-cloudflare
+        timeout-minutes: 10
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'v2-cloudflare'
     visual-testing-customers-v1:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v1
         needs: deploy-v1-cloudflare
-        timeout-minutes: 6
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -208,7 +240,7 @@ jobs:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v2
         needs: deploy-v2-vercel
-        timeout-minutes: 6
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -225,6 +257,27 @@ jobs:
                   SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                   ARGOS_BUILD_NAME: 'customers-v2'
+    visual-testing-customers-v2-cloudflare:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2 (Cloudflare)
+        needs: deploy-v2-cloudflare
+        timeout-minutes: 8
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e-customers
+              env:
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v2'
     pagespeed-testing-v1:
         runs-on: ubuntu-latest
         name: PageSpeed Testing v1

.github/workflows/deploy-production.yaml

@@ -17,7 +17,7 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Deploy staging
+            - name: Deploy
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
@@ -48,6 +48,8 @@ jobs:
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   opItem: op://gitbook-open/2c-production
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: main
+                  commitMessage: ${{ github.sha }}
             - name: Outputs
               run: |
                   echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -17,7 +17,7 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-            - name: Deploy staging
+            - name: Deploy
               id: deploy
               uses: ./.github/composite/deploy-vercel
               with:
@@ -48,6 +48,8 @@ jobs:
                   accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   opItem: op://gitbook-open/2c-staging
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+                  commitTag: main
+                  commitMessage: ${{ github.sha }}
             - name: Outputs
               run: |
                   echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.vscode/settings.json

@@ -9,6 +9,7 @@
     ],
     "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
     "prettier.enable": false,
+    "editor.formatOnSave": true,
     "editor.defaultFormatter": "biomejs.biome",
     "editor.codeActionsOnSave": {
         "source.organizeImports.biome": "explicit",

README.md

@@ -1,7 +1,7 @@
 <h1 align="center">GitBook</h1>
 
 <p align="center">
-  <a href="https://docs.gitbook.com/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> 
+  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> 
 </p>
 
 <p align="center">
@@ -59,15 +59,15 @@ bun install
 4. Start your local development server.
 
 ```
-bun dev
+bun dev:v2
 ```
 
 5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
 
 examples:
 
--   http://localhost:3000/docs.gitbook.com
--   http://localhost:3000/open-source.gitbook.io/midjourney
+-   http://localhost:3000/url/gitbook.com/docs
+-   http://localhost:3000/url/open-source.gitbook.io/midjourney
 
 Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.
 
@@ -150,11 +150,11 @@ See `LICENSE` for more information.
 </p>
 
 ```md
-[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://gitbook.com/)
+[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link)
 ```
 
 ```html
-<a href="https://gitbook.com">
+<a href="https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link">
     <img
         src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"
     />

biome.json

@@ -20,7 +20,8 @@
             "**/.wrangler/**/*",
             "packages/openapi-parser/src/fixtures/**/*",
             "packages/emoji-codepoints/index.ts",
-            "packages/icons/src/data/*.json"
+            "packages/icons/src/data/*.json",
+            "packages/cache-do/worker-configuration.d.ts"
         ]
     },
     "formatter": {

package.json

@@ -4,15 +4,15 @@
     "devDependencies": {
         "@biomejs/biome": "^1.9.4",
         "@changesets/cli": "^2.27.12",
-        "turbo": "^2.4.4",
+        "turbo": "^2.5.0",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.2.5",
+    "packageManager": "bun@1.2.11",
     "overrides": {
         "@codemirror/state": "6.4.1",
-        "react": "18.3.1",
-        "react-dom": "18.3.1",
-        "@gitbook/api": "0.102.0"
+        "@gitbook/api": "^0.119.0",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0"
     },
     "private": true,
     "scripts": {

packages/cache-do/package.json

@@ -21,10 +21,10 @@
     },
     "devDependencies": {
         "typescript": "^5.5.3",
-        "wrangler": "^3.112.0"
+        "wrangler": "^4.10.0"
     },
     "scripts": {
-        "generate": "wrangler types --experimental-include-runtime",
+        "generate": "wrangler types",
         "build": "tsc",
         "typecheck": "tsc --noEmit",
         "dev": "tsc -w",

packages/cache-do/tsconfig.json

@@ -14,7 +14,7 @@
         "resolveJsonModule": true,
         "isolatedModules": true,
         "incremental": true,
-        "types": ["./.wrangler/types/runtime.d.ts"]
+        "types": ["./worker-configuration.d.ts"]
     },
     "include": ["src/**/*.ts"],
     "exclude": ["node_modules"]

packages/cache-do/turbo.json

@@ -0,0 +1,8 @@
+{
+    "extends": ["//"],
+    "tasks": {
+        "generate": {
+            "outputs": ["worker-configuration.d.ts"]
+        }
+    }
+}

packages/cache-tags/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @gitbook/cache-tags
 
+## 0.3.1
+
+### Patch Changes
+
+- 77397ca: Fix version of @gitbook/api referenced in package.json
+
+## 0.3.0
+
+### Minor Changes
+
+- 116575c: Improve typing of getComputedContentSourceCacheTags to match latest API specification
+
 ## 0.2.0
 
 ### Minor Changes

packages/cache-tags/package.json

@@ -8,9 +8,9 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "0.2.0",
+    "version": "0.3.1",
     "dependencies": {
-        "@gitbook/api": "*",
+        "@gitbook/api": "^0.119.0",
         "assert-never": "^1.2.1"
     },
     "devDependencies": {

packages/cache-tags/src/index.ts

@@ -60,7 +60,7 @@ export function getCacheTag(
         | {
               tag: 'computed-document';
               space: string;
-              integration: string;
+              sourceType: string;
           }
         /**
          * All data related to the URL of a content
@@ -84,6 +84,14 @@ export function getCacheTag(
               organization: string;
               openAPISpec: string;
           }
+        /**
+         * All data related to a translation
+         */
+        | {
+              tag: 'translation';
+              organization: string;
+              translationSettings: string;
+          }
 ): string {
     switch (spec.tag) {
         case 'user':
@@ -99,13 +107,15 @@ export function getCacheTag(
         case 'document':
             return `space:${spec.space}:document:${spec.document}`;
         case 'computed-document':
-            return `space:${spec.space}:computed-document:${spec.integration}`;
+            return `space:${spec.space}:computed-document:${spec.sourceType}`;
         case 'site':
             return `site:${spec.site}`;
         case 'integration':
             return `integration:${spec.integration}`;
         case 'openapi':
             return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
+        case 'translation':
+            return `organization:${spec.organization}:translation:${spec.translationSettings}`;
         default:
             assertNever(spec);
     }
@@ -157,6 +167,15 @@ export function getComputedContentSourceCacheTags(
                         })
                     );
                     break;
+                case 'translation-language':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'translation',
+                            organization: inContext.organizationId,
+                            translationSettings: dependency.ref.translationSettings,
+                        })
+                    );
+                    break;
                 default:
                     // Do not throw for unknown dependency types
                     // as it might mean we are lacking behind the API version
@@ -169,18 +188,22 @@ export function getComputedContentSourceCacheTags(
             getCacheTag({
                 tag: 'computed-document',
                 space: inContext.spaceId,
-                integration: source.integration,
+                sourceType: source.type,
             })
         );
     }
 
     // We invalidate the computed content when a new version of the integration is deployed.
-    tags.push(
-        getCacheTag({
-            tag: 'integration',
-            integration: source.integration,
-        })
-    );
+
+    if (source.type.startsWith('integration:')) {
+        const integration = source.type.split(':')[1];
+        tags.push(
+            getCacheTag({
+                tag: 'integration',
+                integration,
+            })
+        );
+    }
 
     return tags;
 }

packages/colors/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @gitbook/colors
 
+## 0.3.3
+
+### Patch Changes
+
+- c3f6b8c: Update chroma ratio per step
+- 5e975ab: Fix code highlighting for HTTP
+- f7a3470: Change lightness check for color step 9 to allow input colors with a higher-than-needed contrast
+
+## 0.3.2
+
+### Patch Changes
+
+- cdffd7c: Desaturate text colors by decreasing chroma for the last steps of the color scale
+
+## 0.3.1
+
+### Patch Changes
+
+- fb90eb0: Reduce chroma of first color scale step
+
 ## 0.3.0
 
 ### Minor Changes

packages/colors/package.json

@@ -8,7 +8,7 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "0.3.0",
+    "version": "0.3.3",
     "devDependencies": {
         "typescript": "^5.5.3"
     },

packages/colors/src/transformations.ts

@@ -214,13 +214,31 @@ export function colorScale(
         const targetL =
             foregroundColor.L * mapping[index] + backgroundColor.L * (1 - mapping[index]);
 
-        if (index === 8 && !mix && Math.abs(baseColor.L - targetL) < 0.2) {
+        if (
+            index === 8 &&
+            !mix &&
+            (darkMode ? targetL - baseColor.L < 0.2 : baseColor.L - targetL < 0.2)
+        ) {
             // Original colour is close enough to target, so let's use the original colour as step 9.
             result.push(hex);
             continue;
         }
 
-        const chromaRatio = index < 8 ? (index + 1) * 0.05 : 1;
+        const chromaRatio = (() => {
+            switch (index) {
+                // Step 9 and 10 have max chroma, meaning they are fully saturated.
+                case 8:
+                case 9:
+                    return 1;
+                // Step 11 and 12 have a reduced chroma
+                case 10:
+                    return 0.4;
+                case 11:
+                    return 0.1;
+                default:
+                    return index * 0.05;
+            }
+        })();
 
         const shade = {
             L: targetL, // Blend lightness

packages/gitbook-v2/.gitignore

@@ -6,6 +6,7 @@
 
 # cloudflare
 .open-next
+.wrangler
 
 # Symbolic links
 public

packages/gitbook-v2/CHANGELOG.md

@@ -1,5 +1,45 @@
 # gitbook-v2
 
+## 0.3.0
+
+### Minor Changes
+
+- 3119066: Add support for reusable content across spaces.
+- 7d7806d: Pass SVG images through image resizing without resizing them to serve them from optimal host.
+
+### Patch Changes
+
+- 1c8d9fe: keep data cache in OpenNext between deployment
+- 778624a: Only resize images with supported extensions.
+- e6ddc0f: Fix URL in sitemap
+- 5e975ab: Fix code highlighting for HTTP
+- e15757d: Fix crash on Cloudflare by using latest stable version of Next.js instead of canary
+- 634e0b4: Improve error messages around undefined site sections.
+- 97b7c79: Increase logging around caching behaviour causing page crashes.
+- 3f29206: Update the regex for validating site redirect
+- dd043df: Revert investigation work around URL caches.
+
+## 0.2.5
+
+### Patch Changes
+
+- Updated dependencies [77397ca]
+  - @gitbook/cache-tags@0.3.1
+
+## 0.2.4
+
+### Patch Changes
+
+- 4234289: Fix incoming URL for requests that were proxied
+- Updated dependencies [116575c]
+  - @gitbook/cache-tags@0.3.0
+
+## 0.2.3
+
+### Patch Changes
+
+- 5b2bf82: Use stable site URL data for route rewrite in the middleware
+
 ## 0.2.2
 
 ### Patch Changes

packages/gitbook-v2/next-env.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
+/// <reference types="next/navigation-types/compat/navigation" />
 
 // NOTE: This file should not be edited
 // see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

packages/gitbook-v2/next.config.mjs

@@ -7,8 +7,6 @@ const nextConfig = {
     experimental: {
         // This is needed to throw "forbidden" when the api token expired during revalidation
         authInterrupts: true,
-
-        // This is needed to use 'use cache'
         useCache: true,
 
         // Content is fully static, we can cache it in the session memory cache for a long time
@@ -33,7 +31,9 @@ const nextConfig = {
         GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
         GITBOOK_SECRET: process.env.GITBOOK_SECRET,
         GITBOOK_IMAGE_RESIZE_SIGNING_KEY: process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+        GITBOOK_IMAGE_RESIZE_MODE: process.env.GITBOOK_IMAGE_RESIZE_MODE,
         GITBOOK_FONTS_URL: process.env.GITBOOK_FONTS_URL,
+        GITBOOK_RUNTIME: process.env.GITBOOK_RUNTIME,
 
         // Next.js envs
         NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
@@ -53,6 +53,24 @@ const nextConfig = {
             },
         ],
     },
+
+    async headers() {
+        return [
+            {
+                source: '/~gitbook/static/:path*',
+                headers: [
+                    {
+                        key: 'Cache-Control',
+                        value: 'public, max-age=31536000, immutable',
+                    },
+                    {
+                        key: 'Access-Control-Allow-Origin',
+                        value: '*',
+                    },
+                ],
+            },
+        ];
+    },
 };
 
 export default nextConfig;

packages/gitbook-v2/open-next.config.ts

@@ -1,10 +1,29 @@
-import { defineCloudflareConfig } from '@opennextjs/cloudflare';
-import d1TagCache from '@opennextjs/cloudflare/d1-tag-cache';
-import kvIncrementalCache from '@opennextjs/cloudflare/kv-cache';
-import memoryQueue from '@opennextjs/cloudflare/memory-queue';
+import type { OpenNextConfig } from '@opennextjs/cloudflare';
 
-export default defineCloudflareConfig({
-    incrementalCache: kvIncrementalCache,
-    queue: memoryQueue,
-    tagCache: d1TagCache,
-});
+export default {
+    default: {
+        override: {
+            wrapper: 'cloudflare-node',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+            queue: () => import('./openNext/queue/middleware').then((m) => m.default),
+            incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
+            tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
+        },
+    },
+    middleware: {
+        external: true,
+        override: {
+            wrapper: 'cloudflare-edge',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+            queue: () => import('./openNext/queue/middleware').then((m) => m.default),
+            incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
+            tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
+        },
+    },
+    dangerous: {
+        enableCacheInterception: true,
+    },
+    edgeExternals: ['node:crypto'],
+} satisfies OpenNextConfig;

packages/gitbook-v2/openNext/customWorkers/default.js

@@ -0,0 +1,36 @@
+import { runWithCloudflareRequestContext } from '../../.open-next/cloudflare/init.js';
+
+import { DurableObject } from 'cloudflare:workers';
+
+// Only needed to run locally, in prod we'll use the one from do.js
+export class R2WriteBuffer extends DurableObject {
+    writePromise;
+
+    async write(cacheKey, value) {
+        // We are already writing to this key
+        if (this.writePromise) {
+            return;
+        }
+
+        this.writePromise = this.env.NEXT_INC_CACHE_R2_BUCKET.put(cacheKey, value);
+        this.ctx.waitUntil(
+            this.writePromise.finally(() => {
+                this.writePromise = undefined;
+            })
+        );
+    }
+}
+
+export default {
+    async fetch(request, env, ctx) {
+        return runWithCloudflareRequestContext(request, env, ctx, async () => {
+            // We can't move the handler import to the top level, otherwise the runtime will not be properly initialized
+            const { handler } = await import(
+                '../../.open-next/server-functions/default/handler.mjs'
+            );
+
+            // - `Request`s are handled by the Next server
+            return handler(request, env, ctx);
+        });
+    },
+};

packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc

@@ -0,0 +1,163 @@
+{
+    "main": "default.js",
+    "name": "gitbook-open-v2-server",
+    "compatibility_date": "2025-04-14",
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
+    "observability": {
+        "enabled": true
+    },
+    "vars": {
+        "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+    },
+    "env": {
+        "dev": {
+            "vars": {
+                "STAGE": "dev"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-dev"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["R2WriteBuffer"]
+                }
+            ]
+        },
+        "preview": {
+            "vars": {
+                "STAGE": "preview",
+                // Just as a test for the preview environment to check that everything works
+                "NEXT_PRIVATE_DEBUG_CACHE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-preview"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    }
+                ]
+            }
+        },
+        "staging": {
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-staging"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-staging"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    }
+                ]
+            },
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-staging-tail"
+                }
+            ]
+        },
+        "production": {
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-production"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-server-production"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-production"
+                    }
+                ]
+            },
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-prod-tail"
+                }
+            ]
+        }
+    }
+}

packages/gitbook-v2/openNext/customWorkers/do.js

@@ -0,0 +1,38 @@
+// This worker only purposes it to host the different DO that we will need in the other workers.
+import { DurableObject } from 'cloudflare:workers';
+
+// `use cache` could cause multiple writes to the same key to happen concurrently, there is a limit of 1 write per key/second
+// so we need to buffer writes to the R2 bucket to avoid hitting this limit.
+export class R2WriteBuffer extends DurableObject {
+    writePromise;
+
+    async write(cacheKey, value) {
+        // We are already writing to this key
+        if (this.writePromise) {
+            return;
+        }
+
+        this.writePromise = this.env.NEXT_INC_CACHE_R2_BUCKET.put(cacheKey, value);
+        this.ctx.waitUntil(
+            this.writePromise.finally(() => {
+                this.writePromise = undefined;
+            })
+        );
+    }
+}
+
+export { DOQueueHandler } from '../../.open-next/.build/durable-objects/queue.js';
+
+export { DOShardedTagCache } from '../../.open-next/.build/durable-objects/sharded-tag-cache.js';
+
+export default {
+    async fetch() {
+        // This worker does not handle any requests, it only provides Durable Objects
+        return new Response('This worker is not meant to handle requests directly', {
+            status: 400,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        });
+    },
+};

packages/gitbook-v2/openNext/customWorkers/doWrangler.jsonc

@@ -0,0 +1,127 @@
+{
+    "main": "do.js",
+    "name": "gitbook-open-v2-do",
+    "compatibility_date": "2025-04-14",
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
+    "observability": {
+        "enabled": true
+    },
+    "env": {
+        "preview": {
+            "vars": {
+                "STAGE": "preview",
+                "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache"
+                    },
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache", "R2WriteBuffer"]
+                }
+            ]
+        },
+        "staging": {
+            "vars": {
+                "STAGE": "staging",
+                "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-staging"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-staging-tail"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache"
+                    },
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache", "R2WriteBuffer"]
+                }
+            ]
+        },
+        "production": {
+            "vars": {
+                "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true",
+                "STAGE": "production"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-production"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-prod-tail"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache"
+                    },
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache", "R2WriteBuffer"]
+                }
+            ]
+        }
+    }
+}

packages/gitbook-v2/openNext/customWorkers/middleware.js

@@ -0,0 +1,42 @@
+import { WorkerEntrypoint } from 'cloudflare:workers';
+import { runWithCloudflareRequestContext } from '../../.open-next/cloudflare/init.js';
+
+import { handler as middlewareHandler } from '../../.open-next/middleware/handler.mjs';
+
+export { DOQueueHandler } from '../../.open-next/.build/durable-objects/queue.js';
+
+export { DOShardedTagCache } from '../../.open-next/.build/durable-objects/sharded-tag-cache.js';
+
+export default class extends WorkerEntrypoint {
+    async fetch(request) {
+        return runWithCloudflareRequestContext(request, this.env, this.ctx, async () => {
+            // - `Request`s are handled by the Next server
+            const reqOrResp = await middlewareHandler(request, this.env, this.ctx);
+            if (reqOrResp instanceof Response) {
+                return reqOrResp;
+            }
+
+            if (this.env.STAGE !== 'preview') {
+                // https://developers.cloudflare.com/workers/configuration/versions-and-deployments/gradual-deployments/#version-affinity
+                reqOrResp.headers.set(
+                    'Cloudflare-Workers-Version-Overrides',
+                    `gitbook-open-v2-${this.env.STAGE}="${this.env.WORKER_VERSION_ID}"`
+                );
+                return this.env.DEFAULT_WORKER?.fetch(reqOrResp, {
+                    cf: {
+                        cacheEverything: false,
+                    },
+                });
+            }
+            // If we are in preview mode, we need to send the request to the preview URL
+            const modifiedUrl = new URL(reqOrResp.url);
+            modifiedUrl.hostname = this.env.PREVIEW_HOSTNAME;
+            const nextRequest = new Request(modifiedUrl, reqOrResp);
+            return fetch(nextRequest, {
+                cf: {
+                    cacheEverything: false,
+                },
+            });
+        });
+    }
+}

packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc

@@ -0,0 +1,216 @@
+{
+    "main": "middleware.js",
+    "name": "gitbook-open-v2",
+    "compatibility_date": "2025-04-14",
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
+    "assets": {
+        "directory": "../../.open-next/assets",
+        "binding": "ASSETS"
+    },
+    "observability": {
+        "enabled": true
+    },
+    "vars": {
+        "NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
+    },
+    "env": {
+        "dev": {
+            "vars": {
+                "STAGE": "dev",
+                "NEXT_PRIVATE_DEBUG_CACHE": "true"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-dev"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-dev"
+                }
+            ]
+        },
+        "preview": {
+            "vars": {
+                "STAGE": "preview",
+                "PREVIEW_HOSTNAME": "TO_REPLACE",
+                "WORKER_VERSION_ID": "TO_REPLACE"
+            },
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-preview"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-preview"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-preview"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-preview"
+                    }
+                ]
+            }
+        },
+        "staging": {
+            "vars": {
+                "STAGE": "staging",
+                "WORKER_VERSION_ID": "TO_REPLACE"
+            },
+            "routes": [
+                {
+                    "pattern": "open-2c.gitbook-staging.com/*",
+                    "zone_name": "gitbook-staging.com"
+                },
+                {
+                    "pattern": "static-2c.gitbook-staging.com/*",
+                    "zone_name": "gitbook-staging.com"
+                }
+            ],
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-staging"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-staging"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-staging"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-staging-tail"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-staging"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache"]
+                }
+            ]
+        },
+        "production": {
+            "vars": {
+                // This is a bit misleading, but it means that we can have 500 concurrent revalidations
+                // This means that we'll have up to 100 durable objects instance running at the same time
+                "MAX_REVALIDATE_CONCURRENCY": "100",
+                // Temporary variable to find the issue once deployed
+                // TODO: remove this once the issue is fixed
+                "DEBUG_CLOUDFLARE": "true",
+                "WORKER_VERSION_ID": "TO_REPLACE",
+                "STAGE": "production"
+            },
+            "routes": [
+                {
+                    "pattern": "open-2c.gitbook.com/*",
+                    "zone_name": "gitbook.com"
+                },
+                {
+                    "pattern": "static-2c.gitbook.com/*",
+                    "zone_name": "gitbook.com"
+                }
+            ],
+            "r2_buckets": [
+                {
+                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
+                    "bucket_name": "gitbook-open-v2-cache-production"
+                }
+            ],
+            "services": [
+                {
+                    "binding": "WORKER_SELF_REFERENCE",
+                    "service": "gitbook-open-v2-production"
+                },
+                {
+                    "binding": "DEFAULT_WORKER",
+                    "service": "gitbook-open-v2-server-production"
+                }
+            ],
+            "tail_consumers": [
+                {
+                    "service": "gitbook-x-prod-tail"
+                }
+            ],
+            "durable_objects": {
+                "bindings": [
+                    {
+                        "name": "WRITE_BUFFER",
+                        "class_name": "R2WriteBuffer",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
+                        "class_name": "DOShardedTagCache",
+                        "script_name": "gitbook-open-v2-do-production"
+                    },
+                    {
+                        "name": "NEXT_CACHE_DO_QUEUE",
+                        "class_name": "DOQueueHandler",
+                        "script_name": "gitbook-open-v2-do-production"
+                    }
+                ]
+            },
+            "migrations": [
+                {
+                    "tag": "v1",
+                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache"]
+                }
+            ]
+        }
+    }
+}

packages/gitbook-v2/openNext/customWorkers/script/updateWrangler.ts

@@ -0,0 +1,26 @@
+// In this script, we use the args from the cli to update the PREVIEW_URL vars in the wrangler config file for the middleware
+import fs from 'node:fs';
+import path from 'node:path';
+
+const wranglerConfigPath = path.join(__dirname, '../middlewareWrangler.jsonc');
+
+const file = fs.readFileSync(wranglerConfigPath, 'utf-8');
+
+const args = process.argv.slice(2);
+// The versionId is in the format xxx-xxx-xxx-xxx, we need the first part to reconstruct the preview URL
+const versionId = args[0];
+
+// The preview URL is in the format https://<versionId>-gitbook-open-v2-server-preview.gitbook.workers.dev
+const previewHostname = `${versionId.split('-')[0]}-gitbook-open-v2-server-preview.gitbook.workers.dev`;
+
+let updatedFile = file.replace(
+    /"PREVIEW_HOSTNAME": "TO_REPLACE"/,
+    `"PREVIEW_HOSTNAME": "${previewHostname}"`
+);
+
+updatedFile = updatedFile.replaceAll(
+    /"WORKER_VERSION_ID": "TO_REPLACE"/g,
+    `"WORKER_VERSION_ID": "${versionId}"`
+);
+
+fs.writeFileSync(wranglerConfigPath, updatedFile);

packages/gitbook-v2/openNext/incrementalCache.ts

@@ -0,0 +1,202 @@
+import { createHash } from 'node:crypto';
+
+import { trace } from '@/lib/tracing';
+import type {
+    CacheEntryType,
+    CacheValue,
+    IncrementalCache,
+    WithLastModified,
+} from '@opennextjs/aws/types/overrides.js';
+import { getCloudflareContext } from '@opennextjs/cloudflare';
+
+import type { DurableObjectNamespace, Rpc } from '@cloudflare/workers-types';
+
+export const BINDING_NAME = 'NEXT_INC_CACHE_R2_BUCKET';
+export const DEFAULT_PREFIX = 'incremental-cache';
+
+export type KeyOptions = {
+    cacheType?: CacheEntryType;
+};
+
+/**
+ *
+ * It is very similar to the `R2IncrementalCache` in the `@opennextjs/cloudflare` package, but it allow us to trace
+ * the cache operations. It also integrates both R2 and Cache API in a single class.
+ * Having our own, will allow us to customize it in the future if needed.
+ */
+class GitbookIncrementalCache implements IncrementalCache {
+    name = 'GitbookIncrementalCache';
+
+    protected localCache: Cache | undefined;
+
+    async get<CacheType extends CacheEntryType = 'cache'>(
+        key: string,
+        cacheType?: CacheType
+    ): Promise<WithLastModified<CacheValue<CacheType>> | null> {
+        const cacheKey = this.getR2Key(key, cacheType);
+        return trace(
+            {
+                operation: 'openNextIncrementalCacheGet',
+                name: cacheKey,
+            },
+            async (span) => {
+                span.setAttribute('cacheType', cacheType ?? 'cache');
+                const r2 = getCloudflareContext().env[BINDING_NAME];
+                const localCache = await this.getCacheInstance();
+                if (!r2) throw new Error('No R2 bucket');
+                try {
+                    // Check local cache first if available
+                    const localCacheEntry = await localCache.match(this.getCacheUrlKey(cacheKey));
+                    if (localCacheEntry) {
+                        span.setAttribute('cacheHit', 'local');
+                        return localCacheEntry.json();
+                    }
+
+                    const r2Object = await r2.get(cacheKey);
+                    if (!r2Object) return null;
+
+                    span.setAttribute('cacheHit', 'r2');
+                    return {
+                        value: await r2Object.json(),
+                        lastModified: r2Object.uploaded.getTime(),
+                    };
+                } catch (e) {
+                    console.error('Failed to get from cache', e);
+                    return null;
+                }
+            }
+        );
+    }
+
+    async set<CacheType extends CacheEntryType = 'cache'>(
+        key: string,
+        value: CacheValue<CacheType>,
+        cacheType?: CacheType
+    ): Promise<void> {
+        const cacheKey = this.getR2Key(key, cacheType);
+        return trace(
+            {
+                operation: 'openNextIncrementalCacheSet',
+                name: cacheKey,
+            },
+            async (span) => {
+                span.setAttribute('cacheType', cacheType ?? 'cache');
+                const localCache = await this.getCacheInstance();
+
+                try {
+                    await this.writeToR2(cacheKey, JSON.stringify(value));
+
+                    //TODO: Check if there is any places where we don't have tags
+                    // Ideally we should always have tags, but in case we don't, we need to decide how to handle it
+                    // For now we default to a build ID tag, which allow us to invalidate the cache in case something is wrong in this deployment
+                    const tags = this.getTagsFromCacheEntry(value) ?? [
+                        `build_id/${process.env.NEXT_BUILD_ID}`,
+                    ];
+
+                    // We consider R2 as the source of truth, so we update the local cache
+                    // only after a successful R2 write
+                    await localCache.put(
+                        this.getCacheUrlKey(cacheKey),
+                        new Response(
+                            JSON.stringify({
+                                value,
+                                // Note: `Date.now()` returns the time of the last IO rather than the actual time.
+                                //       See https://developers.cloudflare.com/workers/reference/security-model/
+                                lastModified: Date.now(),
+                            }),
+                            {
+                                headers: {
+                                    // Cache-Control default to 30 minutes, will be overridden by `revalidate`
+                                    // In theory we should always get the `revalidate` value
+                                    'cache-control': `max-age=${value.revalidate ?? 60 * 30}`,
+                                    'cache-tag': tags.join(','),
+                                },
+                            }
+                        )
+                    );
+                } catch (e) {
+                    console.error('Failed to set to cache', e);
+                }
+            }
+        );
+    }
+
+    async delete(key: string): Promise<void> {
+        const cacheKey = this.getR2Key(key);
+        return trace(
+            {
+                operation: 'openNextIncrementalCacheDelete',
+                name: cacheKey,
+            },
+            async () => {
+                const r2 = getCloudflareContext().env[BINDING_NAME];
+                const localCache = await this.getCacheInstance();
+                if (!r2) throw new Error('No R2 bucket');
+
+                try {
+                    await r2.delete(cacheKey);
+
+                    // Here again R2 is the source of truth, so we delete from local cache first
+                    await localCache.delete(this.getCacheUrlKey(cacheKey));
+                } catch (e) {
+                    console.error('Failed to delete from cache', e);
+                }
+            }
+        );
+    }
+
+    async writeToR2(key: string, value: string): Promise<void> {
+        const env = getCloudflareContext().env as {
+            WRITE_BUFFER: DurableObjectNamespace<
+                Rpc.DurableObjectBranded & {
+                    write: (key: string, value: string) => Promise<void>;
+                }
+            >;
+        };
+        const id = env.WRITE_BUFFER.idFromName(key);
+
+        // A stub is a client used to invoke methods on the Durable Object
+        const stub = env.WRITE_BUFFER.get(id);
+
+        await stub.write(key, value);
+    }
+
+    async getCacheInstance(): Promise<Cache> {
+        if (this.localCache) return this.localCache;
+        this.localCache = await caches.open('incremental-cache');
+        return this.localCache;
+    }
+
+    // Utility function to generate keys for R2/Cache API
+    getR2Key(key: string, cacheType: CacheEntryType = 'cache'): string {
+        const hash = createHash('sha256').update(key).digest('hex');
+        return `${DEFAULT_PREFIX}/${cacheType === 'cache' ? process.env?.NEXT_BUILD_ID : 'dataCache'}/${hash}.${cacheType}`.replace(
+            /\/+/g,
+            '/'
+        );
+    }
+
+    getCacheUrlKey(cacheKey: string): string {
+        return `http://cache.local/${cacheKey}`;
+    }
+
+    getTagsFromCacheEntry<CacheType extends CacheEntryType>(
+        entry: CacheValue<CacheType>
+    ): string[] | undefined {
+        if ('tags' in entry && entry.tags) {
+            return entry.tags;
+        }
+
+        if ('meta' in entry && entry.meta && 'headers' in entry.meta && entry.meta.headers) {
+            const rawTags = entry.meta.headers['x-next-cache-tags'];
+            if (typeof rawTags === 'string') {
+                return rawTags.split(',');
+            }
+        }
+        if ('value' in entry) {
+            return entry.tags;
+        }
+    }
+}
+
+export default new GitbookIncrementalCache();

packages/gitbook-v2/openNext/queue/middleware.ts

@@ -0,0 +1,14 @@
+import { trace } from '@/lib/tracing';
+import type { Queue } from '@opennextjs/aws/types/overrides.js';
+import { getCloudflareContext } from '@opennextjs/cloudflare';
+import doQueue from '@opennextjs/cloudflare/overrides/queue/do-queue';
+
+export default {
+    name: 'GitbookISRQueue',
+    send: async (msg) => {
+        return trace({ operation: 'gitbookISRQueueSend', name: msg.MessageBody.url }, async () => {
+            const { ctx } = getCloudflareContext();
+            ctx.waitUntil(doQueue.send(msg));
+        });
+    },
+} satisfies Queue;

packages/gitbook-v2/openNext/queue/server.ts

@@ -0,0 +1,9 @@
+import type { Queue } from '@opennextjs/aws/types/overrides.js';
+
+export default {
+    name: 'GitbookISRQueue',
+    send: async (msg) => {
+        // We should never reach this point in the server. If that's the case, we should log it.
+        console.warn('GitbookISRQueue: send called on server side, this should not happen.', msg);
+    },
+} satisfies Queue;

packages/gitbook-v2/openNext/tagCache/middleware.ts

@@ -0,0 +1,81 @@
+import { trace } from '@/lib/tracing';
+import type { NextModeTagCache } from '@opennextjs/aws/types/overrides.js';
+import doShardedTagCache from '@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache';
+import { softTagFilter } from '@opennextjs/cloudflare/overrides/tag-cache/tag-cache-filter';
+
+const originalTagCache = doShardedTagCache({
+    baseShardSize: 12,
+    regionalCache: true,
+    // We can probably increase this value even further
+    regionalCacheTtlSec: 60,
+    shardReplication: {
+        numberOfSoftReplicas: 2,
+        numberOfHardReplicas: 1,
+        regionalReplication: {
+            defaultRegion: 'enam',
+        },
+    },
+});
+
+export default {
+    name: 'GitbookTagCache',
+    mode: 'nextMode',
+    getLastRevalidated: async (tags: string[]) => {
+        const tagsToCheck = tags.filter(softTagFilter);
+        if (tagsToCheck.length === 0) {
+            // If we reach here, it probably means that there is an issue that we'll need to address.
+            console.warn(
+                'getLastRevalidated - No valid tags to check for last revalidation, original tags:',
+                tags
+            );
+            return 0; // If no tags to check, return 0
+        }
+        return trace(
+            {
+                operation: 'gitbookTagCacheGetLastRevalidated',
+                name: tagsToCheck.join(', '),
+            },
+            async () => {
+                return await originalTagCache.getLastRevalidated(tagsToCheck);
+            }
+        );
+    },
+    hasBeenRevalidated: async (tags: string[], lastModified?: number) => {
+        const tagsToCheck = tags.filter(softTagFilter);
+        if (tagsToCheck.length === 0) {
+            // If we reach here, it probably means that there is an issue that we'll need to address.
+            console.warn(
+                'hasBeenRevalidated - No valid tags to check for revalidation, original tags:',
+                tags
+            );
+            return false; // If no tags to check, return false
+        }
+        return trace(
+            {
+                operation: 'gitbookTagCacheHasBeenRevalidated',
+                name: tagsToCheck.join(', '),
+            },
+            async () => {
+                const result = await originalTagCache.hasBeenRevalidated(tagsToCheck, lastModified);
+                return result;
+            }
+        );
+    },
+    writeTags: async (tags: string[]) => {
+        return trace(
+            {
+                operation: 'gitbookTagCacheWriteTags',
+                name: tags.join(', '),
+            },
+            async () => {
+                const tagsToWrite = tags.filter(softTagFilter);
+                if (tagsToWrite.length === 0) {
+                    console.warn('writeTags - No valid tags to write');
+                    return; // If no tags to write, exit early
+                }
+                // Write only the filtered tags
+                await originalTagCache.writeTags(tagsToWrite);
+            }
+        );
+    },
+} satisfies NextModeTagCache;

packages/gitbook-v2/package.json

@@ -1,22 +1,23 @@
 {
     "name": "gitbook-v2",
-    "version": "0.2.2",
+    "version": "0.3.0",
     "private": true,
     "dependencies": {
-        "next": "^15.2.3",
+        "@gitbook/api": "^0.119.0",
+        "@gitbook/cache-tags": "workspace:*",
+        "@opennextjs/cloudflare": "1.1.0",
+        "@sindresorhus/fnv1a": "^3.1.0",
+        "assert-never": "^1.2.1",
+        "jwt-decode": "^4.0.0",
+        "next": "^15.3.2",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
-        "@gitbook/api": "*",
-        "@gitbook/cache-tags": "workspace:*",
-        "@sindresorhus/fnv1a": "^3.1.0",
-        "server-only": "^0.0.1",
-        "warn-once": "^0.1.1",
         "rison": "^0.1.1",
-        "jwt-decode": "^4.0.0"
+        "server-only": "^0.0.1",
+        "warn-once": "^0.1.1"
     },
     "devDependencies": {
         "gitbook": "*",
-        "@opennextjs/cloudflare": "^0.5.10",
         "@types/rison": "^0.0.9",
         "tailwindcss": "^3.4.0",
         "postcss": "^8"
@@ -27,8 +28,10 @@
         "build": "next build",
         "build:v2": "next build",
         "start": "next start",
-        "build:v2:cloudflare": "opennextjs-cloudflare",
-        "dev:v2:cloudflare": "wrangler dev --port 8771",
+        "build:v2:cloudflare": "opennextjs-cloudflare build",
+        "dev:v2:cloudflare": "wrangler dev --port 8771 --env preview",
+        "dev:v2:cf:middleware": "wrangler dev --port 8771 --inspector-port 9230 --env dev --config ./openNext/customWorkers/middlewareWrangler.jsonc",
+        "dev:v2:cf:server": "wrangler dev --port 8772 --env dev --config ./openNext/customWorkers/defaultWrangler.jsonc",
         "unit": "bun test",
         "typecheck": "tsc --noEmit"
     }

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/(content)/layout.tsx

@@ -20,7 +20,7 @@ export default async function SiteDynamicLayout({
     const forcedTheme = await getThemeFromMiddleware();
 
     return (
-        <CustomizationRootLayout customization={context.customization}>
+        <CustomizationRootLayout forcedTheme={forcedTheme} customization={context.customization}>
             <SiteLayout
                 context={context}
                 forcedTheme={forcedTheme}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/llms.txt/route.ts

@@ -1,12 +0,0 @@
-import type { NextRequest } from 'next/server';
-
-import { serveLLMsTxt } from '@/routes/llms';
-import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
-
-export async function GET(
-    _request: NextRequest,
-    { params }: { params: Promise<RouteLayoutParams> }
-) {
-    const { context } = await getDynamicSiteContext(await params);
-    return serveLLMsTxt(context);
-}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/robots.txt/route.ts

@@ -1,12 +0,0 @@
-import type { NextRequest } from 'next/server';
-
-import { serveRobotsTxt } from '@/routes/robots';
-import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
-
-export async function GET(
-    _request: NextRequest,
-    { params }: { params: Promise<RouteLayoutParams> }
-) {
-    const { context } = await getDynamicSiteContext(await params);
-    return serveRobotsTxt(context);
-}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/sitemap-pages.xml/route.ts

@@ -1,12 +0,0 @@
-import type { NextRequest } from 'next/server';
-
-import { servePagesSitemap } from '@/routes/sitemap';
-import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
-
-export async function GET(
-    _request: NextRequest,
-    { params }: { params: Promise<RouteLayoutParams> }
-) {
-    const { context } = await getDynamicSiteContext(await params);
-    return servePagesSitemap(context);
-}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/[siteData]/sitemap.xml/route.ts

@@ -1,12 +0,0 @@
-import type { NextRequest } from 'next/server';
-
-import { serveRootSitemap } from '@/routes/sitemap';
-import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
-
-export async function GET(
-    _request: NextRequest,
-    { params }: { params: Promise<RouteLayoutParams> }
-) {
-    const { context } = await getDynamicSiteContext(await params);
-    return serveRootSitemap(context);
-}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/[pagePath]/page.tsx

@@ -3,10 +3,9 @@ import {
     generateSitePageMetadata,
     generateSitePageViewport,
 } from '@/components/SitePage';
-import { getCacheTag } from '@gitbook/cache-tags';
 import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
+
 import type { Metadata, Viewport } from 'next';
-import { unstable_cacheTag as cacheTag } from 'next/cache';
 
 export const dynamic = 'force-static';
 
@@ -15,19 +14,10 @@ type PageProps = {
 };
 
 export default async function Page(props: PageProps) {
-    'use cache';
-
     const params = await props.params;
     const { context } = await getStaticSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
-    cacheTag(
-        getCacheTag({
-            tag: 'site',
-            site: context.site.id,
-        })
-    );
-
     return <SitePage context={context} pageParams={{ pathname }} />;
 }
 

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/layout.tsx

@@ -4,10 +4,8 @@ import {
     generateSiteLayoutMetadata,
     generateSiteLayoutViewport,
 } from '@/components/SiteLayout';
-import { getCacheTag } from '@gitbook/cache-tags';
 import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
 import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
-import { unstable_cacheTag as cacheTag } from 'next/cache';
 
 interface SiteStaticLayoutProps {
     params: Promise<RouteLayoutParams>;
@@ -17,17 +15,8 @@ export default async function SiteStaticLayout({
     params,
     children,
 }: React.PropsWithChildren<SiteStaticLayoutProps>) {
-    'use cache';
-
     const { context, visitorAuthClaims } = await getStaticSiteContext(await params);
 
-    cacheTag(
-        getCacheTag({
-            tag: 'site',
-            site: context.site.id,
-        })
-    );
-
     return (
         <CustomizationRootLayout customization={context.customization}>
             <SiteLayout

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/llms-full.txt/route.ts

@@ -0,0 +1,14 @@
+import type { NextRequest } from 'next/server';
+
+import { serveLLMsFullTxt } from '@/routes/llms-full';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams> }
+) {
+    const { context } = await getStaticSiteContext(await params);
+    return serveLLMsFullTxt(context);
+}

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/llms.txt/route.ts

@@ -10,5 +10,5 @@ export async function GET(
     { params }: { params: Promise<RouteLayoutParams> }
 ) {
     const { context } = await getStaticSiteContext(await params);
-    return serveLLMsTxt(context);
+    return serveLLMsTxt(context, { withMarkdownPages: true });
 }

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/~gitbook/markdown/[pagePath]/route.ts

@@ -0,0 +1,11 @@
+import { servePageMarkdown } from '@/routes/markdownPage';
+import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
+import type { NextRequest } from 'next/server';
+
+export const dynamic = 'force-static';
+
+export async function GET(_request: NextRequest, { params }: { params: Promise<RouteParams> }) {
+    const { context } = await getStaticSiteContext(await params);
+    const pathname = getPagePathFromParams(await params);
+    return servePageMarkdown(context, pathname);
+}

packages/gitbook-v2/src/app/utils.ts

@@ -1,6 +1,6 @@
 import { getVisitorAuthClaims, getVisitorAuthClaimsFromToken } from '@/lib/adaptive';
-import type { PublishedSiteContent, SiteAPIToken } from '@gitbook/api';
-import { fetchSiteContextByURLLookup, getBaseContext } from '@v2/lib/context';
+import type { SiteAPIToken } from '@gitbook/api';
+import { type SiteURLData, fetchSiteContextByURLLookup, getBaseContext } from '@v2/lib/context';
 import { jwtDecode } from 'jwt-decode';
 import { forbidden } from 'next/navigation';
 import rison from 'rison';
@@ -98,7 +98,7 @@ function getModeFromParams(mode: string): RouteParamMode {
 /**
  * Get the decoded site data from the params.
  */
-function getSiteURLDataFromParams(params: RouteLayoutParams): PublishedSiteContent {
+function getSiteURLDataFromParams(params: RouteLayoutParams): SiteURLData {
     const decoded = decodeURIComponent(params.siteData);
     return rison.decode(decoded);
 }

packages/gitbook-v2/src/lib/context.ts

@@ -13,12 +13,43 @@ import type {
     SiteStructure,
     Space,
 } from '@gitbook/api';
-import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
+import {
+    type GitBookDataFetcher,
+    createDataFetcher,
+    getDataOrNull,
+    throwIfDataError,
+} from '@v2/lib/data';
+import assertNever from 'assert-never';
+import { notFound } from 'next/navigation';
 import { assert } from 'ts-essentials';
 import { GITBOOK_URL } from './env';
 import { type ImageResizer, createImageResizer } from './images';
 import { type GitBookLinker, createLinker } from './links';
 
+/**
+ * Data about the site URL. Provided by the middleware.
+ * These data are stable between pages in the same site space.
+ */
+export type SiteURLData = Pick<
+    PublishedSiteContent,
+    | 'organization'
+    | 'apiToken'
+    | 'site'
+    | 'siteSpace'
+    | 'space'
+    | 'revision'
+    | 'changeRequest'
+    | 'shareKey'
+    | 'siteSection'
+    | 'siteBasePath'
+    | 'basePath'
+> & {
+    /**
+     * Identifier used for image resizing.
+     */
+    imagesContextId: string;
+};
+
 /**
  * Generic context when rendering content.
  */
@@ -105,7 +136,7 @@ export type GitBookPageContext = (GitBookSpaceContext | GitBookSiteContext) & {
  */
 export function getBaseContext(input: {
     siteURL: URL | string;
-    siteURLData: PublishedSiteContent;
+    siteURLData: SiteURLData;
     urlMode: 'url' | 'url-host';
 }) {
     const { urlMode, siteURLData } = input;
@@ -134,12 +165,12 @@ export function getBaseContext(input: {
         // Create link in the same format for links to other sites/sections.
         linker.toLinkForContent = (rawURL: string) => {
             const urlObject = new URL(rawURL);
-            return `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`;
+            return `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}${urlObject.hash}`;
         };
     }
 
     const imageResizer = createImageResizer({
-        host: siteURL.host,
+        imagesContextId: siteURLData.imagesContextId,
         // To ensure image resizing work for proxied sites,
         // we serve images from the root of the site.
         linker: linker,
@@ -157,7 +188,7 @@ export function getBaseContext(input: {
  */
 export async function fetchSiteContextByURLLookup(
     baseContext: GitBookBaseContext,
-    data: PublishedSiteContent
+    data: SiteURLData
 ): Promise<GitBookSiteContext> {
     return await fetchSiteContextByIds(baseContext, {
         organization: data.organization,
@@ -212,19 +243,45 @@ export async function fetchSiteContextByIds(
         ? parseSiteSectionsAndGroups(siteStructure, ids.siteSection)
         : null;
 
-    const siteSpace = (
-        siteStructure.type === 'siteSpaces' && siteStructure.structure
-            ? siteStructure.structure
-            : sections?.current.siteSpaces
-    )?.find((siteSpace) => siteSpace.id === ids.siteSpace);
-    if (!siteSpace) {
-        throw new Error('Site space not found');
-    }
+    // Parse the current siteSpace and siteSpaces based on the site structure type.
+    const { siteSpaces, siteSpace }: { siteSpaces: SiteSpace[]; siteSpace: SiteSpace } = (() => {
+        if (siteStructure.type === 'siteSpaces') {
+            const siteSpaces = siteStructure.structure;
+            const siteSpace = siteSpaces.find((siteSpace) => siteSpace.id === ids.siteSpace);
 
-    const siteSpaces =
-        siteStructure.type === 'siteSpaces'
-            ? siteStructure.structure
-            : (sections?.current.siteSpaces ?? []);
+            if (!siteSpace) {
+                throw new Error(
+                    `Site space "${ids.siteSpace}" not found in structure type="siteSpaces"`
+                );
+            }
+
+            return { siteSpaces, siteSpace };
+        }
+
+        if (siteStructure.type === 'sections') {
+            assert(
+                sections,
+                `cannot find site space "${ids.siteSpace}" because parsed sections are missing siteStructure.type="sections" siteSection="${ids.siteSection}"`
+            );
+
+            const currentSection = sections.current;
+            const siteSpaces = currentSection.siteSpaces;
+            const siteSpace = currentSection.siteSpaces.find(
+                (siteSpace) => siteSpace.id === ids.siteSpace
+            );
+
+            if (!siteSpace) {
+                throw new Error(
+                    `Site space "${ids.siteSpace}" not found in structure type="sections" currentSection="${currentSection.id}"`
+                );
+            }
+
+            return { siteSpaces, siteSpace };
+        }
+
+        // @ts-expect-error
+        assertNever(siteStructure, `cannot handle site structure of type ${siteStructure.type}`);
+    })();
 
     const customization = (() => {
         if (ids.siteSpace) {
@@ -277,7 +334,7 @@ export async function fetchSpaceContextByIds(
             })
         ),
         ids.changeRequest
-            ? throwIfDataError(
+            ? getDataOrNull(
                   dataFetcher.getChangeRequest({
                       spaceId: ids.space,
                       changeRequestId: ids.changeRequest,
@@ -286,17 +343,30 @@ export async function fetchSpaceContextByIds(
             : null,
     ]);
 
-    const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision;
+    if (ids.changeRequest && !changeRequest) {
+        // When trying to render a change request with an invalid / non-existing ID,
+        // we should return a 404.
+        notFound();
+    }
 
-    const pages = await throwIfDataError(
+    const revisionId = ids.revision ?? changeRequest?.revision ?? space.revision;
+
+    const pages = await getDataOrNull(
         dataFetcher.getRevisionPages({
             spaceId: ids.space,
             revisionId,
             // We only care about the Git metadata when the Git sync is enabled,
             // otherwise we can optimize performance by not fetching it
             metadata: !!space.gitSync,
-        })
+        }),
+
+        // When trying to render a revision with an invalid / non-existing ID,
+        // we should handle gracefully the 404 and throw notFound.
+        ids.revision ? [404] : undefined
     );
+    if (!pages) {
+        notFound();
+    }
 
     return {
         ...baseContext,
@@ -337,7 +407,7 @@ export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {
 function parseSiteSectionsAndGroups(structure: SiteStructure, siteSectionId: string) {
     const sectionsAndGroups = getSiteStructureSections(structure, { ignoreGroups: false });
     const section = parseCurrentSection(structure, siteSectionId);
-    assert(section, 'A section must be defined when there are multiple sections');
+    assert(section, `couldn't find section "${siteSectionId}" in site structure`);
     return { list: sectionsAndGroups, current: section } satisfies SiteSections;
 }
 

packages/gitbook-v2/src/lib/data/api.ts

@@ -2,13 +2,13 @@ import { trace } from '@/lib/tracing';
 import {
     type ComputedContentSource,
     GitBookAPI,
-    type GitBookAPIServiceBinding,
+    type HttpResponse,
     type RenderIntegrationUI,
 } from '@gitbook/api';
 import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
 import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
 import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
-import { wrapDataFetcherError } from './errors';
+import { DataFetcherError, wrapDataFetcherError } from './errors';
 import type { GitBookDataFetcher } from './types';
 
 interface DataFetcherInput {
@@ -18,6 +18,15 @@ interface DataFetcherInput {
     apiToken: string | null;
 }
 
+/**
+ * Options to pass to the `fetch` call to disable the Next data-cache when wrapped in `use cache`.
+ */
+export const noCacheFetchOptions: Partial<RequestInit> = {
+    next: {
+        revalidate: 0,
+    },
+};
+
 /**
  * Create a data fetcher using an API token.
  * The data are being cached by Next.js built-in cache.
@@ -94,6 +103,15 @@ export function createDataFetcher(
                 })
             );
         },
+        getRevisionPageMarkdown(params) {
+            return trace('getRevisionPageMarkdown', () =>
+                getRevisionPageMarkdown(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    pageId: params.pageId,
+                })
+            );
+        },
         getReusableContent(params) {
             return trace('getReusableContent', () =>
                 getReusableContent(input, {
@@ -165,38 +183,37 @@ export function createDataFetcher(
                 })
             );
         },
-        //
-        // API that are not tied to the token
-        // where the data is the same for all users
-        //
+
         getUserById(userId) {
-            return trace('getUserById', () => getUserById({ apiToken: null }, { userId }));
+            return trace('getUserById', () => getUserById(input, { userId }));
+        },
+
+        streamAIResponse(params) {
+            return streamAIResponse(input, params);
         },
     };
 }
 
-async function getUserById(input: DataFetcherInput, params: { userId: string }) {
+const getUserById = async (input: DataFetcherInput, params: { userId: string }) => {
     'use cache';
-
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.users.getUserById(params.userId);
-        return res.data;
+    return trace(`getUserById(${params.userId})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.users.getUserById(params.userId, {
+                ...noCacheFetchOptions,
+            });
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('days');
+            return res.data;
+        });
     });
-}
+};
 
-async function getSpace(
+const getSpace = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        shareKey: string | undefined;
-    }
-) {
+    params: { spaceId: string; shareKey: string | undefined }
+) => {
     'use cache';
-
-    cacheLife('days');
     cacheTag(
         getCacheTag({
             tag: 'space',
@@ -204,151 +221,218 @@ async function getSpace(
         })
     );
 
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getSpaceById(params.spaceId, {
-            shareKey: params.shareKey,
+    return trace(`getSpace(${params.spaceId}, ${params.shareKey})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.spaces.getSpaceById(
+                params.spaceId,
+                {
+                    shareKey: params.shareKey,
+                },
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('days');
+            return res.data;
         });
-        return res.data;
     });
-}
+};
 
-async function getChangeRequest(
+const getChangeRequest = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        changeRequestId: string;
-    }
-) {
+    params: { spaceId: string; changeRequestId: string }
+) => {
     'use cache';
+    cacheTag(
+        getCacheTag({
+            tag: 'change-request',
+            space: params.spaceId,
+            changeRequest: params.changeRequestId,
+        })
+    );
 
-    cacheLife('minutes');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getChangeRequestById(params.spaceId, params.changeRequestId);
-        cacheTag(
-            getCacheTag({
-                tag: 'change-request',
-                space: params.spaceId,
-                changeRequest: res.data.id,
-            })
-        );
-        return res.data;
-    });
-}
-
-async function getRevision(
-    input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        metadata: boolean;
-    }
-) {
-    'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getRevisionById(params.spaceId, params.revisionId, {
-            metadata: params.metadata,
+    return trace(`getChangeRequest(${params.spaceId}, ${params.changeRequestId})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.spaces.getChangeRequestById(
+                params.spaceId,
+                params.changeRequestId,
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('minutes');
+            return res.data;
         });
-        return res.data;
     });
-}
+};
 
-async function getRevisionPages(
+const getRevision = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        metadata: boolean;
-    }
-) {
+    params: { spaceId: string; revisionId: string; metadata: boolean }
+) => {
     'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.listPagesInRevisionById(params.spaceId, params.revisionId, {
-            metadata: params.metadata,
+    return trace(`getRevision(${params.spaceId}, ${params.revisionId})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.spaces.getRevisionById(
+                params.spaceId,
+                params.revisionId,
+                {
+                    metadata: params.metadata,
+                },
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('max');
+            return res.data;
         });
-        return res.data.pages;
     });
-}
+};
 
-async function getRevisionFile(
+const getRevisionPages = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        fileId: string;
-    }
-) {
+    params: { spaceId: string; revisionId: string; metadata: boolean }
+) => {
     'use cache';
-
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getFileInRevisionById(
-            params.spaceId,
-            params.revisionId,
-            params.fileId,
-            {}
-        );
-        return res.data;
+    return trace(`getRevisionPages(${params.spaceId}, ${params.revisionId})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.spaces.listPagesInRevisionById(
+                params.spaceId,
+                params.revisionId,
+                {
+                    metadata: params.metadata,
+                },
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('max');
+            return res.data.pages;
+        });
     });
-}
+};
 
-async function getRevisionPageByPath(
+const getRevisionFile = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        path: string;
-    }
-) {
+    params: { spaceId: string; revisionId: string; fileId: string }
+) => {
     'use cache';
+    return trace(
+        `getRevisionFile(${params.spaceId}, ${params.revisionId}, ${params.fileId})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.spaces.getFileInRevisionById(
+                    params.spaceId,
+                    params.revisionId,
+                    params.fileId,
+                    {},
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('max');
+                return res.data;
+            });
+        }
+    );
+};
 
-    cacheLife('max');
-
-    const encodedPath = encodeURIComponent(params.path);
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getPageInRevisionByPath(
-            params.spaceId,
-            params.revisionId,
-            encodedPath,
-            {}
-        );
-
-        return res.data;
-    });
-}
-
-async function getDocument(
+const getRevisionPageMarkdown = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        documentId: string;
-    }
-) {
+    params: { spaceId: string; revisionId: string; pageId: string }
+) => {
     'use cache';
+    return trace(
+        `getRevisionPageMarkdown(${params.spaceId}, ${params.revisionId}, ${params.pageId})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.spaces.getPageInRevisionById(
+                    params.spaceId,
+                    params.revisionId,
+                    params.pageId,
+                    {
+                        format: 'markdown',
+                    },
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
 
-    cacheLife('max');
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('max');
 
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getDocumentById(params.spaceId, params.documentId, {});
-        return res.data;
+                if (!('markdown' in res.data)) {
+                    throw new DataFetcherError('Page is not a document', 404);
+                }
+                return res.data.markdown;
+            });
+        }
+    );
+};
+
+const getRevisionPageByPath = async (
+    input: DataFetcherInput,
+    params: { spaceId: string; revisionId: string; path: string }
+) => {
+    'use cache';
+    return trace(
+        `getRevisionPageByPath(${params.spaceId}, ${params.revisionId}, ${params.path})`,
+        async () => {
+            const encodedPath = encodeURIComponent(params.path);
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.spaces.getPageInRevisionByPath(
+                    params.spaceId,
+                    params.revisionId,
+                    encodedPath,
+                    {},
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('max');
+                return res.data;
+            });
+        }
+    );
+};
+
+const getDocument = async (
+    input: DataFetcherInput,
+    params: { spaceId: string; documentId: string }
+) => {
+    'use cache';
+    return trace(`getDocument(${params.spaceId}, ${params.documentId})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.spaces.getDocumentById(
+                params.spaceId,
+                params.documentId,
+                {},
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('max');
+            return res.data;
+        });
     });
-}
+};
 
-async function getComputedDocument(
+const getComputedDocument = async (
     input: DataFetcherInput,
     params: {
         spaceId: string;
@@ -356,11 +440,8 @@ async function getComputedDocument(
         source: ComputedContentSource;
         seed: string;
     }
-) {
+) => {
     'use cache';
-
-    cacheLife('days');
-
     cacheTag(
         ...getComputedContentSourceCacheTags(
             {
@@ -371,48 +452,62 @@ async function getComputedDocument(
         )
     );
 
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getComputedDocument(params.spaceId, {
-            source: params.source,
-            seed: params.seed,
-        });
-        return res.data;
-    });
-}
+    return trace(
+        `getComputedDocument(${params.spaceId}, ${params.organizationId}, ${params.source.type}, ${params.seed})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.spaces.getComputedDocument(
+                    params.spaceId,
+                    {
+                        source: params.source,
+                        seed: params.seed,
+                    },
+                    {},
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('max');
+                return res.data;
+            });
+        }
+    );
+};
 
-async function getReusableContent(
+const getReusableContent = async (
     input: DataFetcherInput,
-    params: {
-        spaceId: string;
-        revisionId: string;
-        reusableContentId: string;
-    }
-) {
+    params: { spaceId: string; revisionId: string; reusableContentId: string }
+) => {
     'use cache';
+    return trace(
+        `getReusableContent(${params.spaceId}, ${params.revisionId}, ${params.reusableContentId})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.spaces.getReusableContentInRevisionById(
+                    params.spaceId,
+                    params.revisionId,
+                    params.reusableContentId,
+                    {},
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('max');
+                return res.data;
+            });
+        }
+    );
+};
 
-    cacheLife('max');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getReusableContentInRevisionById(
-            params.spaceId,
-            params.revisionId,
-            params.reusableContentId
-        );
-        return res.data;
-    });
-}
-
-async function getLatestOpenAPISpecVersionContent(
+const getLatestOpenAPISpecVersionContent = async (
     input: DataFetcherInput,
-    params: {
-        organizationId: string;
-        slug: string;
-    }
-) {
+    params: { organizationId: string; slug: string }
+) => {
     'use cache';
-
     cacheTag(
         getCacheTag({
             tag: 'openapi',
@@ -420,29 +515,32 @@ async function getLatestOpenAPISpecVersionContent(
             openAPISpec: params.slug,
         })
     );
-    cacheLife('days');
 
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.orgs.getLatestOpenApiSpecVersionContent(
-            params.organizationId,
-            params.slug
-        );
-        return res.data;
-    });
-}
+    return trace(
+        `getLatestOpenAPISpecVersionContent(${params.organizationId}, ${params.slug})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.orgs.getLatestOpenApiSpecVersionContent(
+                    params.organizationId,
+                    params.slug,
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('max');
+                return res.data;
+            });
+        }
+    );
+};
 
-async function getPublishedContentSite(
+const getPublishedContentSite = async (
     input: DataFetcherInput,
-    params: {
-        organizationId: string;
-        siteId: string;
-        siteShareKey: string | undefined;
-    }
-) {
+    params: { organizationId: string; siteId: string; siteShareKey: string | undefined }
+) => {
     'use cache';
-
-    cacheLife('days');
     cacheTag(
         getCacheTag({
             tag: 'site',
@@ -450,16 +548,30 @@ async function getPublishedContentSite(
         })
     );
 
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.orgs.getPublishedContentSite(params.organizationId, params.siteId, {
-            shareKey: params.siteShareKey,
-        });
-        return res.data;
-    });
-}
+    return trace(
+        `getPublishedContentSite(${params.organizationId}, ${params.siteId}, ${params.siteShareKey})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.orgs.getPublishedContentSite(
+                    params.organizationId,
+                    params.siteId,
+                    {
+                        shareKey: params.siteShareKey,
+                    },
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('days');
+                return res.data;
+            });
+        }
+    );
+};
 
-async function getSiteRedirectBySource(
+const getSiteRedirectBySource = async (
     input: DataFetcherInput,
     params: {
         organizationId: string;
@@ -467,126 +579,179 @@ async function getSiteRedirectBySource(
         siteShareKey: string | undefined;
         source: string;
     }
-) {
+) => {
     'use cache';
-
     cacheTag(
         getCacheTag({
             tag: 'site',
             site: params.siteId,
         })
     );
-    cacheLife('days');
 
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.orgs.getSiteRedirectBySource(params.organizationId, params.siteId, {
-            shareKey: params.siteShareKey,
-            source: params.source,
-        });
+    return trace(
+        `getSiteRedirectBySource(${params.organizationId}, ${params.siteId}, ${params.siteShareKey}, ${params.source})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const api = apiClient(input);
+                const res = await api.orgs.getSiteRedirectBySource(
+                    params.organizationId,
+                    params.siteId,
+                    {
+                        shareKey: params.siteShareKey,
+                        source: params.source,
+                    },
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('days');
+                return res.data;
+            });
+        }
+    );
+};
 
-        return res.data;
-    });
-}
-
-async function getEmbedByUrl(
-    input: DataFetcherInput,
-    params: {
-        url: string;
-        spaceId: string;
-    }
-) {
+const getEmbedByUrl = async (input: DataFetcherInput, params: { spaceId: string; url: string }) => {
     'use cache';
+    cacheTag(
+        getCacheTag({
+            tag: 'space',
+            space: params.spaceId,
+        })
+    );
 
-    cacheLife('weeks');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
-        return res.data;
+    return trace(`getEmbedByUrl(${params.spaceId}, ${params.url})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.spaces.getEmbedByUrlInSpace(
+                params.spaceId,
+                {
+                    url: params.url,
+                },
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('weeks');
+            return res.data;
+        });
     });
-}
+};
 
-async function searchSiteContent(
+const searchSiteContent = async (
     input: DataFetcherInput,
     params: Parameters<GitBookDataFetcher['searchSiteContent']>[0]
-) {
+) => {
     'use cache';
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: params.siteId,
+        })
+    );
 
-    const { organizationId, siteId, query, scope } = params;
+    return trace(
+        `searchSiteContent(${params.organizationId}, ${params.siteId}, ${params.query})`,
+        async () => {
+            return wrapDataFetcherError(async () => {
+                const { organizationId, siteId, query, scope } = params;
+                const api = apiClient(input);
+                const res = await api.orgs.searchSiteContent(
+                    organizationId,
+                    siteId,
+                    {
+                        query,
+                        ...scope,
+                    },
+                    {},
+                    {
+                        ...noCacheFetchOptions,
+                    }
+                );
+                cacheTag(...getCacheTagsFromResponse(res));
+                cacheLife('hours');
+                return res.data.items;
+            });
+        }
+    );
+};
 
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.orgs.searchSiteContent(organizationId, siteId, {
-            query,
-            ...scope,
-        });
-        return res.data.items;
-    });
-}
-
-async function renderIntegrationUi(
+const renderIntegrationUi = async (
     input: DataFetcherInput,
-    params: {
-        integrationName: string;
-        request: RenderIntegrationUI;
-    }
-) {
+    params: { integrationName: string; request: RenderIntegrationUI }
+) => {
     'use cache';
+    cacheTag(
+        getCacheTag({
+            tag: 'integration',
+            integration: params.integrationName,
+        })
+    );
 
-    cacheTag(getCacheTag({ tag: 'integration', integration: params.integrationName }));
-    cacheLife('days');
-
-    return wrapDataFetcherError(async () => {
-        const api = await apiClient(input);
-        const res = await api.integrations.renderIntegrationUiWithPost(
-            params.integrationName,
-            params.request
-        );
-        return res.data;
+    return trace(`renderIntegrationUi(${params.integrationName})`, async () => {
+        return wrapDataFetcherError(async () => {
+            const api = apiClient(input);
+            const res = await api.integrations.renderIntegrationUiWithPost(
+                params.integrationName,
+                params.request,
+                {
+                    ...noCacheFetchOptions,
+                }
+            );
+            cacheTag(...getCacheTagsFromResponse(res));
+            cacheLife('days');
+            return res.data;
+        });
     });
-}
+};
 
-let loggedServiceBinding = false;
+async function* streamAIResponse(
+    input: DataFetcherInput,
+    params: Parameters<GitBookDataFetcher['streamAIResponse']>[0]
+) {
+    const api = apiClient(input);
+    const res = await api.orgs.streamAiResponseInSite(
+        params.organizationId,
+        params.siteId,
+        {
+            input: params.input,
+            output: params.output,
+            model: params.model,
+            instructions: params.instructions,
+            previousResponseId: params.previousResponseId,
+        },
+        {
+            ...noCacheFetchOptions,
+        }
+    );
+
+    for await (const event of res) {
+        yield event;
+    }
+}
 
 /**
  * Create a new API client.
  */
-export async function apiClient(input: DataFetcherInput = { apiToken: null }) {
+export function apiClient(input: DataFetcherInput = { apiToken: null }) {
     const { apiToken } = input;
-    let serviceBinding: GitBookAPIServiceBinding | undefined;
-
-    try {
-        // HACK: This is a workaround to avoid webpack trying to bundle this cloudflare only module
-        // @ts-ignore
-        const { env } = await import(
-            /* webpackIgnore: true */ `${'__cloudflare:workers'.replaceAll('_', '')}`
-        );
-        serviceBinding = env.GITBOOK_API;
-        if (!loggedServiceBinding) {
-            loggedServiceBinding = true;
-            if (serviceBinding) {
-                // biome-ignore lint/suspicious/noConsole: we want to log here
-                console.log(`using service binding for the API (${GITBOOK_API_URL})`);
-            } else {
-                // biome-ignore lint/suspicious/noConsole: we want to log here
-                console.warn(`no service binding for the API (${GITBOOK_API_URL})`);
-            }
-        }
-    } catch (error) {
-        if (process.env.NODE_ENV === 'production' && !process.env.VERCEL) {
-            throw error;
-        }
-    }
 
     const api = new GitBookAPI({
         authToken: apiToken || GITBOOK_API_TOKEN || undefined,
         endpoint: GITBOOK_API_URL,
         userAgent: GITBOOK_USER_AGENT,
-        serviceBinding,
     });
 
     return api;
 }
+
+/**
+ * Get the tags from the API responses.
+ */
+function getCacheTagsFromResponse(response: HttpResponse<unknown, unknown>) {
+    const cacheTagHeader = response.headers.get('x-gitbook-cache-tag');
+    const tags = !cacheTagHeader ? [] : cacheTagHeader.split(',');
+    return tags;
+}

packages/gitbook-v2/src/lib/data/cloudflare.ts

@@ -0,0 +1,13 @@
+import { getCloudflareContext as getCloudflareContextOpenNext } from '@opennextjs/cloudflare';
+import { GITBOOK_RUNTIME } from '../env';
+
+/**
+ * Return the Cloudflare context or null when not running in Cloudflare.
+ */
+export function getCloudflareContext() {
+    if (GITBOOK_RUNTIME !== 'cloudflare') {
+        return null;
+    }
+
+    return getCloudflareContextOpenNext();
+}

packages/gitbook-v2/src/lib/data/errors.ts

@@ -98,6 +98,10 @@ export async function wrapDataFetcherError<T>(
  */
 export function getExposableError(error: Error): DataFetcherErrorData {
     if (error instanceof GitBookAPIError) {
+        if (error.code >= 500) {
+            throw error;
+        }
+
         return {
             code: error.code,
             message: error.errorMessage,
@@ -105,6 +109,10 @@ export function getExposableError(error: Error): DataFetcherErrorData {
     }
 
     if (error instanceof DataFetcherError) {
+        if (error.code >= 500) {
+            throw error;
+        }
+
         return {
             code: error.code,
             message: error.message,

packages/gitbook-v2/src/lib/data/index.ts

@@ -4,3 +4,4 @@ export * from './pages';
 export * from './urls';
 export * from './errors';
 export * from './lookup';
+export * from './visitor';

packages/gitbook-v2/src/lib/data/lookup.ts

@@ -1,48 +1,102 @@
 import { race, tryCatch } from '@/lib/async';
-import { joinPath } from '@/lib/paths';
+import { joinPath, joinPathWithBaseURL } from '@/lib/paths';
 import { trace } from '@/lib/tracing';
-import type { PublishedSiteContentLookup } from '@gitbook/api';
+import type { GitBookAPI, PublishedSiteContentLookup, SiteVisitorPayload } from '@gitbook/api';
 import { apiClient } from './api';
 import { getExposableError } from './errors';
 import type { DataFetcherResponse } from './types';
 import { getURLLookupAlternatives, stripURLSearch } from './urls';
 
-/**
- * Lookup a content by its URL using the GitBook API.
- * To optimize caching, we try multiple lookup alternatives and return the first one that matches.
- */
-export async function getPublishedContentByURL(input: {
+interface LookupPublishedContentByUrlInput {
     url: string;
-    visitorAuthToken: string | null;
     redirectOnError: boolean;
     apiToken: string | null;
+    visitorPayload: SiteVisitorPayload;
+}
+
+/**
+ * Lookup a content by its URL using the GitBook resolvePublishedContentByUrl API endpoint.
+ * To optimize caching, we try multiple lookup alternatives and return the first one that matches.
+ */
+export async function resolvePublishedContentByUrl(input: LookupPublishedContentByUrlInput) {
+    return lookupPublishedContentByUrl({
+        url: input.url,
+        fetchLookupAPIResult: ({ url, signal }) => {
+            const api = apiClient({ apiToken: input.apiToken });
+            return trace(
+                {
+                    operation: 'resolvePublishedContentByUrl',
+                    name: url,
+                },
+                () =>
+                    tryCatch(
+                        api.urls.resolvePublishedContentByUrl(
+                            {
+                                url,
+                                ...(input.visitorPayload ? { visitor: input.visitorPayload } : {}),
+                                redirectOnError: input.redirectOnError,
+                            },
+                            { signal }
+                        )
+                    )
+            );
+        },
+    });
+}
+
+/**
+ * Lookup a content by its URL using the GitBook getPublishedContentByUrl API endpoint.
+ * To optimize caching, we try multiple lookup alternatives and return the first one that matches.
+ *
+ * @deprecated use resolvePublishedContentByUrl.
+ *
+ */
+export async function getPublishedContentByURL(input: LookupPublishedContentByUrlInput) {
+    return lookupPublishedContentByUrl({
+        url: input.url,
+        fetchLookupAPIResult: ({ url, signal }) => {
+            const api = apiClient({ apiToken: input.apiToken });
+            return trace(
+                {
+                    operation: 'getPublishedContentByURL',
+                    name: url,
+                },
+                () =>
+                    tryCatch(
+                        api.urls.getPublishedContentByUrl(
+                            {
+                                url,
+                                visitorAuthToken: input.visitorPayload.jwtToken ?? undefined,
+                                redirectOnError: input.redirectOnError,
+                                // @ts-expect-error - cacheVersion is not a real query param
+                                cacheVersion: 'v2',
+                            },
+                            { signal }
+                        )
+                    )
+            );
+        },
+    });
+}
+
+type TryCatch<T> = ReturnType<typeof tryCatch<T>>;
+
+async function lookupPublishedContentByUrl(input: {
+    url: string;
+    fetchLookupAPIResult: (args: {
+        url: string;
+        signal: AbortSignal;
+    }) => TryCatch<Awaited<ReturnType<GitBookAPI['urls']['resolvePublishedContentByUrl']>>>;
 }): Promise<DataFetcherResponse<PublishedSiteContentLookup>> {
     const lookupURL = new URL(input.url);
     const url = stripURLSearch(lookupURL);
     const lookup = getURLLookupAlternatives(url);
 
     const result = await race(lookup.urls, async (alternative, { signal }) => {
-        const api = await apiClient({ apiToken: input.apiToken });
-
-        const callResult = await trace(
-            {
-                operation: 'getPublishedContentByURL',
-                name: alternative.url,
-            },
-            () =>
-                tryCatch(
-                    api.urls.getPublishedContentByUrl(
-                        {
-                            url: alternative.url,
-                            visitorAuthToken: input.visitorAuthToken ?? undefined,
-                            redirectOnError: input.redirectOnError,
-                        },
-                        {
-                            signal,
-                        }
-                    )
-                )
-        );
+        const callResult = await input.fetchLookupAPIResult({
+            url: alternative.url,
+            signal,
+        });
 
         if (callResult.error) {
             if (alternative.primary) {
@@ -100,6 +154,7 @@ export async function getPublishedContentByURL(input: {
 
             const siteResult: PublishedSiteContentLookup = {
                 ...data,
+                canonicalUrl: joinPathWithBaseURL(data.canonicalUrl, alternative.extraPath),
                 basePath: joinPath(data.basePath, lookup.basePath ?? ''),
                 pathname: joinPath(data.pathname, alternative.extraPath),
                 ...(changeRequest ? { changeRequest } : {}),

packages/gitbook-v2/src/lib/data/types.ts

@@ -97,6 +97,15 @@ export interface GitBookDataFetcher {
         path: string;
     }): Promise<DataFetcherResponse<api.RevisionPageDocument | api.RevisionPageGroup>>;
 
+    /**
+     * Get the markdown content of a page by its path.
+     */
+    getRevisionPageMarkdown(params: {
+        spaceId: string;
+        revisionId: string;
+        pageId: string;
+    }): Promise<DataFetcherResponse<string>>;
+
     /**
      * Get a document by its space ID and document ID.
      */
@@ -170,4 +179,17 @@ export interface GitBookDataFetcher {
         integrationName: string;
         request: api.RenderIntegrationUI;
     }): Promise<DataFetcherResponse<api.ContentKitRenderOutput>>;
+
+    /**
+     * Stream an AI response.
+     */
+    streamAIResponse(params: {
+        organizationId: string;
+        siteId: string;
+        input: api.AIMessageInput[];
+        output: api.AIOutputFormat;
+        model: api.AIModel;
+        instructions?: string;
+        previousResponseId?: string;
+    }): AsyncGenerator<api.AIStreamResponse, void, unknown>;
 }

packages/gitbook-v2/src/lib/data/visitor.test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, it } from 'bun:test';
+import { getVisitorAuthBasePath } from './visitor';
+
+describe('getVisitorAuthBasePath', () => {
+    it('should return the correct base path for proxy requests', () => {
+        expect(
+            getVisitorAuthBasePath(
+                new URL('https://proxy.gitbook.site/sites/site_foo/hello/world'),
+                {
+                    site: 'site_foo',
+                    siteSpace: 'sitesp_foo',
+                    basePath: '/foo',
+                    siteBasePath: '/foo',
+                    organization: 'org_foo',
+                    space: 'space_foo',
+                    pathname: '/hello/world',
+                    complete: false,
+                    apiToken: 'api_token_foo',
+                    canonicalUrl: 'https://example.com/docs/foo/hello/world',
+                }
+            )
+        ).toBe('/sites/site_foo/');
+    });
+
+    it('should return the correct base path for non-proxy requests', () => {
+        expect(
+            getVisitorAuthBasePath(new URL('https://example.com/docs/foo/hello/world'), {
+                site: 'site_foo',
+                siteSpace: 'sitesp_foo',
+                basePath: '/foo/',
+                siteBasePath: '/foo/',
+                organization: 'org_foo',
+                space: 'space_foo',
+                pathname: '/hello/world',
+                complete: false,
+                apiToken: 'api_token_foo',
+                canonicalUrl: 'https://example.com/docs/foo/hello/world',
+            })
+        ).toBe('/foo/');
+    });
+});

packages/gitbook-v2/src/lib/data/visitor.ts

@@ -0,0 +1,19 @@
+import { withLeadingSlash, withTrailingSlash } from '@/lib/paths';
+import type { PublishedSiteContent } from '@gitbook/api';
+import { getProxyRequestIdentifier, isProxyRequest } from '@v2/lib/proxy';
+
+/**
+ * Get the appropriate base path for the visitor authentication cookie.
+ */
+export function getVisitorAuthBasePath(
+    siteRequestURL: URL,
+    siteURLData: PublishedSiteContent
+): string {
+    // The siteRequestURL for proxy requests is of the form `https://proxy.gitbook.com/site/siteId/...`
+    // In such cases, we should not use the resolved siteBasePath for the cookie because for subsequent requests
+    // we will not have the siteBasePath in the request URL in order to retrieve the cookie. So we use the
+    // proxy identifier instead.
+    return isProxyRequest(siteRequestURL)
+        ? withLeadingSlash(withTrailingSlash(getProxyRequestIdentifier(siteRequestURL)))
+        : siteURLData.siteBasePath;
+}

packages/gitbook-v2/src/lib/env/globals.ts

@@ -6,6 +6,14 @@ import 'server-only';
  * and not from the `process.env` object.
  */
 
+/**
+ * Runtime environment.
+ */
+export const GITBOOK_RUNTIME = (process.env.GITBOOK_RUNTIME ?? 'unknown') as
+    | 'vercel'
+    | 'cloudflare'
+    | 'unknown';
+
 /**
  * Main host on which GitBook is running.
  */
@@ -77,6 +85,15 @@ export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ??
 export const GITBOOK_IMAGE_RESIZE_SIGNING_KEY =
     process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY ?? null;
 
+/**
+ * Mode used for resizing images.
+ */
+export const GITBOOK_IMAGE_RESIZE_MODE = enforceEnum(
+    'GITBOOK_IMAGE_RESIZE_MODE',
+    process.env.GITBOOK_IMAGE_RESIZE_MODE || 'cdn-cgi',
+    ['cdn-cgi', 'cf-fetch']
+);
+
 /**
  * Endpoint where icons are served.
  */
@@ -92,3 +109,12 @@ export const GITBOOK_ICONS_TOKEN = process.env.GITBOOK_ICONS_TOKEN;
  * Secret used to validate requests from the GitBook app.
  */
 export const GITBOOK_SECRET = process.env.GITBOOK_SECRET ?? null;
+
+function enforceEnum<T extends string>(key: string, value: string, enumValues: T[]): T {
+    if (!enumValues.includes(value as T)) {
+        throw new Error(
+            `Invalid value for ${key}: "${value}", expected one of: ${enumValues.join(', ')}`
+        );
+    }
+    return value as T;
+}

packages/gitbook-v2/src/lib/images/checkIsSizableImageURL.test.ts

@@ -0,0 +1,81 @@
+import { describe, expect, it } from 'bun:test';
+import { SizableImageAction, checkIsSizableImageURL } from './checkIsSizableImageURL';
+
+describe('checkIsSizableImageURL', () => {
+    it('should return Skip for non-parsable URLs', () => {
+        expect(checkIsSizableImageURL('not a url')).toBe(SizableImageAction.Skip);
+    });
+
+    it('should return Skip for non-http(s) URLs', () => {
+        expect(checkIsSizableImageURL('data:image/png;base64,abc')).toBe(SizableImageAction.Skip);
+        expect(checkIsSizableImageURL('file:///path/to/image.jpg')).toBe(SizableImageAction.Skip);
+    });
+
+    it('should return Skip for localhost URLs', () => {
+        expect(checkIsSizableImageURL('http://localhost:3000/image.jpg')).toBe(
+            SizableImageAction.Skip
+        );
+        expect(checkIsSizableImageURL('https://localhost/image.png')).toBe(SizableImageAction.Skip);
+    });
+
+    it('should return Skip for GitBook image URLs', () => {
+        expect(checkIsSizableImageURL('https://example.com/~gitbook/image/test.jpg')).toBe(
+            SizableImageAction.Skip
+        );
+    });
+
+    it('should return Resize for supported image extensions', () => {
+        expect(checkIsSizableImageURL('https://example.com/image.jpg')).toBe(
+            SizableImageAction.Resize
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.jpeg')).toBe(
+            SizableImageAction.Resize
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.png')).toBe(
+            SizableImageAction.Resize
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.gif')).toBe(
+            SizableImageAction.Resize
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.webp')).toBe(
+            SizableImageAction.Resize
+        );
+    });
+
+    it('should return Resize for URLs without extensions', () => {
+        expect(checkIsSizableImageURL('https://example.com/image')).toBe(SizableImageAction.Resize);
+    });
+
+    it('should return Passthrough for unsupported image extensions', () => {
+        expect(checkIsSizableImageURL('https://example.com/image.svg')).toBe(
+            SizableImageAction.Passthrough
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.bmp')).toBe(
+            SizableImageAction.Passthrough
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.tiff')).toBe(
+            SizableImageAction.Passthrough
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.ico')).toBe(
+            SizableImageAction.Passthrough
+        );
+    });
+
+    it('should handle URLs with query parameters correctly', () => {
+        expect(checkIsSizableImageURL('https://example.com/image.jpg?width=100')).toBe(
+            SizableImageAction.Resize
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.svg?height=200')).toBe(
+            SizableImageAction.Passthrough
+        );
+    });
+
+    it('should be case-insensitive for extensions', () => {
+        expect(checkIsSizableImageURL('https://example.com/image.JPG')).toBe(
+            SizableImageAction.Resize
+        );
+        expect(checkIsSizableImageURL('https://example.com/image.PNG')).toBe(
+            SizableImageAction.Resize
+        );
+    });
+});

packages/gitbook-v2/src/lib/images/checkIsSizableImageURL.ts

@@ -0,0 +1,43 @@
+import { getExtension } from '@/lib/paths';
+
+export enum SizableImageAction {
+    Resize = 'resize',
+    Skip = 'skip',
+    Passthrough = 'passthrough',
+}
+
+/**
+ * https://developers.cloudflare.com/images/transform-images/#supported-input-formats
+ */
+const SUPPORTED_IMAGE_EXTENSIONS = ['.jpg', '.jpeg', '.png', '.gif', '.webp'];
+
+/**
+ * Check if an image URL is resizable.
+ * Skip it for non-http(s) URLs (data, etc).
+ * Skip it for SVGs.
+ * Skip it for GitBook images (to avoid recursion).
+ */
+export function checkIsSizableImageURL(input: string): SizableImageAction {
+    if (!URL.canParse(input)) {
+        return SizableImageAction.Skip;
+    }
+
+    const parsed = new URL(input);
+    if (parsed.protocol !== 'http:' && parsed.protocol !== 'https:') {
+        return SizableImageAction.Skip;
+    }
+    if (parsed.hostname === 'localhost') {
+        return SizableImageAction.Skip;
+    }
+    if (parsed.pathname.includes('/~gitbook/image')) {
+        return SizableImageAction.Skip;
+    }
+
+    const extension = getExtension(parsed.pathname).toLowerCase();
+    if (!extension || SUPPORTED_IMAGE_EXTENSIONS.includes(extension)) {
+        // If no extension, we consider it resizable.
+        return SizableImageAction.Resize;
+    }
+
+    return SizableImageAction.Passthrough;
+}

packages/gitbook-v2/src/lib/images/createImageResizer.ts

@@ -1,45 +1,22 @@
 import 'server-only';
-
 import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY, GITBOOK_IMAGE_RESIZE_URL } from '../env';
 import type { GitBookLinker } from '../links';
+import { SizableImageAction, checkIsSizableImageURL } from './checkIsSizableImageURL';
+import { getImageSize } from './resizer';
 import { type SignatureVersion, generateImageSignature } from './signatures';
 import type { ImageResizer } from './types';
 
-interface CloudflareImageJsonFormat {
-    width: number;
-    height: number;
-    original: {
-        file_size: number;
-        width: number;
-        height: number;
-        format: string;
-    };
-}
-
-/**
- * https://developers.cloudflare.com/images/image-resizing/resize-with-workers/
- */
-export interface CloudflareImageOptions {
-    format?: 'webp' | 'avif' | 'json' | 'jpeg';
-    fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
-    width?: number;
-    height?: number;
-    dpr?: number;
-    anim?: boolean;
-    quality?: number;
-}
-
 /**
  * Create an image resizer for a rendering context.
  */
 export function createImageResizer({
-    host,
+    imagesContextId,
     linker,
 }: {
     /** The linker to use to create URLs. */
     linker: GitBookLinker;
-    /** The host name of the current site. */
-    host: string;
+    /** The site identifier to use for verifying the image signature. */
+    imagesContextId: string;
 }): ImageResizer {
     if (!GITBOOK_IMAGE_RESIZE_URL || !GITBOOK_IMAGE_RESIZE_SIGNING_KEY) {
         return createNoopImageResizer();
@@ -47,7 +24,7 @@ export function createImageResizer({
 
     return {
         getResizedImageURL: (urlInput) => {
-            if (!checkIsSizableImageURL(urlInput)) {
+            if (checkIsSizableImageURL(urlInput) === SizableImageAction.Skip) {
                 return null;
             }
 
@@ -58,7 +35,7 @@ export function createImageResizer({
 
             return async (options) => {
                 cachedSignature ??= await generateImageSignature({
-                    host,
+                    imagesContextId,
                     url: urlInput,
                 });
 
@@ -87,7 +64,7 @@ export function createImageResizer({
         },
 
         getImageSize: async (input, options) => {
-            if (!checkIsSizableImageURL(input)) {
+            if (checkIsSizableImageURL(input) !== SizableImageAction.Resize) {
                 return null;
             }
 
@@ -106,124 +83,6 @@ export function createNoopImageResizer(): ImageResizer {
     };
 }
 
-/**
- * Check if a URL is an HTTP URL.
- */
-export function checkIsHttpURL(input: string | URL): boolean {
-    if (!URL.canParse(input)) {
-        return false;
-    }
-    const parsed = new URL(input);
-    return parsed.protocol === 'http:' || parsed.protocol === 'https:';
-}
-
-/**
- * Check if an image URL is resizable.
- * Skip it for non-http(s) URLs (data, etc).
- * Skip it for SVGs.
- * Skip it for GitBook images (to avoid recursion).
- */
-export function checkIsSizableImageURL(input: string): boolean {
-    if (!URL.canParse(input)) {
-        return false;
-    }
-
-    if (input.includes('/~gitbook/image')) {
-        return false;
-    }
-
-    const parsed = new URL(input);
-    if (parsed.pathname.endsWith('.svg') || parsed.pathname.endsWith('.avif')) {
-        return false;
-    }
-    if (!checkIsHttpURL(parsed)) {
-        return false;
-    }
-
-    return true;
-}
-
-/**
- * Get the size of an image.
- */
-export async function getImageSize(
-    input: string,
-    defaultSize: Partial<CloudflareImageOptions> = {}
-): Promise<{ width: number; height: number } | null> {
-    if (!checkIsSizableImageURL(input)) {
-        return null;
-    }
-
-    try {
-        const response = await resizeImage(input, {
-            // Abort the request after 2 seconds to avoid blocking rendering for too long
-            signal: AbortSignal.timeout(2000),
-            // Measure size and resize it to the most common size
-            // to optimize caching
-            ...defaultSize,
-            format: 'json',
-            anim: false,
-        });
-
-        const json = (await response.json()) as CloudflareImageJsonFormat;
-        return {
-            width: json.original.width,
-            height: json.original.height,
-        };
-    } catch (_error) {
-        return null;
-    }
-}
-
-/**
- * Execute a Cloudflare Image Resize operation on an image.
- */
-export async function resizeImage(
-    input: string,
-    options: CloudflareImageOptions & {
-        signal?: AbortSignal;
-    }
-): Promise<Response> {
-    const { signal, ...resizeOptions } = options;
-
-    const parsed = new URL(input);
-    if (parsed.protocol === 'data:') {
-        throw new Error('Cannot resize data: URLs');
-    }
-
-    if (parsed.hostname === 'localhost') {
-        throw new Error('Cannot resize localhost URLs');
-    }
-
-    // Since Cloudflare Images options on fetch are not supported on Cloudflare Pages,
-    // we need to use the Cloudflare Image Resize API directly.
-    if (!GITBOOK_IMAGE_RESIZE_URL) {
-        throw new Error('GITBOOK_IMAGE_RESIZE_URL is not set');
-    }
-
-    return await fetch(
-        `${GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
-            resizeOptions
-        )}/${encodeURIComponent(input)}`,
-        {
-            headers: {
-                // Pass the `Accept` header, as Cloudflare uses this to validate the format.
-                Accept:
-                    resizeOptions.format === 'json'
-                        ? 'application/json'
-                        : `image/${resizeOptions.format || 'jpeg'}`,
-            },
-            signal,
-        }
-    );
-}
-
-function stringifyOptions(options: CloudflareImageOptions): string {
-    return Object.entries({ ...options }).reduce((rest, [key, value]) => {
-        return `${rest}${rest ? ',' : ''}${key}=${value}`;
-    }, '');
-}
-
 /**
  * Because of a bug in Cloudflare, 127.0.0.1 is replaced by localhost.
  * We protect against it by converting to a special token, and then parsing

packages/gitbook-v2/src/lib/images/getImageResizingContextId.test.ts

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'bun:test';
+import { getImageResizingContextId } from './getImageResizingContextId';
+
+describe('getImageResizingContextId', () => {
+    it('should return proxy identifier for proxy requests', () => {
+        const proxyRequestURL = new URL('https://proxy.gitbook.site/sites/site_foo/hello/world');
+        expect(getImageResizingContextId(proxyRequestURL)).toBe('sites/site_foo');
+    });
+
+    it('should return preview identifier for preview requests', () => {
+        const previewRequestURL = new URL('https://preview/site_foo/hello/world');
+        expect(getImageResizingContextId(previewRequestURL)).toBe('site_foo');
+    });
+
+    it('should return host for regular requests', () => {
+        const regularRequestURL = new URL('https://example.com/docs/foo/hello/world');
+        expect(getImageResizingContextId(regularRequestURL)).toBe('example.com');
+    });
+});

packages/gitbook-v2/src/lib/images/getImageResizingContextId.ts

@@ -0,0 +1,17 @@
+import { getPreviewRequestIdentifier, isPreviewRequest } from '@v2/lib/preview';
+import { getProxyRequestIdentifier, isProxyRequest } from '@v2/lib/proxy';
+
+/**
+ * Get the site identifier to use for image resizing for an incoming request.
+ * This identifier can be obtained before resolving the request URL.
+ */
+export function getImageResizingContextId(url: URL): string {
+    if (isProxyRequest(url)) {
+        return getProxyRequestIdentifier(url);
+    }
+    if (isPreviewRequest(url)) {
+        return getPreviewRequestIdentifier(url);
+    }
+
+    return url.host;
+}

packages/gitbook-v2/src/lib/images/index.ts

@@ -2,3 +2,6 @@ export * from './types';
 export * from './createImageResizer';
 export * from './signatures';
 export * from './utils';
+export * from './getImageResizingContextId';
+export * from './resizer';
+export * from './checkIsSizableImageURL';

packages/gitbook-v2/src/lib/images/resizer/cdn-cgi.ts

@@ -0,0 +1,48 @@
+import { GITBOOK_IMAGE_RESIZE_URL } from '@v2/lib/env';
+import type { CloudflareImageOptions } from './types';
+import { copyImageResponse } from './utils';
+
+/**
+ * Resize an image by doing a request to a /cdn/cgi/ endpoint.
+ * https://developers.cloudflare.com/images/transform-images/transform-via-url/
+ */
+export async function resizeImageWithCDNCgi(
+    input: string,
+    options: CloudflareImageOptions & {
+        signal?: AbortSignal;
+    }
+): Promise<Response> {
+    const { signal, ...resizeOptions } = options;
+
+    // Since Cloudflare Images options on fetch are not supported on Cloudflare Pages,
+    // we need to use the Cloudflare Image Resize API directly.
+    if (!GITBOOK_IMAGE_RESIZE_URL) {
+        throw new Error('GITBOOK_IMAGE_RESIZE_URL is not set for cdn-cgi image resize mode');
+    }
+
+    const resizeURL = `${GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
+        resizeOptions
+    )}/${encodeURIComponent(input)}`;
+
+    // biome-ignore lint/suspicious/noConsole: this log is useful for debugging
+    console.log(`resize image using cdn-cgi: ${resizeURL}`);
+
+    return copyImageResponse(
+        await fetch(resizeURL, {
+            headers: {
+                // Pass the `Accept` header, as Cloudflare uses this to validate the format.
+                Accept:
+                    resizeOptions.format === 'json'
+                        ? 'application/json'
+                        : `image/${resizeOptions.format || 'jpeg'}`,
+            },
+            signal,
+        })
+    );
+}
+
+function stringifyOptions(options: CloudflareImageOptions): string {
+    return Object.entries({ ...options }).reduce((rest, [key, value]) => {
+        return `${rest}${rest ? ',' : ''}${key}=${value}`;
+    }, '');
+}

packages/gitbook-v2/src/lib/images/resizer/cf-fetch.ts

@@ -0,0 +1,34 @@
+import type { CloudflareImageOptions } from './types';
+import { copyImageResponse } from './utils';
+
+/**
+ * Resize an image by doing a request to the image itself using the Cloudflare fetch.
+ * https://developers.cloudflare.com/images/transform-images/transform-via-workers/
+ *
+ * This method doesn't work in Cloudflare Pages and is only supported in workers.
+ */
+export async function resizeImageWithCFFetch(
+    input: string,
+    options: CloudflareImageOptions & {
+        signal?: AbortSignal;
+    }
+): Promise<Response> {
+    const { signal, ...resizeOptions } = options;
+
+    // biome-ignore lint/suspicious/noConsole: this log is useful for debugging
+    console.log(`resize image using cf-fetch: ${input}`);
+
+    return copyImageResponse(
+        await fetch(input, {
+            headers: {
+                // Pass the `Accept` header, as Cloudflare uses this to validate the format.
+                Accept:
+                    resizeOptions.format === 'json'
+                        ? 'application/json'
+                        : `image/${resizeOptions.format || 'jpeg'}`,
+            },
+            signal,
+            cf: { image: resizeOptions },
+        })
+    );
+}

packages/gitbook-v2/src/lib/images/resizer/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './resizeImage';

packages/gitbook-v2/src/lib/images/resizer/resizeImage.ts

@@ -0,0 +1,72 @@
+import 'server-only';
+import assertNever from 'assert-never';
+import { GITBOOK_IMAGE_RESIZE_MODE } from '../../env';
+import { SizableImageAction, checkIsSizableImageURL } from '../checkIsSizableImageURL';
+import { resizeImageWithCDNCgi } from './cdn-cgi';
+import { resizeImageWithCFFetch } from './cf-fetch';
+import type { CloudflareImageJsonFormat, CloudflareImageOptions } from './types';
+
+/**
+ * Get the size of an image.
+ */
+export async function getImageSize(
+    input: string,
+    defaultSize: Partial<CloudflareImageOptions> = {}
+): Promise<{ width: number; height: number } | null> {
+    if (checkIsSizableImageURL(input) !== SizableImageAction.Resize) {
+        return null;
+    }
+
+    try {
+        const response = await resizeImage(input, {
+            // Abort the request after 2 seconds to avoid blocking rendering for too long
+            signal: AbortSignal.timeout(2000),
+            // Measure size and resize it to the most common size
+            // to optimize caching
+            ...defaultSize,
+            format: 'json',
+            anim: false,
+        });
+
+        const json = (await response.json()) as CloudflareImageJsonFormat;
+        return {
+            width: json.original.width,
+            height: json.original.height,
+        };
+    } catch (error) {
+        console.warn(`Error getting image size for ${input}:`, error);
+        return null;
+    }
+}
+
+/**
+ * Execute a Cloudflare Image Resize operation on an image.
+ */
+export async function resizeImage(
+    input: string,
+    options: CloudflareImageOptions & {
+        signal?: AbortSignal;
+    }
+): Promise<Response> {
+    const action = checkIsSizableImageURL(input);
+    if (action === SizableImageAction.Skip) {
+        throw new Error(
+            'Cannot resize this image, this function should have never been called on this url'
+        );
+    }
+
+    if (action === SizableImageAction.Passthrough) {
+        return fetch(input, {
+            signal: options.signal,
+        });
+    }
+
+    switch (GITBOOK_IMAGE_RESIZE_MODE) {
+        case 'cdn-cgi':
+            return resizeImageWithCDNCgi(input, options);
+        case 'cf-fetch':
+            return resizeImageWithCFFetch(input, options);
+        default:
+            assertNever(GITBOOK_IMAGE_RESIZE_MODE);
+    }
+}

packages/gitbook-v2/src/lib/images/resizer/types.ts

@@ -0,0 +1,23 @@
+export interface CloudflareImageJsonFormat {
+    width: number;
+    height: number;
+    original: {
+        file_size: number;
+        width: number;
+        height: number;
+        format: string;
+    };
+}
+
+/**
+ * https://developers.cloudflare.com/images/image-resizing/resize-with-workers/
+ */
+export interface CloudflareImageOptions {
+    format?: 'webp' | 'avif' | 'json' | 'jpeg';
+    fit?: 'scale-down' | 'contain' | 'cover' | 'crop' | 'pad';
+    width?: number;
+    height?: number;
+    dpr?: number;
+    anim?: boolean;
+    quality?: number;
+}

packages/gitbook-v2/src/lib/images/resizer/utils.ts

@@ -0,0 +1,7 @@
+/**
+ * Copy a response to make sure it can be mutated by the rest of the middleware.
+ * To avoid errors "Can't modify immutable headers".
+ */
+export function copyImageResponse(response: Response) {
+    return new Response(response.body, response);
+}

packages/gitbook-v2/src/lib/images/signatures.ts

@@ -18,7 +18,7 @@ export const CURRENT_SIGNATURE_VERSION: SignatureVersion = '2';
 
 type SignFnInput = {
     url: string;
-    host: string;
+    imagesContextId: string;
 };
 
 type SignFn = (input: SignFnInput) => MaybePromise<string>;
@@ -32,6 +32,11 @@ export async function verifyImageSignature(
 ): Promise<boolean> {
     const generator = IMAGE_SIGNATURE_FUNCTIONS[version];
     const generated = await generator(input);
+
+    // biome-ignore lint/suspicious/noConsole: we want to log the signature comparison
+    console.log(
+        `comparing image signature for "${input.url}" on identifier "${input.imagesContextId}": "${generated}" (expected) === "${signature}" (actual)`
+    );
     return generated === signature;
 }
 
@@ -60,12 +65,14 @@ const generateSignatureV2: SignFn = async (input) => {
     assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
     const all = [
         input.url,
-        input.host, // The hostname is used to avoid serving images from other sites on the same domain
+        input.imagesContextId, // The hostname is used to avoid serving images from other sites on the same domain
         GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
     ]
         .filter(Boolean)
         .join(':');
-    return fnv1a(all, { utf8Buffer: fnv1aUtf8Buffer }).toString(16);
+
+    const signature = fnv1a(all, { utf8Buffer: fnv1aUtf8Buffer }).toString(16);
+    return signature;
 };
 
 // Reused buffer for FNV-1a hashing in the v1 algorithm

packages/gitbook-v2/src/lib/links.test.ts

@@ -19,7 +19,7 @@ const siteGitBookIO = createLinker({
     siteBasePath: '/sitename/',
 });
 
-describe('toPathInContent', () => {
+describe('toPathInSpace', () => {
     it('should return the correct path', () => {
         expect(root.toPathInSpace('some/path')).toBe('/some/path');
         expect(variantInSection.toPathInSpace('some/path')).toBe('/section/variant/some/path');
@@ -29,6 +29,16 @@ describe('toPathInContent', () => {
         expect(root.toPathInSpace('/some/path')).toBe('/some/path');
         expect(variantInSection.toPathInSpace('/some/path')).toBe('/section/variant/some/path');
     });
+
+    it('should remove the trailing slash', () => {
+        expect(root.toPathInSpace('some/path/')).toBe('/some/path');
+        expect(variantInSection.toPathInSpace('some/path/')).toBe('/section/variant/some/path');
+    });
+
+    it('should not add a trailing slash', () => {
+        expect(root.toPathInSpace('')).toBe('');
+        expect(variantInSection.toPathInSpace('')).toBe('/section/variant');
+    });
 });
 
 describe('toPathInSite', () => {
@@ -36,6 +46,16 @@ describe('toPathInSite', () => {
         expect(root.toPathInSite('some/path')).toBe('/some/path');
         expect(siteGitBookIO.toPathInSite('some/path')).toBe('/sitename/some/path');
     });
+
+    it('should remove the trailing slash', () => {
+        expect(root.toPathInSite('some/path/')).toBe('/some/path');
+        expect(siteGitBookIO.toPathInSite('some/path/')).toBe('/sitename/some/path');
+    });
+
+    it('should not add a trailing slash', () => {
+        expect(root.toPathInSite('')).toBe('');
+        expect(siteGitBookIO.toPathInSite('')).toBe('/sitename');
+    });
 });
 
 describe('toRelativePathInSite', () => {

packages/gitbook-v2/src/lib/links.ts

@@ -93,6 +93,11 @@ export function createLinker(
         },
 
         toAbsoluteURL(absolutePath: string): string {
+            // If the path is already a full URL, we return it as is.
+            if (URL.canParse(absolutePath)) {
+                return absolutePath;
+            }
+
             if (!servedOn.host) {
                 return absolutePath;
             }
@@ -123,5 +128,9 @@ export function createLinker(
 function joinPaths(prefix: string, path: string): string {
     const prefixPath = prefix.endsWith('/') ? prefix : `${prefix}/`;
     const suffixPath = path.startsWith('/') ? path.slice(1) : path;
-    return prefixPath + suffixPath;
+    return removeTrailingSlash(prefixPath + suffixPath);
+}
+
+function removeTrailingSlash(path: string): string {
+    return path.endsWith('/') ? path.slice(0, -1) : path;
 }

packages/gitbook-v2/src/lib/middleware.ts

@@ -1,5 +1,6 @@
-import { CustomizationThemeMode, type PublishedSiteContent } from '@gitbook/api';
+import { CustomizationThemeMode } from '@gitbook/api';
 import { headers } from 'next/headers';
+import type { SiteURLData } from './context';
 
 export enum MiddlewareHeaders {
     /**
@@ -57,7 +58,7 @@ export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
  * Get the site URL data from the middleware headers.
  * This function should only be called in a server action or a dynamic route.
  */
-export async function getSiteURLDataFromMiddleware(): Promise<PublishedSiteContent> {
+export async function getSiteURLDataFromMiddleware(): Promise<SiteURLData> {
     const headersList = await headers();
     const siteURLData = headersList.get(MiddlewareHeaders.SiteURLData);
 

packages/gitbook-v2/src/lib/preview.test.ts

@@ -0,0 +1,21 @@
+import { describe, expect, it } from 'bun:test';
+import { getPreviewRequestIdentifier, isPreviewRequest } from './preview';
+
+describe('isPreviewRequest', () => {
+    it('should return true for preview requests', () => {
+        const previewRequestURL = new URL('https://preview/site_foo/hello/world');
+        expect(isPreviewRequest(previewRequestURL)).toBe(true);
+    });
+
+    it('should return false for non-preview requests', () => {
+        const nonPreviewRequestURL = new URL('https://example.com/docs/foo/hello/world');
+        expect(isPreviewRequest(nonPreviewRequestURL)).toBe(false);
+    });
+});
+
+describe('getPreviewRequestIdentifier', () => {
+    it('should return the correct identifier for preview requests', () => {
+        const previewRequestURL = new URL('https://preview/site_foo/hello/world');
+        expect(getPreviewRequestIdentifier(previewRequestURL)).toBe('site_foo');
+    });
+});

packages/gitbook-v2/src/lib/preview.ts

@@ -0,0 +1,13 @@
+/**
+ * Check if the request to the site is a preview request.
+ */
+export function isPreviewRequest(requestURL: URL): boolean {
+    return requestURL.host === 'preview';
+}
+
+export function getPreviewRequestIdentifier(requestURL: URL): string {
+    // For preview requests, we extract the site ID from the pathname
+    // e.g. https://preview/site_id/...
+    const pathname = requestURL.pathname.slice(1).split('/');
+    return pathname[0];
+}

packages/gitbook-v2/src/lib/proxy.test.ts

@@ -0,0 +1,21 @@
+import { describe, expect, it } from 'bun:test';
+import { getProxyRequestIdentifier, isProxyRequest } from './proxy';
+
+describe('isProxyRequest', () => {
+    it('should return true for proxy requests', () => {
+        const proxyRequestURL = new URL('https://proxy.gitbook.site/sites/site_foo/hello/world');
+        expect(isProxyRequest(proxyRequestURL)).toBe(true);
+    });
+
+    it('should return false for non-proxy requests', () => {
+        const nonProxyRequestURL = new URL('https://example.com/docs/foo/hello/world');
+        expect(isProxyRequest(nonProxyRequestURL)).toBe(false);
+    });
+});
+
+describe('getProxyRequestIdentifier', () => {
+    it('should return the correct identifier for proxy requests', () => {
+        const proxyRequestURL = new URL('https://proxy.gitbook.site/sites/site_foo/hello/world');
+        expect(getProxyRequestIdentifier(proxyRequestURL)).toBe('sites/site_foo');
+    });
+});

packages/gitbook-v2/src/lib/proxy.ts

@@ -0,0 +1,15 @@
+/**
+ * Check if the request to the site was through a proxy.
+ */
+export function isProxyRequest(requestURL: URL): boolean {
+    return (
+        requestURL.host === 'proxy.gitbook.site' || requestURL.host === 'proxy.gitbook-staging.site'
+    );
+}
+
+export function getProxyRequestIdentifier(requestURL: URL): string {
+    // For proxy requests, we extract the site ID from the pathname
+    // e.g. https://proxy.gitbook.site/site/siteId/...
+    const pathname = requestURL.pathname.slice(1).split('/');
+    return pathname.slice(0, 2).join('/');
+}