Version Packages (#2984)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

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

@@ -0,0 +1,71 @@
+name: 'Deploy cloudflare'
+description: 'Deploy GitBook to Cloudflare'
+inputs:
+  opItem:
+    description: '1Password item to load secrets from'
+    required: true
+  opServiceAccount:
+    description: '1Password service account token'
+    required: true
+  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
+  deploy:
+    description: 'Deploy as main version for all traffic instead of uploading versions'
+    required: true
+outputs:
+    deployment-url: 
+      description: "Deployment URL"
+      value: ${{ steps.deploy.outputs.deployment-url }}
+runs:
+    using: 'composite'
+    steps:
+        - name: Setup Bun
+          uses: ./.github/composite/setup-bun
+        - name: Install dependencies
+          run: bun install --frozen-lockfile
+          shell: bash
+          env:
+              PUPPETEER_SKIP_DOWNLOAD: 1
+        - name: Load secret
+          uses: 1password/load-secrets-action@v2
+          env:
+            OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
+            GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
+            GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
+            GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
+            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.opItem }}/NEXT_SERVER_ACTIONS_ENCRYPTION_KEY
+            GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
+            GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
+            GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
+            GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
+            GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
+            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_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
+        - name: Build worker
+          run: bun run turbo build:v2:cloudflare
+          shell: bash
+        - id: deploy
+          name: Deploy to Cloudflare
+          uses: cloudflare/wrangler-action@v3.14.0
+          with:
+              apiToken: ${{ inputs.apiToken }}
+              accountId: ${{ inputs.accountId }}
+              workingDirectory: ./
+              wranglerVersion: '3.112.0'
+              environment: ${{ inputs.environment }}
+              command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
+        - name: Outputs
+          shell: bash
+          env:
+            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+          run: |
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

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

@@ -1,15 +1,21 @@
 name: 'Deploy vercel'
 description: 'Deploy GitBook to Vercel'
 inputs:
-  vercel-org:
+  vercelOrg:
     description: 'Vercel organization'
     required: true
-  vercel-project:
+  vercelProject:
     description: 'Vercel project'
     required: true
-  vercel-token:
+  vercelToken:
     description: 'Vercel token'
     required: true
+  opItem:
+    description: '1Password item to load secrets from'
+    required: true
+  opServiceAccount:
+    description: '1Password service account token'
+    required: true
   environment:
     description: 'Environment to deploy to'
     required: true
@@ -27,31 +33,43 @@ runs:
           shell: bash
           env:
               PUPPETEER_SKIP_DOWNLOAD: 1
-        - name: Sets env vars for environment
-          shell: bash
-          run: |
-              echo "VERCEL_ENVIRONMENT=${{ inputs.environment }}" >> $GITHUB_ENV
         - name: Pull Vercel Environment Information
-          run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}
+          run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
           shell: bash
           env:
-            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Load secret
+          uses: 1password/load-secrets-action@v2
+          env:
+            OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
+            GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
+            GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
+            GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
+            GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
+            GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
+            GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
+            GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
+            GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
+            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_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
         - name: Build Project Artifacts
-          run: bun run vercel build --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}
+          run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
           shell: bash
           env:
-            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
         - name: Deploy Project Artifacts to Vercel
           id: deploy
           shell: bash
           run: |
-              DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }})
+              DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }})
               echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
           env:
-            VERCEL_ORG_ID: ${{ inputs.vercel-org }}
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercel-project }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
         - name: Outputs
           shell: bash
           run: |

.github/workflows/ci.yaml

@@ -7,316 +7,6 @@ on:
 env:
     NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
-    deploy:
-        name: Deploy to Cloudflare Pages
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Sets env vars for production
-              run: |
-                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
-              if: startsWith(github.ref, 'refs/heads/main')
-            - name: Sets env vars for preview
-              run: |
-                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
-            - name: Build Next.js with next-on-pages
-              run: bun run turbo gitbook#build:cloudflare
-              env:
-                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
-                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
-                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
-                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
-                  SENTRY_RELEASE: ${{ github.sha }}
-            - id: deploy
-              name: Deploy to Cloudflare
-              uses: cloudflare/wrangler-action@v3.14.0
-              with:
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  workingDirectory: ./
-                  wranglerVersion: '3.82.0'
-                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
-            - name: Archive build output
-              uses: actions/upload-artifact@v4
-              with:
-                  name: build-output
-                  path: .vercel/
-            # Until https://github.com/cloudflare/wrangler-action/issues/301 is done
-            - name: Update Deployment Status to Success
-              env:
-                  DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
-              run: |
-                  curl -X POST \
-                    -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
-                    -H "Accept: application/vnd.github.v3+json" \
-                    -d '{"state": "success", "target_url": "${{ steps.deploy.outputs.deployment-url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
-                    https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }}
-    deploy-v2-vercel:
-        name: Deploy v2 to Vercel
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Deploy ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
-              id: deploy
-              uses: ./.github/composite/deploy-vercel
-              with:
-                  environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
-                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
-                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
-    deploy-v2-vercel-staging:
-        name: Deploy v2 to Vercel (staging)
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        if: startsWith(github.ref, 'refs/heads/main')
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Deploy staging
-              id: deploy
-              uses: ./.github/composite/deploy-vercel
-              with:
-                  environment: staging
-                  vercel-org: ${{ secrets.VERCEL_ORG_ID }}
-                  vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
-                  vercel-token: ${{ secrets.VERCEL_TOKEN }}
-    deploy-v2-cloudflare:
-        name: Deploy v2 to Cloudflare Worker
-        runs-on: ubuntu-latest
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Sets env vars for production
-              run: |
-                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "GITBOOK_URL=https://open-2c.gitbook.com" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static-2c.gitbook.com" >> $GITHUB_ENV
-              if: startsWith(github.ref, 'refs/heads/main')
-            - name: Sets env vars for preview
-              run: |
-                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
-            - name: Build worker
-              run: bun run turbo build:v2:cloudflare
-              env:
-                  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
-                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-                  SENTRY_ORG: ${{ vars.SENTRY_ORG }}
-                  SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
-                  SENTRY_DSN: ${{ vars.SENTRY_DSN }}
-                  SENTRY_RELEASE: ${{ github.sha }}
-            - id: deploy
-              name: Deploy to Cloudflare
-              uses: cloudflare/wrangler-action@v3.14.0
-              with:
-                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-                  workingDirectory: ./
-                  wranglerVersion: '3.82.0'
-                  command: versions upload --config ./packages/gitbook-v2/wrangler.toml
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-    comment-deployments:
-        runs-on: ubuntu-latest
-        name: Comment Deployments
-        if: always() && !startsWith(github.ref, 'refs/heads/main')
-        needs:
-            - deploy
-            - deploy-v2-vercel
-            - deploy-v2-cloudflare
-        steps:
-            - name: Find GitHub Comment
-              uses: peter-evans/find-comment@v3
-              id: fc
-              with:
-                  issue-number: ${{ github.event.pull_request.number }}
-                  comment-author: 'github-actions[bot]'
-                  body-includes: 'Summary of the deployments'
-
-            - name: Create or update GitHub comment
-              uses: peter-evans/create-or-update-comment@v4
-              with:
-                  comment-id: ${{ steps.fc.outputs.comment-id }}
-                  issue-number: ${{ github.event.pull_request.number }}
-                  body: |
-                      Summary of the deployments:
-
-                      ### Version 1 (production)
-
-                      | Version | URL | Status |
-                      | --- | --- | --- |
-                      | Latest commit | [${{ needs.deploy.outputs.deployment-url }}](${{ needs.deploy.outputs.deployment-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
-                      | PR | [${{ needs.deploy.outputs.deployment-alias-url }}](${{ needs.deploy.outputs.deployment-alias-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
-
-                      ### Version 2 (experimental)
-
-                      | Version | URL | Status |
-                      | --- | --- | --- |
-                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
-                      | Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
-
-                      ### Test content
-
-                      | Site | v1 | v2 |
-                      | --- | --- | --- |
-                      | GitBook | [${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy.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.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy.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) |
-                  edit-mode: replace
-    visual-testing:
-        runs-on: ubuntu-latest
-        name: Visual Testing
-        needs: deploy
-        timeout-minutes: 6
-        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.outputs.deployment-url }}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-    visual-testing-v2:
-        runs-on: ubuntu-latest
-        name: Visual Testing v2
-        needs: deploy-v2-vercel
-        timeout-minutes: 6
-        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-vercel.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'v2'
-    visual-testing-customers:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers
-        needs: deploy
-        timeout-minutes: 6
-        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.outputs.deployment-url }}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers'
-    visual-testing-customers-v2:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers v2
-        needs: deploy-v2-vercel
-        timeout-minutes: 6
-        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-vercel.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers-v2'
-    pagespeed-testing:
-        runs-on: ubuntu-latest
-        name: PageSpeed Testing
-        needs: deploy
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run pagespeed tests
-              run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
-              env:
-                  DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment-url}}
-                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
     format:
         runs-on: ubuntu-latest
         name: Format

.github/workflows/deploy-preview.yaml

@@ -0,0 +1,245 @@
+name: Preview
+on:
+    pull_request:
+    push:
+      branches:
+        - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy-v1-cloudflare:
+        name: Deploy v1 to Cloudflare Pages
+        runs-on: ubuntu-latest
+        environment: 
+          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Sets env vars for production
+              if: github.ref == 'refs/heads/main'
+              run: |
+                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+            - name: Build Next.js with next-on-pages
+              run: bun run turbo gitbook#build:cloudflare
+              env:
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.14.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.112.0'
+                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (preview)
+        runs-on: ubuntu-latest
+        environment: 
+          name: 2v-preview
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy to Vercel
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                  environment: preview
+                  vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                  vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                  vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                  opItem: op://gitbook-open/2v-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (preview)
+        runs-on: ubuntu-latest
+        environment: 
+          name: 2c-preview
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy to Cloudflare
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: preview
+                  deploy: ${{ github.ref == 'refs/heads/main' }}
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-preview
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+    comment-deployments:
+        runs-on: ubuntu-latest
+        name: Comment Deployments (preview)
+        if: always() && !startsWith(github.ref, 'refs/heads/main')
+        needs:
+            - deploy-v1-cloudflare
+            - deploy-v2-vercel
+            - deploy-v2-cloudflare
+        steps:
+            - name: Find GitHub Comment
+              uses: peter-evans/find-comment@v3
+              id: fc
+              with:
+                  issue-number: ${{ github.event.pull_request.number }}
+                  comment-author: 'github-actions[bot]'
+                  body-includes: 'Summary of the deployments'
+
+            - name: Create or update GitHub comment
+              uses: peter-evans/create-or-update-comment@v4
+              with:
+                  comment-id: ${{ steps.fc.outputs.comment-id }}
+                  issue-number: ${{ github.event.pull_request.number }}
+                  body: |
+                      Summary of the deployments:
+
+                      ### Version 1 (production)
+
+                      | 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 | URL | Status |
+                      | --- | --- | --- |
+                      | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
+                      | Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
+
+                      ### 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) |
+                  edit-mode: replace
+    visual-testing-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing v1
+        needs: deploy-v1-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
+              env:
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+    visual-testing-v2-vercel:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2
+        needs: deploy-v2-vercel
+        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-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'v2-vercel'
+    visual-testing-customers-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 6
+        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-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v1'
+    visual-testing-customers-v2:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2
+        needs: deploy-v2-vercel
+        timeout-minutes: 6
+        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-vercel.outputs.deployment-url }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.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
+        needs: deploy-v1-cloudflare
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Run pagespeed tests
+              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
+              env:
+                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/deploy-production.yaml

@@ -0,0 +1,53 @@
+name: Production
+on:
+    push:
+        branches:
+            - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (production)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2v-production
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy staging
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                environment: production
+                vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                opItem: op://gitbook-open/2v-production
+                opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (production)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2c-production
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: production
+                  deploy: true
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-production
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -0,0 +1,53 @@
+name: Staging
+on:
+    push:
+        branches:
+            - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
+jobs:
+    deploy-v2-vercel:
+        name: Deploy v2 to Vercel (staging)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2v-staging
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy staging
+              id: deploy
+              uses: ./.github/composite/deploy-vercel
+              with:
+                environment: staging
+                vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
+                vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
+                vercelToken: ${{ secrets.VERCEL_TOKEN }}
+                opItem: op://gitbook-open/2v-staging
+                opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+    deploy-v2-cloudflare:
+        name: Deploy v2 to Cloudflare Worker (staging)
+        runs-on: ubuntu-latest
+        environment: 
+            name: 2c-staging
+            url: ${{ steps.deploy.outputs.deployment-url }}
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Deploy
+              id: deploy
+              uses: ./.github/composite/deploy-cloudflare
+              with:
+                  environment: staging
+                  deploy: true
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  opItem: op://gitbook-open/2c-staging
+                  opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.prettierignore

@@ -1,17 +0,0 @@
-.next
-.vercel
-.open-next
-
-# Generated
-packages/emoji-codepoints/index.ts
-packages/gitbook/public/~gitbook/static/
-packages/icons/src/data/*.json
-
-# Build files
-dist/
-
-README.md
-CHANGELOG.md
-
-# v2
-packages/gitbook-v2/public/~gitbook/static/

.prettierrc.json

@@ -1,5 +0,0 @@
-{
-    "printWidth": 100,
-    "singleQuote": true,
-    "tabWidth": 4
-}

.vscode/settings.json

@@ -11,6 +11,7 @@
     "prettier.enable": false,
     "editor.defaultFormatter": "biomejs.biome",
     "editor.codeActionsOnSave": {
-        "source.organizeImports": "explicit"
+        "source.organizeImports.biome": "explicit",
+        "source.fixAll.biome": "explicit"
     }
 }

biome.json

@@ -18,7 +18,9 @@
             "**/.vercel/**/*",
             "**/.cache/**/*",
             "**/.wrangler/**/*",
-            "packages/openapi-parser/src/fixtures/**/*"
+            "packages/openapi-parser/src/fixtures/**/*",
+            "packages/emoji-codepoints/index.ts",
+            "packages/icons/src/data/*.json"
         ]
     },
     "formatter": {
@@ -67,7 +69,12 @@
                 "useThrowOnlyError": "error"
             },
             "suspicious": {
-                "noConsole": "warn",
+                "noConsole": {
+                    "level": "warn",
+                    "options": {
+                        "allow": ["assert", "error", "warn"]
+                    }
+                },
                 "noExplicitAny": "warn",
                 "noImplicitAnyLet": "warn",
                 "noConfusingVoidType": "warn",

package.json

@@ -11,7 +11,8 @@
     "overrides": {
         "@codemirror/state": "6.4.1",
         "react": "18.3.1",
-        "react-dom": "18.3.1"
+        "react-dom": "18.3.1",
+        "@gitbook/api": "0.99.0"
     },
     "private": true,
     "scripts": {

packages/cache-do/package.json

@@ -21,7 +21,7 @@
     },
     "devDependencies": {
         "typescript": "^5.5.3",
-        "wrangler": "^3.109.2"
+        "wrangler": "^3.112.0"
     },
     "scripts": {
         "generate": "wrangler types --experimental-include-runtime",

packages/cache-tags/.gitignore

@@ -0,0 +1 @@
+dist/

packages/cache-tags/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @gitbook/cache-tags
+
+## 0.2.0
+
+### Minor Changes
+
+- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
+
+## 0.1.0
+
+### Minor Changes
+
+- 05ffd0e: Initial version of the package

packages/cache-tags/README.md

@@ -0,0 +1,3 @@
+# `@gitbook/cache-tags`
+
+Utility to generate cache tags for GitBook Open.

packages/cache-tags/package.json

@@ -0,0 +1,25 @@
+{
+    "name": "@gitbook/cache-tags",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "version": "0.2.0",
+    "dependencies": {
+        "@gitbook/api": "*",
+        "assert-never": "^1.2.1"
+    },
+    "devDependencies": {
+        "typescript": "^5.5.3"
+    },
+    "scripts": {
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w"
+    },
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+}

packages/cache-tags/src/index.ts

@@ -0,0 +1,186 @@
+import type { ComputedContentSource } from '@gitbook/api';
+import assertNever from 'assert-never';
+
+/**
+ * Get a stringified cache tag for a given object.
+ */
+export function getCacheTag(
+    spec: /**
+     * All data related to a user
+     * @deprecated - in v2, no tag as this is an immutable data
+     */
+        | {
+              tag: 'user';
+              user: string;
+          }
+        /**
+         * All data related to a space
+         */
+        | {
+              tag: 'space';
+              space: string;
+          }
+        /**
+         * All data related to an integration.
+         */
+        | {
+              tag: 'integration';
+              integration: string;
+          }
+        /**
+         * All data related to a change request
+         */
+        | {
+              tag: 'change-request';
+              space: string;
+              changeRequest: string;
+          }
+        /**
+         * Immutable data related to a revision
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'revision';
+              space: string;
+              revision: string;
+          }
+        /**
+         * Immutable data related to a document
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'document';
+              space: string;
+              document: string;
+          }
+        /**
+         * Immutable data related to a computed document
+         * @deprecated - in v2, no tag as this is an immutable data
+         */
+        | {
+              tag: 'computed-document';
+              space: string;
+              integration: string;
+          }
+        /**
+         * All data related to the URL of a content
+         */
+        | {
+              tag: 'url';
+              hostname: string;
+          }
+        /**
+         * All data related to a site
+         */
+        | {
+              tag: 'site';
+              site: string;
+          }
+        /**
+         * All data related to an OpenAPI spec
+         */
+        | {
+              tag: 'openapi';
+              organization: string;
+              openAPISpec: string;
+          }
+): string {
+    switch (spec.tag) {
+        case 'user':
+            return `user:${spec.user}`;
+        case 'url':
+            return `url:${spec.hostname}`;
+        case 'space':
+            return `space:${spec.space}`;
+        case 'change-request':
+            return `space:${spec.space}:change-request:${spec.changeRequest}`;
+        case 'revision':
+            return `space:${spec.space}:revision:${spec.revision}`;
+        case 'document':
+            return `space:${spec.space}:document:${spec.document}`;
+        case 'computed-document':
+            return `space:${spec.space}:computed-document:${spec.integration}`;
+        case 'site':
+            return `site:${spec.site}`;
+        case 'integration':
+            return `integration:${spec.integration}`;
+        case 'openapi':
+            return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
+        default:
+            assertNever(spec);
+    }
+}
+
+/**
+ * Get the cache tag for a given URL.
+ */
+export function getCacheTagForURL(url: string | URL) {
+    const parsedURL = url instanceof URL ? url : new URL(url);
+    return getCacheTag({
+        tag: 'url',
+        hostname: parsedURL.hostname,
+    });
+}
+
+/**
+ * Get the tags for a computed content source.
+ */
+export function getComputedContentSourceCacheTags(
+    inContext: {
+        spaceId: string;
+        organizationId: string;
+    },
+    source: ComputedContentSource
+) {
+    const tags: string[] = [];
+
+    // We add the dependencies as tags, to ensure that the computed content is invalidated
+    // when the dependencies are updated.
+    const dependencies = Object.values(source.dependencies ?? {});
+    if (dependencies.length > 0) {
+        dependencies.forEach((dependency) => {
+            switch (dependency.ref.kind) {
+                case 'space':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'space',
+                            space: dependency.ref.space,
+                        })
+                    );
+                    break;
+                case 'openapi':
+                    tags.push(
+                        getCacheTag({
+                            tag: 'openapi',
+                            organization: inContext.organizationId,
+                            openAPISpec: dependency.ref.spec,
+                        })
+                    );
+                    break;
+                default:
+                    // Do not throw for unknown dependency types
+                    // as it might mean we are lacking behind the API version
+                    break;
+            }
+        });
+    } else {
+        // Push a dummy tag, as the v1 is only using the first tag
+        tags.push(
+            getCacheTag({
+                tag: 'computed-document',
+                space: inContext.spaceId,
+                integration: source.integration,
+            })
+        );
+    }
+
+    // We invalidate the computed content when a new version of the integration is deployed.
+    tags.push(
+        getCacheTag({
+            tag: 'integration',
+            integration: source.integration,
+        })
+    );
+
+    return tags;
+}

packages/cache-tags/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "target": "esnext",
+        "lib": ["dom", "dom.iterable", "esnext"],
+        "allowJs": true,
+        "skipLibCheck": true,
+        "strict": true,
+        "noEmit": false,
+        "declaration": true,
+        "outDir": "dist",
+        "esModuleInterop": true,
+        "module": "esnext",
+        "moduleResolution": "bundler",
+        "resolveJsonModule": true,
+        "isolatedModules": true,
+        "jsx": "react-jsx",
+        "incremental": true,
+        "types": [
+            "bun-types" // add Bun global
+        ]
+    },
+    "include": ["src/**/*.ts", "src/**/*.tsx"],
+    "exclude": ["node_modules"]
+}

packages/colors/CHANGELOG.md

@@ -1,7 +1,13 @@
 # @gitbook/colors
 
+## 0.3.0
+
+### Minor Changes
+
+- 4f0a772: Override tint lightness if supplied color is out of bounds
+
 ## 0.2.0
 
 ### Minor Changes
 
--   445baaa: Initial release
+- 445baaa: Initial release

packages/colors/package.json

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

packages/colors/src/transformations.ts

@@ -184,6 +184,7 @@ export function colorScale(
     const mixColor = mix?.color ? rgbToOklch(hexToRgbArray(mix.color)) : null;
     const foregroundColor = rgbToOklch(hexToRgbArray(foreground));
     const backgroundColor = rgbToOklch(hexToRgbArray(background));
+    let mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
 
     if (mixColor && mix?.ratio && mix.ratio > 0) {
         // If defined, we mix in a (tiny) bit of the mix color with the base color.
@@ -192,7 +193,20 @@ export function colorScale(
         baseColor.H = mix.color === DEFAULT_TINT_COLOR ? baseColor.H : mixColor.H;
     }
 
-    const mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
+    if (
+        (darkMode && baseColor.L < backgroundColor.L) ||
+        (!darkMode && baseColor.L > backgroundColor.L)
+    ) {
+        // If the supplied color is outside of our lightness bounds, use the supplied color's lightness.
+        // This is mostly used to allow darker-than-dark backgrounds for brands that specifically want that look.
+        const difference = (backgroundColor.L - baseColor.L) / backgroundColor.L;
+        backgroundColor.L = baseColor.L;
+        // At the edges of the scale, the subtle lightness changes stop being perceptible. We need to amp up our mapping to still stand out.
+        const amplifier = 1;
+        mapping = mapping.map((step, index) =>
+            index < 9 ? step + step * amplifier * difference : step
+        );
+    }
 
     const result = [];
 

packages/gitbook-v2/CHANGELOG.md

@@ -1,13 +1,34 @@
 # gitbook-v2
 
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [f32bf1f]
+  - @gitbook/cache-tags@0.2.0
+
+## 0.2.0
+
+### Minor Changes
+
+- 76c7974: Add route to revalidate cached data
+
+## 0.1.2
+
+### Patch Changes
+
+- 05ffd0e: Improving data cache management for computed content
+- Updated dependencies [05ffd0e]
+  - @gitbook/cache-tags@0.1.0
+
 ## 0.1.1
 
 ### Patch Changes
 
--   3e11678: fix: lost section groups
+- 3e11678: fix: lost section groups
 
 ## 0.1.0
 
 ### Minor Changes
 
--   cfccc44: Setup structure and deployment for new version
+- cfccc44: Setup structure and deployment for new version

packages/gitbook-v2/next.config.mjs

@@ -10,10 +10,21 @@ const nextConfig = {
 
     env: {
         BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
-        GITBOOK_URL: process.env.GITBOOK_URL,
+
-        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
+        // GitBook envs
+        GITBOOK_API_URL: process.env.GITBOOK_API_URL,
+        GITBOOK_APP_URL: process.env.GITBOOK_APP_URL,
+        GITBOOK_INTEGRATIONS_HOST: process.env.GITBOOK_INTEGRATIONS_HOST,
+        GITBOOK_IMAGE_RESIZE_URL: process.env.GITBOOK_IMAGE_RESIZE_URL,
         GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
         GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
+        GITBOOK_URL: process.env.GITBOOK_URL,
+        GITBOOK_API_TOKEN: process.env.GITBOOK_API_TOKEN,
+        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,
+
+        // Next.js envs
         NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
 
         // Used to detect if the app is running in V2 mode

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

@@ -1,30 +1,10 @@
-// default open-next.config.ts file created by @opennextjs/cloudflare
+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 cache from '@opennextjs/cloudflare/kvCache';
+export default defineCloudflareConfig({
-
+    incrementalCache: kvIncrementalCache,
-const config = {
+    queue: memoryQueue,
-    default: {
+    tagCache: d1TagCache,
-        override: {
+});
-            wrapper: 'cloudflare-node',
-            converter: 'edge',
-            incrementalCache: async () => cache,
-            tagCache: 'dummy',
-            queue: 'dummy',
-        },
-    },
-
-    middleware: {
-        external: true,
-        override: {
-            wrapper: 'cloudflare-edge',
-            converter: 'edge',
-            proxyExternalRequest: 'fetch',
-        },
-    },
-
-    dangerous: {
-        enableCacheInterception: false,
-    },
-};
-
-export default config;

packages/gitbook-v2/package.json

@@ -1,18 +1,20 @@
 {
     "name": "gitbook-v2",
-    "version": "0.1.1",
+    "version": "0.2.1",
     "private": true,
     "dependencies": {
-        "next": "canary",
+        "next": "^15.2.1",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
-        "@gitbook/api": "0.96.1",
+        "@gitbook/api": "*",
+        "@gitbook/cache-tags": "workspace:*",
         "@sindresorhus/fnv1a": "^3.1.0",
-        "server-only": "^0.0.1"
+        "server-only": "^0.0.1",
+        "warn-once": "^0.1.1"
     },
     "devDependencies": {
         "gitbook": "*",
-        "@opennextjs/cloudflare": "^0.5.3",
+        "@opennextjs/cloudflare": "^0.5.10",
         "tailwindcss": "^3.4.0",
         "postcss": "^8"
     },
@@ -24,6 +26,7 @@
         "start": "next start",
         "build:v2:cloudflare": "opennextjs-cloudflare",
         "dev:v2:cloudflare": "wrangler dev --port 8771",
-        "unit": "bun test"
+        "unit": "bun test",
+        "typecheck": "tsc --noEmit"
     }
 }

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

@@ -16,7 +16,7 @@ export default async function Page(props: PageProps) {
     const context = await getDynamicSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
-    return <SitePage context={context} pageParams={{ pathname }} redirectOnFallback={true} />;
+    return <SitePage context={context} pageParams={{ pathname }} />;
 }
 
 export async function generateViewport(props: PageProps): Promise<Viewport> {
@@ -25,14 +25,12 @@ export async function generateViewport(props: PageProps): Promise<Viewport> {
 }
 
 export async function generateMetadata(props: PageProps): Promise<Metadata> {
-    const [params, searchParams] = await Promise.all([props.params, props.searchParams]);
+    const params = await props.params;
     const context = await getDynamicSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
     return generateSitePageMetadata({
         context,
         pageParams: { pathname },
-        redirectOnFallback: true,
-        fallback: !!searchParams.fallback,
     });
 }

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

@@ -6,7 +6,7 @@ import {
 } from '@/components/SiteLayout';
 import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
 import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
-import { getThemeFromMiddleware } from '@v2/lib/middleware';
+import { getThemeFromMiddleware, getVisitorAuthTokenFromMiddleware } from '@v2/lib/middleware';
 
 interface SiteDynamicLayoutProps {
     params: Promise<RouteLayoutParams>;
@@ -18,6 +18,7 @@ export default async function SiteDynamicLayout({
 }: React.PropsWithChildren<SiteDynamicLayoutProps>) {
     const context = await getDynamicSiteContext(await params);
     const forcedTheme = await getThemeFromMiddleware();
+    const visitorAuthToken = await getVisitorAuthTokenFromMiddleware();
 
     return (
         <CustomizationRootLayout customization={context.customization}>
@@ -25,6 +26,7 @@ export default async function SiteDynamicLayout({
                 context={context}
                 forcedTheme={forcedTheme}
                 withTracking={!GITBOOK_DISABLE_TRACKING}
+                visitorAuthToken={visitorAuthToken}
             >
                 {children}
             </SiteLayout>

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/~gitbook/icon/route.ts

@@ -3,8 +3,6 @@ import type { NextRequest } from 'next/server';
 import { serveIcon } from '@/routes/icon';
 import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
 
-export const dynamic = 'force-static';
-
 export async function GET(
     request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams> }

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,12 @@
+import { PDFRootLayout } from '@/components/PDF';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export default async function RootLayout(props: {
+    params: Promise<RouteLayoutParams>;
+    children: React.ReactNode;
+}) {
+    const { params, children } = props;
+    const context = await getDynamicSiteContext(await params);
+
+    return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
+}

packages/gitbook-v2/src/app/sites/dynamic/[mode]/[siteURL]/~gitbook/pdf/page.tsx

@@ -0,0 +1,20 @@
+import { PDFPage, generatePDFMetadata } from '@/components/PDF';
+import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
+
+export async function generateMetadata({
+    params,
+}: {
+    params: Promise<RouteLayoutParams>;
+}) {
+    const context = await getDynamicSiteContext(await params);
+    return generatePDFMetadata(context);
+}
+
+export default async function Page(props: {
+    params: Promise<RouteLayoutParams>;
+    searchParams: Promise<{ [key: string]: string }>;
+}) {
+    const { params, searchParams } = props;
+    const context = await getDynamicSiteContext(await params);
+    return <PDFPage context={context} searchParams={await searchParams} />;
+}

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

@@ -3,8 +3,8 @@ import {
     generateSitePageMetadata,
     generateSitePageViewport,
 } from '@/components/SitePage';
+import { getCacheTag } from '@gitbook/cache-tags';
 import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
-import { getSiteCacheTag } from '@v2/lib/cache';
 import type { Metadata, Viewport } from 'next';
 import { unstable_cacheTag as cacheTag } from 'next/cache';
 
@@ -21,9 +21,14 @@ export default async function Page(props: PageProps) {
     const context = await getStaticSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
-    cacheTag(getSiteCacheTag(context.site.id));
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: context.site.id,
+        })
+    );
 
-    return <SitePage context={context} pageParams={{ pathname }} redirectOnFallback={true} />;
+    return <SitePage context={context} pageParams={{ pathname }} />;
 }
 
 export async function generateViewport(props: PageProps): Promise<Viewport> {
@@ -39,6 +44,5 @@ export async function generateMetadata(props: PageProps): Promise<Metadata> {
     return generateSitePageMetadata({
         context,
         pageParams: { pathname },
-        redirectOnFallback: true,
     });
 }

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

@@ -4,8 +4,8 @@ import {
     generateSiteLayoutMetadata,
     generateSiteLayoutViewport,
 } from '@/components/SiteLayout';
+import { getCacheTag } from '@gitbook/cache-tags';
 import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
-import { getSiteCacheTag } from '@v2/lib/cache';
 import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
 import { unstable_cacheTag as cacheTag } from 'next/cache';
 
@@ -21,11 +21,20 @@ export default async function SiteStaticLayout({
 
     const context = await getStaticSiteContext(await params);
 
-    cacheTag(getSiteCacheTag(context.site.id));
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: context.site.id,
+        })
+    );
 
     return (
         <CustomizationRootLayout customization={context.customization}>
-            <SiteLayout context={context} withTracking={!GITBOOK_DISABLE_TRACKING}>
+            <SiteLayout
+                context={context}
+                withTracking={!GITBOOK_DISABLE_TRACKING}
+                visitorAuthToken={null}
+            >
                 {children}
             </SiteLayout>
         </CustomizationRootLayout>

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

@@ -1,9 +1,9 @@
-import { fetchSiteContextByURL } from '@v2/lib/context';
+import {
-import { createDataFetcher } from '@v2/lib/data';
+    fetchSiteContextByURL,
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from '@v2/lib/env';
+    fetchSiteContextByURLLookup,
-import { createImageResizer } from '@v2/lib/images';
+    getBaseContext,
-import { createLinker } from '@v2/lib/links';
+} from '@v2/lib/context';
-import { headers } from 'next/headers';
+import { getSiteURLDataFromMiddleware } from '@v2/lib/middleware';
 
 export type RouteParamMode = 'url-host' | 'url';
 
@@ -21,29 +21,19 @@ export type RouteParams = RouteLayoutParams & {
 /**
  * Get the static context when rendering statically a site.
  */
-export async function getStaticSiteContext(params: RouteLayoutParams) {
+export function getStaticSiteContext(params: RouteLayoutParams) {
-    const url = getSiteURLFromParams(params);
+    const siteURL = getSiteURLFromParams(params);
-
+    return fetchSiteContextByURL(
-    const dataFetcher = createDataFetcher();
+        getBaseContext({
-    const { linker, host } = createLinkerFromParams(params);
+            siteURL,
-    const context = await fetchSiteContextByURL(
+            urlMode: getModeFromParams(params.mode),
+        }),
         {
-            dataFetcher,
+            url: siteURL.toString(),
-            linker,
-        },
-        {
-            url: url.toString(),
             visitorAuthToken: null,
             redirectOnError: false,
         }
     );
-
-    context.imageResizer = createImageResizer({
-        host,
-        linker: context.linker,
-    });
-
-    return context;
 }
 
 /**
@@ -51,36 +41,16 @@ export async function getStaticSiteContext(params: RouteLayoutParams) {
  * The context will depend on the request.
  */
 export async function getDynamicSiteContext(params: RouteLayoutParams) {
-    const url = getSiteURLFromParams(params);
+    const siteURL = getSiteURLFromParams(params);
-    const headersSet = await headers();
+    const siteURLData = await getSiteURLDataFromMiddleware();
 
-    const dataFetcher = createDataFetcher({
+    return fetchSiteContextByURLLookup(
-        apiToken: headersSet.get('x-gitbook-token') ?? GITBOOK_API_TOKEN,
+        getBaseContext({
-        apiEndpoint: headersSet.get('x-gitbook-api') ?? GITBOOK_API_URL,
+            siteURL,
-    });
+            urlMode: getModeFromParams(params.mode),
-
+        }),
-    const { linker, host } = createLinkerFromParams(params);
+        siteURLData
-
-    const context = await fetchSiteContextByURL(
-        {
-            dataFetcher,
-            linker,
-        },
-        {
-            url: url.toString(),
-            visitorAuthToken: headersSet.get('x-gitbook-visitor-token'),
-
-            // TODO: set it only when the token comes from the cookies.
-            redirectOnError: true,
-        }
     );
-
-    context.imageResizer = createImageResizer({
-        host,
-        linker: context.linker,
-    });
-
-    return context;
 }
 
 /**
@@ -91,39 +61,6 @@ export function getPagePathFromParams(params: RouteParams) {
     return decoded;
 }
 
-function createLinkerFromParams(params: RouteLayoutParams) {
-    const url = getSiteURLFromParams(params);
-    const mode = getModeFromParams(params.mode);
-
-    if (mode === 'url-host') {
-        return {
-            linker: createLinker({
-                host: url.host,
-                pathname: '/',
-            }),
-            host: url.host,
-        };
-    }
-
-    const gitbookURL = new URL(GITBOOK_URL);
-    const linker = createLinker({
-        protocol: gitbookURL.protocol,
-        host: gitbookURL.host,
-        pathname: `/url/${url.host}`,
-    });
-
-    // 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}`;
-    };
-
-    return {
-        linker,
-        host: gitbookURL.host,
-    };
-}
-
 function getSiteURLFromParams(params: RouteLayoutParams) {
     const decoded = decodeURIComponent(params.siteURL);
     const url = new URL(`https://${decoded}`);

packages/gitbook-v2/src/app/~gitbook/env/route.ts

@@ -0,0 +1,38 @@
+import { type NextRequest, NextResponse } from 'next/server';
+
+import {
+    GITBOOK_API_PUBLIC_URL,
+    GITBOOK_API_TOKEN,
+    GITBOOK_API_URL,
+    GITBOOK_APP_URL,
+    GITBOOK_ASSETS_URL,
+    GITBOOK_DISABLE_TRACKING,
+    GITBOOK_ICONS_URL,
+    GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+    GITBOOK_INTEGRATIONS_HOST,
+    GITBOOK_SECRET,
+    GITBOOK_URL,
+    GITBOOK_USER_AGENT,
+} from '@v2/lib/env';
+
+/**
+ * Output the public environment variables for this deployment
+ */
+export async function GET(_req: NextRequest) {
+    return NextResponse.json({
+        GITBOOK_URL,
+        GITBOOK_APP_URL,
+        GITBOOK_API_URL,
+        GITBOOK_API_PUBLIC_URL,
+        GITBOOK_ASSETS_URL,
+        GITBOOK_ICONS_URL,
+        GITBOOK_USER_AGENT,
+        GITBOOK_INTEGRATIONS_HOST,
+        GITBOOK_DISABLE_TRACKING,
+
+        // Secret envs
+        GITBOOK_SECRET: !!GITBOOK_SECRET,
+        GITBOOK_API_TOKEN: !!GITBOOK_API_TOKEN,
+        GITBOOK_IMAGE_RESIZE_SIGNING_KEY: !!GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+    });
+}

packages/gitbook-v2/src/app/~gitbook/revalidate/route.ts

@@ -0,0 +1,35 @@
+import { type NextRequest, NextResponse } from 'next/server';
+
+import { withVerifySignature } from '@v2/lib/routes';
+import { revalidateTag } from 'next/cache';
+
+interface JsonBody {
+    tags: string[];
+}
+
+/**
+ * Revalidate cached data based on tags.
+ * The body should be a JSON with { tags: string[] }
+ */
+export async function POST(req: NextRequest) {
+    return withVerifySignature<JsonBody>(req, async (body) => {
+        if (!body.tags || !Array.isArray(body.tags)) {
+            return NextResponse.json(
+                {
+                    error: 'tags must be an array',
+                },
+                { status: 400 }
+            );
+        }
+
+        body.tags.forEach((tag) => {
+            // biome-ignore lint/suspicious/noConsole: we want to log here
+            console.log(`Revalidating tag: ${tag}`);
+            revalidateTag(tag);
+        });
+
+        return NextResponse.json({
+            success: true,
+        });
+    });
+}

packages/gitbook-v2/src/app/~space/[spaceId]/pdf.ts

@@ -0,0 +1,57 @@
+import {
+    type GitBookBaseContext,
+    type GitBookSpaceContext,
+    fetchSpaceContextByIds,
+} from '@v2/lib/context';
+import { createDataFetcher } from '@v2/lib/data';
+import { createLinker } from '@v2/lib/links';
+import { getAPITokenFromMiddleware } from '@v2/lib/middleware';
+
+export type SpacePDFRouteParams = {
+    spaceId: string;
+    changeRequestId?: string;
+    revisionId?: string;
+};
+
+export async function getSpacePDFContext(
+    params: SpacePDFRouteParams
+): Promise<GitBookSpaceContext> {
+    const { spaceId } = params;
+
+    const apiToken = await getAPITokenFromMiddleware();
+
+    const linker = createLinker({
+        pathname: getPDFRoutePath(params),
+    });
+    const dataFetcher = createDataFetcher({
+        apiToken: apiToken,
+    });
+
+    const baseContext: GitBookBaseContext = {
+        linker,
+        dataFetcher,
+    };
+
+    return await fetchSpaceContextByIds(baseContext, {
+        space: spaceId,
+        shareKey: undefined,
+        changeRequest: params.changeRequestId,
+        revision: params.revisionId,
+    });
+}
+
+function getPDFRoutePath(params: SpacePDFRouteParams) {
+    let path = `/~space/${params.spaceId}`;
+
+    if (params.changeRequestId) {
+        path += `/~/changes/${params.changeRequestId}`;
+    }
+
+    if (params.revisionId) {
+        path += `/~/revisions/${params.revisionId}`;
+    }
+
+    path += '~gitbook/pdf';
+
+    return path;
+}

packages/gitbook-v2/src/app/~space/[spaceId]/~/changes/[changeRequestId]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,2 @@
+import RootLayout from '@v2/app/~space/[spaceId]/~gitbook/pdf/layout';
+export default RootLayout;

packages/gitbook-v2/src/app/~space/[spaceId]/~/changes/[changeRequestId]/~gitbook/pdf/page.tsx

@@ -0,0 +1,4 @@
+import PDFPage, { generateMetadata } from '@v2/app/~space/[spaceId]/~gitbook/pdf/page';
+
+export default PDFPage;
+export { generateMetadata };

packages/gitbook-v2/src/app/~space/[spaceId]/~/revisions/[changeRequestId]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,2 @@
+import RootLayout from '@v2/app/~space/[spaceId]/~gitbook/pdf/layout';
+export default RootLayout;

packages/gitbook-v2/src/app/~space/[spaceId]/~/revisions/[changeRequestId]/~gitbook/pdf/page.tsx

@@ -0,0 +1,4 @@
+import PDFPage, { generateMetadata } from '@v2/app/~space/[spaceId]/~gitbook/pdf/page';
+
+export default PDFPage;
+export { generateMetadata };

packages/gitbook-v2/src/app/~space/[spaceId]/~gitbook/pdf/layout.tsx

@@ -0,0 +1,12 @@
+import { PDFRootLayout } from '@/components/PDF';
+import { type SpacePDFRouteParams, getSpacePDFContext } from '@v2/app/~space/[spaceId]/pdf';
+
+export default async function RootLayout(props: {
+    params: Promise<SpacePDFRouteParams>;
+    children: React.ReactNode;
+}) {
+    const { params, children } = props;
+    const context = await getSpacePDFContext(await params);
+
+    return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
+}

packages/gitbook-v2/src/app/~space/[spaceId]/~gitbook/pdf/page.tsx

@@ -0,0 +1,20 @@
+import { PDFPage, generatePDFMetadata } from '@/components/PDF';
+import { type SpacePDFRouteParams, getSpacePDFContext } from '@v2/app/~space/[spaceId]/pdf';
+
+export async function generateMetadata({
+    params,
+}: {
+    params: Promise<SpacePDFRouteParams>;
+}) {
+    const context = await getSpacePDFContext(await params);
+    return generatePDFMetadata(context);
+}
+
+export default async function Page(props: {
+    params: Promise<SpacePDFRouteParams>;
+    searchParams: Promise<{ [key: string]: string }>;
+}) {
+    const { params, searchParams } = props;
+    const context = await getSpacePDFContext(await params);
+    return <PDFPage context={context} searchParams={await searchParams} />;
+}

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

@@ -1,34 +0,0 @@
-/**
- * Get the cache tag for a site.
- */
-export function getSiteCacheTag(siteId: string) {
-    return `site:${siteId}`;
-}
-
-/**
- * Get the cache tag for a hostname.
- */
-export function getHostnameCacheTag(hostname: string) {
-    return `url:${hostname}`;
-}
-
-/**
- * Get the cache tag for an OpenAPI spec.
- */
-export function getOpenAPISpecCacheTag(organizationId: string, slug: string) {
-    return `organization:${organizationId}:openapi:${slug}`;
-}
-
-/**
- * Get the cache tag for a space.
- */
-export function getSpaceCacheTag(spaceId: string) {
-    return `space:${spaceId}`;
-}
-
-/**
- * Get the cache tag for a change request.
- */
-export function getChangeRequestCacheTag(spaceId: string, changeRequestId: string) {
-    return `space:${spaceId}:change-request:${changeRequestId}`;
-}

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

@@ -1,6 +1,7 @@
 import { getSiteStructureSections } from '@/lib/sites';
 import type {
     ChangeRequest,
+    PublishedSiteContentLookup,
     RevisionPage,
     RevisionPageDocument,
     Site,
@@ -12,11 +13,12 @@ import type {
     SiteStructure,
     Space,
 } from '@gitbook/api';
-import { type GitBookDataFetcher, createDataFetcher } from '@v2/lib/data';
+import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
 import { redirect } from 'next/navigation';
 import { assert } from 'ts-essentials';
-import type { ImageResizer } from './images';
+import { GITBOOK_URL } from './env';
-import { type GitBookSpaceLinker, appendBasePathToLinker } from './links';
+import { type ImageResizer, createImageResizer } from './images';
+import { type GitBookSpaceLinker, createLinker } from './links';
 
 /**
  * Generic context when rendering content.
@@ -90,9 +92,6 @@ export type GitBookSiteContext = GitBookSpaceContext & {
 
     /** Scripts to load for the site. */
     scripts: SiteIntegrationScript[];
-
-    /** Visitor token used to fetch the site */
-    visitorAuthToken: string | null;
 };
 
 /**
@@ -102,6 +101,73 @@ export type GitBookPageContext = (GitBookSpaceContext | GitBookSiteContext) & {
     page: RevisionPageDocument;
 };
 
+/**
+ * Get the base context for a request.
+ */
+export function getBaseContext(input: {
+    siteURL: URL | string;
+    urlMode: 'url' | 'url-host';
+    apiToken?: string | null;
+}) {
+    const url = typeof input.siteURL === 'string' ? new URL(input.siteURL) : input.siteURL;
+    const urlMode = input.urlMode;
+
+    const dataFetcher = createDataFetcher({
+        apiToken: input.apiToken ?? null,
+    });
+
+    const linker = getLinkerForSiteURL({
+        siteURL: url,
+        urlMode,
+    });
+
+    const imageResizer = createImageResizer({
+        host: url.host,
+        // To ensure image resizing work for proxied sites,
+        // we serve images from the root of the site.
+        linker: linker,
+    });
+
+    return {
+        dataFetcher,
+        linker,
+        imageResizer,
+    };
+}
+
+/**
+ * Get the linker for a given site URL.
+ */
+export function getLinkerForSiteURL(input: {
+    siteURL: URL;
+    urlMode: 'url' | 'url-host';
+}) {
+    const { siteURL, urlMode } = input;
+
+    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
+    const linker =
+        urlMode === 'url-host'
+            ? createLinker({
+                  host: siteURL.host,
+                  pathname: siteURL.pathname,
+              })
+            : createLinker({
+                  protocol: gitbookURL?.protocol,
+                  host: gitbookURL?.host,
+                  pathname: `/url/${siteURL.host}${siteURL.pathname}`,
+              });
+
+    if (urlMode === 'url') {
+        // 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 linker;
+}
+
 /**
  * Fetch the context of a site for a given URL and a base context.
  */
@@ -114,21 +180,33 @@ export async function fetchSiteContextByURL(
     }
 ): Promise<GitBookSiteContext> {
     const { dataFetcher } = baseContext;
-    const data = await dataFetcher.getPublishedContentByUrl({
+    const data = await throwIfDataError(
-        url: input.url,
+        dataFetcher.getPublishedContentByUrl({
-        visitorAuthToken: input.visitorAuthToken,
+            url: input.url,
-        redirectOnError: input.redirectOnError,
+            visitorAuthToken: input.visitorAuthToken,
-    });
+            redirectOnError: input.redirectOnError,
+        })
+    );
 
+    return fetchSiteContextByURLLookup(baseContext, data);
+}
+
+/**
+ * Fetch the context of a site using the resolution of a URL
+ */
+export async function fetchSiteContextByURLLookup(
+    baseContext: GitBookBaseContext,
+    data: PublishedSiteContentLookup
+): Promise<GitBookSiteContext> {
+    const { dataFetcher } = baseContext;
     if ('redirect' in data) {
         redirect(data.redirect);
     }
 
-    const context = await fetchSiteContextByIds(
+    return await fetchSiteContextByIds(
         {
             ...baseContext,
-            dataFetcher: createDataFetcher({
+            dataFetcher: dataFetcher.withToken({
-                apiEndpoint: dataFetcher.apiEndpoint,
                 apiToken: data.apiToken,
             }),
         },
@@ -141,16 +219,8 @@ export async function fetchSiteContextByURL(
             shareKey: data.shareKey,
             changeRequest: data.changeRequest,
             revision: data.revision,
-            visitorAuthToken: input.visitorAuthToken,
         }
     );
-
-    const siteContext = {
-        ...context,
-        linker: appendBasePathToLinker(context.linker, data.basePath),
-    };
-
-    return siteContext;
 }
 
 /**
@@ -167,18 +237,19 @@ export async function fetchSiteContextByIds(
         shareKey: string | undefined;
         changeRequest: string | undefined;
         revision: string | undefined;
-        visitorAuthToken: string | null;
     }
 ): Promise<GitBookSiteContext> {
     const { dataFetcher } = baseContext;
 
     const [{ site: orgSite, structure: siteStructure, customizations, scripts }, spaceContext] =
         await Promise.all([
-            dataFetcher.getPublishedContentSite({
+            throwIfDataError(
-                organizationId: ids.organization,
+                dataFetcher.getPublishedContentSite({
-                siteId: ids.site,
+                    organizationId: ids.organization,
-                siteShareKey: ids.shareKey,
+                    siteId: ids.site,
-            }),
+                    siteShareKey: ids.shareKey,
+                })
+            ),
             fetchSpaceContextByIds(baseContext, ids),
         ]);
 
@@ -233,7 +304,6 @@ export async function fetchSiteContextByIds(
         structure: siteStructure,
         sections,
         scripts,
-        visitorAuthToken: ids.visitorAuthToken,
     };
 }
 
@@ -252,27 +322,33 @@ export async function fetchSpaceContextByIds(
     const { dataFetcher } = baseContext;
 
     const [space, changeRequest] = await Promise.all([
-        dataFetcher.getSpace({
+        throwIfDataError(
-            spaceId: ids.space,
+            dataFetcher.getSpace({
-            shareKey: ids.shareKey,
+                spaceId: ids.space,
-        }),
+                shareKey: ids.shareKey,
+            })
+        ),
         ids.changeRequest
-            ? dataFetcher.getChangeRequest({
+            ? throwIfDataError(
-                  spaceId: ids.space,
+                  dataFetcher.getChangeRequest({
-                  changeRequestId: ids.changeRequest,
+                      spaceId: ids.space,
-              })
+                      changeRequestId: ids.changeRequest,
+                  })
+              )
             : null,
     ]);
 
     const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision;
 
-    const pages = await dataFetcher.getRevisionPages({
+    const pages = await throwIfDataError(
-        spaceId: ids.space,
+        dataFetcher.getRevisionPages({
-        revisionId,
+            spaceId: ids.space,
-        // We only care about the Git metadata when the Git sync is enabled,
+            revisionId,
-        // otherwise we can optimize performance by not fetching it
+            // We only care about the Git metadata when the Git sync is enabled,
-        metadata: !!space.gitSync,
+            // otherwise we can optimize performance by not fetching it
-    });
+            metadata: !!space.gitSync,
+        })
+    );
 
     return {
         ...baseContext,

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

@@ -1,128 +1,162 @@
-import { type ComputedContentSource, GitBookAPI } from '@gitbook/api';
+import { trace } from '@/lib/tracing';
+import {
+    type ComputedContentSource,
+    GitBookAPI,
+    type GitBookAPIServiceBinding,
+} from '@gitbook/api';
+import {
+    getCacheTag,
+    getCacheTagForURL,
+    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 {
+import { wrapDataFetcherError } from './errors';
-    getChangeRequestCacheTag,
-    getHostnameCacheTag,
-    getOpenAPISpecCacheTag,
-    getSiteCacheTag,
-    getSpaceCacheTag,
-} from '../cache';
 import type { GitBookDataFetcher } from './types';
 
 interface DataFetcherInput {
-    /**
-     * API host to use.
-     */
-    apiEndpoint: string;
-
     /**
      * API token.
      */
     apiToken: string | null;
 }
 
-const commonInput: DataFetcherInput = {
-    apiEndpoint: GITBOOK_API_URL,
-    apiToken: GITBOOK_API_TOKEN,
-};
-
 /**
  * Create a data fetcher using an API token.
  * The data are being cached by Next.js built-in cache.
  */
-export function createDataFetcher(input: DataFetcherInput = commonInput): GitBookDataFetcher {
+export function createDataFetcher(
+    input: DataFetcherInput = { apiToken: null }
+): GitBookDataFetcher {
     return {
-        apiEndpoint: input.apiEndpoint,
+        async api() {
+            return apiClient(input);
+        },
+
+        withToken({ apiToken }) {
+            return createDataFetcher({
+                apiToken,
+            });
+        },
 
         //
         // API that are tied to the token
         //
         getPublishedContentSite(params) {
-            return getPublishedContentSite(input, {
+            return trace('getPublishedContentSite', () =>
-                organizationId: params.organizationId,
+                getPublishedContentSite(input, {
-                siteId: params.siteId,
+                    organizationId: params.organizationId,
-                siteShareKey: params.siteShareKey,
+                    siteId: params.siteId,
-            });
+                    siteShareKey: params.siteShareKey,
+                })
+            );
         },
         getSiteRedirectBySource(params) {
-            return getSiteRedirectBySource(input, {
+            return trace('getSiteRedirectBySource', () =>
-                organizationId: params.organizationId,
+                getSiteRedirectBySource(input, {
-                siteId: params.siteId,
+                    organizationId: params.organizationId,
-                siteShareKey: params.siteShareKey,
+                    siteId: params.siteId,
-                source: params.source,
+                    siteShareKey: params.siteShareKey,
-            });
+                    source: params.source,
+                })
+            );
         },
         getRevision(params) {
-            return getRevision(input, {
+            return trace('getRevision', () =>
-                spaceId: params.spaceId,
+                getRevision(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                metadata: params.metadata,
+                    revisionId: params.revisionId,
-            });
+                    metadata: params.metadata,
+                })
+            );
         },
         getRevisionPages(params) {
-            return getRevisionPages(input, {
+            return trace('getRevisionPages', () =>
-                spaceId: params.spaceId,
+                getRevisionPages(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                metadata: params.metadata,
+                    revisionId: params.revisionId,
-            });
+                    metadata: params.metadata,
+                })
+            );
         },
         getRevisionFile(params) {
-            return getRevisionFile(input, {
+            return trace('getRevisionFile', () =>
-                spaceId: params.spaceId,
+                getRevisionFile(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                fileId: params.fileId,
+                    revisionId: params.revisionId,
-            });
+                    fileId: params.fileId,
+                })
+            );
         },
         getRevisionPageByPath(params) {
-            return getRevisionPageByPath(input, {
+            return trace('getRevisionPageByPath', () =>
-                spaceId: params.spaceId,
+                getRevisionPageByPath(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                path: params.path,
+                    revisionId: params.revisionId,
-            });
+                    path: params.path,
+                })
+            );
         },
         getReusableContent(params) {
-            return getReusableContent(input, {
+            return trace('getReusableContent', () =>
-                spaceId: params.spaceId,
+                getReusableContent(input, {
-                revisionId: params.revisionId,
+                    spaceId: params.spaceId,
-                reusableContentId: params.reusableContentId,
+                    revisionId: params.revisionId,
-            });
+                    reusableContentId: params.reusableContentId,
+                })
+            );
         },
         getLatestOpenAPISpecVersionContent(params) {
-            return getLatestOpenAPISpecVersionContent(input, {
+            return trace('getLatestOpenAPISpecVersionContent', () =>
-                organizationId: params.organizationId,
+                getLatestOpenAPISpecVersionContent(input, {
-                slug: params.slug,
+                    organizationId: params.organizationId,
-            });
+                    slug: params.slug,
+                })
+            );
         },
         getSpace(params) {
-            return getSpace(input, {
+            return trace('getSpace', () =>
-                spaceId: params.spaceId,
+                getSpace(input, {
-                shareKey: params.shareKey,
+                    spaceId: params.spaceId,
-            });
+                    shareKey: params.shareKey,
+                })
+            );
         },
         getChangeRequest(params) {
-            return getChangeRequest(input, {
+            return trace('getChangeRequest', () =>
-                spaceId: params.spaceId,
+                getChangeRequest(input, {
-                changeRequestId: params.changeRequestId,
+                    spaceId: params.spaceId,
-            });
+                    changeRequestId: params.changeRequestId,
+                })
+            );
         },
         getDocument(params) {
-            return getDocument(input, {
+            return trace('getDocument', () =>
-                spaceId: params.spaceId,
+                getDocument(input, {
-                documentId: params.documentId,
+                    spaceId: params.spaceId,
-            });
+                    documentId: params.documentId,
+                })
+            );
         },
         getComputedDocument(params) {
-            return getComputedDocument(input, {
+            return trace('getComputedDocument', () =>
-                spaceId: params.spaceId,
+                getComputedDocument(input, {
-                source: params.source,
+                    organizationId: params.organizationId,
-            });
+                    spaceId: params.spaceId,
+                    source: params.source,
+                })
+            );
         },
         getEmbedByUrl(params) {
-            return getEmbedByUrl(input, {
+            return trace('getEmbedByUrl', () =>
-                url: params.url,
+                getEmbedByUrl(input, {
-                spaceId: params.spaceId,
+                    url: params.url,
-            });
+                    spaceId: params.spaceId,
+                })
+            );
+        },
+        searchSiteContent(params) {
+            return trace('searchSiteContent', () => searchSiteContent(input, params));
         },
 
         //
@@ -130,33 +164,33 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
         // where the data is the same for all users
         //
         getUserById(userId) {
-            return getUserById(commonInput, userId);
+            return trace('getUserById', () => getUserById({ apiToken: null }, { userId }));
         },
         getPublishedContentByUrl(params) {
-            return getPublishedContentByUrl(commonInput, {
+            return trace('getPublishedContentByUrl', () =>
-                url: params.url,
+                getPublishedContentByUrl(
-                visitorAuthToken: params.visitorAuthToken,
+                    { apiToken: null },
-                redirectOnError: params.redirectOnError,
+                    {
-            });
+                        url: params.url,
+                        visitorAuthToken: params.visitorAuthToken,
+                        redirectOnError: params.redirectOnError,
+                    }
+                )
+            );
         },
     };
 }
 
-async function getUserById(input: DataFetcherInput, userId: string) {
+async function getUserById(input: DataFetcherInput, params: { userId: string }) {
     'use cache';
 
     cacheLife('days');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).users.getUserById(userId);
+        const api = await apiClient(input);
+        const res = await api.users.getUserById(params.userId);
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getSpace(
@@ -169,12 +203,20 @@ async function getSpace(
     'use cache';
 
     cacheLife('days');
-    cacheTag(getSpaceCacheTag(params.spaceId));
+    cacheTag(
+        getCacheTag({
+            tag: 'space',
+            space: params.spaceId,
+        })
+    );
 
-    const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
+    return wrapDataFetcherError(async () => {
-        shareKey: params.shareKey,
+        const api = await apiClient(input);
+        const res = await api.spaces.getSpaceById(params.spaceId, {
+            shareKey: params.shareKey,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getChangeRequest(
@@ -188,20 +230,18 @@ async function getChangeRequest(
 
     cacheLife('minutes');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getChangeRequestById(
+        const api = await apiClient(input);
-            params.spaceId,
+        const res = await api.spaces.getChangeRequestById(params.spaceId, params.changeRequestId);
-            params.changeRequestId
+        cacheTag(
+            getCacheTag({
+                tag: 'change-request',
+                space: params.spaceId,
+                changeRequest: res.data.id,
+            })
         );
-        cacheTag(getChangeRequestCacheTag(params.spaceId, res.data.id));
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getRevision(
@@ -216,10 +256,13 @@ async function getRevision(
 
     cacheLife('max');
 
-    const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
+    return wrapDataFetcherError(async () => {
-        metadata: params.metadata,
+        const api = await apiClient(input);
+        const res = await api.spaces.getRevisionById(params.spaceId, params.revisionId, {
+            metadata: params.metadata,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getRevisionPages(
@@ -234,14 +277,13 @@ async function getRevisionPages(
 
     cacheLife('max');
 
-    const res = await getAPI(input).spaces.listPagesInRevisionById(
+    return wrapDataFetcherError(async () => {
-        params.spaceId,
+        const api = await apiClient(input);
-        params.revisionId,
+        const res = await api.spaces.listPagesInRevisionById(params.spaceId, params.revisionId, {
-        {
             metadata: params.metadata,
-        }
+        });
-    );
+        return res.data.pages;
-    return res.data.pages;
+    });
 }
 
 async function getRevisionFile(
@@ -256,20 +298,16 @@ async function getRevisionFile(
 
     cacheLife('max');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getFileInRevisionById(
+        const api = await apiClient(input);
+        const res = await api.spaces.getFileInRevisionById(
             params.spaceId,
             params.revisionId,
-            params.fileId
+            params.fileId,
+            {}
         );
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getRevisionPageByPath(
@@ -285,21 +323,17 @@ async function getRevisionPageByPath(
     cacheLife('max');
 
     const encodedPath = encodeURIComponent(params.path);
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getPageInRevisionByPath(
+        const api = await apiClient(input);
+        const res = await api.spaces.getPageInRevisionByPath(
             params.spaceId,
             params.revisionId,
-            encodedPath
+            encodedPath,
+            {}
         );
 
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getDocument(
@@ -313,26 +347,42 @@ async function getDocument(
 
     cacheLife('max');
 
-    const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
+    return wrapDataFetcherError(async () => {
-    return res.data;
+        const api = await apiClient(input);
+        const res = await api.spaces.getDocumentById(params.spaceId, params.documentId, {});
+        return res.data;
+    });
 }
 
 async function getComputedDocument(
     input: DataFetcherInput,
     params: {
         spaceId: string;
+        organizationId: string;
         source: ComputedContentSource;
     }
 ) {
     'use cache';
 
-    // TODO: we need to resolve dependencies and pass them in the cache key
     cacheLife('days');
 
-    const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
+    cacheTag(
-        source: params.source,
+        ...getComputedContentSourceCacheTags(
+            {
+                spaceId: params.spaceId,
+                organizationId: params.organizationId,
+            },
+            params.source
+        )
+    );
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.spaces.getComputedDocument(params.spaceId, {
+            source: params.source,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getReusableContent(
@@ -347,20 +397,15 @@ async function getReusableContent(
 
     cacheLife('max');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).spaces.getReusableContentInRevisionById(
+        const api = await apiClient(input);
+        const res = await api.spaces.getReusableContentInRevisionById(
             params.spaceId,
             params.revisionId,
             params.reusableContentId
         );
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getLatestOpenAPISpecVersionContent(
@@ -372,22 +417,23 @@ async function getLatestOpenAPISpecVersionContent(
 ) {
     'use cache';
 
-    cacheTag(getOpenAPISpecCacheTag(params.organizationId, params.slug));
+    cacheTag(
+        getCacheTag({
+            tag: 'openapi',
+            organization: params.organizationId,
+            openAPISpec: params.slug,
+        })
+    );
     cacheLife('days');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getLatestOpenApiSpecVersionContent(
+        const api = await apiClient(input);
+        const res = await api.orgs.getLatestOpenApiSpecVersionContent(
             params.organizationId,
             params.slug
         );
         return res.data;
-    } catch (error) {
+    });
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getPublishedContentByUrl(
@@ -402,21 +448,28 @@ async function getPublishedContentByUrl(
 
     const { url, visitorAuthToken, redirectOnError } = params;
 
-    const hostname = new URL(url).hostname;
+    cacheTag(getCacheTagForURL(url));
-    cacheTag(getHostnameCacheTag(hostname));
     cacheLife('days');
 
-    const res = await getAPI(input).urls.getPublishedContentByUrl({
+    return wrapDataFetcherError(async () => {
-        url,
+        const api = await apiClient(input);
-        visitorAuthToken: visitorAuthToken ?? undefined,
+        const res = await api.urls.getPublishedContentByUrl({
-        redirectOnError,
+            url,
+            visitorAuthToken: visitorAuthToken ?? undefined,
+            redirectOnError,
+        });
+
+        if ('site' in res.data) {
+            cacheTag(
+                getCacheTag({
+                    tag: 'site',
+                    site: res.data.site,
+                })
+            );
+        }
+
+        return res.data;
     });
-
-    if ('site' in res.data) {
-        cacheTag(getSiteCacheTag(res.data.site));
-    }
-
-    return res.data;
 }
 
 async function getPublishedContentSite(
@@ -429,17 +482,21 @@ async function getPublishedContentSite(
 ) {
     'use cache';
 
-    cacheTag(getSiteCacheTag(params.siteId));
     cacheLife('days');
-
+    cacheTag(
-    const res = await getAPI(input).orgs.getPublishedContentSite(
+        getCacheTag({
-        params.organizationId,
+            tag: 'site',
-        params.siteId,
+            site: params.siteId,
-        {
+        })
-            shareKey: params.siteShareKey,
-        }
     );
-    return res.data;
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.orgs.getPublishedContentSite(params.organizationId, params.siteId, {
+            shareKey: params.siteShareKey,
+        });
+        return res.data;
+    });
 }
 
 async function getSiteRedirectBySource(
@@ -453,33 +510,23 @@ async function getSiteRedirectBySource(
 ) {
     'use cache';
 
-    cacheTag(getSiteCacheTag(params.siteId));
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: params.siteId,
+        })
+    );
     cacheLife('days');
 
-    try {
+    return wrapDataFetcherError(async () => {
-        const res = await getAPI(input).orgs.getSiteRedirectBySource(
+        const api = await apiClient(input);
-            params.organizationId,
+        const res = await api.orgs.getSiteRedirectBySource(params.organizationId, params.siteId, {
-            params.siteId,
+            shareKey: params.siteShareKey,
-            {
+            source: params.source,
-                shareKey: params.siteShareKey,
+        });
-                source: params.source,
-            }
-        );
 
         return res.data;
-    } catch (error) {
+    });
-        // 422 is returned when the source is invalid
-        // we don't want to throw but just return null
-        if (checkHasErrorCode(error, 422)) {
-            return null;
-        }
-
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
 }
 
 async function getEmbedByUrl(
@@ -493,22 +540,71 @@ async function getEmbedByUrl(
 
     cacheLife('weeks');
 
-    const api = getAPI(input);
+    return wrapDataFetcherError(async () => {
-    const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
+        const api = await apiClient(input);
-    return res.data;
+        const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
+        return res.data;
+    });
 }
 
-function getAPI(input: DataFetcherInput) {
+async function searchSiteContent(
-    const { apiEndpoint, apiToken } = input;
+    input: DataFetcherInput,
+    params: Parameters<GitBookDataFetcher['searchSiteContent']>[0]
+) {
+    'use cache';
+
+    const { organizationId, siteId, query, scope } = params;
+
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
+        const api = await apiClient(input);
+        const res = await api.orgs.searchSiteContent(organizationId, siteId, {
+            query,
+            ...scope,
+        });
+        return res.data.items;
+    });
+}
+
+let loggedServiceBinding = false;
+
+/**
+ * Create a new API client.
+ */
+export async 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 ?? undefined,
+        authToken: apiToken || GITBOOK_API_TOKEN || undefined,
-        endpoint: apiEndpoint,
+        endpoint: GITBOOK_API_URL,
         userAgent: GITBOOK_USER_AGENT,
+        serviceBinding,
     });
 
     return api;
 }
-
-function checkHasErrorCode(error: unknown, code: number) {
-    return error instanceof Error && 'code' in error && error.code === code;
-}

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

@@ -0,0 +1,115 @@
+import { GitBookAPIError } from '@gitbook/api';
+import type { DataFetcherErrorData, DataFetcherResponse } from './types';
+
+export class DataFetcherError extends Error {
+    constructor(
+        message: string,
+        public readonly code: number
+    ) {
+        super(message);
+    }
+}
+
+/**
+ * Throw an error if the response contains an error.
+ */
+export function throwIfDataError<T>(response: DataFetcherResponse<T>): T;
+export function throwIfDataError<T>(response: Promise<DataFetcherResponse<T>>): Promise<T>;
+export function throwIfDataError<T>(
+    response: DataFetcherResponse<T> | Promise<DataFetcherResponse<T>>
+): T | Promise<T> {
+    if (response instanceof Promise) {
+        return response.then((result) => throwIfDataError(result));
+    }
+
+    if (response.error) {
+        throw new DataFetcherError(response.error.message, response.error.code);
+    }
+    return response.data;
+}
+
+/**
+ * Get the data from the response or null if there is an "Not found" error.
+ */
+export function getDataOrNull<T>(
+    response: DataFetcherResponse<T>,
+    ignoreErrors?: number[]
+): T | null;
+export function getDataOrNull<T>(
+    response: Promise<DataFetcherResponse<T>>,
+    ignoreErrors?: number[]
+): Promise<T | null>;
+export function getDataOrNull<T>(
+    response: DataFetcherResponse<T> | Promise<DataFetcherResponse<T>>,
+    ignoreErrors: number[] = [404]
+): T | null | Promise<T | null> {
+    if (response instanceof Promise) {
+        return response.then((result) => getDataOrNull(result, ignoreErrors));
+    }
+
+    if (response.error) {
+        if (ignoreErrors.includes(response.error.code)) return null;
+        throw new DataFetcherError(response.error.message, response.error.code);
+    }
+    return response.data;
+}
+
+/**
+ * Ignore error for an API or data call.
+ */
+export async function ignoreDataThrownError<T>(promise: Promise<T>): Promise<T | null> {
+    try {
+        return await promise;
+    } catch (error) {
+        getExposableError(error as Error);
+        return null;
+    }
+}
+
+/**
+ * Ignore all errors for an API or data call.
+ */
+export async function ignoreAllThrownError<T>(promise: Promise<T>): Promise<T | null> {
+    try {
+        return await promise;
+    } catch (error) {
+        console.warn('Ignoring error', error);
+        return null;
+    }
+}
+
+/**
+ * Wrap an async execution to handle errors and return a DataFetcherResponse.
+ */
+export async function wrapDataFetcherError<T>(
+    fn: () => Promise<T>
+): Promise<DataFetcherResponse<T>> {
+    try {
+        return { data: await fn() };
+    } catch (error) {
+        return {
+            error: getExposableError(error as Error),
+        };
+    }
+}
+
+/**
+ * Get a data fetcher exposable error from a JS error.
+ */
+export function getExposableError(error: Error): DataFetcherErrorData {
+    if (error instanceof GitBookAPIError) {
+        return {
+            code: error.code,
+            message: error.errorMessage,
+        };
+    }
+
+    if (error instanceof DataFetcherError) {
+        return {
+            code: error.code,
+            message: error.message,
+        };
+    }
+
+    throw error;
+}

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

@@ -1,4 +1,6 @@
 export * from './api';
 export * from './types';
-export * from './utils';
+export * from './pages';
 export * from './urls';
+export * from './errors';
+export * from './lookup';

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

@@ -0,0 +1,128 @@
+import { race, tryCatch } from '@/lib/async';
+import { joinPath } from '@/lib/paths';
+import { trace } from '@/lib/tracing';
+import type { PublishedSiteContentLookup } 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: {
+    url: string;
+    visitorAuthToken: string | null;
+    redirectOnError: boolean;
+}): 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();
+
+        const callResult = await trace(
+            {
+                operation: 'getPublishedContentByURL',
+                name: alternative.url,
+            },
+            () =>
+                tryCatch(
+                    api.urls.getPublishedContentByUrl(
+                        {
+                            url: alternative.url,
+                            visitorAuthToken: input.visitorAuthToken ?? undefined,
+                            redirectOnError: input.redirectOnError,
+                        },
+                        {
+                            signal,
+                        }
+                    )
+                )
+        );
+
+        if (callResult.error) {
+            if (alternative.primary) {
+                // We only return an error for the primary alternative (full URL),
+                // as other parts could result in errors due to the URL being incomplete (share links, etc).
+                return { error: callResult.error };
+            }
+            return null;
+        }
+
+        const {
+            data: { data },
+        } = callResult;
+
+        if ('redirect' in data) {
+            if (alternative.primary) {
+                // Append the path to the redirect URL
+                // because we might have matched a shorter path and the redirect is relative to it
+                if (alternative.extraPath) {
+                    if (data.target === 'content') {
+                        const redirect = new URL(data.redirect);
+                        redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
+                        data.redirect = redirect.toString();
+                    } else {
+                        const redirect = new URL(data.redirect);
+                        if (redirect.searchParams.has('location')) {
+                            redirect.searchParams.set(
+                                'location',
+                                joinPath(
+                                    redirect.searchParams.get('location') ?? '',
+                                    alternative.extraPath
+                                )
+                            );
+                            data.redirect = redirect.toString();
+                        }
+                    }
+                }
+
+                return { data };
+            }
+
+            return null;
+        }
+
+        /**
+         * We use the following criteria to determine if the lookup result is the right one:
+         * - the primary alternative was resolved (because that's the longest or most inclusive path)
+         * - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
+         *
+         * In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
+         */
+        if (alternative.primary || ('site' in data && data.complete)) {
+            const siteResult: PublishedSiteContentLookup = {
+                ...data,
+                changeRequest: data.changeRequest ?? lookup.changeRequest,
+                revision: data.revision ?? lookup.revision,
+                basePath: joinPath(data.basePath, lookup.basePath ?? ''),
+                pathname: joinPath(data.pathname, alternative.extraPath),
+            };
+            return { data: siteResult };
+        }
+
+        return null;
+    });
+
+    if (!result) {
+        return {
+            error: {
+                code: 404,
+                message: 'No content found',
+            },
+        };
+    }
+
+    if (result.error) {
+        return {
+            error: getExposableError(result.error),
+        };
+    }
+
+    return {
+        data: result.data,
+    };
+}

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

@@ -0,0 +1,29 @@
+import type { JSONDocument, RevisionPageDocument, Space } from '@gitbook/api';
+import { getDataOrNull } from './errors';
+import type { GitBookDataFetcher } from './types';
+
+/**
+ * Get the document for a page.
+ */
+export async function getPageDocument(
+    dataFetcher: GitBookDataFetcher,
+    space: Space,
+    page: RevisionPageDocument
+): Promise<JSONDocument | null> {
+    if (page.documentId) {
+        return getDataOrNull(
+            dataFetcher.getDocument({ spaceId: space.id, documentId: page.documentId })
+        );
+    }
+    if (page.computed) {
+        return getDataOrNull(
+            dataFetcher.getComputedDocument({
+                organizationId: space.organization,
+                spaceId: space.id,
+                source: page.computed,
+            })
+        );
+    }
+
+    return null;
+}

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

@@ -1,19 +1,41 @@
 import type * as api from '@gitbook/api';
 
+export type DataFetcherErrorData = {
+    code: number;
+    message: string;
+};
+
+export type DataFetcherResponse<T> =
+    | {
+          data: T;
+          error?: undefined;
+      }
+    | {
+          error: DataFetcherErrorData;
+          data?: undefined;
+      };
+
 /**
  * Generic fetcher for GitBook data.
  * It is used between v1 and v2.
  */
 export interface GitBookDataFetcher {
     /**
-     * Endpoint of the API.
+     * Get an API client for the current context.
      */
-    apiEndpoint: string;
+    api(): Promise<api.GitBookAPI>;
+
+    /**
+     * Create a data fetcher authenticated with a specific token.
+     */
+    withToken(input: {
+        apiToken: string;
+    }): GitBookDataFetcher;
 
     /**
      * Get a user by its ID.
      */
-    getUserById(userId: string): Promise<api.User | null>;
+    getUserById(userId: string): Promise<DataFetcherResponse<api.User>>;
 
     /**
      * Get a published content by its URL.
@@ -22,7 +44,7 @@ export interface GitBookDataFetcher {
         url: string;
         visitorAuthToken: string | null;
         redirectOnError: boolean;
-    }): Promise<api.PublishedSiteContentLookup>;
+    }): Promise<DataFetcherResponse<api.PublishedSiteContentLookup>>;
 
     /**
      * Get a published content site by its organization ID and site ID.
@@ -31,12 +53,14 @@ export interface GitBookDataFetcher {
         organizationId: string;
         siteId: string;
         siteShareKey: string | undefined;
-    }): Promise<api.PublishedContentSite>;
+    }): Promise<DataFetcherResponse<api.PublishedContentSite>>;
 
     /**
      * Get a space by its ID.
      */
-    getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<api.Space>;
+    getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<
+        DataFetcherResponse<api.Space>
+    >;
 
     /**
      * Get a change request by its space ID and change request ID.
@@ -44,7 +68,7 @@ export interface GitBookDataFetcher {
     getChangeRequest(params: {
         spaceId: string;
         changeRequestId: string;
-    }): Promise<api.ChangeRequest | null>;
+    }): Promise<DataFetcherResponse<api.ChangeRequest>>;
 
     /**
      * Get the revision by its space ID and revision ID.
@@ -53,7 +77,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    }): Promise<api.Revision>;
+    }): Promise<DataFetcherResponse<api.Revision>>;
 
     /**
      * Get the revision pages by its space ID and revision ID.
@@ -62,7 +86,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    }): Promise<api.RevisionPage[]>;
+    }): Promise<DataFetcherResponse<api.RevisionPage[]>>;
 
     /**
      * Get a revision file by its space ID, revision ID and file ID.
@@ -71,7 +95,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         fileId: string;
-    }): Promise<api.RevisionFile | null>;
+    }): Promise<DataFetcherResponse<api.RevisionFile>>;
 
     /**
      * Get a revision page by its path.
@@ -80,20 +104,23 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         path: string;
-    }): Promise<api.RevisionPageDocument | api.RevisionPageGroup | null>;
+    }): Promise<DataFetcherResponse<api.RevisionPageDocument | api.RevisionPageGroup>>;
 
     /**
      * Get a document by its space ID and document ID.
      */
-    getDocument(params: { spaceId: string; documentId: string }): Promise<api.JSONDocument>;
+    getDocument(params: { spaceId: string; documentId: string }): Promise<
+        DataFetcherResponse<api.JSONDocument>
+    >;
 
     /**
      * Get a computed document by its space ID and computed source.
      */
     getComputedDocument(params: {
+        organizationId: string;
         spaceId: string;
         source: api.ComputedContentSource;
-    }): Promise<api.JSONDocument>;
+    }): Promise<DataFetcherResponse<api.JSONDocument>>;
 
     /**
      * Get a reusable content by its space ID, revision ID and reusable content ID.
@@ -102,7 +129,7 @@ export interface GitBookDataFetcher {
         spaceId: string;
         revisionId: string;
         reusableContentId: string;
-    }): Promise<api.RevisionReusableContent | null>;
+    }): Promise<DataFetcherResponse<api.RevisionReusableContent>>;
 
     /**
      * Get the latest OpenAPI spec version content by its organization ID and slug.
@@ -110,7 +137,7 @@ export interface GitBookDataFetcher {
     getLatestOpenAPISpecVersionContent(params: {
         organizationId: string;
         slug: string;
-    }): Promise<api.OpenAPISpecContent | null>;
+    }): Promise<DataFetcherResponse<api.OpenAPISpecContent>>;
 
     /**
      * Get a site redirect by its source path.
@@ -120,10 +147,27 @@ export interface GitBookDataFetcher {
         siteId: string;
         siteShareKey: string | undefined;
         source: string;
-    }): Promise<{ redirect: api.SiteRedirect | null; target: string } | null>;
+    }): Promise<DataFetcherResponse<{ redirect: api.SiteRedirect | null; target: string }>>;
 
     /**
      * Get an embed by its URL.
      */
-    getEmbedByUrl(params: { url: string; spaceId: string }): Promise<api.Embed>;
+    getEmbedByUrl(params: { url: string; spaceId: string }): Promise<
+        DataFetcherResponse<api.Embed>
+    >;
+
+    /**
+     * Search content in a site.
+     */
+    searchSiteContent(params: {
+        organizationId: string;
+        siteId: string;
+        query: string;
+        scope:
+            | { mode: 'all' }
+            | { mode: 'current'; siteSpaceId: string }
+            | { mode: 'specific'; siteSpaceIds: string[] };
+        /** Cache bust to ensure the search results are fresh when the space is updated. */
+        cacheBust?: string;
+    }): Promise<DataFetcherResponse<api.SearchSpaceResult[]>>;
 }

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

@@ -1,121 +1,3 @@
-import { race, tryCatch } from '@/lib/async';
-import { joinPath } from '@/lib/paths';
-import { GitBookAPI, type GitBookAPIError, type PublishedSiteContentLookup } from '@gitbook/api';
-import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
-
-/**
- * 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: {
-    url: string;
-    visitorAuthToken: string | null;
-    redirectOnError: boolean;
-}): Promise<
-    | { data: PublishedSiteContentLookup; error?: undefined }
-    | { data?: undefined; error: Error | GitBookAPIError }
-> {
-    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 = new GitBookAPI({
-            authToken: GITBOOK_API_TOKEN ?? undefined,
-            endpoint: GITBOOK_API_URL,
-            userAgent: GITBOOK_USER_AGENT,
-        });
-
-        const callResult = await tryCatch(
-            api.urls.getPublishedContentByUrl(
-                {
-                    url: alternative.url,
-                    visitorAuthToken: input.visitorAuthToken ?? undefined,
-                    redirectOnError: input.redirectOnError,
-                    cache: true,
-                },
-                {
-                    signal,
-                    headers: {
-                        'x-gitbook-force-cache': 'true',
-                    },
-                }
-            )
-        );
-
-        if (callResult.error) {
-            if (alternative.primary) {
-                // We only return an error for the primary alternative (full URL),
-                // as other parts could result in errors due to the URL being incomplete (share links, etc).
-                return { error: callResult.error };
-            }
-            return null;
-        }
-
-        const {
-            data: { data },
-        } = callResult;
-
-        if ('redirect' in data) {
-            if (alternative.primary) {
-                // Append the path to the redirect URL
-                // because we might have matched a shorter path and the redirect is relative to it
-                if (alternative.extraPath) {
-                    if (data.target === 'content') {
-                        const redirect = new URL(data.redirect);
-                        redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
-                        data.redirect = redirect.toString();
-                    } else {
-                        const redirect = new URL(data.redirect);
-                        if (redirect.searchParams.has('location')) {
-                            redirect.searchParams.set(
-                                'location',
-                                joinPath(
-                                    redirect.searchParams.get('location') ?? '',
-                                    alternative.extraPath
-                                )
-                            );
-                            data.redirect = redirect.toString();
-                        }
-                    }
-                }
-
-                return { data };
-            }
-
-            return null;
-        }
-
-        /**
-         * We use the following criteria to determine if the lookup result is the right one:
-         * - the primary alternative was resolved (because that's the longest or most inclusive path)
-         * - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
-         *
-         * In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
-         */
-        if (alternative.primary || ('site' in data && data.complete)) {
-            const siteResult: PublishedSiteContentLookup = {
-                ...data,
-                changeRequest: data.changeRequest ?? lookup.changeRequest,
-                revision: data.revision ?? lookup.revision,
-                basePath: joinPath(data.basePath, lookup.basePath ?? ''),
-                pathname: joinPath(data.pathname, alternative.extraPath),
-            };
-            return { data: siteResult };
-        }
-
-        return null;
-    });
-
-    if (!result) {
-        return {
-            error: new Error('No content found'),
-        };
-    }
-
-    return result;
-}
-
 /**
  * For a given GitBook URL, return a list of alternative URLs that could be matched against to lookup the content.
  * The approach is optimized to aim at reusing cached lookup results as much as possible.

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

@@ -1,20 +0,0 @@
-import type { RevisionPageDocument } from '@gitbook/api';
-import type { GitBookDataFetcher } from './types';
-
-/**
- * Get the document for a page.
- */
-export async function getPageDocument(
-    dataFetcher: GitBookDataFetcher,
-    spaceId: string,
-    page: RevisionPageDocument
-) {
-    if (page.documentId) {
-        return dataFetcher.getDocument({ spaceId, documentId: page.documentId });
-    }
-    if (page.computed) {
-        return dataFetcher.getComputedDocument({ spaceId, source: page.computed });
-    }
-
-    return null;
-}

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

@@ -1,60 +0,0 @@
-/**
- * Main host on which GitBook is running.
- */
-export const GITBOOK_URL =
-    process.env.NODE_ENV === 'development'
-        ? 'http://localhost:3000'
-        : ((process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ??
-          process.env.GITBOOK_URL ??
-          '');
-
-/**
- * URL at which static assets are served.
- */
-export const GITBOOK_ASSETS_URL =
-    process.env.NODE_ENV === 'development'
-        ? 'http://localhost:3000'
-        : (process.env.GITBOOK_ASSETS_PREFIX ?? GITBOOK_URL);
-
-/**
- * GitBook app URL.
- */
-export const GITBOOK_APP_URL = process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? 'https://app.gitbook.com';
-
-/**
- * Default GitBook API URL endpoint.
- */
-export const GITBOOK_API_URL = process.env.GITBOOK_API_URL ?? 'https://api.gitbook.com';
-
-/**
- * Default GitBook API token.
- * It can be use to avoid rate-limiting.
- */
-export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN ?? null;
-
-/**
- * User agent to use for API requests.
- */
-export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT ?? 'GitBook-Open/2.0.0';
-
-/**
- * Whether to disable tracking of events into site insights.
- * This is used to disable tracking in development mode.
- */
-export const GITBOOK_DISABLE_TRACKING = Boolean(
-    !!process.env.GITBOOK_DISABLE_TRACKING || process.env.NODE_ENV !== 'production'
-);
-
-/**
- * Hostname serving the integrations.
- */
-export const GITBOOK_INTEGRATIONS_HOST =
-    process.env.GITBOOK_INTEGRATIONS_HOST ?? 'integrations.gitbook.com';
-
-/**
- * Endpoint to use for resizing images.
- * It should be a Cloudflare domain with image resizing enabled.
- */
-export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ?? null;
-export const GITBOOK_IMAGE_RESIZE_SIGNING_KEY =
-    process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY ?? null;

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

@@ -0,0 +1,89 @@
+import 'server-only';
+
+/*
+ * Support both Cloudflare and Vercel, environment variables can be bundled.
+ * To avoid leaking them on the client-side, they should be accessed from this file
+ * and not from the `process.env` object.
+ */
+
+/**
+ * Main host on which GitBook is running.
+ */
+export const GITBOOK_URL =
+    process.env.NODE_ENV === 'development'
+        ? 'http://localhost:3000'
+        : (process.env.GITBOOK_URL ??
+          (process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ??
+          '');
+
+/**
+ * URL at which static assets are served.
+ */
+export const GITBOOK_ASSETS_URL =
+    process.env.NODE_ENV === 'development'
+        ? 'http://localhost:3000'
+        : process.env.GITBOOK_ASSETS_PREFIX;
+
+/**
+ * GitBook app URL.
+ */
+export const GITBOOK_APP_URL = process.env.GITBOOK_APP_URL || 'https://app.gitbook.com';
+
+/**
+ * Default GitBook API URL endpoint.
+ */
+export const GITBOOK_API_URL = process.env.GITBOOK_API_URL || 'https://api.gitbook.com';
+
+/**
+ * Default GitBook API URL endpoint, to be shared with the client.
+ */
+export const GITBOOK_API_PUBLIC_URL = process.env.GITBOOK_API_PUBLIC_URL || GITBOOK_API_URL;
+
+/**
+ * Default GitBook API token.
+ * It can be use to avoid rate-limiting.
+ */
+export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN || null;
+
+/**
+ * User agent to use for API requests.
+ */
+export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT || 'GitBook-Open/2.0.0';
+
+/**
+ * Whether to disable tracking of events into site insights.
+ * This is used to disable tracking in development mode.
+ */
+export const GITBOOK_DISABLE_TRACKING = Boolean(
+    !!process.env.GITBOOK_DISABLE_TRACKING || process.env.NODE_ENV !== 'production'
+);
+
+/**
+ * Hostname serving the integrations.
+ */
+export const GITBOOK_INTEGRATIONS_HOST =
+    process.env.GITBOOK_INTEGRATIONS_HOST || 'integrations.gitbook.com';
+
+/**
+ * Endpoint to use for resizing images.
+ * It should be a Cloudflare domain with image resizing enabled.
+ */
+export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ?? null;
+export const GITBOOK_IMAGE_RESIZE_SIGNING_KEY =
+    process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY ?? null;
+
+/**
+ * Endpoint where icons are served.
+ */
+export const GITBOOK_ICONS_URL =
+    process.env.GITBOOK_ICONS_URL || `${GITBOOK_ASSETS_URL || ''}/~gitbook/static/icons`;
+
+/**
+ * Token passed to the icons endpoint.
+ */
+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;

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

@@ -0,0 +1,2 @@
+export * from './globals';
+export * from './urls';

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

@@ -0,0 +1,45 @@
+import { GITBOOK_ASSETS_URL, GITBOOK_URL } from './globals';
+
+/**
+ * Check if the URL is a GitBook host URL.
+ */
+export function isGitBookHostURL(input: URL | string): boolean {
+    const url = typeof input === 'string' ? new URL(input) : input;
+
+    if (!GITBOOK_URL) {
+        return false;
+    }
+
+    const gitbookHost = new URL(GITBOOK_URL).host;
+
+    if (url.host === gitbookHost) {
+        return true;
+    }
+
+    // Handle the Cloudflare preview URLs that are prefixed with a random hash
+    // https://developers.cloudflare.com/workers/configuration/previews/
+    if (url.host.endsWith(`-${gitbookHost}`)) {
+        return true;
+    }
+
+    return false;
+}
+
+/**
+ * Check if the URL is a GitBook assets host URL.
+ */
+export function isGitBookAssetsHostURL(input: URL | string): boolean {
+    const url = typeof input === 'string' ? new URL(input) : input;
+
+    if (!GITBOOK_ASSETS_URL) {
+        return false;
+    }
+
+    const gitbookAssetsHost = new URL(GITBOOK_ASSETS_URL).host;
+
+    if (url.host === gitbookAssetsHost) {
+        return true;
+    }
+
+    return false;
+}

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

@@ -62,28 +62,27 @@ export function createImageResizer({
                     url: urlInput,
                 });
 
-                const url = new URL(
+                const url = linker.toAbsoluteURL(linker.toPathInContent('/~gitbook/image'));
-                    linker.toAbsoluteURL(linker.toPathInContent('/~gitbook/image'))
+                const searchParams = new URLSearchParams();
-                );
+                searchParams.set('url', getImageAPIUrl(urlInput));
-                url.searchParams.set('url', getImageAPIUrl(urlInput));
 
                 if (options.width) {
-                    url.searchParams.set('width', options.width.toString());
+                    searchParams.set('width', options.width.toString());
                 }
                 if (options.height) {
-                    url.searchParams.set('height', options.height.toString());
+                    searchParams.set('height', options.height.toString());
                 }
                 if (options.dpr) {
-                    url.searchParams.set('dpr', options.dpr.toString());
+                    searchParams.set('dpr', options.dpr.toString());
                 }
                 if (options.quality) {
-                    url.searchParams.set('quality', options.quality.toString());
+                    searchParams.set('quality', options.quality.toString());
                 }
 
-                url.searchParams.set('sign', cachedSignature.signature);
+                searchParams.set('sign', cachedSignature.signature);
-                url.searchParams.set('sv', cachedSignature.version);
+                searchParams.set('sv', cachedSignature.version);
 
-                return url.toString();
+                return `${url}?${searchParams.toString()}`;
             };
         },
 

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

@@ -1,5 +1,6 @@
 import { getPagePath } from '@/lib/pages';
 import type { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
+import warnOnce from 'warn-once';
 
 /**
  * Generic interface to generate links based on a given context.
@@ -46,13 +47,11 @@ export function createLinker(
     /** Where the top of the space is served on */
     servedOn: {
         protocol?: string;
-        host: string;
+        host?: string;
         pathname: string;
     }
 ): GitBookSpaceLinker {
-    if (servedOn.host.includes('/')) {
+    warnOnce(!servedOn.host, 'No host provided to createLinker. It can lead to issues with links.');
-        throw new Error('Host cannot include a slash');
-    }
 
     const linker: GitBookSpaceLinker = {
         toPathInContent(relativePath: string): string {
@@ -60,6 +59,10 @@ export function createLinker(
         },
 
         toAbsoluteURL(absolutePath: string): string {
+            if (!servedOn.host) {
+                return absolutePath;
+            }
+
             return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
         },
 

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

@@ -1,14 +1,52 @@
-import { CustomizationThemeMode } from '@gitbook/api';
+import { CustomizationThemeMode, type PublishedSiteContent } from '@gitbook/api';
 import { headers } from 'next/headers';
 
 export enum MiddlewareHeaders {
+    /**
+     * Type of the route (static or dynamic)
+     */
+    RouteType = 'x-gitbook-route-type',
+
+    /**
+     * The URL of the site (without the pathname)
+     */
+    SiteURL = 'x-gitbook-site-url',
+
+    /**
+     * The data associated with the URL.
+     */
+    SiteURLData = 'x-gitbook-site-url-data',
+
+    /**
+     * The mode of the URL (url or url-host)
+     */
     URLMode = 'x-gitbook-url-mode',
+
+    /**
+     * The theme of the page (light or dark)
+     */
     Theme = 'x-gitbook-theme',
+
+    /**
+     * The customization override to apply.
+     */
     Customization = 'x-gitbook-customization',
+
+    /**
+     * The visitor token used to access this content
+     */
+    VisitorAuthToken = 'x-gitbook-visitor-token',
+
+    /**
+     * The API token used to fetch the content.
+     * This should only be passed for non-site dynamic routes.
+     */
+    APIToken = 'x-gitbook-api-token',
 }
 
 /**
  * Get the URL mode from the middleware headers.
+ * This function should only be called in a server action or a dynamic route.
  */
 export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
     const headersList = await headers();
@@ -20,8 +58,40 @@ export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
     return mode as '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> {
+    const headersList = await headers();
+    const siteURLData = headersList.get(MiddlewareHeaders.SiteURLData);
+
+    if (!siteURLData) {
+        throw new Error(
+            'Site URL data is not set by the middleware. This should only be called in a server action or a dynamic route.'
+        );
+    }
+
+    return JSON.parse(siteURLData);
+}
+
+/**
+ * Get the URL from the middleware headers.
+ * This function should only be called in a server action or a dynamic route.
+ */
+export async function getSiteURLFromMiddleware(): Promise<string> {
+    const headersList = await headers();
+    const siteURL = headersList.get(MiddlewareHeaders.SiteURL);
+    if (!siteURL) {
+        throw new Error('URL mode is not set by the middleware');
+    }
+
+    return siteURL;
+}
+
 /**
  * For preview, the theme can be set via query string (?theme=light).
+ * This function should only be called in a dynamic route.
  */
 export async function getThemeFromMiddleware() {
     const headersList = await headers();
@@ -34,3 +104,31 @@ export async function getThemeFromMiddleware() {
         ? CustomizationThemeMode.Light
         : CustomizationThemeMode.Dark;
 }
+
+/**
+ * Get the visitor auth token from the middleware headers.
+ * This function should only be called in a dynamic route.
+ */
+export async function getVisitorAuthTokenFromMiddleware(): Promise<string | null> {
+    const headersList = await headers();
+    const visitorAuthToken = headersList.get(MiddlewareHeaders.VisitorAuthToken);
+    if (!visitorAuthToken) {
+        return null;
+    }
+
+    return visitorAuthToken;
+}
+
+/**
+ * Get the API token from the middleware headers.
+ * This function should only be called in a dynamic route.
+ */
+export async function getAPITokenFromMiddleware(): Promise<string> {
+    const headersList = await headers();
+    const apiToken = headersList.get(MiddlewareHeaders.APIToken);
+    if (!apiToken) {
+        throw new Error('API token is not set by the middleware');
+    }
+
+    return apiToken;
+}

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

@@ -0,0 +1,41 @@
+import crypto from 'node:crypto';
+import { NextResponse } from 'next/server';
+import { GITBOOK_SECRET } from './env';
+
+/**
+ * Verify the signature of the request and call the function with the body.
+ */
+export async function withVerifySignature<T>(
+    request: Request,
+    fn: (body: T) => Promise<NextResponse>
+) {
+    try {
+        const rawBody = await request.text();
+        const body = JSON.parse(rawBody) as T;
+
+        if (GITBOOK_SECRET) {
+            // Retrieve the signature header from the request
+            const incomingSignature = request.headers.get('x-gitbook-signature');
+            if (!incomingSignature) {
+                return NextResponse.json({ error: 'Missing signature header' }, { status: 400 });
+            }
+
+            const computedSignature = crypto
+                .createHmac('sha256', GITBOOK_SECRET)
+                .update(rawBody)
+                .digest('hex');
+
+            // Compare incoming signature to computed signature
+            if (incomingSignature !== computedSignature) {
+                return NextResponse.json({ error: 'Invalid signature' }, { status: 401 });
+            }
+        }
+
+        return await fn(body);
+    } catch (_error) {
+        return NextResponse.json(
+            { error: 'Invalid request or unable to parse JSON' },
+            { status: 400 }
+        );
+    }
+}

packages/gitbook-v2/src/lib/server-actions.ts

@@ -0,0 +1,31 @@
+import { type GitBookBaseContext, fetchSiteContextByURLLookup, getBaseContext } from './context';
+import {
+    getSiteURLDataFromMiddleware,
+    getSiteURLFromMiddleware,
+    getURLModeFromMiddleware,
+} from './middleware';
+
+/**
+ * Get the base context for a server action.
+ * This function should only be called in a server action.
+ */
+export async function getServerActionBaseContext() {
+    const siteURL = await getSiteURLFromMiddleware();
+    const siteURLData = await getSiteURLDataFromMiddleware();
+    const urlMode = await getURLModeFromMiddleware();
+
+    return getBaseContext({
+        siteURL,
+        urlMode,
+        apiToken: siteURLData.apiToken,
+    });
+}
+
+/**
+ * Fetch the context for a site in a server action.
+ * The server action is always dynamic and the request is passed through the middleware.
+ */
+export async function fetchServerActionSiteContext(baseContext: GitBookBaseContext) {
+    const siteURLData = await getSiteURLDataFromMiddleware();
+    return fetchSiteContextByURLLookup(baseContext, siteURLData);
+}

packages/gitbook-v2/src/middleware.ts

@@ -1,40 +1,53 @@
-import { GitBookAPIError } from '@gitbook/api';
+import { CustomizationThemeMode } from '@gitbook/api';
 import type { NextRequest } from 'next/server';
 import { NextResponse } from 'next/server';
 
 import { getContentSecurityPolicy } from '@/lib/csp';
+import { validateSerializedCustomization } from '@/lib/customization';
 import { removeLeadingSlash, removeTrailingSlash } from '@/lib/paths';
+import {
+    type ResponseCookies,
+    getPathScopedCookieName,
+    getResponseCookiesForVisitorAuth,
+    getVisitorToken,
+    normalizeVisitorAuthURL,
+} from '@/lib/visitor-token';
 import { serveResizedImage } from '@/routes/image';
-import { getPublishedContentByURL } from '@v2/lib/data';
+import { getLinkerForSiteURL } from '@v2/lib/context';
+import {
+    DataFetcherError,
+    getPublishedContentByURL,
+    normalizeURL,
+    throwIfDataError,
+} from '@v2/lib/data';
+import { isGitBookAssetsHostURL, isGitBookHostURL } from '@v2/lib/env';
 import { MiddlewareHeaders } from '@v2/lib/middleware';
 
 export const config = {
-    matcher: ['/((?!_next/|_static/|_vercel|[\\w-]+\\.\\w+).*)'],
+    matcher: [
+        '/((?!_next/static|_next/image|~gitbook/static|~gitbook/revalidate|~gitbook/monitoring|~scalar/proxy).*)',
+    ],
 };
 
 type URLWithMode = { url: URL; mode: 'url' | 'url-host' };
 
 export async function middleware(request: NextRequest) {
     try {
-        /**
+        const requestURL = new URL(request.url);
-         * Serve image resizing requests (all requests containing `/~gitbook/image`).
+
-         * All URLs containing `/~gitbook/image` are rewritten to `/~gitbook/image`
+        // Redirect to normalize the URL
-         * and serve from a single route handler.
+        const normalized = normalizeURL(requestURL);
-         *
+        if (normalized.toString() !== requestURL.toString()) {
-         * In GitBook v1: image resizing was done at the root of the hostname (docs.company.com/~gitbook/image)
+            return NextResponse.redirect(normalized.toString());
-         * In GitBook v2: image resizing is done at the content level (docs.company.com/section/variant/~gitbook/image)
-         */
-        if (request.nextUrl.pathname.endsWith('/~gitbook/image')) {
-            return serveResizedImage(request);
         }
 
-        // Route all requests to a site
+        for (const handler of [serveSiteRoutes, servePreviewRoutes]) {
-        const extracted = extractURL(request);
+            const result = await handler(requestURL, request);
-        if (extracted) {
+            if (result) {
-            return serveSiteByURL(request, extracted);
+                return result;
+            }
         }
 
-        // Handle the rest with the router default logic
         return NextResponse.next();
     } catch (error) {
         return serveErrorResponse(error as Error);
@@ -42,112 +55,276 @@ export async function middleware(request: NextRequest) {
 }
 
 /**
- * Serve site by URL.
+ * Handle request that are targetting the site routes group.
  */
-async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
+async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
-    const dynamicHeaders = getDynamicHeaders(request);
+    const match = getSiteURLFromRequest(request);
-    const { url, mode } = urlWithMode;
+    if (!match) {
-
+        return null;
-    const result = await getPublishedContentByURL({
-        url: url.toString(),
-        visitorAuthToken: null,
-        redirectOnError: false,
-    });
-
-    if (result.error) {
-        throw result.error;
     }
 
-    const { data } = result;
+    const { url: siteURL, mode } = match;
 
+    /**
+     * Serve image resizing requests (all requests containing `/~gitbook/image`).
+     * All URLs containing `/~gitbook/image` are rewritten to `/~gitbook/image`
+     * and serve from a single route handler.
+     *
+     * In GitBook v1: image resizing was done at the root of the hostname (docs.company.com/~gitbook/image)
+     * In GitBook v2: image resizing is done at the content level (docs.company.com/section/variant/~gitbook/image)
+     */
+    if (siteURL.pathname.endsWith('/~gitbook/image')) {
+        return await serveResizedImage(request, {
+            host: siteURL.host,
+        });
+    }
+
+    //
+    // Detect and extract the visitor authentication token from the request
+    //
+    // @ts-ignore - request typing
+    const visitorToken = getVisitorToken(request, siteURL);
+
+    const data = await throwIfDataError(
+        getPublishedContentByURL({
+            url: siteURL.toString(),
+            visitorAuthToken: visitorToken?.token ?? null,
+            // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
+            // redirecting when the token is invalid as we could be dealing with stale token stored in the cookie.
+            // For example when the VA backend signature has changed but the token stored in the cookie is not yet expired.
+            redirectOnError: visitorToken?.source === 'visitor-auth-cookie',
+        })
+    );
+    let cookies: ResponseCookies = {};
+
+    //
+    // Handle redirects
+    //
     if ('redirect' in data) {
+        // biome-ignore lint/suspicious/noConsole: we want to log the redirect
+        console.log('redirect', data.redirect);
+        if (data.target === 'content') {
+            // For content redirects, we use the linker to redirect the optimal URL
+            // during development and testing in 'url' mode.
+            const linker = getLinkerForSiteURL({
+                siteURL,
+                urlMode: mode,
+            });
+
+            const contentRedirect = new URL(linker.toLinkForContent(data.redirect), request.url);
+
+            // Keep the same search params as the original request
+            // as it might contain a VA token
+            contentRedirect.search = request.nextUrl.search;
+
+            return NextResponse.redirect(contentRedirect);
+        }
+
         return NextResponse.redirect(data.redirect);
     }
 
-    const requestHeaders = new Headers(request.headers);
+    cookies = {
-    requestHeaders.set(MiddlewareHeaders.URLMode, mode);
+        ...cookies,
-    if (dynamicHeaders) {
+        ...getResponseCookiesForVisitorAuth(data.basePath, visitorToken),
-        for (const [key, value] of Object.entries(dynamicHeaders)) {
+    };
-            requestHeaders.set(key, value);
+
-        }
+    //
+    // Make sure the URL is clean of any va token after a successful lookup
+    // The token is stored in a cookie that is set on the redirect response
+    //
+    const requestURLWithoutToken = normalizeVisitorAuthURL(requestURL);
+    if (requestURLWithoutToken.toString() !== requestURL.toString()) {
+        return writeResponseCookies(
+            NextResponse.redirect(requestURLWithoutToken.toString()),
+            cookies
+        );
     }
 
+    //
+    // Render and serve the content
+    //
+
+    // When visitor has authentication (adaptive content or VA), we serve dynamic routes.
+    let routeType = visitorToken ? 'dynamic' : 'static';
+
+    const requestHeaders = new Headers(request.headers);
+    requestHeaders.set(MiddlewareHeaders.RouteType, routeType);
+    requestHeaders.set(MiddlewareHeaders.URLMode, mode);
+    requestHeaders.set(MiddlewareHeaders.SiteURL, `${siteURL.origin}${data.basePath}`);
+    requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data));
+
+    // Preview of customization/theme
+    const customization = siteURL.searchParams.get('customization');
+    if (customization && validateSerializedCustomization(customization)) {
+        routeType = 'dynamic';
+        requestHeaders.set(MiddlewareHeaders.Customization, customization);
+    }
+    const theme = siteURL.searchParams.get('theme');
+    if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
+        routeType = 'dynamic';
+        requestHeaders.set(MiddlewareHeaders.Theme, theme);
+    }
+
+    // We support forcing dynamic routes by setting a `gitbook-dynamic-route` cookie
+    // This is useful for testing dynamic routes.
+    if (request.cookies.has('gitbook-dynamic-route')) {
+        routeType = 'dynamic';
+    }
+
+    // Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied
+    requestHeaders.set('x-forwarded-host', request.nextUrl.host);
+    requestHeaders.set('origin', request.nextUrl.origin);
+
+    const siteURLWithoutProtocol = `${siteURL.host}${data.basePath}`;
+    const { pathname, routeType: routeTypeFromPathname } = encodePathInSiteContent(data.pathname);
+    routeType = routeTypeFromPathname ?? routeType;
+
     const route = [
         'sites',
-        dynamicHeaders ? 'dynamic' : 'static',
+        routeType,
         mode,
-        encodeURIComponent(url.host + data.basePath),
+        encodeURIComponent(siteURLWithoutProtocol),
-        encodePathInSiteContent(data.pathname),
+        pathname,
     ].join('/');
 
-    console.log('route', route);
+    console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
 
-    const response = NextResponse.rewrite(new URL(`/${route}`, request.url), {
+    const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
-        headers: requestHeaders,
+    const response = NextResponse.rewrite(rewrittenURL, {
+        request: {
+            headers: requestHeaders,
+        },
     });
 
     // Add Content Security Policy header
     response.headers.set('content-security-policy', getContentSecurityPolicy());
+    // Basic security headers
+    response.headers.set('strict-transport-security', 'max-age=31536000');
+    response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
+    response.headers.set('x-content-type-options', 'nosniff');
+    // Debug header
+    response.headers.set('x-gitbook-route-type', routeType);
+    response.headers.set('x-gitbook-route-site', siteURLWithoutProtocol);
 
-    return response;
+    return writeResponseCookies(response, cookies);
+}
+
+/**
+ * Serve routes for previewing unpublished content.
+ * Routes are:
+ *   - PDF export for a space: /~space/:spaceId/~gitbook/pdf
+ *   - Preview of an unpublished site: /~site/:siteId/
+ */
+async function servePreviewRoutes(requestURL: URL, request: NextRequest) {
+    const pathnameParts = requestURL.pathname.slice(1).split('/');
+
+    if (pathnameParts[0] !== '~space' && pathnameParts[0] !== '~site') {
+        return null;
+    }
+
+    // We store the API token in a cookie that is scoped to the specific preview route
+    // to avoid errors when multiple previews are opened in different tabs.
+    const cookieName = getPathScopedCookieName(
+        'gitbook-api-token',
+        pathnameParts.slice(0, 2).join('/')
+    );
+
+    // Extract a potential GitBook API token passed in the request
+    // If found, we redirect to the same URL but with the token in the cookie
+    const queryAPIToken = requestURL.searchParams.get('token');
+    if (queryAPIToken) {
+        requestURL.searchParams.delete('token');
+        return writeResponseCookies(NextResponse.redirect(requestURL.toString()), {
+            [cookieName]: {
+                value: queryAPIToken,
+                options: {
+                    httpOnly: true,
+                    sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
+                    secure: process.env.NODE_ENV === 'production',
+                    maxAge: 60 * 60, // 1 hour
+                },
+            },
+        });
+    }
+
+    const apiToken = request.cookies.get(cookieName)?.value;
+    if (!apiToken) {
+        throw new DataFetcherError('Missing API token', 400);
+    }
+
+    // Handle the rest with the router default logic
+    return NextResponse.next({
+        headers: {
+            [MiddlewareHeaders.APIToken]: apiToken,
+        },
+    });
 }
 
 /**
  * Serve an error response.
  */
 function serveErrorResponse(error: Error) {
-    if (error instanceof GitBookAPIError) {
+    if (error instanceof DataFetcherError) {
-        return NextResponse.json(
+        return new Response(error.message, {
-            { error: error.message },
+            status: error.code,
-            { status: 500, headers: { 'content-type': 'application/json' } }
+            headers: { 'content-type': 'text/plain' },
-        );
+        });
     }
 
     throw error;
 }
 
 /**
- * The URL of the GitBook content can be passed in 3 different ways:
+ * The URL of the GitBook content can be passed in 3 different ways (in order of priority):
- * - The request URL is in the `X-GitBook-URL` header.
+ * - The request has a `X-GitBook-URL` header:
- * - Hostname is in the `X-GitBook-Host` header and the pathname is the path in the request URL.
+ *      URL is taken from the header.
- * - The request URL is matching `/url/:url`
+ * - The request has a `X-Forwarded-Host` header:
+ *      Host is taken from the header, pathname is taken from the request URL.
+ * - The request URL is matching `/url/:url`:
+ *      URL is taken from the pathname.
  */
-function extractURL(request: NextRequest): URLWithMode | null {
+function getSiteURLFromRequest(request: NextRequest): URLWithMode | null {
     const xGitbookUrl = request.headers.get('x-gitbook-url');
     if (xGitbookUrl) {
         return {
-            url: new URL(xGitbookUrl),
+            url: appendQueryParams(new URL(xGitbookUrl), request.nextUrl.searchParams),
             mode: 'url-host',
         };
     }
 
-    const xGitbookHost = request.headers.get('x-gitbook-host');
+    const isMainHost = isGitBookHostURL(request.url);
-    if (xGitbookHost) {
+    const isAssetsHost = isGitBookAssetsHostURL(request.url);
-        return {
-            url: new URL(`https://${xGitbookHost}${request.nextUrl.pathname}`),
-            mode: 'url-host',
-        };
-    }
 
+    // /url/:url requests on the main host
     const prefix = '/url/';
-    if (request.nextUrl.pathname.startsWith(prefix)) {
+    if (isMainHost && request.nextUrl.pathname.startsWith(prefix)) {
         return {
-            url: new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`),
+            url: appendQueryParams(
+                new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`),
+                request.nextUrl.searchParams
+            ),
             mode: 'url',
         };
     }
 
-    return null;
+    // Skip other requests to main hosts
-}
+    if (isMainHost || isAssetsHost) {
+        return null;
+    }
+
+    const xForwardedHost = request.headers.get('x-forwarded-host');
+    // The x-forwarded-host is set by Vercel for all requests
+    // so we ignore it if the hostname is the same as the instance one.
+    if (xForwardedHost) {
+        return {
+            url: appendQueryParams(
+                new URL(`https://${xForwardedHost}${request.nextUrl.pathname}`),
+                request.nextUrl.searchParams
+            ),
+            mode: 'url-host',
+        };
+    }
 
-/**
- * Evaluate if a request is dynamic or static.
- */
-function getDynamicHeaders(_request: NextRequest): null | Record<string, string> {
-    // TODO:
-    // - check token in query string
-    // - check token in cookies
-    // - check special headers or query string
     return null;
 }
 
@@ -155,21 +332,48 @@ function getDynamicHeaders(_request: NextRequest): null | Record<string, string>
  * Encode path in a site content.
  * Special paths are not encoded and passed to be handled by the route handlers.
  */
-function encodePathInSiteContent(rawPathname: string) {
+function encodePathInSiteContent(rawPathname: string): {
+    pathname: string;
+    routeType?: 'static' | 'dynamic';
+} {
     const pathname = removeLeadingSlash(removeTrailingSlash(rawPathname));
 
     if (pathname.match(/^~gitbook\/ogimage\/\S+$/)) {
-        return pathname;
+        return { pathname };
     }
 
     switch (pathname) {
         case '~gitbook/icon':
-        case '~gitbook/image':
         case 'llms.txt':
         case 'sitemap.xml':
         case 'robots.txt':
-            return pathname;
+            return { pathname };
+        case '~gitbook/pdf':
+            // PDF routes are always dynamic as they depend on the search params.
+            return { pathname, routeType: 'dynamic' };
         default:
-            return encodeURIComponent(pathname || '/');
+            return { pathname: encodeURIComponent(pathname || '/') };
     }
 }
+
+/**
+ * Append all the query params from a URL to another URL.
+ */
+function appendQueryParams(url: URL, from: URLSearchParams) {
+    for (const [key, value] of from.entries()) {
+        url.searchParams.set(key, value);
+    }
+
+    return url;
+}
+
+/**
+ * Write the cookies to a response.
+ */
+function writeResponseCookies<R extends NextResponse>(response: R, cookies: ResponseCookies): R {
+    Object.entries(cookies).forEach(([key, { value, options }]) => {
+        response.cookies.set(key, value, options);
+    });
+
+    return response;
+}

packages/gitbook-v2/turbo.json

@@ -0,0 +1,11 @@
+{
+    "extends": ["//"],
+    "tasks": {
+        "generate": {
+            "outputs": ["public"]
+        },
+        "typecheck": {
+            "dependsOn": ["^typecheck"]
+        }
+    }
+}

packages/gitbook-v2/wrangler.toml

@@ -1,5 +1,50 @@
 main = ".open-next/worker.js"
-name = "gitbook-v2"
+name = "gitbook-open-v2"
-compatibility_date = "2024-09-23"
+compatibility_date = "2025-03-11"
-compatibility_flags = ["nodejs_compat"]
+compatibility_flags = ["nodejs_compat", "allow_importable_env"]
 assets = { directory = ".open-next/assets", binding = "ASSETS" }
+observability = { enabled = true }
+
+[env.preview]
+kv_namespaces = [
+  { binding = "NEXT_CACHE_WORKERS_KV", id = "b7dd9cf58bf2458f84812a2d83b3760c" } # gitbook-open-v2-cache-preview
+]
+d1_databases = [
+  { binding = "NEXT_CACHE_D1", database_id = "f59ddb40-ad72-4312-9395-0ac6a129af8e", database_name = "gitbook-open-v2-tags-preview" }
+]
+services = [
+  { binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-preview" },
+  { binding = "GITBOOK_API", service = "gitbook-x-prod-api-cache" }
+]
+
+[env.staging]
+routes = [
+  { pattern = "open-2c.gitbook-staging.com/*", zone_name = "gitbook-staging.com" },
+  { pattern = "static-2c.gitbook-staging.com/*", zone_name = "gitbook-staging.com" }
+]
+kv_namespaces = [
+  { binding = "NEXT_CACHE_WORKERS_KV", id = "a446e25f12b741afb185f1e5b4474f0a" } # gitbook-open-v2-cache-staging
+]
+d1_databases = [
+  { binding = "NEXT_CACHE_D1", database_id = "9df62e39-1f35-4066-83aa-e9b8ed3ac8d5", database_name = "gitbook-open-v2-tags-staging" }
+]
+services = [
+  { binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-staging" },
+  { binding = "GITBOOK_API", service = "gitbook-x-staging-api-cache" }
+]
+
+[env.production]
+routes = [
+  { pattern = "open-2c.gitbook.com/*", zone_name = "gitbook.com" },
+  { pattern = "static-2c.gitbook.com/*", zone_name = "gitbook.com" }
+]
+kv_namespaces = [
+  { binding = "NEXT_CACHE_WORKERS_KV", id = "72379746280d4e79acf24440eea950dc" } # gitbook-open-v2-cache-production
+]
+d1_databases = [
+  { binding = "NEXT_CACHE_D1", database_id = "a6f16fce-5f45-43a9-89a4-7b83ddf25b77", database_name = "gitbook-open-v2-tags-production" }
+]
+services = [
+  { binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-production" },
+  { binding = "GITBOOK_API", service = "gitbook-x-prod-api-cache" }
+]

packages/gitbook/.env.example

@@ -23,8 +23,5 @@
 ## Caching
 # GITBOOK_OUTPUT_CACHE=true
 
-### Sentry ###
-# SENTRY_DSN=xxx
-
 ### Silent logs
 # SILENT=true

packages/gitbook/.gitignore

@@ -23,9 +23,6 @@ next-env.d.ts
 # visual tests
 screenshots/
 
-# Sentry Config File
-.sentryclirc
-
 /test-results/
 /playwright-report/
 /blob-report/

packages/gitbook/CHANGELOG.md

@@ -1,404 +1,496 @@
 # gitbook
 
+## 0.8.1
+
+### Patch Changes
+
+- 886e204: Update OpenAPI operation path design
+- Updated dependencies [886e204]
+- Updated dependencies [4f0a772]
+  - @gitbook/react-openapi@1.1.5
+  - @gitbook/colors@0.3.0
+
+## 0.8.0
+
+### Minor Changes
+
+- eec3eed: Add styling for prominent search bar option
+
+### Patch Changes
+
+- 16292de: Display sidebar on no-TOC pages
+- 9b5f971: Transparent background for OpenAPI path block
+- 99da8df: Optimize favicons and og:image using the image resizer
+- b011ea0: Fix rendering of code blocks in Ask AI when being streamed
+- 9bc3d50: Info hint background and link color fixes
+- 31d800e: Render OpenAPISchemas block
+- Updated dependencies [6aaeae2]
+- Updated dependencies [c60e9ba]
+- Updated dependencies [9108c56]
+- Updated dependencies [31d800e]
+- Updated dependencies [ff3b708]
+- Updated dependencies [f32bf1f]
+- Updated dependencies [c9ea239]
+  - @gitbook/react-contentkit@0.7.0
+  - @gitbook/react-openapi@1.1.4
+  - @gitbook/cache-tags@0.2.0
+
+## 0.7.3
+
+### Patch Changes
+
+- eaf2d68: OpenAPI operation title fallback in sections
+- Updated dependencies [844059f]
+- Updated dependencies [88f64b0]
+  - @gitbook/react-openapi@1.1.3
+  - @gitbook/icons@0.2.0
+  - @gitbook/react-contentkit@0.6.2
+
+## 0.7.2
+
+### Patch Changes
+
+- f127d28: Rename OpenAPIModels to OpenAPISchemas
+- Updated dependencies [f127d28]
+  - @gitbook/react-openapi@1.1.2
+
+## 0.7.1
+
+### Patch Changes
+
+- Updated dependencies [f574858]
+  - @gitbook/react-openapi@1.1.1
+
+## 0.7.0
+
+### Minor Changes
+
+- bb3ca9c: Implement OpenAPI models blocks
+
+### Patch Changes
+
+- 5907bd9: Adjust hint block spacing
+- 9ffc3b6: Fix content overflowing out of its container in tabs
+- Updated dependencies [0278a14]
+- Updated dependencies [bb3ca9c]
+- Updated dependencies [3173d8e]
+- Updated dependencies [052e07a]
+  - @gitbook/openapi-parser@2.1.0
+  - @gitbook/react-openapi@1.1.0
+
+## 0.6.5
+
+### Patch Changes
+
+- 05ffd0e: Improving data cache management for computed content
+- 8beb5d6: Add input elements to ContentKit
+- Updated dependencies [53f5dbe]
+- Updated dependencies [05ffd0e]
+- Updated dependencies [8beb5d6]
+  - @gitbook/openapi-parser@2.0.2
+  - @gitbook/cache-tags@0.1.0
+  - @gitbook/react-contentkit@0.6.1
+  - @gitbook/react-openapi@1.0.5
+
 ## 0.6.4
 
 ### Patch Changes
 
--   9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
+- 9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
--   2ae76f9: Change how a site in proxy mode is resolved
+- 2ae76f9: Change how a site in proxy mode is resolved
--   027a859: Add support for links style customization option
+- 027a859: Add support for links style customization option
--   3e11678: fix: lost section groups
+- 3e11678: fix: lost section groups
--   3319375: Support OpenAPI operation block
+- 3319375: Support OpenAPI operation block
--   Updated dependencies [722f02e]
+- Updated dependencies [722f02e]
--   Updated dependencies [0924259]
+- Updated dependencies [0924259]
-    -   @gitbook/react-openapi@1.0.4
+  - @gitbook/react-openapi@1.0.4
-    -   @gitbook/openapi-parser@2.0.1
+  - @gitbook/openapi-parser@2.0.1
 
 ## 0.6.3
 
 ### Patch Changes
 
--   a820739: Remove unused search api method from gitbook/api/lib
+- a820739: Remove unused search api method from gitbook/api/lib
--   a054554: Implement a trusted mode to speed up OpenAPI spec validation
+- a054554: Implement a trusted mode to speed up OpenAPI spec validation
--   66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
+- 66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
--   9f0de74: Add support for new OpenAPI ref
+- 9f0de74: Add support for new OpenAPI ref
--   da55fac: Render GitBook blocks in OpenAPI operation description
+- da55fac: Render GitBook blocks in OpenAPI operation description
--   Updated dependencies [c808bb1]
+- Updated dependencies [c808bb1]
--   Updated dependencies [dc2dbc5]
+- Updated dependencies [dc2dbc5]
--   Updated dependencies [f1d1d2f]
+- Updated dependencies [f1d1d2f]
--   Updated dependencies [e24206e]
+- Updated dependencies [e24206e]
--   Updated dependencies [a054554]
+- Updated dependencies [a054554]
--   Updated dependencies [05e1d8c]
+- Updated dependencies [05e1d8c]
--   Updated dependencies [b4a12d6]
+- Updated dependencies [b4a12d6]
--   Updated dependencies [9f0de74]
+- Updated dependencies [9f0de74]
--   Updated dependencies [da55fac]
+- Updated dependencies [da55fac]
-    -   @gitbook/openapi-parser@2.0.0
+  - @gitbook/openapi-parser@2.0.0
-    -   @gitbook/react-openapi@1.0.3
+  - @gitbook/react-openapi@1.0.3
 
 ## 0.6.2
 
 ### Patch Changes
 
--   359bb97: Fix opening external links when the GitBook page is embedded in an iframe
+- 359bb97: Fix opening external links when the GitBook page is embedded in an iframe
--   6157583: Improve Markdown parsing
+- 6157583: Improve Markdown parsing
--   82cd9f2: Add support for anchor links in OpenAPI blocks
+- 82cd9f2: Add support for anchor links in OpenAPI blocks
--   Updated dependencies [445baaa]
+- Updated dependencies [445baaa]
--   Updated dependencies [bb5c6a4]
+- Updated dependencies [bb5c6a4]
--   Updated dependencies [a3f1fea]
+- Updated dependencies [a3f1fea]
--   Updated dependencies [6157583]
+- Updated dependencies [6157583]
--   Updated dependencies [7419ee7]
+- Updated dependencies [7419ee7]
--   Updated dependencies [82cd9f2]
+- Updated dependencies [82cd9f2]
-    -   @gitbook/colors@0.2.0
+  - @gitbook/colors@0.2.0
-    -   @gitbook/react-openapi@1.0.2
+  - @gitbook/react-openapi@1.0.2
-    -   @gitbook/openapi-parser@1.0.1
+  - @gitbook/openapi-parser@1.0.1
 
 ## 0.6.1
 
 ### Patch Changes
 
--   dddb4ec: Fix long tab group description
+- dddb4ec: Fix long tab group description
--   Updated dependencies [f8d4c76]
+- Updated dependencies [f8d4c76]
--   Updated dependencies [dddb4ec]
+- Updated dependencies [dddb4ec]
--   Updated dependencies [f8d4c76]
+- Updated dependencies [f8d4c76]
-    -   @gitbook/react-openapi@1.0.1
+  - @gitbook/react-openapi@1.0.1
 
 ## 0.6.0
 
 ### Minor Changes
 
--   98245e5: Adapt code to pull token from customer backend generated custom cookies
+- 98245e5: Adapt code to pull token from customer backend generated custom cookies
--   af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
+- af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
--   95f2aa4: Track new events for site insights when ads are being clicked
+- 95f2aa4: Track new events for site insights when ads are being clicked
--   08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
+- 08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
--   1138d59: Add support for sidebar background styles
+- 1138d59: Add support for sidebar background styles
--   9e18ae6: Overhaul colour scale & Tailwind colour classes
+- 9e18ae6: Overhaul colour scale & Tailwind colour classes
--   e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
+- e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
--   7059c2b: Add support for computed content by fetching computed documents for pages.
+- 7059c2b: Add support for computed content by fetching computed documents for pages.
--   c71d159: Track events for site insights using the new dedicated API.
+- c71d159: Track events for site insights using the new dedicated API.
--   eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
+- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
--   ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
+- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
--   7ee9158: Restyle PageAside to use sidebar list styles
+- 7ee9158: Restyle PageAside to use sidebar list styles
--   dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
+- dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
--   1417279: Track clicks on links (header, footer, content) for site insights.
+- 1417279: Track clicks on links (header, footer, content) for site insights.
--   9eca010: Improve the display of recommended questions by streaming them.
+- 9eca010: Improve the display of recommended questions by streaming them.
--   160fca1: new OpenAPI blocks design
+- 160fca1: new OpenAPI blocks design
--   71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
+- 71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
--   1823101: Fix internal properties appearing in OpenAPI docs.
+- 1823101: Fix internal properties appearing in OpenAPI docs.
--   6a073e1: Add antialiasing for text rendering
+- 6a073e1: Add antialiasing for text rendering
--   8126a83: Improve readability of tables with hover style and vertical dividers
+- 8126a83: Improve readability of tables with hover style and vertical dividers
--   db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
+- db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
--   99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
+- 99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
--   e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
+- e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
 
 ### Patch Changes
 
--   d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
+- d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
--   c30bc24: Fix empty sitemap
+- c30bc24: Fix empty sitemap
--   e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
+- e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
--   5b4e710: Support llms.txt
+- 5b4e710: Support llms.txt
--   b6c3870: Add support for keyboard marks
+- b6c3870: Add support for keyboard marks
--   6059efe: Fix search no results error showing while there are results
+- 6059efe: Fix search no results error showing while there are results
--   c77142a: Log component stack in Sentry
+- c77142a: Log component stack in Sentry
--   1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
+- 1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
--   32aa1f9: Handle security issue with cookies on Safari
+- 32aa1f9: Handle security issue with cookies on Safari
--   d935fb1: Don't add extra page scroll when footer is not present
+- d935fb1: Don't add extra page scroll when footer is not present
--   53de5b1: Fix site section URL resolution in Ask AI sources
+- 53de5b1: Fix site section URL resolution in Ask AI sources
--   24f5249: Fix vertical section overflow color
+- 24f5249: Fix vertical section overflow color
--   1762f85: Reduce gap between subsequent header buttons
+- 1762f85: Reduce gap between subsequent header buttons
--   c1e27cc: Fix pass Sentry release properly
+- c1e27cc: Fix pass Sentry release properly
--   5ae1b88: Fix shrinking page icons
+- 5ae1b88: Fix shrinking page icons
--   8f046a9: Start using tint in more places, TOC and PageAside
+- 8f046a9: Start using tint in more places, TOC and PageAside
--   665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
+- 665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
 
-    To reduce the load on the API and also avoid errors.
+  To reduce the load on the API and also avoid errors.
 
--   26e6401: Remove KV cache backend and only rely on DO as an external cache backend
+- 26e6401: Remove KV cache backend and only rely on DO as an external cache backend
--   8cfa67c: Fix default outline list styling
+- 8cfa67c: Fix default outline list styling
--   d66c184: Ignore errors from event flushing
+- d66c184: Ignore errors from event flushing
--   6088fa5: Simplify search results logic to investigate a bug
+- 6088fa5: Simplify search results logic to investigate a bug
--   68287d3: Cache API spec for 24 hours, revalidated every 2 hours
+- 68287d3: Cache API spec for 24 hours, revalidated every 2 hours
--   09c7c30: Try to fix error on og image generation
+- 09c7c30: Try to fix error on og image generation
--   ae99f87: Improve emoji setup, align with GitBook app
+- ae99f87: Improve emoji setup, align with GitBook app
--   2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
+- 2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
--   3a7210d: Fix zoom image view transition on Safari
+- 3a7210d: Fix zoom image view transition on Safari
--   718a8a5: Position the variant picker in the ToC
+- 718a8a5: Position the variant picker in the ToC
--   e5dc05e: Update footer styling and allow for more than 4 footer groups
+- e5dc05e: Update footer styling and allow for more than 4 footer groups
--   8276ba0: Make cookies access safer
+- 8276ba0: Make cookies access safer
--   1b8a456: Fix Image blocks zoomable behaviour
+- 1b8a456: Fix Image blocks zoomable behaviour
--   56c52e0: Handle Firefox security error on localStorage
+- 56c52e0: Handle Firefox security error on localStorage
--   0510b6f: Add section description to SectionGroupTile
+- 0510b6f: Add section description to SectionGroupTile
--   1fcc807: Fix errors from customization not found
+- 1fcc807: Fix errors from customization not found
--   46edde9: Improve the OpenAPI package API
+- 46edde9: Improve the OpenAPI package API
--   8af1abc: Improve contrast of search box placeholder
+- 8af1abc: Improve contrast of search box placeholder
--   92b7668: Improve header offset
+- 92b7668: Improve header offset
--   d9c8d57: Do not dereference before caching OpenAPI spec.
+- d9c8d57: Do not dereference before caching OpenAPI spec.
--   94876e3: Fix regression issue with page icons for multi-line titles
+- 94876e3: Fix regression issue with page icons for multi-line titles
--   47971dc: Fix OG image generation for non-latin characters
+- 47971dc: Fix OG image generation for non-latin characters
--   82dc9c4: Simplify the `useHash` algo used.
+- 82dc9c4: Simplify the `useHash` algo used.
--   128ad20: Ignore cache invalidation error from local backend
+- 128ad20: Ignore cache invalidation error from local backend
--   ff05e20: Improvements to inline images in headings
+- ff05e20: Improvements to inline images in headings
--   cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
+- cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
--   d5aaccd: Remove use of deprecatd API createSitesPageFeedback
+- d5aaccd: Remove use of deprecatd API createSitesPageFeedback
--   48ab59f: Improve colour contrast of list item decoration
+- 48ab59f: Improve colour contrast of list item decoration
--   d2bc567: Set Sentry release
+- d2bc567: Set Sentry release
--   37d13d8: Avoid error on fetch by passing a string URL
+- 37d13d8: Avoid error on fetch by passing a string URL
--   d3e573c: Generate sitemap for all sections and spaces
+- d3e573c: Generate sitemap for all sections and spaces
--   f7b801b: Add feedback form to page rating control
+- f7b801b: Add feedback form to page rating control
--   d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
+- d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
--   46f63cb: Fix code format overriding inline link styles
+- 46f63cb: Fix code format overriding inline link styles
--   5950657: Fix emojis display
+- 5950657: Fix emojis display
--   528a053: Fix server actions stability leading to no results found sometimes on search
+- 528a053: Fix server actions stability leading to no results found sometimes on search
--   eac1314: Lazy load iframely script to make page more responsive
+- eac1314: Lazy load iframely script to make page more responsive
--   ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
+- ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
--   6f54826: New highlight colors
+- 6f54826: New highlight colors
--   5c87ec7: Implement a safer way to interact with localStorage.
+- 5c87ec7: Implement a safer way to interact with localStorage.
 
-    If it's disabled on the browser it should not throw error.
+  If it's disabled on the browser it should not throw error.
 
--   02d876e: Fix search UI behaviour
+- 02d876e: Fix search UI behaviour
--   f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
+- f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
--   5576906: Fix table of content displaying arrow next to page with only hidden pages
+- 5576906: Fix table of content displaying arrow next to page with only hidden pages
--   aaab157: Visual fix for section group in Safari
+- aaab157: Visual fix for section group in Safari
--   cbe6139: Fix dynamic tabs infinite loop
+- cbe6139: Fix dynamic tabs infinite loop
--   65cc4af: Fix error when accessing a change request not found
+- 65cc4af: Fix error when accessing a change request not found
--   727bde2: Improve and split OpenAPI parser into its own package
+- 727bde2: Improve and split OpenAPI parser into its own package
--   0b6ddca: Fix variant selector contrast for non-default themes
+- 0b6ddca: Fix variant selector contrast for non-default themes
--   87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
+- 87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
--   fde32e2: Force route handler to be dynamic to avoid errors
+- fde32e2: Force route handler to be dynamic to avoid errors
--   a025118: Change card layout depending on cover aspect ratio
+- a025118: Change card layout depending on cover aspect ratio
--   300f7bf: Fix search loading state
+- 300f7bf: Fix search loading state
--   29d5979: Disable C/C++ highlight temporarily
+- 29d5979: Disable C/C++ highlight temporarily
--   18953b2: Subtler tint color when based on the primary color, by mixing in some gray
+- 18953b2: Subtler tint color when based on the primary color, by mixing in some gray
--   1c97536: Fix Sentry instrumentation
+- 1c97536: Fix Sentry instrumentation
--   b0bd871: Even safer localStorage
+- b0bd871: Even safer localStorage
--   b950a64: Avoid errors on legacy browsers
+- b950a64: Avoid errors on legacy browsers
--   38061bd: Add section groups to section tabs
+- 38061bd: Add section groups to section tabs
--   160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
+- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
--   0e601e2: Improve styling of header buttons with shadows and high-contrast styles
+- 0e601e2: Improve styling of header buttons with shadows and high-contrast styles
--   6691492: Fix viewing PDF from space
+- 6691492: Fix viewing PDF from space
--   e8e64bf: Fix bullet list display on full size blocks
+- e8e64bf: Fix bullet list display on full size blocks
--   16194c5: Vertical orientation for sections list on sites without header
+- 16194c5: Vertical orientation for sections list on sites without header
--   b41d425: Improve OpenAPI rendering performances by caching markdown parsing
+- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
--   1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
+- 1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
--   1429384: Fix error when accessing some not found pages.
+- 1429384: Fix error when accessing some not found pages.
--   21cbd9e: Change link color to primary-subtle
+- 21cbd9e: Change link color to primary-subtle
--   5dab70f: Fix "Parser" language syntax highlighting
+- 5dab70f: Fix "Parser" language syntax highlighting
--   deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
+- deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
--   56331d2: Fix breadcrumbs emoji display + add contrast styles
+- 56331d2: Fix breadcrumbs emoji display + add contrast styles
--   a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
+- a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
--   44a20fe: Improve smoothness of scroll listener
+- 44a20fe: Improve smoothness of scroll listener
--   5664e5a: Fix variant dropdown styling in header
+- 5664e5a: Fix variant dropdown styling in header
--   6b50360: Fix view transition error on Safari
+- 6b50360: Fix view transition error on Safari
--   741dd49: Bump `heading-3` font size to offset it from paragraphs
+- 741dd49: Bump `heading-3` font size to offset it from paragraphs
--   5112e3e: Fix Sentry instrumentation server-side
+- 5112e3e: Fix Sentry instrumentation server-side
--   1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
+- 1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
--   Updated dependencies [d9029c7]
+- Updated dependencies [d9029c7]
--   Updated dependencies [6e54a06]
+- Updated dependencies [6e54a06]
--   Updated dependencies [162b4b7]
+- Updated dependencies [162b4b7]
--   Updated dependencies [e4e2f52]
+- Updated dependencies [e4e2f52]
--   Updated dependencies [0c03676]
+- Updated dependencies [0c03676]
--   Updated dependencies [3e5e458]
+- Updated dependencies [3e5e458]
--   Updated dependencies [46edde9]
+- Updated dependencies [46edde9]
--   Updated dependencies [d9c8d57]
+- Updated dependencies [d9c8d57]
--   Updated dependencies [ccf2cff]
+- Updated dependencies [ccf2cff]
--   Updated dependencies [dda0cc6]
+- Updated dependencies [dda0cc6]
--   Updated dependencies [eb7c22f]
+- Updated dependencies [eb7c22f]
--   Updated dependencies [ea1468c]
+- Updated dependencies [ea1468c]
--   Updated dependencies [648f0e9]
+- Updated dependencies [648f0e9]
--   Updated dependencies [160fca1]
+- Updated dependencies [160fca1]
--   Updated dependencies [f92e906]
+- Updated dependencies [f92e906]
--   Updated dependencies [e721f17]
+- Updated dependencies [e721f17]
--   Updated dependencies [727bde2]
+- Updated dependencies [727bde2]
--   Updated dependencies [dff08ae]
+- Updated dependencies [dff08ae]
--   Updated dependencies [fc7b16f]
+- Updated dependencies [fc7b16f]
--   Updated dependencies [fe8acc9]
+- Updated dependencies [fe8acc9]
--   Updated dependencies [1823101]
+- Updated dependencies [1823101]
--   Updated dependencies [a652958]
+- Updated dependencies [a652958]
--   Updated dependencies [2f73db7]
+- Updated dependencies [2f73db7]
--   Updated dependencies [160fca1]
+- Updated dependencies [160fca1]
--   Updated dependencies [12c7862]
+- Updated dependencies [12c7862]
--   Updated dependencies [b41d425]
+- Updated dependencies [b41d425]
-    -   @gitbook/react-openapi@1.0.0
+  - @gitbook/react-openapi@1.0.0
-    -   @gitbook/openapi-parser@1.0.0
+  - @gitbook/openapi-parser@1.0.0
-    -   @gitbook/react-contentkit@0.6.0
+  - @gitbook/react-contentkit@0.6.0
 
 ## 0.5.0
 
 ### Minor Changes
 
--   57cdd25: GitBook Open now supports Ask AI in sites. When asking a question to Ask AI, GitBook will use context from across your site sections and variants to provide the best answer.
+- 57cdd25: GitBook Open now supports Ask AI in sites. When asking a question to Ask AI, GitBook will use context from across your site sections and variants to provide the best answer.
--   ca134c8: Fix an issue where the active site section indicator appeared above any dropdowns.
+- ca134c8: Fix an issue where the active site section indicator appeared above any dropdowns.
--   d48926e: Fix an issue where the space dropdown was shown under the site sections in Safari.
+- d48926e: Fix an issue where the space dropdown was shown under the site sections in Safari.
--   9fe8142: Fix an issue where Ask AI was erroring due to an object being passed as a param.
+- 9fe8142: Fix an issue where Ask AI was erroring due to an object being passed as a param.
--   d843e5e: Fix an issue where the space dropdown could appear behind the header.
+- d843e5e: Fix an issue where the space dropdown could appear behind the header.
--   a2e5647: Fix the styling of site section tabs on smaller screens.
+- a2e5647: Fix the styling of site section tabs on smaller screens.
 
 ### Patch Changes
 
--   076dc48: Fix expandable block anchore resolution
+- 076dc48: Fix expandable block anchore resolution
--   d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
+- d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
--   23584c9: Update the site header with new styling, a new search button, and refactored layout
+- 23584c9: Update the site header with new styling, a new search button, and refactored layout
--   664debc: Add support for tint color
+- 664debc: Add support for tint color
--   4d56f11: Update styling of search+ask modal
+- 4d56f11: Update styling of search+ask modal
--   061c0c1: Fix a regression in variant drop-down caused by missing z-index.
+- 061c0c1: Fix a regression in variant drop-down caused by missing z-index.
--   2f76712: Add breadcrumbs above page title
+- 2f76712: Add breadcrumbs above page title
--   07cf835: Add scroll margin to the top when there are sections
+- 07cf835: Add scroll margin to the top when there are sections
--   5d72b35: Smoother tab transition for sections
+- 5d72b35: Smoother tab transition for sections
--   7c71363: Don't adjust fallback font for mono font.
+- 7c71363: Don't adjust fallback font for mono font.
--   7675c2c: Optimize performances by using new API endpoint for fetching site data.
+- 7675c2c: Optimize performances by using new API endpoint for fetching site data.
--   87eea73: Fix margin and image resolution of header logo
+- 87eea73: Fix margin and image resolution of header logo
--   aa2ed0f: Restyle hint blocks
+- aa2ed0f: Restyle hint blocks
--   ffd3937: Fix security issue with image resizing that could be used for phishing
+- ffd3937: Fix security issue with image resizing that could be used for phishing
--   2ce59d7: Fix - whitespace added to site section tabs with icons.
+- 2ce59d7: Fix - whitespace added to site section tabs with icons.
--   c73e07d: Increase token max length to fix code not highlighted
+- c73e07d: Increase token max length to fix code not highlighted
--   3b3d6e2: Add icons to sections
+- 3b3d6e2: Add icons to sections
--   1ed18c0: style: adds missing scalar css variables
+- 1ed18c0: style: adds missing scalar css variables
--   Updated dependencies [b7a5106]
+- Updated dependencies [b7a5106]
--   Updated dependencies [4771c78]
+- Updated dependencies [4771c78]
--   Updated dependencies [ff50ac2]
+- Updated dependencies [ff50ac2]
--   Updated dependencies [867481c]
+- Updated dependencies [867481c]
--   Updated dependencies [7ba67fd]
+- Updated dependencies [7ba67fd]
--   Updated dependencies [a78c1ec]
+- Updated dependencies [a78c1ec]
-    -   @gitbook/cache-do@0.1.1
+  - @gitbook/cache-do@0.1.1
-    -   @gitbook/react-openapi@0.7.1
+  - @gitbook/react-openapi@0.7.1
 
 ## 0.4.0
 
 ### Minor Changes
 
--   e09f747: Revalidate change request cached content when pressing refresh button
+- e09f747: Revalidate change request cached content when pressing refresh button
--   2fa0851: Add navigation tabs for sections
+- 2fa0851: Add navigation tabs for sections
--   a4b63b8: Support resolution of new site URLs with sections
+- a4b63b8: Support resolution of new site URLs with sections
--   5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
+- 5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
--   e9b31a5: Unify section tab styles with page item styles
+- e9b31a5: Unify section tab styles with page item styles
--   f12a215: Add support for Norwegian language
+- f12a215: Add support for Norwegian language
--   f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
+- f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
--   1f24fe4: Add support for page icons
+- 1f24fe4: Add support for page icons
--   cda08a9: Add support for searching results in a sections site
+- cda08a9: Add support for searching results in a sections site
--   b32e40c: Persist state of tabs and dynamically sync them based on title
+- b32e40c: Persist state of tabs and dynamically sync them based on title
--   15d2ee3: Show the caption for file blocks
+- 15d2ee3: Show the caption for file blocks
--   f885e88: Improve the toolbar for change-requests and revisions to show more actions
+- f885e88: Improve the toolbar for change-requests and revisions to show more actions
--   07ea45b: Remove deprecated synced block from GitBook Open
+- 07ea45b: Remove deprecated synced block from GitBook Open
--   c3675fd: Added support for new Reusable Content block.
+- c3675fd: Added support for new Reusable Content block.
--   1f24fe4: Add support for icons style customization for sites
+- 1f24fe4: Add support for icons style customization for sites
--   4c19014: Prevent search indexation for pages where it's configured as disabled
+- 4c19014: Prevent search indexation for pages where it's configured as disabled
--   3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
+- 3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
--   1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
+- 1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
--   2c437f7: Fix linking to a tab itself
+- 2c437f7: Fix linking to a tab itself
 
 ### Patch Changes
 
--   aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
+- aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
--   51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
+- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
--   a7066cc: Fix scroll position when navigating pages on mobile
+- a7066cc: Fix scroll position when navigating pages on mobile
--   c754fc9: Add automatic color contrast in site header, restyle search button
+- c754fc9: Add automatic color contrast in site header, restyle search button
--   5fe7adb: RND-3532: drop down menu for hidden links at small screen size
+- 5fe7adb: RND-3532: drop down menu for hidden links at small screen size
--   6295881: Change dark mode shadow for multi-space search toolbar
+- 6295881: Change dark mode shadow for multi-space search toolbar
--   f89b31c: Upgrade the scalar api client package
+- f89b31c: Upgrade the scalar api client package
--   13c7534: Use ellipsis and fix icon color for more links in the header on small screen
+- 13c7534: Use ellipsis and fix icon color for more links in the header on small screen
--   f885e88: Improve consistency of change request preview by removing cache-control on response
+- f885e88: Improve consistency of change request preview by removing cache-control on response
--   16e6171: Improve performances of loading pages with embeds by caching them
+- 16e6171: Improve performances of loading pages with embeds by caching them
--   34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
+- 34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
--   af9e66e: Only display spaces dropdown in compact header when site is multi-variants
+- af9e66e: Only display spaces dropdown in compact header when site is multi-variants
--   e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
+- e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
--   042b850: Automatically scroll to active item in TOC
+- 042b850: Automatically scroll to active item in TOC
--   d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
+- d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
--   bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
+- bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
--   fe9e6c1: Update ogimage with new design
+- fe9e6c1: Update ogimage with new design
--   17f71ba: Use url hash to open Expandable and scroll to anchor
+- 17f71ba: Use url hash to open Expandable and scroll to anchor
--   3c07e65: Fix margin for paragraphs in quote blocks
+- 3c07e65: Fix margin for paragraphs in quote blocks
--   636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
+- 636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
--   f16560c: Include offset in calculations of whether scrollable element is in view
+- f16560c: Include offset in calculations of whether scrollable element is in view
--   689f553: Fix inconsistent click area in table because of scroll indicator
+- 689f553: Fix inconsistent click area in table because of scroll indicator
--   6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
+- 6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
--   e914903: Synchronize response and response example tabs
+- e914903: Synchronize response and response example tabs
--   0f990c7: Show definition title when visible in cards
+- 0f990c7: Show definition title when visible in cards
--   e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
+- e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
--   4cbcc5b: Rollback of scalar modal while fixing perf issue
+- 4cbcc5b: Rollback of scalar modal while fixing perf issue
--   3996110: Optimize images rendered in community ads
+- 3996110: Optimize images rendered in community ads
--   133c3e7: Update design of Checkbox to be more consistent and readable
+- 133c3e7: Update design of Checkbox to be more consistent and readable
--   5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
+- 5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
--   0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
+- 0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
--   2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
+- 2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
--   b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
+- b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
--   cb782a7: Fix "ip" being passed to BSA for community ads
+- cb782a7: Fix "ip" being passed to BSA for community ads
--   a7af3ca: Improving the look and feel of new section tabs
+- a7af3ca: Improving the look and feel of new section tabs
--   0bf985a: Don't show hidden pages in the empty state of a page
+- 0bf985a: Don't show hidden pages in the empty state of a page
--   d6c28a0: Update header styling of sections, variant selector, and button links
+- d6c28a0: Update header styling of sections, variant selector, and button links
 
-    -   Change position of variant selector depending on context (next to logo or in table of contents)
+  - Change position of variant selector depending on context (next to logo or in table of contents)
-    -   Update section tab styling and animation
+  - Update section tab styling and animation
-    -   Make header buttons smaller with a new `medium` button size
+  - Make header buttons smaller with a new `medium` button size
 
--   Updated dependencies [51fa3ab]
+- Updated dependencies [51fa3ab]
--   Updated dependencies [9b8d519]
+- Updated dependencies [9b8d519]
--   Updated dependencies [cf3045a]
+- Updated dependencies [cf3045a]
--   Updated dependencies [f89b31c]
+- Updated dependencies [f89b31c]
--   Updated dependencies [d0f4860]
+- Updated dependencies [d0f4860]
--   Updated dependencies [ef9d012]
+- Updated dependencies [ef9d012]
--   Updated dependencies [094e9cd]
+- Updated dependencies [094e9cd]
--   Updated dependencies [636b868]
+- Updated dependencies [636b868]
--   Updated dependencies [56f5fa1]
+- Updated dependencies [56f5fa1]
--   Updated dependencies [5c35f36]
+- Updated dependencies [5c35f36]
--   Updated dependencies [4247361]
+- Updated dependencies [4247361]
--   Updated dependencies [aa8c49e]
+- Updated dependencies [aa8c49e]
--   Updated dependencies [e914903]
+- Updated dependencies [e914903]
--   Updated dependencies [4cbcc5b]
+- Updated dependencies [4cbcc5b]
--   Updated dependencies [0f1565c]
+- Updated dependencies [0f1565c]
--   Updated dependencies [237b703]
+- Updated dependencies [237b703]
--   Updated dependencies [51955da]
+- Updated dependencies [51955da]
--   Updated dependencies [a679e72]
+- Updated dependencies [a679e72]
--   Updated dependencies [c079c3c]
+- Updated dependencies [c079c3c]
--   Updated dependencies [5c35f36]
+- Updated dependencies [5c35f36]
--   Updated dependencies [776bc31]
+- Updated dependencies [776bc31]
-    -   @gitbook/react-openapi@0.7.0
+  - @gitbook/react-openapi@0.7.0
-    -   @gitbook/cache-do@0.1.0
+  - @gitbook/cache-do@0.1.0
-    -   @gitbook/icons@0.1.0
+  - @gitbook/icons@0.1.0
-    -   @gitbook/react-contentkit@0.5.1
+  - @gitbook/react-contentkit@0.5.1
-    -   @gitbook/react-math@0.6.0
+  - @gitbook/react-math@0.6.0
 
 ## 0.3.0
 
 ### Minor Changes
 
--   24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
+- 24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
 
 ### Patch Changes
 
--   acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
+- acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
--   Updated dependencies [709f1a1]
+- Updated dependencies [709f1a1]
--   Updated dependencies [ede2335]
+- Updated dependencies [ede2335]
--   Updated dependencies [0426312]
+- Updated dependencies [0426312]
-    -   @gitbook/react-openapi@0.6.0
+  - @gitbook/react-openapi@0.6.0
 
 ## 0.2.2
 
 ### Patch Changes
 
--   Updated dependencies [3445db4]
+- Updated dependencies [3445db4]
-    -   @gitbook/react-contentkit@0.5.0
+  - @gitbook/react-contentkit@0.5.0
-    -   @gitbook/react-openapi@0.5.0
+  - @gitbook/react-openapi@0.5.0
-    -   @gitbook/react-math@0.5.0
+  - @gitbook/react-math@0.5.0
 
 ## 0.2.1
 
 ### Patch Changes
 
--   Updated dependencies [24cd72e]
+- Updated dependencies [24cd72e]
-    -   @gitbook/react-contentkit@0.4.0
+  - @gitbook/react-contentkit@0.4.0
-    -   @gitbook/react-math@0.4.0
+  - @gitbook/react-math@0.4.0
-    -   @gitbook/react-openapi@0.4.0
+  - @gitbook/react-openapi@0.4.0
 
 ## 0.2.0
 
 ### Minor Changes
 
--   de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
+- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
 
 ### Patch Changes
 
--   Updated dependencies [de747b7]
+- Updated dependencies [de747b7]
--   Updated dependencies [de747b7]
+- Updated dependencies [de747b7]
-    -   @gitbook/react-contentkit@0.3.0
+  - @gitbook/react-contentkit@0.3.0
-    -   @gitbook/react-openapi@0.3.0
+  - @gitbook/react-openapi@0.3.0
-    -   @gitbook/react-math@0.3.0
+  - @gitbook/react-math@0.3.0

packages/gitbook/e2e/customers.spec.ts

@@ -4,7 +4,7 @@ import { type TestsCase, runTestCases } from './util';
 const testCases: TestsCase[] = [
     {
         name: 'Snyk',
-        baseUrl: 'https://docs.snyk.io',
+        contentBaseURL: 'https://docs.snyk.io',
         tests: [
             { name: 'Home', url: '/' },
             { name: 'OpenAPI', url: '/snyk-api/reference/apps' },
@@ -12,227 +12,222 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Nexthink',
-        baseUrl: 'https://docs.nexthink.com',
+        contentBaseURL: 'https://docs.nexthink.com',
         tests: [{ name: 'Home', url: '/', screenshot: { waitForTOCScrolling: false } }],
     },
     {
         name: 'asiksupport-stg.dto.kemkes.go.id',
-        baseUrl: 'https://asiksupport-stg.dto.kemkes.go.id',
+        contentBaseURL: 'https://asiksupport-stg.dto.kemkes.go.id',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'jasons-tutorials.gitbook.io',
-        baseUrl: 'https://jasons-tutorials.gitbook.io',
+        contentBaseURL: 'https://jasons-tutorials.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'faq.deltaemulator.com',
-        baseUrl: 'https://faq.deltaemulator.com',
+        contentBaseURL: 'https://faq.deltaemulator.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.dify.ai',
-        baseUrl: 'https://docs.dify.ai',
+        contentBaseURL: 'https://docs.dify.ai',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'seeddao.gitbook.io',
-        baseUrl: 'https://seeddao.gitbook.io',
+        contentBaseURL: 'https://seeddao.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'faq.altstore.io',
-        baseUrl: 'https://faq.altstore.io',
+        contentBaseURL: 'https://faq.altstore.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'support.audacityteam.org',
-        baseUrl: 'https://support.audacityteam.org',
+        contentBaseURL: 'https://support.audacityteam.org',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.gmgn.ai',
-        baseUrl: 'https://docs.gmgn.ai',
+        contentBaseURL: 'https://docs.gmgn.ai',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.spicychat.ai',
-        baseUrl: 'https://docs.spicychat.ai',
+        contentBaseURL: 'https://docs.spicychat.ai',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.portainer.io',
-        baseUrl: 'https://docs.portainer.io',
+        contentBaseURL: 'https://docs.portainer.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.chirptoken.io',
-        baseUrl: 'https://docs.chirptoken.io',
+        contentBaseURL: 'https://docs.chirptoken.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.dexscreener.com',
-        baseUrl: 'https://docs.dexscreener.com',
+        contentBaseURL: 'https://docs.dexscreener.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.pancakeswap.finance',
-        baseUrl: 'https://docs.pancakeswap.finance',
+        contentBaseURL: 'https://docs.pancakeswap.finance',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'book.character.ai',
-        baseUrl: 'https://book.character.ai',
+        contentBaseURL: 'https://book.character.ai',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.tradeonnova.io',
-        baseUrl: 'https://docs.tradeonnova.io',
+        contentBaseURL: 'https://docs.tradeonnova.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'azcoiner.gitbook.io',
-        baseUrl: 'https://azcoiner.gitbook.io',
+        contentBaseURL: 'https://azcoiner.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.midas.app',
-        baseUrl: 'https://docs.midas.app',
+        contentBaseURL: 'https://docs.midas.app',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.keeper.io',
-        baseUrl: 'https://docs.keeper.io',
+        contentBaseURL: 'https://docs.keeper.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'adiblar.gitbook.io',
-        baseUrl: 'https://adiblar.gitbook.io',
+        contentBaseURL: 'https://adiblar.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.gradient.network',
-        baseUrl: 'https://docs.gradient.network',
+        contentBaseURL: 'https://docs.gradient.network',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'mygate-network.gitbook.io',
-        baseUrl: 'https://mygate-network.gitbook.io',
+        contentBaseURL: 'https://mygate-network.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'treasurenft.gitbook.io',
-        baseUrl: 'https://treasurenft.gitbook.io',
+        contentBaseURL: 'https://treasurenft.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'browndust2.gitbook.io',
-        baseUrl: 'https://browndust2.gitbook.io',
+        contentBaseURL: 'https://browndust2.gitbook.io',
         tests: [{ name: 'Home', url: '/', screenshot: { waitForTOCScrolling: false } }],
     },
     {
         name: 'junookyo.gitbook.io',
-        baseUrl: 'https://junookyo.gitbook.io',
+        contentBaseURL: 'https://junookyo.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'meshnet.nordvpn.com',
-        baseUrl: 'https://meshnet.nordvpn.com',
+        contentBaseURL: 'https://meshnet.nordvpn.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'manual.bubble.io',
-        baseUrl: 'https://manual.bubble.io',
+        contentBaseURL: 'https://manual.bubble.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.tickettool.xyz',
-        baseUrl: 'https://docs.tickettool.xyz',
+        contentBaseURL: 'https://docs.tickettool.xyz',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'wiki.redmodding.org',
-        baseUrl: 'https://wiki.redmodding.org',
+        contentBaseURL: 'https://wiki.redmodding.org',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.cherry-ai.com',
-        baseUrl: 'https://docs.cherry-ai.com',
+        contentBaseURL: 'https://docs.cherry-ai.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.snyk.io',
-        baseUrl: 'https://docs.snyk.io',
+        contentBaseURL: 'https://docs.snyk.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.realapp.link',
-        baseUrl: 'https://docs.realapp.link',
+        contentBaseURL: 'https://docs.realapp.link',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.plaza.finance',
-        baseUrl: 'https://docs.plaza.finance',
+        contentBaseURL: 'https://docs.plaza.finance',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.publicai.io',
-        baseUrl: 'https://docs.publicai.io',
+        contentBaseURL: 'https://docs.publicai.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'hyperliquid.gitbook.io',
-        baseUrl: 'https://hyperliquid.gitbook.io',
+        contentBaseURL: 'https://hyperliquid.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.umbraco.com',
-        baseUrl: 'https://docs.umbraco.com',
+        contentBaseURL: 'https://docs.umbraco.com',
         tests: [{ name: 'Home', url: '/welcome', screenshot: { waitForTOCScrolling: false } }],
     },
     {
         name: 'sosovalue-white-paper.gitbook.io',
-        baseUrl: 'https://sosovalue-white-paper.gitbook.io',
+        contentBaseURL: 'https://sosovalue-white-paper.gitbook.io',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.revrobotics.com',
-        baseUrl: 'https://docs.revrobotics.com',
+        contentBaseURL: 'https://docs.revrobotics.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'chartschool.stockcharts.com',
-        baseUrl: 'https://chartschool.stockcharts.com',
+        contentBaseURL: 'https://chartschool.stockcharts.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.soniclabs.com',
-        baseUrl: 'https://docs.soniclabs.com',
+        contentBaseURL: 'https://docs.soniclabs.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.meshchain.ai',
-        baseUrl: 'https://docs.meshchain.ai',
+        contentBaseURL: 'https://docs.meshchain.ai',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.thousandeyes.com',
-        baseUrl: 'https://docs.thousandeyes.com',
+        contentBaseURL: 'https://docs.thousandeyes.com',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.raydium.io',
-        baseUrl: 'https://docs.raydium.io',
+        contentBaseURL: 'https://docs.raydium.io',
-        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'docs.solv.finance',
-        baseUrl: 'https://docs.solv.finance',
         tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.fluentbit.io',
-        baseUrl: 'https://docs.fluentbit.io',
+        contentBaseURL: 'https://docs.fluentbit.io',
         tests: [{ name: 'Home', url: '/' }],
     },
 ];

packages/gitbook/e2e/internal.spec.ts

@@ -14,10 +14,12 @@ import {
     getVisitorAuthCookieValue,
 } from '@/lib/visitor-token';
 
+import { getSiteAPIToken } from '../tests/utils';
 import {
     type TestsCase,
     allDeprecatedThemePresets,
     allLocales,
+    allSearchStyles,
     allSidebarBackgroundStyles,
     allThemeModes,
     allThemes,
@@ -31,7 +33,7 @@ import {
 const testCases: TestsCase[] = [
     {
         name: 'GitBook Site (Single Variant)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
         tests: [
             {
                 name: 'Home',
@@ -84,7 +86,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook Site (Multi Variants)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/multi-variants/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/multi-variants/',
         tests: [
             {
                 name: 'Variants dropdown',
@@ -135,7 +137,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook Site (Navigation when switching variant)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/',
         tests: [
             {
                 name: 'Keep navigation path/route when switching variant (Public)',
@@ -155,8 +157,8 @@ const testCases: TestsCase[] = [
                         .click();
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
-                    await page.waitForURL(
+                    await page.waitForURL((url) =>
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions/2.0/reference/api-reference/pets?fallback=true'
+                        url.pathname.includes('api-multi-versions/2.0/reference/api-reference/pets')
                     );
                 },
             },
@@ -178,15 +180,17 @@ const testCases: TestsCase[] = [
                         .click();
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
-                    await page.waitForURL(
+                    await page.waitForURL((url) =>
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets?fallback=true'
+                        url.pathname.includes(
+                            'api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets'
+                        )
                     );
                 },
             },
             {
                 name: 'Keep navigation path/route when switching variant (VA)',
                 screenshot: false,
-                url: (() => {
+                url: () => {
                     const privateKey = 'c26190fc-74b2-4b54-9fc7-df9941104953';
                     const token = jwt.sign(
                         {
@@ -198,7 +202,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `api-multi-versions-va/reference/api-reference/pets?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const spaceDrowpdown = await page
                         .locator('[data-testid="space-dropdown-button"]')
@@ -213,8 +217,10 @@ const testCases: TestsCase[] = [
                         .click();
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
-                    await page.waitForURL(
+                    await page.waitForURL((url) =>
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-va/2.0/reference/api-reference/pets?fallback=true'
+                        url.pathname.includes(
+                            'api-multi-versions-va/2.0/reference/api-reference/pets'
+                        )
                     );
                 },
             },
@@ -222,7 +228,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'GitBook Site (Sections and Section Groups)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
         tests: [
             {
                 name: 'Site with sections and section groups',
@@ -244,16 +250,14 @@ const testCases: TestsCase[] = [
                     const sectionGroupDropdown = await page.getByText('Test Section Group 1');
                     await sectionGroupDropdown.hover();
                     await page.getByText('Section B').click();
-                    await page.waitForURL(
+                    await page.waitForURL((url) => url.pathname.includes('/sections/sections-4'));
-                        'https://gitbook-open-e2e-sites.gitbook.io/sections/sections-4'
-                    );
                 },
             },
         ],
     },
     {
         name: 'GitBook',
-        baseUrl: 'https://docs.gitbook.com',
+        contentBaseURL: 'https://docs.gitbook.com',
         tests: [
             {
                 name: 'Home',
@@ -297,7 +301,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Versioning',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Revision',
@@ -308,7 +312,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'PDF',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'PDF',
@@ -316,12 +320,56 @@ const testCases: TestsCase[] = [
                 screenshot: {
                     waitForTOCScrolling: false,
                 },
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="print-button"]')).toBeVisible();
+                },
+            },
+        ],
+    },
+    {
+        name: 'Space PDF',
+        tests: [
+            {
+                name: 'Main content',
+                url: async () => {
+                    const data = await getSiteAPIToken(
+                        'https://gitbook.gitbook.io/test-gitbook-open/'
+                    );
+
+                    const searchParams = new URLSearchParams();
+                    searchParams.set('limit', '10');
+                    searchParams.set('token', data.apiToken);
+
+                    return `~space/${data.space}/~gitbook/pdf?${searchParams.toString()}`;
+                },
+                screenshot: false,
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="print-button"]')).toBeVisible();
+                },
+            },
+            {
+                name: 'Change request',
+                url: async () => {
+                    const data = await getSiteAPIToken(
+                        'https://gitbook.gitbook.io/test-gitbook-open/'
+                    );
+
+                    const searchParams = new URLSearchParams();
+                    searchParams.set('limit', '10');
+                    searchParams.set('token', data.apiToken);
+
+                    return `~space/${data.space}/~/changes/HrtgUd5MlFusCMv1elA7/~gitbook/pdf?${searchParams.toString()}`;
+                },
+                screenshot: false,
+                run: async (page) => {
+                    await expect(page.locator('[data-testid="print-button"]')).toBeVisible();
+                },
             },
         ],
     },
     {
         name: 'Content tests',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Text',
@@ -484,7 +532,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Page options',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Hidden',
@@ -518,7 +566,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Customization',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: allThemeModes.flatMap((themeMode) => [
             {
                 name: `Without header - Theme mode ${themeMode}`,
@@ -600,6 +648,23 @@ const testCases: TestsCase[] = [
                         run: waitForCookiesDialog,
                     })),
                 ]),
+                ...allSearchStyles.flatMap((searchStyle) => ({
+                    name: `Theme ${theme} – Search ${searchStyle} – Mode ${themeMode}`,
+                    url: getCustomizationURL({
+                        styling: {
+                            theme,
+                            search: searchStyle,
+                        },
+                        header: {
+                            links: headerLinks,
+                        },
+                        themes: {
+                            default: themeMode,
+                            toggeable: false,
+                        },
+                    }),
+                    run: waitForCookiesDialog,
+                })),
             ]),
             // Deprecated header themes
             ...allDeprecatedThemePresets.flatMap((preset) => [
@@ -652,7 +717,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Ads',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Without previewed ads',
@@ -663,7 +728,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Shared space navigation (first site)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-uno/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-uno/',
         tests: [
             {
                 name: 'Navigation to shared space',
@@ -684,7 +749,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Shared space navigation (second site)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-dos/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/shared-space-dos/',
         tests: [
             {
                 name: 'Navigation to shared space',
@@ -704,7 +769,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Site Redirects',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
         tests: [
             {
                 name: 'Redirect to SSO page',
@@ -718,7 +783,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Share links',
-        baseUrl: 'https://gitbook.gitbook.io/gbo-tests-share-links/',
+        contentBaseURL: 'https://gitbook.gitbook.io/gbo-tests-share-links/',
         tests: [
             {
                 name: 'Valid link',
@@ -738,11 +803,11 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Space',
-        baseUrl: 'https://gitbook.gitbook.io/gbo-va-space/',
+        contentBaseURL: 'https://gitbook.gitbook.io/gbo-va-space/',
         tests: [
             {
                 name: 'First',
-                url: (() => {
+                url: () => {
                     const privateKey = '70b844d0-c519-4532-8586-5970ce48c537';
                     const token = jwt.sign(
                         {
@@ -754,7 +819,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `first?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(
                         page.getByRole('heading', { level: 1, name: 'first' })
@@ -764,7 +829,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'Second',
-                url: (() => {
+                url: () => {
                     const privateKey = '70b844d0-c519-4532-8586-5970ce48c537';
                     const token = jwt.sign(
                         {
@@ -776,7 +841,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `second?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(
                         page.getByRole('heading', { level: 1, name: 'second' })
@@ -788,11 +853,11 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Collection',
-        baseUrl: 'https://gitbook.gitbook.io/gbo-va-collection/',
+        contentBaseURL: 'https://gitbook.gitbook.io/gbo-va-collection/',
         tests: [
             {
                 name: 'Root',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -804,12 +869,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Primary (Space A)',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -820,13 +885,16 @@ const testCases: TestsCase[] = [
                             expiresIn: '24h',
                         }
                     );
+
+                    // Test that when accessing the non-canonical URL, we are redirected to the canonical URL
+                    // with the jwt token in the query string
                     return `spacea?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Space B',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -838,12 +906,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `spaceb?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Space C',
-                url: (() => {
+                url: () => {
                     const privateKey = 'af5688dc-f0b6-4146-9b1d-6d834c62c980';
                     const token = jwt.sign(
                         {
@@ -855,18 +923,18 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `spacec?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
         ],
     },
     {
         name: 'Visitor Auth - Space (custom domain)',
-        baseUrl: 'https://test.gitbook.community/',
+        contentBaseURL: 'https://test.gitbook.community/',
         tests: [
             {
                 name: 'Root',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -878,12 +946,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'First',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -895,7 +963,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `first?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(
                         page.getByRole('heading', { level: 1, name: 'first' })
@@ -905,7 +973,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'Custom page',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -917,12 +985,12 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `custom-page?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
             {
                 name: 'Inner page',
-                url: (() => {
+                url: () => {
                     const privateKey = '19c8166f-c436-4ed1-a24e-60954b804021';
                     const token = jwt.sign(
                         {
@@ -934,14 +1002,14 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `custom-page/inner-page?jwt_token=${token}`;
-                })(),
+                },
                 run: waitForCookiesDialog,
             },
         ],
     },
     {
         name: 'Visitor Auth - Site (redirects to fallback/auth URL)',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/va-site-redirects-fallback/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/va-site-redirects-fallback/',
         tests: [
             {
                 name: 'Redirect to fallback on invalid token pulled from cookie',
@@ -973,7 +1041,7 @@ const testCases: TestsCase[] = [
             {
                 name: 'Show error message when invalid token is passed to url',
                 screenshot: false,
-                url: (() => {
+                url: () => {
                     const token = jwt.sign(
                         {
                             name: 'gitbook-open-tests',
@@ -984,7 +1052,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     await expect(page.locator('pre')).toContainText(
                         'Error while validating the JWT token. Reason: The token signature is invalid.'
@@ -995,7 +1063,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Languages',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: allLocales.map((locale) => ({
             name: locale,
             url: getCustomizationURL({
@@ -1011,7 +1079,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'SEO',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Index by default',
@@ -1062,11 +1130,11 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Adaptive Content - VA',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/',
         tests: [
             {
                 name: 'isAlphaUser',
-                url: (() => {
+                url: () => {
                     const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
                     const token = jwt.sign(
                         {
@@ -1079,7 +1147,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const alphaUserPage = page
                         .locator('a[class*="group\\/toclink"]')
@@ -1093,7 +1161,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'isBetaUser',
-                url: (() => {
+                url: () => {
                     const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
                     const token = jwt.sign(
                         {
@@ -1106,7 +1174,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const alphaUserPage = page
                         .locator('a[class*="group\\/toclink"]')
@@ -1120,7 +1188,7 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'isAlphaUser & isBetaUser',
-                url: (() => {
+                url: () => {
                     const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
                     const token = jwt.sign(
                         {
@@ -1134,7 +1202,7 @@ const testCases: TestsCase[] = [
                         }
                     );
                     return `?jwt_token=${token}`;
-                })(),
+                },
                 run: async (page) => {
                     const alphaUserPage = page
                         .locator('a[class*="group\\/toclink"]')
@@ -1150,7 +1218,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Adaptive Content - Public',
-        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-public/',
+        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-public/',
         tests: [
             {
                 name: 'No custom cookie',
@@ -1293,7 +1361,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Tables',
-        baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
+        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
                 name: 'Default table',

packages/gitbook/e2e/util.ts

@@ -2,12 +2,13 @@ import { argosScreenshot } from '@argos-ci/playwright';
 import {
     CustomizationBackground,
     CustomizationCorners,
-    CustomizationFont,
+    CustomizationDefaultFont,
     type CustomizationHeaderItem,
     CustomizationHeaderPreset,
     CustomizationIconsStyle,
     CustomizationLinksStyle,
     CustomizationLocale,
+    CustomizationSearchStyle,
     CustomizationSidebarBackgroundStyle,
     CustomizationSidebarListStyle,
     CustomizationTheme,
@@ -20,14 +21,14 @@ import deepMerge from 'deepmerge';
 import rison from 'rison';
 import type { DeepPartial } from 'ts-essentials';
 
-import { getContentTestURL } from '../tests/utils';
+import { getContentTestURL, getTestURL } from '../tests/utils';
 
 export interface Test {
     name: string;
     /**
      * URL to visit for testing.
      */
-    url: string;
+    url: string | (() => string | Promise<string>);
     cookies?: Parameters<BrowserContext['addCookies']>[0];
     /**
      * Test to run
@@ -60,11 +61,11 @@ export interface Test {
     only?: boolean;
 }
 
-export interface TestsCase {
+export type TestsCase = {
     name: string;
-    baseUrl: string;
     tests: Array<Test>;
-}
+    contentBaseURL?: string;
+};
 
 export const allLocales: CustomizationLocale[] = [
     CustomizationLocale.Fr,
@@ -109,6 +110,11 @@ export const allSidebarBackgroundStyles: CustomizationSidebarBackgroundStyle[] =
     CustomizationSidebarBackgroundStyle.Filled,
 ];
 
+export const allSearchStyles: CustomizationSearchStyle[] = [
+    CustomizationSearchStyle.Prominent,
+    CustomizationSearchStyle.Subtle,
+];
+
 // Common customization settings
 
 export const headerLinks: CustomizationHeaderItem[] = [
@@ -142,9 +148,14 @@ export function runTestCases(testCases: TestsCase[]) {
         test.describe(testCase.name, () => {
             for (const testEntry of testCase.tests) {
                 const testFn = testEntry.only ? test.only : test;
-                testFn(testEntry.name, async ({ page, baseURL, context }) => {
+                testFn(testEntry.name, async ({ page, context }) => {
-                    const contentUrl = new URL(testEntry.url, testCase.baseUrl);
+                    const testEntryPathname =
-                    const url = getContentTestURL(contentUrl.toString(), baseURL);
+                        typeof testEntry.url === 'function' ? await testEntry.url() : testEntry.url;
+                    const url = testCase.contentBaseURL
+                        ? getContentTestURL(
+                              new URL(testEntryPathname, testCase.contentBaseURL).toString()
+                          )
+                        : getTestURL(testEntryPathname);
                     if (testEntry.cookies) {
                         await context.addCookies(
                             testEntry.cookies.map((cookie) => ({
@@ -155,6 +166,21 @@ export function runTestCases(testCases: TestsCase[]) {
                         );
                     }
 
+                    // Set the header to disable the Vercel toolbar
+                    // But only on the main document as it'd cause CORS issues on other resources
+                    await page.route('**/*', async (route, request) => {
+                        if (request.resourceType() === 'document') {
+                            await route.continue({
+                                headers: {
+                                    ...request.headers(),
+                                    'x-vercel-skip-toolbar': '1',
+                                },
+                            });
+                        } else {
+                            await route.continue();
+                        }
+                    });
+
                     await page.goto(url);
                     if (testEntry.run) {
                         await testEntry.run(page);
@@ -229,7 +255,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
             dangerColor: { light: '#FB2C36', dark: '#FB2C36' },
             successColor: { light: '#00C950', dark: '#00C950' },
             corners: CustomizationCorners.Rounded,
-            font: CustomizationFont.Inter,
+            font: CustomizationDefaultFont.Inter,
             background: CustomizationBackground.Plain,
             icons: CustomizationIconsStyle.Regular,
             links: CustomizationLinksStyle.Default,
@@ -237,6 +263,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
                 background: CustomizationSidebarBackgroundStyle.Default,
                 list: CustomizationSidebarListStyle.Default,
             },
+            search: CustomizationSearchStyle.Subtle,
         },
         internationalization: {
             locale: CustomizationLocale.En,

packages/gitbook/next.config.js

@@ -1,83 +1,49 @@
-const { withSentryConfig } = require('@sentry/nextjs');
+module.exports = {
-
+    env: {
-module.exports = withSentryConfig(
+        BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
-    {
+        GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
-        env: {
+        GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
-            BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
+        GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
-            SENTRY_RELEASE: process.env.SENTRY_RELEASE ?? '',
+        NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
-            SENTRY_DSN: process.env.SENTRY_DSN ?? '',
-            SENTRY_ENVIRONMENT: process.env.SENTRY_ENVIRONMENT ?? 'development',
-            GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
-            GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
-            GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
-            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
-        },
-
-        webpack(config, { dev, webpack }) {
-            config.resolve.fallback = {
-                ...config.resolve.fallback,
-
-                // Required for `swagger2openapi` to work:
-                fs: false,
-                path: false,
-                http: false,
-            };
-
-            // Tree shake debug code for Sentry
-            // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/tree-shaking/#tree-shaking-with-nextjs
-            if (!dev) {
-                config.plugins.push(
-                    new webpack.DefinePlugin({
-                        __SENTRY_DEBUG__: false,
-                        // We always init Sentry with enableTracing: false for now, so this is useless
-                        __SENTRY_TRACING__: false,
-                        __RRWEB_EXCLUDE_IFRAME__: true,
-                        __RRWEB_EXCLUDE_SHADOW_DOM__: true,
-                        __SENTRY_EXCLUDE_REPLAY_WORKER__: true,
-                    })
-                );
-            }
-
-            return config;
-        },
-
-        async headers() {
-            return [
-                // Cache all static assets for 1 year
-                {
-                    source: '/~gitbook/static/:path*',
-                    headers: [
-                        {
-                            key: 'Cache-Control',
-                            value: 'public, max-age=31536000, immutable',
-                        },
-                    ],
-                },
-            ];
-        },
-
-        assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
-        poweredByHeader: false,
-
-        images: {
-            remotePatterns: [
-                {
-                    protocol: 'https',
-                    hostname: '*.gitbook.io',
-                },
-            ],
-        },
     },
-    {
-        release: process.env.SENTRY_RELEASE,
-        org: process.env.SENTRY_ORG,
-        project: process.env.SENTRY_PROJECT,
-        authToken: process.env.SENTRY_AUTH_TOKEN,
 
-        // Upload a larger set of source maps for prettier stack traces (increases build time)
+    webpack(config) {
-        widenClientFileUpload: true,
+        config.resolve.fallback = {
-        // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load)
+            ...config.resolve.fallback,
-        tunnelRoute: '/~gitbook/monitoring',
+
-        disableLogger: true,
+            // Required for `swagger2openapi` to work:
-    }
+            fs: false,
-);
+            path: false,
+            http: false,
+        };
+
+        return config;
+    },
+
+    async headers() {
+        return [
+            // Cache all static assets for 1 year
+            {
+                source: '/~gitbook/static/:path*',
+                headers: [
+                    {
+                        key: 'Cache-Control',
+                        value: 'public, max-age=31536000, immutable',
+                    },
+                ],
+            },
+        ];
+    },
+
+    assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
+    poweredByHeader: false,
+
+    images: {
+        remotePatterns: [
+            {
+                protocol: 'https',
+                hostname: '*.gitbook.io',
+            },
+        ],
+    },
+};

packages/gitbook/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.6.4",
+    "version": "0.8.1",
     "private": true,
     "scripts": {
         "dev": "env-cmd --silent -f ../../.env.local next dev",
@@ -16,8 +16,9 @@
         "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math"
     },
     "dependencies": {
-        "@gitbook/api": "0.96.1",
+        "@gitbook/api": "*",
         "@gitbook/cache-do": "workspace:*",
+        "@gitbook/cache-tags": "workspace:*",
         "@gitbook/colors": "workspace:*",
         "@gitbook/emoji-codepoints": "workspace:*",
         "@gitbook/icons": "workspace:*",
@@ -28,7 +29,6 @@
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-navigation-menu": "^1.2.3",
         "@radix-ui/react-popover": "^1.0.7",
-        "@sentry/nextjs": "8.35.0",
         "@sindresorhus/fnv1a": "^3.1.0",
         "@tailwindcss/container-queries": "^0.1.1",
         "@tailwindcss/typography": "^0.5.16",
@@ -58,11 +58,13 @@
         "react-hotkeys-hook": "^4.4.1",
         "rison": "^0.1.1",
         "server-only": "^0.0.1",
-        "shiki": "^1.27.2",
+        "shiki": "^3.2.0",
         "tailwind-merge": "^2.2.0",
         "tailwind-shades": "^1.1.2",
         "url-join": "^5.0.0",
-        "usehooks-ts": "^3.1.0"
+        "usehooks-ts": "^3.1.0",
+        "ai": "^4.1.46",
+        "jwt-decode": "^4.0.0"
     },
     "devDependencies": {
         "@argos-ci/playwright": "^3.10.0",

packages/gitbook/playwright.config.ts

@@ -16,7 +16,6 @@ export default defineConfig({
         },
     ],
     use: {
-        baseURL: process.env.BASE_URL || 'http://localhost:3000',
         trace: 'on-first-retry',
         screenshot: 'only-on-failure',
     },

packages/gitbook/sentry.client.config.ts

@@ -1,18 +0,0 @@
-import * as Sentry from '@sentry/browser';
-
-const dsn = process.env.SENTRY_DSN;
-if (dsn) {
-    Sentry.init({
-        dsn,
-        release: process.env.SENTRY_RELEASE,
-
-        // Disable tracing as it creates additional requests in an env where subrequests are limited.
-        tracesSampleRate: 0,
-
-        // Disable transactions  as it creates additional requests in an env where subrequests are limited.
-        // https://docs.sentry.io/platforms/node/configuration/filtering/#using--3
-        beforeSendTransaction: () => {
-            return null;
-        },
-    });
-}

packages/gitbook/src/app/global-error.tsx

@@ -1,14 +1,8 @@
 'use client';
 
-import { captureException } from '@sentry/nextjs';
 import NextError from 'next/error';
-import { useEffect } from 'react';
-
-export default function GlobalError({ error }: { error: Error }) {
-    useEffect(() => {
-        captureException(error);
-    }, [error]);
 
+export default function GlobalError() {
     return (
         <html lang="en">
             <body>

packages/gitbook/src/app/middleware/(site)/(content)/[[...pathname]]/page.tsx

@@ -38,10 +38,9 @@ export async function generateMetadata(props: PageProps): Promise<Metadata> {
 }
 
 async function getSitePageProps(props: PageProps) {
-    const { params: rawParams, searchParams: rawSearchParams } = props;
+    const { params: rawParams } = props;
 
     const params = await rawParams;
-    const searchParams = await rawSearchParams;
 
     const pointer = await getSiteContentPointer();
     const context = await fetchV1ContextForSitePointer(pointer);
@@ -49,7 +48,5 @@ async function getSitePageProps(props: PageProps) {
     return {
         context,
         pageParams: params,
-        redirectOnFallback: true,
-        fallback: !!searchParams.fallback,
     };
 }

packages/gitbook/src/app/middleware/(site)/(content)/layout.tsx

@@ -1,4 +1,4 @@
-import { getThemeFromMiddleware } from '@v2/lib/middleware';
+import { getThemeFromMiddleware, getVisitorAuthTokenFromMiddleware } from '@v2/lib/middleware';
 import type { Metadata, Viewport } from 'next';
 import type React from 'react';
 
@@ -22,12 +22,14 @@ export default async function ContentLayout(props: { children: React.ReactNode }
 
     const context = await fetchLayoutData();
     const queryStringTheme = await getThemeFromMiddleware();
+    const visitorAuthToken = await getVisitorAuthTokenFromMiddleware();
 
     return (
         <SiteLayout
             context={context}
             forcedTheme={queryStringTheme}
             withTracking={await shouldTrackEvents()}
+            visitorAuthToken={visitorAuthToken}
         >
             {children}
         </SiteLayout>

packages/gitbook/src/app/middleware/(site)/error.tsx

@@ -1,8 +1,5 @@
 'use client';
 
-import { captureException, withScope } from '@sentry/nextjs';
-import React from 'react';
-
 import { Button } from '@/components/primitives/Button';
 import { t, useLanguage } from '@/intl/client';
 import { tcls } from '@/lib/tailwind';
@@ -11,18 +8,9 @@ export default function ErrorPage(props: {
     error: Error & { digest?: string };
     reset: () => void;
 }) {
-    const { error, reset } = props;
+    const { reset } = props;
     const language = useLanguage();
 
-    React.useEffect(() => {
-        withScope((scope) => {
-            if ('_componentStack' in error && error._componentStack) {
-                scope.setExtra('componentStack', error._componentStack);
-            }
-            captureException(error);
-        });
-    }, [error]);
-
     return (
         <div
             className={tcls(

packages/gitbook/src/app/middleware/(space)/~gitbook/pdf/layout.tsx

@@ -1,24 +1,9 @@
-import { CustomizationRootLayout } from '@/components/RootLayout';
+import { PDFRootLayout } from '@/components/PDF';
-import { defaultCustomizationForSpace } from '@/lib/utils';
-
 import { getV1ContextForPDF } from './pointer';
 
-/**
+export default async function RootLayout(props: { children: React.ReactNode }) {
- * Layout to be used for the site root. It fetches the customization data for the
- * site or space and initializes the CustomizationRootLayout with it.
- */
-export default async function PDFRootLayout(props: { children: React.ReactNode }) {
     const { children } = props;
-
     const context = await getV1ContextForPDF();
 
-    return (
+    return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
-        <CustomizationRootLayout
-            customization={
-                'customization' in context ? context.customization : defaultCustomizationForSpace()
-            }
-        >
-            {children}
-        </CustomizationRootLayout>
-    );
 }

packages/gitbook/src/app/middleware/(space)/~gitbook/pdf/page.tsx

@@ -1,361 +1,17 @@
-import {
+import { PDFPage, generatePDFMetadata } from '@/components/PDF';
-    type CustomizationSettings,
-    type Revision,
-    type RevisionPageDocument,
-    type RevisionPageGroup,
-    RevisionPageType,
-    type SiteCustomizationSettings,
-    SiteInsightsTrademarkPlacement,
-    type Space,
-} from '@gitbook/api';
-import { Icon } from '@gitbook/icons';
-import type { GitBookSpaceContext } from '@v2/lib/context';
-import { getPageDocument } from '@v2/lib/data';
-import type { GitBookSpaceLinker } from '@v2/lib/links';
-import type { Metadata } from 'next';
-import { notFound } from 'next/navigation';
-import * as React from 'react';
-
-import { DocumentView } from '@/components/DocumentView';
-import { TrademarkLink } from '@/components/TableOfContents/Trademark';
-import type { PolymorphicComponentProp } from '@/components/utils/types';
-import { getSpaceLanguage } from '@/intl/server';
-import { tString } from '@/intl/translate';
-import { getAbsoluteHref, getPagePDFContainerId } from '@/lib/links';
-import { resolvePageId } from '@/lib/pages';
-import { tcls } from '@/lib/tailwind';
-import { type PDFSearchParams, getPDFSearchParams } from '@/lib/urls';
-import { defaultCustomizationForSpace } from '@/lib/utils';
-
-import { PageControlButtons } from './PageControlButtons';
-import { PrintButton } from './PrintButton';
-import './pdf.css';
 import { getV1ContextForPDF } from './pointer';
 
-const DEFAULT_LIMIT = 100;
-
 export const runtime = 'edge';
 export const dynamic = 'force-dynamic';
 
-export async function generateMetadata(): Promise<Metadata> {
+export async function generateMetadata() {
     const context = await getV1ContextForPDF();
-
+    return generatePDFMetadata(context);
-    return {
-        title: 'site' in context ? context.site.title : context.space.title,
-        robots: 'noindex, nofollow',
-    };
 }
 
-/**
+export default async function Page(props: {
- * Render a space as a standalone HTML page that can be printed as a PDF.
- */
-export default async function PDFHTMLOutput(props: {
     searchParams: Promise<{ [key: string]: string }>;
 }) {
-    const searchParams = new URLSearchParams(await props.searchParams);
+    const context = await getV1ContextForPDF();
-    const pdfParams = getPDFSearchParams(new URLSearchParams(searchParams));
+    return <PDFPage context={context} searchParams={await props.searchParams} />;
-
-    // Build current PDF URL and preserve all search params
-    let currentPDFUrl = await getAbsoluteHref('~gitbook/pdf', true);
-    currentPDFUrl += `?${searchParams.toString()}`;
-
-    // Fetch the context
-    const baseContext = await getV1ContextForPDF();
-
-    const customization =
-        'customization' in baseContext ? baseContext.customization : defaultCustomizationForSpace();
-    const language = getSpaceLanguage(customization);
-
-    // Compute the pages to render
-    const { pages, total } = selectPages(baseContext.pages, pdfParams);
-    const pageIds = pages.map(
-        ({ page }) => [page.id, getPagePDFContainerId(page)] as [string, string]
-    );
-
-    // Build a linker that create anchor links for the pages rendered in the PDF page.
-    const linker: GitBookSpaceLinker = {
-        ...baseContext.linker,
-        toPathForPage(input) {
-            if (pages.some((p) => p.page.id === input.page.id)) {
-                return `#${getPagePDFContainerId(input.page, input.anchor)}`;
-            }
-            if (input.page.type === RevisionPageType.Group) {
-                return '#';
-            }
-
-            // Use an absolute URL to the page
-            return input.page.urls.app;
-        },
-    };
-
-    const context: GitBookSpaceContext = {
-        ...baseContext,
-        linker,
-    };
-
-    return (
-        <div className="print-mode">
-            {pdfParams.back !== 'false' ? (
-                <div className={tcls('fixed', 'left-12', 'top-12', 'print:hidden', 'z-50')}>
-                    <a
-                        title={tString(language, 'pdf_goback')}
-                        href={pdfParams.back ?? linker.toAbsoluteURL(linker.toPathInContent(''))}
-                        className={tcls(
-                            'flex',
-                            'flex-row',
-                            'items-center',
-                            'justify-center',
-                            'text-sm',
-                            'text-tint',
-                            'hover:text-primary',
-                            'p-4',
-                            'rounded-full',
-                            'bg-white',
-                            'shadow-sm',
-                            'hover:shadow-md',
-                            'border-slate-300',
-                            'border'
-                        )}
-                    >
-                        <Icon icon="arrow-left" className={tcls('size-6')} />
-                    </a>
-                </div>
-            ) : null}
-
-            <div className={tcls('fixed', 'right-12', 'top-12', 'print:hidden', 'z-50')}>
-                <PrintButton
-                    title={tString(language, 'pdf_print')}
-                    className={tcls(
-                        'flex',
-                        'flex-row',
-                        'items-center',
-                        'justify-center',
-                        'text-sm',
-                        'text-tint',
-                        'hover:text-primary',
-                        'p-4',
-                        'rounded-full',
-                        'bg-white',
-                        'shadow-sm',
-                        'hover:shadow-md',
-                        'border-slate-300',
-                        'border'
-                    )}
-                >
-                    <Icon icon="print" className={tcls('size-6')} />
-                </PrintButton>
-            </div>
-
-            <PageControlButtons
-                pageIds={pageIds}
-                pdfHref={currentPDFUrl}
-                singlePageMode={!!pdfParams.only}
-                total={total}
-                limit={pdfParams.limit ?? DEFAULT_LIMIT}
-                trademark={
-                    customization.trademark.enabled ? (
-                        <TrademarkLink
-                            space={context.space}
-                            customization={customization}
-                            placement={SiteInsightsTrademarkPlacement.Pdf}
-                        />
-                    ) : null
-                }
-            />
-
-            {pdfParams.only ? null : (
-                <PDFSpaceIntro space={context.space} customization={customization} />
-            )}
-            {pages.map(({ page }) =>
-                page.type === 'group' ? (
-                    <PDFPageGroup key={page.id} space={context.space} page={page} />
-                ) : (
-                    <React.Suspense
-                        key={page.id}
-                        fallback={
-                            <PrintPage id={getPagePDFContainerId(page)}>
-                                <p>Loading...</p>
-                            </PrintPage>
-                        }
-                    >
-                        <PDFPageDocument page={page} context={context} />
-                    </React.Suspense>
-                )
-            )}
-        </div>
-    );
-}
-
-async function PDFSpaceIntro(props: {
-    space: Space;
-    customization: CustomizationSettings | SiteCustomizationSettings;
-}) {
-    const { space, customization } = props;
-
-    return (
-        <PrintPage isFirst>
-            <div className={tcls('flex', 'items-center', 'justify-center', 'py-12')}>
-                <h1 className={tcls('text-6xl', 'font-bold')}>
-                    {customization.title ?? space.title}
-                </h1>
-            </div>
-        </PrintPage>
-    );
-}
-
-async function PDFPageGroup(props: { space: Space; page: RevisionPageGroup }) {
-    const { page } = props;
-
-    return (
-        <PrintPage id={getPagePDFContainerId(page)}>
-            <div
-                className={tcls(
-                    'break-before-page',
-                    'mt-10',
-                    'print:mt-0',
-                    'flex',
-                    'items-center',
-                    'justify-center',
-                    'py-12'
-                )}
-            >
-                <h1 className={tcls('text-5xl', 'font-bold')}>{page.title}</h1>
-            </div>
-        </PrintPage>
-    );
-}
-
-async function PDFPageDocument(props: {
-    page: RevisionPageDocument;
-    context: GitBookSpaceContext;
-}) {
-    const { page, context } = props;
-    const { space } = context;
-    const document = await getPageDocument(context.dataFetcher, space.id, page);
-
-    return (
-        <PrintPage id={getPagePDFContainerId(page)}>
-            <h1 className={tcls('text-4xl', 'font-bold')}>{page.title}</h1>
-            {page.description ? (
-                <p className={tcls('decoration-primary/6', 'mt-2', 'mb-3')}>{page.description}</p>
-            ) : null}
-
-            {document ? (
-                <DocumentView
-                    document={document}
-                    style="mt-6 space-y-6"
-                    blockStyle="max-w-full"
-                    context={{
-                        mode: 'print',
-                        contentContext: {
-                            ...context,
-                            page,
-                        },
-                        getId: (id) => getPagePDFContainerId(page, id),
-                    }}
-                />
-            ) : null}
-        </PrintPage>
-    );
-}
-
-function PrintPage(
-    props: PolymorphicComponentProp<
-        'div',
-        {
-            isFirst?: boolean;
-        }
-    >
-) {
-    const { children, isFirst, className, ...rest } = props;
-
-    return (
-        <div
-            {...rest}
-            className={tcls(
-                className,
-                'my-11',
-                'print:my-0',
-                'mx-auto',
-                'max-w-4xl',
-                'w-full',
-                'p-12',
-                'print:p-0',
-                'shadow-xl',
-                'print:shadow-none',
-                'rounded-sm',
-                'bg-white',
-                'min-h-[29.7cm]',
-                'print:min-h-0',
-                isFirst ? null : 'break-before-page',
-                'break-anywhere'
-            )}
-        >
-            {children}
-        </div>
-    );
-}
-
-type FlatPageEntry = { page: RevisionPageDocument | RevisionPageGroup; depth: number };
-
-/**
- * Compute the ordered flat set of pages to render.
- */
-function selectPages(
-    rootPages: Revision['pages'],
-    params: PDFSearchParams
-): { pages: FlatPageEntry[]; total: number } {
-    const flattenPage = (
-        page: RevisionPageDocument | RevisionPageGroup,
-        depth: number
-    ): FlatPageEntry[] => {
-        return [
-            { page, depth },
-            ...page.pages.flatMap((child) => {
-                if (child.type !== 'document') {
-                    return [];
-                }
-
-                if (child.hidden) {
-                    return [];
-                }
-
-                return flattenPage(child, depth + 1);
-            }),
-        ];
-    };
-
-    const limitTo = (entries: FlatPageEntry[]) => {
-        return {
-            // Apply a soft-limit, the limit can be controlled by the URL to allow testing
-            pages: entries.slice(0, params.limit ?? DEFAULT_LIMIT),
-            total: entries.length,
-        };
-    };
-
-    if (params.page) {
-        const found = resolvePageId(rootPages, params.page);
-        if (!found) {
-            notFound();
-        }
-
-        if (!params.only) {
-            return limitTo([{ page: found.page, depth: 0 }]);
-        }
-
-        return limitTo(flattenPage(found.page, 0));
-    }
-
-    const allPages = rootPages.flatMap((page) => {
-        if (page.type !== 'document' && page.type !== 'group') {
-            return [];
-        }
-
-        if (page.hidden) {
-            return [];
-        }
-
-        return flattenPage(page, 0);
-    });
-    return limitTo(allPages);
 }

packages/gitbook/src/app/middleware/(space)/~gitbook/pdf/pointer.ts

@@ -4,23 +4,6 @@ import type { SiteContentPointer, SpaceContentPointer } from '@/lib/api';
 import { getSiteContentPointer, getSpacePointer } from '@/lib/pointer';
 import { fetchV1ContextForSitePointer, fetchV1ContextForSpacePointer } from '@/lib/v1';
 
-/**
- * PDF generation can be done at the site level (e.g. docs.foo.com/~gitbook/pdf) or
- * at the space level (e.g. open.gitbook.com/~space/:spaceId/~gitbook/pdf) which is
- * for PDF export of in-app private spaces.
- *
- * This function returns the pointer depending on the context.
- */
-export async function getSiteOrSpacePointerForPDF(): Promise<
-    SiteContentPointer | SpaceContentPointer
-> {
-    try {
-        return await getSiteContentPointer();
-    } catch (_error) {
-        return getSpacePointer();
-    }
-}
-
 /**
  * Get the context for the PDF pointer.
  */
@@ -31,3 +14,18 @@ export async function getV1ContextForPDF(): Promise<GitBookSiteContext | GitBook
         ? await fetchV1ContextForSitePointer(pointer)
         : await fetchV1ContextForSpacePointer(pointer);
 }
+
+/**
+ * PDF generation can be done at the site level (e.g. docs.foo.com/~gitbook/pdf) or
+ * at the space level (e.g. open.gitbook.com/~space/:spaceId/~gitbook/pdf) which is
+ * for PDF export of in-app private spaces.
+ *
+ * This function returns the pointer depending on the context.
+ */
+async function getSiteOrSpacePointerForPDF(): Promise<SiteContentPointer | SpaceContentPointer> {
+    try {
+        return await getSiteContentPointer();
+    } catch (_error) {
+        return getSpacePointer();
+    }
+}

packages/gitbook/src/cloudflare-entrypoint.ts

@@ -1,6 +1,7 @@
 // @ts-ignore
 import nextOnPagesHandler from '@cloudflare/next-on-pages/fetch-handler';
 
+import { withResponseCacheTags } from './lib/cache/response';
 import { withMiddlewareHeadersStorage } from './lib/middleware';
 
 /**
@@ -9,8 +10,8 @@ import { withMiddlewareHeadersStorage } from './lib/middleware';
  */
 export default {
     async fetch(request, env, ctx) {
-        const response = await withMiddlewareHeadersStorage(() =>
+        const response = await withResponseCacheTags(() =>
-            nextOnPagesHandler.fetch(request, env, ctx)
+            withMiddlewareHeadersStorage(() => nextOnPagesHandler.fetch(request, env, ctx))
         );
 
         return response;

packages/gitbook/src/components/AdminToolbar/AdminToolbar.tsx

@@ -4,6 +4,7 @@ import { headers } from 'next/headers';
 import React from 'react';
 
 import { tcls } from '@/lib/tailwind';
+import { throwIfDataError } from '@v2/lib/data';
 
 import { DateRelative } from '../primitives';
 import { RefreshChangeRequestButton } from './RefreshChangeRequestButton';
@@ -47,7 +48,7 @@ function ToolbarLayout(props: { children: React.ReactNode }) {
  */
 export async function AdminToolbar(props: AdminToolbarProps) {
     const { context } = props;
-    const mode = await headers().get('x-gitbook-mode');
+    const mode = (await headers()).get('x-gitbook-mode');
 
     if (mode === 'multi-id') {
         // We don't show the admin toolbar in multi-id mode, as it's used for previewing in the dashboard.
@@ -107,11 +108,13 @@ async function RevisionToolbar(props: { context: GitBookSiteContext }) {
     const { context } = props;
     const { space, revisionId } = context;
 
-    const revision = await context.dataFetcher.getRevision({
+    const revision = await throwIfDataError(
-        spaceId: space.id,
+        context.dataFetcher.getRevision({
-        revisionId,
+            spaceId: space.id,
-        metadata: true,
+            revisionId,
-    });
+            metadata: true,
+        })
+    );
 
     return (
         <ToolbarLayout>

packages/gitbook/src/components/Ads/renderAd.tsx

@@ -5,6 +5,8 @@ import { headers } from 'next/headers';
 
 import { getV1BaseContext } from '@/lib/v1';
 
+import { isV2 } from '@/lib/v2';
+import { getServerActionBaseContext } from '@v2/lib/server-actions';
 import { AdClassicRendering } from './AdClassicRendering';
 import { AdCoverRendering } from './AdCoverRendering';
 import { AdPixels } from './AdPixels';
@@ -41,7 +43,7 @@ interface FetchPlaceholderAdOptions {
  * and properly access user-agent and IP.
  */
 export async function renderAd(options: FetchAdOptions) {
-    const baseContext = await getV1BaseContext();
+    const context = isV2() ? await getServerActionBaseContext() : await getV1BaseContext();
 
     const mode = options.source === 'live' ? options.mode : 'classic';
     const result = options.source === 'live' ? await fetchAd(options) : await getPlaceholderAd();
@@ -64,9 +66,9 @@ export async function renderAd(options: FetchAdOptions) {
         children: (
             <>
                 {mode === 'classic' || !('callToAction' in ad) ? (
-                    <AdClassicRendering ad={ad} insightsAd={insightsAd} context={baseContext} />
+                    <AdClassicRendering ad={ad} insightsAd={insightsAd} context={context} />
                 ) : (
-                    <AdCoverRendering ad={ad} insightsAd={insightsAd} context={baseContext} />
+                    <AdCoverRendering ad={ad} insightsAd={insightsAd} context={context} />
                 )}
                 {ad.pixel ? <AdPixels rawPixel={ad.pixel} /> : null}
             </>

packages/gitbook/src/components/DocumentView/Block.tsx

@@ -25,7 +25,7 @@ import { IntegrationBlock } from './Integration';
 import { List } from './List';
 import { ListItem } from './ListItem';
 import { BlockMath } from './Math';
-import { OpenAPI } from './OpenAPI';
+import { OpenAPIOperation, OpenAPISchemas } from './OpenAPI';
 import { Paragraph } from './Paragraph';
 import { Quote } from './Quote';
 import { ReusableContent } from './ReusableContent';
@@ -82,7 +82,9 @@ export function Block<T extends DocumentBlock>(props: BlockProps<T>) {
                 return <Table {...props} block={block} />;
             case 'swagger':
             case 'openapi-operation':
-                return <OpenAPI {...props} block={block} />;
+                return <OpenAPIOperation {...props} block={block} />;
+            case 'openapi-schemas':
+                return <OpenAPISchemas {...props} block={block} />;
             case 'embed':
                 return <Embed {...props} block={block} />;
             case 'blockquote':
@@ -156,6 +158,7 @@ export function BlockSkeleton(props: { block: DocumentBlock; style: ClassValue }
         case 'table':
         case 'swagger':
         case 'openapi-operation':
+        case 'openapi-schemas':
         case 'math':
         case 'divider':
         case 'content-ref':

packages/gitbook/src/components/DocumentView/Blocks.tsx

@@ -42,43 +42,41 @@ type UnwrappedBlocksProps<TBlock extends DocumentBlock> = DocumentContextProps &
 
     /** Style passed to all blocks */
     blockStyle?: ClassValue;
+
+    /** True if all blocks should be considered offscreen */
+    isOffscreen?: boolean;
 };
 
 /**
  * Renders a list of blocks without a wrapper element.
  */
 export function UnwrappedBlocks<TBlock extends DocumentBlock>(props: UnwrappedBlocksProps<TBlock>) {
-    const { nodes, blockStyle, ...contextProps } = props;
+    const { nodes, blockStyle, isOffscreen: defaultIsOffscreen = false, ...contextProps } = props;
 
-    let isOffscreen = false;
+    let isOffscreen = defaultIsOffscreen;
+    return nodes.map((node) => {
+        isOffscreen =
+            isOffscreen ||
+            isBlockOffscreen({
+                document: props.document,
+                block: node,
+                ancestorBlocks: props.ancestorBlocks,
+            });
 
-    return (
+        return (
-        <>
+            <Block
-            {nodes.map((node) => {
+                key={node.key}
-                isOffscreen =
+                block={node}
-                    isOffscreen ||
+                style={[
-                    isBlockOffscreen({
+                    'mx-auto w-full decoration-primary/6',
-                        document: props.document,
+                    node.data && 'fullWidth' in node.data && node.data.fullWidth
-                        block: node,
+                        ? 'max-w-screen-xl'
-                        ancestorBlocks: props.ancestorBlocks,
+                        : 'max-w-3xl',
-                    });
+                    blockStyle,
-
+                ]}
-                return (
+                isEstimatedOffscreen={isOffscreen}
-                    <Block
+                {...contextProps}
-                        key={node.key}
+            />
-                        block={node}
+        );
-                        style={[
+    });
-                            'mx-auto w-full decoration-primary/6',
-                            node.data && 'fullWidth' in node.data && node.data.fullWidth
-                                ? 'max-w-screen-xl'
-                                : 'max-w-3xl',
-                            blockStyle,
-                        ]}
-                        isEstimatedOffscreen={isOffscreen}
-                        {...contextProps}
-                    />
-                );
-            })}
-        </>
-    );
 }

packages/gitbook/src/components/DocumentView/CodeBlock/ClientCodeBlock.tsx

@@ -1,10 +1,11 @@
 'use client';
 
 import type { DocumentBlockCode } from '@gitbook/api';
-import { useEffect, useRef, useState } from 'react';
+import { useEffect, useMemo, useRef, useState } from 'react';
-
-import { useHasBeenInViewport } from '@/components/hooks/useHasBeenInViewport';
 
+import { useInViewportListener } from '@/components/hooks/useInViewportListener';
+import { useScrollListener } from '@/components/hooks/useScrollListener';
+import { useDebounceCallback } from 'usehooks-ts';
 import type { BlockProps } from '../Block';
 import { CodeBlockRenderer } from './CodeBlockRenderer';
 import type { HighlightLine, RenderedInline } from './highlight';
@@ -21,46 +22,82 @@ type ClientBlockProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> &
 export function ClientCodeBlock(props: ClientBlockProps) {
     const { block, style, inlines } = props;
     const blockRef = useRef<HTMLDivElement>(null);
-    const [lines, setLines] = useState<HighlightLine[]>(() => plainHighlight(block, []));
+    const isInViewportRef = useRef(false);
+    const [isInViewport, setIsInViewport] = useState(false);
+    const plainLines = useMemo(() => plainHighlight(block, []), [block]);
+    const [lines, setLines] = useState<null | HighlightLine[]>(null);
 
     // Preload the highlighter when the block is mounted.
     useEffect(() => {
         import('./highlight').then(({ preloadHighlight }) => preloadHighlight(block));
     }, [block]);
 
-    // Check if the block is in the viewport to start highlighting it.
+    // When user scrolls, we need to wait for the scroll to finish before running the highlight
-    const hasBeenInViewport = useHasBeenInViewport(blockRef, {
+    const isScrollingRef = useRef(false);
-        rootMargin: '200px',
+    const onFinishScrolling = useDebounceCallback(() => {
-    });
+        isScrollingRef.current = false;
 
-    // Highlight the block when it's in the viewport.
+        // If the block is in the viewport after the scroll, we need to run the highlight
+        if (isInViewportRef.current) {
+            setIsInViewport(true);
+        }
+    }, 100);
+    useScrollListener(
+        () => {
+            isScrollingRef.current = true;
+            onFinishScrolling();
+        },
+        useRef(typeof window !== 'undefined' ? window : null)
+    );
+
+    // Detect when the block is in viewport
+    useInViewportListener(
+        blockRef,
+        (isInViewport, disconnect) => {
+            isInViewportRef.current = isInViewport;
+            if (isScrollingRef.current) {
+                // If the user is scrolling, we don't want to run the highlight
+                // because it will be run when the scroll is finished
+                return;
+            }
+
+            if (isInViewport) {
+                // Disconnect once in viewport
+                disconnect();
+                setIsInViewport(true);
+            }
+        },
+        { rootMargin: '200px' }
+    );
+
+    // When the block is visible or updated, we need to re-run the highlight
     useEffect(() => {
-        if (hasBeenInViewport) {
+        if (isInViewport) {
-            let canceled = false;
+            // If the block is in viewport, we need to run the highlight
-            import('./highlight').then(({ highlight }) => {
+            let cancelled = false;
-                // We use requestIdleCallback to avoid blocking the main thread
+
-                // when scrolling.
+            if (typeof window !== 'undefined') {
-                if (typeof requestIdleCallback === 'function') {
+                import('./highlight').then(({ highlight }) => {
-                    requestIdleCallback(() =>
+                    highlight(block, inlines).then((lines) => {
-                        highlight(block, inlines).then((result) => {
+                        if (cancelled) {
-                            if (!canceled) {
+                            return;
-                                setLines(result);
-                            }
-                        })
-                    );
-                } else {
-                    highlight(block, inlines).then((result) => {
-                        if (!canceled) {
-                            setLines(result);
                         }
+
+                        setLines(lines);
                     });
-                }
+                });
-            });
+            }
+
             return () => {
-                canceled = true;
+                cancelled = true;
             };
         }
-    }, [hasBeenInViewport, block, inlines]);
 
-    return <CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines} />;
+        // Otherwise if the block is not in viewport, we reset to the plain lines
+        setLines(null);
+    }, [isInViewport, block, inlines]);
+
+    return (
+        <CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines ?? plainLines} />
+    );
 }

packages/gitbook/src/components/DocumentView/CodeBlock/CodeBlock.tsx

@@ -1,17 +1,19 @@
 import type { DocumentBlockCode } from '@gitbook/api';
 
 import { getNodeFragmentByType } from '@/lib/document';
+import { isV2 } from '@/lib/v2';
 
 import type { BlockProps } from '../Block';
 import { Blocks } from '../Blocks';
 import { ClientCodeBlock } from './ClientCodeBlock';
-import { type RenderedInline, getInlines } from './highlight';
+import { CodeBlockRenderer } from './CodeBlockRenderer';
+import { type RenderedInline, getInlines, highlight } from './highlight';
 
 /**
  * Render a code block, can be client-side or server-side.
  */
-export function CodeBlock(props: BlockProps<DocumentBlockCode>) {
+export async function CodeBlock(props: BlockProps<DocumentBlockCode>) {
-    const { block, document, style, context } = props;
+    const { block, document, style, isEstimatedOffscreen, context } = props;
     const inlines = getInlines(block);
     const richInlines: RenderedInline[] = inlines.map((inline, index) => {
         const body = (() => {
@@ -34,5 +36,11 @@ export function CodeBlock(props: BlockProps<DocumentBlockCode>) {
         return { inline, body };
     });
 
+    if (isV2() && !isEstimatedOffscreen) {
+        // In v2, we render the code block server-side
+        const lines = await highlight(block, richInlines);
+        return <CodeBlockRenderer block={block} style={style} lines={lines} />;
+    }
+
     return <ClientCodeBlock block={block} style={style} inlines={richInlines} />;
 }

packages/gitbook/src/components/DocumentView/CodeBlock/highlight.test.ts

@@ -46,7 +46,7 @@ it('should parse plain code', async () => {
 
 it('should parse different code in parallel', async () => {
     await Promise.all(
-        ['shell', 'scss', 'markdown', 'less', 'scss', 'css', 'scss', 'yaml'].map(async (syntax) =>
+        ['shell', 'scss', 'scss', 'css', 'scss', 'yaml'].map(async (syntax) =>
             highlight(
                 {
                     object: 'block',

packages/gitbook/src/components/DocumentView/CodeBlock/highlight.ts

@@ -35,14 +35,11 @@ export type RenderedInline = {
 
 const theme = createCssVariablesTheme();
 
-const highlighter = createSingletonShorthands(
+const { getSingletonHighlighter } = createSingletonShorthands(
     createdBundledHighlighter<any, any>({
         langs: bundledLanguages,
         themes: {},
-        engine: () =>
+        engine: () => createJavaScriptRegexEngine({ forgiving: true, target: 'ES2018' }),
-            createJavaScriptRegexEngine({
-                forgiving: true,
-            }),
     })
 );
 
@@ -52,7 +49,7 @@ const highlighter = createSingletonShorthands(
 export async function preloadHighlight(block: DocumentBlockCode) {
     const langName = getBlockLang(block);
     if (langName) {
-        await highlighter.getSingletonHighlighter({
+        await getSingletonHighlighter({
             langs: [langName],
             themes: [theme],
         });
@@ -74,7 +71,12 @@ export async function highlight(
 
     const code = getPlainCodeBlock(block);
 
-    const lines = await highlighter.codeToTokensBase(code, {
+    const highlighter = await getSingletonHighlighter({
+        langs: [langName],
+        themes: [theme],
+    });
+
+    const lines = highlighter.codeToTokensBase(code, {
         lang: langName,
         theme,
         tokenizeMaxLineLength: 400,
@@ -132,12 +134,6 @@ function getLanguageForSyntax(syntax: string): BundledLanguage | null {
     // Normalize the syntax to lowercase.
     syntax = syntax.toLowerCase();
 
-    // Temporary disable highlighting for C/C++ code blocks
-    // @see https://github.com/shikijs/shiki/issues/893
-    if (syntax === 'cpp' || syntax === 'c') {
-        return null;
-    }
-
     // Check if the syntax is a bundled language.
     if (checkIsBundledLanguage(syntax)) {
         return syntax;

packages/gitbook/src/components/DocumentView/DocumentView.tsx

@@ -46,9 +46,12 @@ export function DocumentView(
 
         /** Style passed to all blocks */
         blockStyle?: ClassValue;
+
+        /** True if the document should be considered offscreen */
+        isOffscreen?: boolean;
     }
 ) {
-    const { document, style, blockStyle = [], context } = props;
+    const { document, style, blockStyle = [], context, isOffscreen = false } = props;
 
     return (
         <Blocks
@@ -62,6 +65,7 @@ export function DocumentView(
                 'whitespace-pre-wrap',
             ]}
             context={context}
+            isOffscreen={isOffscreen}
         />
     );
 }

packages/gitbook/src/components/DocumentView/Embed.tsx

@@ -5,6 +5,7 @@ import ReactDOM from 'react-dom';
 import { Card } from '@/components/primitives';
 import { tcls } from '@/lib/tailwind';
 
+import { getDataOrNull } from '@v2/lib/data';
 import type { BlockProps } from './Block';
 import { Caption } from './Caption';
 import { IntegrationBlock } from './Integration';
@@ -18,10 +19,16 @@ export async function Embed(props: BlockProps<gitbookAPI.DocumentBlockEmbed>) {
 
     ReactDOM.preload('https://cdn.iframe.ly/embed.js', { as: 'script' });
 
-    const embed = await context.contentContext.dataFetcher.getEmbedByUrl({
+    const embed = await getDataOrNull(
-        url: block.data.url,
+        context.contentContext.dataFetcher.getEmbedByUrl({
-        spaceId: context.contentContext.space?.id,
+            url: block.data.url,
-    });
+            spaceId: context.contentContext.space?.id,
+        })
+    );
+
+    if (!embed) {
+        return null;
+    }
 
     return (
         <Caption {...props} withBorder>

packages/gitbook/src/components/DocumentView/Hint.tsx

@@ -37,22 +37,21 @@ export function Hint(props: BlockProps<DocumentBlockHint>) {
         >
             <div
                 className={tcls(
-                    'py-3',
+                    'py-4',
-                    'pl-3',
+                    'pl-4',
-                    '-mt-px', // Bump icon up 1px for optical alignment with heading
                     hasHeading ? hintStyle.header : null,
                     hintStyle.iconColor
                 )}
             >
                 <Icon
                     icon={hintStyle.icon}
-                    className={tcls('size-[1.2em]', 'mt-0.5', firstLine.lineHeight)}
+                    className={tcls('size-[1.2em]', 'mt-px', firstLine.lineHeight)}
                 />
             </div>
             {hasHeading ? (
                 <Block
                     style={tcls(
-                        'flip-heading-hash p-3 text-[1em] *:mt-0',
+                        'flip-heading-hash p-4 pl-3 text-[1em] *:mt-0',
                         hasHeading ? hintStyle.header : null
                     )}
                     ancestorBlocks={[...ancestorBlocks, block]}
@@ -70,11 +69,12 @@ export function Hint(props: BlockProps<DocumentBlockHint>) {
                     'flip-heading-hash'
                 )}
                 style={[
-                    'p-3',
+                    'p-4',
+                    'pl-3',
                     'empty:p-0',
                     '-row-end-1',
                     '-col-end-1',
-                    'space-y-4',
+                    'space-y-3',
                     '[&_.hint]:border',
                     '[&_pre]:border',
                     '[&_pre]:border-neutral',
@@ -104,8 +104,8 @@ const HINT_STYLES: {
             '[&_.can-override-text]:text-neutral-strong',
         ],
         container:
-            'bg-neutral theme-muted:bg-neutral-base theme-bold-tint:bg-neutral-base theme-gradient:bg-neutral-12/1 border-neutral',
+            'bg-info border-info theme-muted-tint:bg-info-solid/2 theme-bold-tint:bg-info-solid/2',
-        containerWithHeader: 'border-info-solid bg-neutral-subtle theme-gradient:bg-neutral-12/1',
+        containerWithHeader: 'border-info-solid bg-info-subtle',
     },
     warning: {
         icon: 'circle-exclamation',
@@ -113,11 +113,13 @@ const HINT_STYLES: {
         header: 'bg-warning-active',
         body: [
             'text-neutral-strong',
-            '[&_a]:text-warning',
+            'links-default:[&_a]:text-warning',
-            '[&_a:hover]:text-warning-strong',
+            'links-default:[&_a:hover]:text-warning-strong',
+            'links-default:[&_a]:decoration-warning/6',
+            'links-accent:[&_a]:decoration-warning',
+            'decoration-warning/6',
             '[&_.can-override-bg]:bg-warning-active',
             '[&_.can-override-text]:text-warning-strong',
-            'decoration-warning/6',
         ],
         container: 'bg-warning border-warning',
         containerWithHeader: 'border-warning-solid bg-warning-subtle',
@@ -128,11 +130,13 @@ const HINT_STYLES: {
         header: 'bg-danger-active',
         body: [
             'text-neutral-strong',
-            '[&_a]:text-danger',
+            'links-default:[&_a]:text-danger',
-            '[&_a:hover]:text-danger-strong',
+            'links-default:[&_a:hover]:text-danger-strong',
+            'links-default:[&_a]:decoration-danger/6',
+            'links-accent:[&_a]:decoration-danger',
+            'decoration-danger/6',
             '[&_.can-override-bg]:bg-danger-active',
             '[&_.can-override-text]:text-danger-strong',
-            'decoration-danger/6',
         ],
         container: 'bg-danger border-danger',
         containerWithHeader: 'border-danger-solid bg-danger-subtle',
@@ -143,11 +147,13 @@ const HINT_STYLES: {
         header: 'bg-success-active',
         body: [
             'text-neutral-strong',
-            '[&_a]:text-success',
+            'links-default:[&_a]:text-success',
-            '[&_a:hover]:text-success-strong',
+            'links-default:[&_a:hover]:text-success-strong',
+            'links-default:[&_a]:decoration-success/6',
+            'links-accent:[&_a]:decoration-success',
+            'decoration-success/6',
             '[&_.can-override-bg]:bg-success-active',
             '[&_.can-override-text]:text-success-strong',
-            'decoration-success/6',
         ],
         container: 'bg-success border-success',
         containerWithHeader: 'border-success-solid bg-success-subtle',

packages/gitbook/src/components/DocumentView/Inlines.tsx

@@ -24,23 +24,19 @@ export function Inlines<T extends DocumentInline | DocumentText>(
 ) {
     const { nodes, document, ancestorInlines, ...contextProps } = props;
 
-    return (
+    return nodes.map((node) => {
-        <>
+        if (node.object === 'text') {
-            {nodes.map((node) => {
+            return <Text key={node.key} text={node} />;
-                if (node.object === 'text') {
+        }
-                    return <Text key={node.key} text={node} />;
-                }
 
-                return (
+        return (
-                    <Inline
+            <Inline
-                        key={node.key}
+                key={node.key}
-                        inline={node}
+                inline={node}
-                        document={document}
+                document={document}
-                        ancestorInlines={ancestorInlines}
+                ancestorInlines={ancestorInlines}
-                        {...contextProps}
+                {...contextProps}
-                    />
+            />
-                );
+        );
-            })}
+    });
-        </>
-    );
 }

packages/gitbook/src/components/DocumentView/Integration/IntegrationBlock.tsx

@@ -6,7 +6,7 @@ import {
     type ContentKitServerContext,
 } from '@gitbook/react-contentkit';
 
-import { ignoreAPIError, renderIntegrationUi } from '@/lib/api';
+import { renderIntegrationUi } from '@/lib/api';
 import { parseMarkdown } from '@/lib/markdown';
 import { tcls } from '@/lib/tailwind';
 import { GITBOOK_INTEGRATIONS_HOST } from '@v2/lib/env';
@@ -14,6 +14,7 @@ import { GITBOOK_INTEGRATIONS_HOST } from '@v2/lib/env';
 import type { BlockProps } from '../Block';
 import { PlainCodeBlock } from '../CodeBlock';
 import './contentkit.css';
+import { ignoreAllThrownError } from '@v2/lib/data';
 
 const outputContext: ContentKitServerContext = {
     icons: {
@@ -63,9 +64,8 @@ export async function IntegrationBlock(props: BlockProps<DocumentBlockIntegratio
         context: contentKitContext,
     };
 
-    const initialOutput = await ignoreAPIError(
+    const initialOutput = await ignoreAllThrownError(
-        renderIntegrationUi(block.data.integration, initialInput),
+        renderIntegrationUi(block.data.integration, initialInput)
-        true
     );
     if (!initialOutput || initialOutput.type === 'complete') {
         return null;

packages/gitbook/src/components/DocumentView/Integration/contentkit.css

@@ -3,8 +3,13 @@
     @apply flex gap-4;
 }
 
+/** Add margin bottom to all stacks that are not the last child and have a form */
+.contentkit-stack:not(:last-child):has(.contentkit-form) {
+    @apply mb-4;
+}
+
 .contentkit-hstack {
-    @apply flex-row gap-4 items-center;
+    @apply flex-row gap-3 items-center;
 }
 .contentkit-hstack.contentkit-stack-align-center {
     @apply justify-center;
@@ -88,17 +93,23 @@
 
 /** Buttons */
 .contentkit-button {
-    @apply flex gap-2 items-center justify-center px-2 py-1 rounded
+    @apply text-sm px-3 h-8 text-center inline-block py-1.5 rounded-md straight-corners:rounded-none place-self-start ring-1 ring-tint hover:ring-tint-hover shadow-sm shadow-tint dark:shadow-tint-1 hover:shadow-md active:shadow-none contrast-more:ring-tint-12 contrast-more:hover:ring-2 contrast-more:hover:ring-tint-12 hover:scale-105 active:scale-100 transition-all grow-0 shrink-0 truncate w-full;
-        border border-tint hover:border-tint-hover
+}
-        text-tint hover:text-tint-strong;
+
+.contentkit-button-style-primary {
+    @apply bg-primary-solid text-contrast-primary-solid hover:bg-primary-solid-hover hover:text-contrast-primary-solid-hover ring-0 contrast-more:ring-1;
+}
+
+.contentkit-button-style-secondary {
+    @apply bg-tint text-tint hover:bg-tint-hover hover:text-primary contrast-more:bg-tint-subtle;
 }
 
 .contentkit-button .contentkit-icon {
     @apply w-4 h-4;
 }
 
-.contentkit-button .contentkit-button-label {
+.contentkit-button-loading {
-    @apply text-sm font-medium text-tint-strong;
+    @apply size-5 flex mx-auto animate-spin;
 }
 
 /** Modals */
@@ -143,7 +154,21 @@
 
 /** Text input */
 .contentkit-textinput {
-    @apply w-full px-2 py-1 rounded border border-tint text-sm text-tint;
+    @apply w-full rounded border border-tint text-tint-strong placeholder:text-tint flex resize-none flex-1 px-2 py-1.5 text-sm bg-transparent whitespace-pre-line;
+    @apply focus:outline-primary focus:border-primary;
+}
+
+/** Form */
+.contentkit-form {
+    @apply flex flex-col gap-1;
+}
+
+.contentkit-form:not(:first-of-type) {
+    @apply mt-4;
+}
+
+.contentkit-label {
+    @apply text-sm font-medium text-tint-strong;
 }
 
 /** Dividers */

packages/gitbook/src/components/DocumentView/List.tsx

@@ -21,7 +21,7 @@ export function List(
             tag={getListTag(block.type)}
             nodes={block.nodes}
             ancestorBlocks={[...ancestorBlocks, block]}
-            style={['space-y-2', style]}
+            style={['min-w-0 space-y-2', style]}
         />
     );
 }