Version Packages (#2945)

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

.bun-version

@@ -1 +0,0 @@
-1.2.1

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

@@ -0,0 +1,70 @@
+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_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

@@ -0,0 +1,75 @@
+name: 'Deploy vercel'
+description: 'Deploy GitBook to Vercel'
+inputs:
+  vercelOrg:
+    description: 'Vercel organization'
+    required: true
+  vercelProject:
+    description: 'Vercel project'
+    required: true
+  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
+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: Pull Vercel Environment Information
+          run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
+          shell: bash
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+            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_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=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
+          shell: bash
+          env:
+            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Deploy Project Artifacts to Vercel
+          id: deploy
+          shell: bash
+          run: |
+              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.vercelOrg }}
+            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
+        - name: Outputs
+          shell: bash
+          run: |
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/composite/setup-bun/action.yaml

@@ -15,4 +15,4 @@ runs:
         - name: Setup bun
           uses: oven-sh/setup-bun@v2
           with:
-              bun-version-file: '.bun-version'
+              bun-version-file: 'package.json'

.github/workflows/ci.yaml

@@ -7,300 +7,10 @@ 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 }}
-        env:
-            VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
-            VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
-        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 "VERCEL_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
-                  echo "GITBOOK_URL=https://open-2v.gitbook.com" >> $GITHUB_ENV
-                  echo "GITBOOK_ASSETS_PREFIX=https://static-2v.gitbook.com" >> $GITHUB_ENV
-              if: startsWith(github.ref, 'refs/heads/main')
-            - name: Sets env vars for preview
-              run: |
-                  echo "VERCEL_ENVIRONMENT=preview" >> $GITHUB_ENV
-                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
-              if: 1 && !startsWith(github.ref, 'refs/heads/main')
-            - name: Pull Vercel Environment Information
-              run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ secrets.VERCEL_TOKEN }}
-            - name: Build Project Artifacts
-              run: bun run vercel build --token=${{ secrets.VERCEL_TOKEN }}
-              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 }}
-            - name: Deploy Project Artifacts to Vercel
-              id: deploy
-              run: |
-                  DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=$VERCEL_ENVIRONMENT $([ "$VERCEL_ENVIRONMENT" = "production" ] && echo "--prod") --token=${{ secrets.VERCEL_TOKEN }})
-                  echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-    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 }}
-        env:
-            VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
-            VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
-        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
-        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 }}
-            - uses: actions/upload-artifact@v4
-              if: ${{ !cancelled() }}
-              with:
-                  name: playwright-test-results
-                  path: packages/gitbook/test-results/
-                  retention-days: 3
-    visual-testing-customers:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers
-        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
-            - 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'
-            - uses: actions/upload-artifact@v4
-              if: ${{ !cancelled() }}
-              with:
-                  name: playwright-test-results-customers
-                  path: packages/gitbook/test-results/
-                  retention-days: 3
-    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
+        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -311,22 +21,10 @@ jobs:
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun format:check
-    lint:
-        runs-on: ubuntu-latest
-        name: Lint
-        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
-            - run: bun lint --no-cache
     test:
         runs-on: ubuntu-latest
         name: Test
+        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -341,6 +39,7 @@ jobs:
         # CI to check that the repository builds correctly on a machine without the credentials
         runs-on: ubuntu-latest
         name: Build (Open Source)
+        timeout-minutes: 6
         env:
             NPM_TOKEN_READONLY: ''
         steps:
@@ -356,6 +55,7 @@ jobs:
     typecheck:
         runs-on: ubuntu-latest
         name: Typecheck
+        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4

.github/workflows/deploy-preview.yaml

@@ -0,0 +1,253 @@
+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 "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
+                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+            - name: Sets env vars for preview
+              if: github.ref != 'refs/heads/main'
+              run: |
+                  echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
+            - 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.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 }}/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 }}/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 $DEPLOYMENT_URL
+              env:
+                  DEPLOYMENT_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 }}"

.github/workflows/publish.yaml

@@ -28,6 +28,7 @@ jobs:
               uses: changesets/action@v1
               with:
                   publish: npm run release
+                  version: npm run changeset-version
               env:
                   # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                   # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["biomejs.biome"]
+}

.vscode/settings.json

@@ -7,5 +7,11 @@
         ["style \\=([^;]*);", "\"([^\"]*)\""],
         ["style \\=([^;]*);", "\\`([^\\`]*)\\`"]
     ],
-    "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"]
+    "tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
+    "prettier.enable": false,
+    "editor.defaultFormatter": "biomejs.biome",
+    "editor.codeActionsOnSave": {
+        "source.organizeImports.biome": "explicit",
+        "source.fixAll.biome": "explicit"
+    }
 }

biome.json

@@ -0,0 +1,173 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "vcs": {
+        "enabled": false,
+        "clientKind": "git",
+        "useIgnoreFile": false
+    },
+    "files": {
+        "ignoreUnknown": false,
+        "ignore": [
+            "**/node_modules/**/*",
+            "**/dist/**/*",
+            "**/build/**/*",
+            "**/public/**/*",
+            "**/.next/**/*",
+            "**/.open-next/**/*",
+            "**/.turbo/**/*",
+            "**/.vercel/**/*",
+            "**/.cache/**/*",
+            "**/.wrangler/**/*",
+            "packages/openapi-parser/src/fixtures/**/*"
+        ]
+    },
+    "formatter": {
+        "enabled": true,
+        "useEditorconfig": true,
+        "formatWithErrors": false,
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineEnding": "lf",
+        "lineWidth": 100,
+        "attributePosition": "auto",
+        "bracketSpacing": true
+    },
+    "organizeImports": {
+        "enabled": true
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": true,
+            "performance": {
+                "noDelete": "warn"
+            },
+            "security": {
+                "noDangerouslySetInnerHtml": "off"
+            },
+            "complexity": {
+                "noForEach": "off",
+                "noUselessFragments": "warn",
+                "noBannedTypes": "warn"
+            },
+            "correctness": {
+                "noUndeclaredVariables": "error",
+                "noUnusedVariables": "error",
+                "useArrayLiterals": "error",
+                "useHookAtTopLevel": "error",
+                "noUnusedImports": "error",
+                "noVoidElementsWithChildren": "warn",
+                "useJsxKeyInIterable": "warn",
+                "useExhaustiveDependencies": "warn",
+                "noUnknownFunction": "warn"
+            },
+            "style": {
+                "noNonNullAssertion": "warn",
+                "noParameterAssign": "off",
+                "useThrowOnlyError": "error"
+            },
+            "suspicious": {
+                "noConsole": {
+                    "level": "warn",
+                    "options": {
+                        "allow": ["assert", "error", "warn"]
+                    }
+                },
+                "noExplicitAny": "warn",
+                "noImplicitAnyLet": "warn",
+                "noConfusingVoidType": "warn",
+                "noControlCharactersInRegex": "warn",
+                "noPrototypeBuiltins": "warn",
+                "noAssignInExpressions": "warn",
+                "noArrayIndexKey": "warn"
+            },
+            "a11y": {
+                "useSemanticElements": "warn",
+                "useKeyWithClickEvents": "warn",
+                "noSvgWithoutTitle": "warn",
+                "useButtonType": "warn",
+                "useIframeTitle": "warn",
+                "useAltText": "warn",
+                "noPositiveTabindex": "warn",
+                "useFocusableInteractive": "warn",
+                "useAriaPropsForRole": "warn",
+                "useValidAnchor": "warn",
+                "noLabelWithoutControl": "warn",
+                "noNoninteractiveTabindex": "warn"
+            },
+            "nursery": {
+                "useSortedClasses": {
+                    "level": "error",
+                    "fix": "safe",
+                    "options": {
+                        "attributes": ["class", "className", "style"],
+                        "functions": ["clsx", "tw"]
+                    }
+                }
+            }
+        }
+    },
+    "javascript": {
+        "formatter": {
+            "jsxQuoteStyle": "double",
+            "quoteProperties": "asNeeded",
+            "trailingCommas": "es5",
+            "semicolons": "always",
+            "arrowParentheses": "always",
+            "bracketSameLine": false,
+            "quoteStyle": "single",
+            "attributePosition": "auto",
+            "bracketSpacing": true
+        }
+    },
+    "overrides": [
+        {
+            "include": [
+                "packages/gitbook/**/*",
+                "packages/gitbook-v2/**/*",
+                "packages/react-openapi/**/*",
+                "packages/react-math/**/*",
+                "packages/react-contentkit/**/*",
+                "packages/icons/**/*"
+            ],
+            "javascript": {
+                "globals": ["React"]
+            }
+        },
+        {
+            "include": ["packages/gitbook/**/*"],
+            "javascript": {
+                "globals": ["React", "GitBookIntegrationEvent"]
+            }
+        },
+        {
+            "include": ["*.css"],
+            "javascript": {
+                "globals": ["theme"]
+            }
+        },
+        {
+            "include": ["*.test.ts", "packages/gitbook/tests/**/*"],
+            "javascript": {
+                "globals": ["Bun"]
+            }
+        },
+        {
+            "include": [
+                "packages/cache-do/**/*",
+                "packages/gitbook/cf-env.d.ts",
+                "packages/gitbook/src/cloudflare-entrypoint.ts"
+            ],
+            "javascript": {
+                "globals": [
+                    "DurableObjectLocationHint",
+                    "DurableObjectNamespace",
+                    "DurableObjectStub",
+                    "ContinentCode",
+                    "Fetcher",
+                    "ExportedHandler"
+                ]
+            }
+        }
+    ]
+}

docs/caching.md

@@ -1,22 +0,0 @@
-# Caching
-
-## Revalidating the cache
-
-Invalidate cache can be done at two levels using tags:
-
--   Data fetching cache
--   Rendering cache
-
-To invalidate and refetch the data cache, you can execute a POST request to `/~/gitbook/revalidate`:
-
-```bash
-curl --location --request POST 'https://gitbook/mycompany.com/~gitbook/revalidate' \
---header 'Content-Type: application/json' \
---data-raw '{"tags": ["space.id"]}'
-```
-
-To invalidate the rendering cache, the implementation mainly depends on the infrastructure serving the content, GitBook outputs a `Cache-Tag` header on every requests. The value of the header is a comma separated list of tags.
-
-## Purging the cache
-
-Purging the cache, without revalidating, is done by passing `"purge": true` in the request body.

package.json

@@ -2,12 +2,12 @@
     "name": "gitbook",
     "version": "0.1.0",
     "devDependencies": {
+        "@biomejs/biome": "^1.9.4",
         "@changesets/cli": "^2.27.12",
-        "prettier": "^3.0.3",
-        "turbo": "^2.4.1-canary.2",
+        "turbo": "^2.4.4",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.1.18",
+    "packageManager": "bun@1.2.4",
     "overrides": {
         "@codemirror/state": "6.4.1",
         "react": "18.3.1",
@@ -20,23 +20,20 @@
         "build": "turbo run build",
         "build:v2": "turbo run build:v2",
         "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
-        "lint": "turbo run lint",
-        "lint:fix": "turbo run lint -- --fix",
         "typecheck": "turbo run typecheck",
-        "format": "prettier ./ --ignore-unknown --write",
-        "format:check": "prettier ./ --ignore-unknown --list-different",
+        "format": "biome check --write ./",
+        "format:check": "biome check --diagnostic-level=error ./",
         "unit": "turbo run unit",
         "e2e": "turbo run e2e",
         "e2e-customers": "turbo run e2e-customers",
         "changeset": "changeset",
+        "changeset-version": "changeset version && bun run format",
         "release": "turbo run release && changeset publish",
         "release:preview": "turbo run release:preview",
         "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
         "clean": "turbo run clean"
     },
-    "workspaces": [
-        "packages/*"
-    ],
+    "workspaces": ["packages/*"],
     "patchedDependencies": {
         "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
         "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"

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",
@@ -31,12 +31,5 @@
         "release": "wrangler deploy",
         "release:preview": "wrangler deploy && wrangler deploy --env preview"
     },
-    "files": [
-        "dist",
-        "src",
-        "bin",
-        "data",
-        "README.md",
-        "CHANGELOG.md"
-    ]
+    "files": ["dist", "src", "bin", "data", "README.md", "CHANGELOG.md"]
 }

packages/cache-do/src/CacheObject.ts

@@ -1,5 +1,5 @@
-import { encode, decode } from '@msgpack/msgpack';
 import { DurableObject } from 'cloudflare:workers';
+import { decode, encode } from '@msgpack/msgpack';
 import { LRUMap } from 'lru_map';
 
 export interface CacheObjectDescriptor {
@@ -137,7 +137,7 @@ export class CacheObject extends DurableObject {
      */
     public async purge() {
         return this.logOperation({ operation: 'purge' }, async (setLog) => {
-            let result = new Set<string>();
+            const result = new Set<string>();
 
             try {
                 // List all the keys in the cache object.
@@ -149,11 +149,7 @@ export class CacheObject extends DurableObject {
                 entries.forEach((exp) => {
                     result.add(exp.k);
                 });
-            } catch (error) {
-                // If an error occurs, reset the cache object.
-                // This is a safety mechanism to prevent the cache object from being stuck in a bad state.
-                console.error('Error during purge, resetting the cache object', error);
-            }
+            } catch (_error) {}
 
             await this.reset();
             return Array.from(result);
@@ -174,7 +170,7 @@ export class CacheObject extends DurableObject {
                 const toDeleteSet = new Set<string>();
 
                 for (const [key, exp] of entries) {
-                    const timestamp = parseInt(key.split('.')[1]);
+                    const timestamp = Number.parseInt(key.split('.')[1]);
                     if (timestamp < Date.now()) {
                         toDeleteSet.add(key);
                         for (let i = 0; i < exp.c; i++) {
@@ -194,10 +190,7 @@ export class CacheObject extends DurableObject {
                 if (toDelete.length) {
                     await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
                 }
-            } catch (error) {
-                // If an error occurs, reset the cache object.
-                // This is a safety mechanism to prevent the cache object from being stuck in a bad state.
-                console.error('Error during alarm, reset the cache object', error);
+            } catch (_error) {
                 await this.reset();
             }
         });
@@ -218,10 +211,10 @@ export class CacheObject extends DurableObject {
      */
     async logOperation<T>(
         log: Record<string, unknown>,
-        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>,
+        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>
     ): Promise<T> {
         const objectId = this.ctx.id.name ?? this.ctx.id.toString();
-        let update: Record<string, unknown> = {};
+        const update: Record<string, unknown> = {};
         const start = performance.now();
         try {
             return await fn((arg) => {
@@ -265,7 +258,7 @@ function encodeChunks<T>(key: string, value: T): Record<string, Uint8Array> {
 function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
     const chunks = Array.from(entries.entries())
         .map(([key, value]) => {
-            const index = parseInt(key.split('.').pop()!);
+            const index = Number.parseInt(key.split('.').pop()!);
             return [index, value] as const;
         })
         .sort(([a], [b]) => a - b)

packages/cache-do/src/CacheObjectStub.ts

@@ -1,4 +1,4 @@
-import type { CacheObject, CacheObjectDescriptor } from './CacheObject';
+import type { CacheObject } from './CacheObject';
 
 export type CacheLocationId = ContinentCode;
 const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
@@ -30,7 +30,7 @@ export class CacheObjectStub {
         /** ID of the location to target */
         private locationId: CacheLocationId,
         /** Name of the tag */
-        private tag: string,
+        private tag: string
     ) {
         const groupId = getCacheObjectIdName(this.locationId, this.tag);
         this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
@@ -85,7 +85,7 @@ export class CacheObjectStub {
                 });
                 const locationkeys = await cacheGroup.purge();
                 locationkeys.forEach((key) => keys.add(key));
-            }),
+            })
         );
 
         return keys;

packages/cache-tags/.gitignore

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

packages/cache-tags/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @gitbook/cache-tags
+
+## 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.1.0",
+    "dependencies": {
+        "@gitbook/api": "0.96.1",
+        "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,175 @@
+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 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/package.json

@@ -17,10 +17,5 @@
         "typecheck": "tsc --noEmit",
         "dev": "tsc -w"
     },
-    "files": [
-        "dist",
-        "src",
-        "README.md",
-        "CHANGELOG.md"
-    ]
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
 }

packages/colors/src/transformations.ts

@@ -1,4 +1,4 @@
-import { DARK_BASE, LIGHT_BASE, DEFAULT_TINT_COLOR } from './colors';
+import { DARK_BASE, DEFAULT_TINT_COLOR, LIGHT_BASE } from './colors';
 
 type ColorShades = {
     [key: string]: string;
@@ -178,7 +178,7 @@ export function colorScale(
         background = darkMode ? DARK_BASE : LIGHT_BASE,
         foreground = darkMode ? LIGHT_BASE : DARK_BASE,
         mix,
-    }: ColorScaleOptions = {},
+    }: ColorScaleOptions = {}
 ) {
     const baseColor = rgbToOklch(hexToRgbArray(hex));
     const mixColor = mix?.color ? rgbToOklch(hexToRgbArray(mix.color)) : null;

packages/colors/tsconfig.json

@@ -13,7 +13,7 @@
         "moduleResolution": "bundler",
         "resolveJsonModule": true,
         "isolatedModules": true,
-        "jsx": "react",
+        "jsx": "react-jsx",
         "incremental": true,
         "types": [
             "bun-types" // add Bun global

packages/emoji-codepoints/build.ts

@@ -17,12 +17,11 @@ Object.entries(emojis).forEach(([key, value]) => {
     if (emoji && key !== emoji) {
         output[key] = emoji;
     } else if (!emoji) {
-        console.log('No emoji for', key);
     }
 });
 
 fs.mkdirSync(path.resolve(__dirname, 'dist'), { recursive: true });
 fs.writeFileSync(
     path.resolve(__dirname, 'dist/index.ts'),
-    `export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`,
+    `export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`
 );

packages/gitbook-v2/CHANGELOG.md

@@ -1,5 +1,25 @@
 # gitbook-v2
 
+## 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
+
 ## 0.1.0
 
 ### Minor Changes

packages/gitbook-v2/next.config.mjs

@@ -10,11 +10,25 @@ 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
+        GITBOOK_V2: 'true',
     },
 
     assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,

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';
-
-const config = {
-    default: {
-        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;
+export default defineCloudflareConfig({
+    incrementalCache: kvIncrementalCache,
+    queue: memoryQueue,
+    tagCache: d1TagCache,
+});

packages/gitbook-v2/package.json

@@ -1,24 +1,26 @@
 {
     "name": "gitbook-v2",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "private": true,
     "dependencies": {
-        "next": "canary",
+        "next": "^15.2.1",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
-        "@gitbook/api": "^0.96.0",
+        "@gitbook/api": "0.96.1",
+        "@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": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@40fec7d",
         "tailwindcss": "^3.4.0",
         "postcss": "^8"
     },
     "scripts": {
         "generate": "rm -rf ./public && cp -r ../gitbook/public ./public",
-        "dev:v2": "env-cmd --silent -f ../../.env.local next",
+        "dev:v2": "env-cmd --silent -f ../../.env.local next --turbopack",
         "build": "next build",
         "build:v2": "next build",
         "start": "next start",

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

@@ -1,10 +1,10 @@
-import { getDynamicSiteContext, getPagePathFromParams, RouteParams } from '@v2/app/utils';
 import {
+    SitePage,
     generateSitePageMetadata,
     generateSitePageViewport,
-    SitePage,
 } from '@/components/SitePage';
-import { Metadata, Viewport } from 'next';
+import { type RouteParams, getDynamicSiteContext, getPagePathFromParams } from '@v2/app/utils';
+import type { Metadata, Viewport } from 'next';
 
 type PageProps = {
     params: Promise<RouteParams>;

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

@@ -1,18 +1,24 @@
 import { CustomizationRootLayout } from '@/components/RootLayout';
-import { SiteLayout } from '@/components/SiteLayout';
-import { getDynamicSiteContext, RouteLayoutParams } from '@v2/app/utils';
+import {
+    SiteLayout,
+    generateSiteLayoutMetadata,
+    generateSiteLayoutViewport,
+} 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>;
+}
 
 export default async function SiteDynamicLayout({
     params,
     children,
-}: {
-    params: Promise<RouteLayoutParams>;
-    children: React.ReactNode;
-}) {
+}: React.PropsWithChildren<SiteDynamicLayoutProps>) {
     const context = await getDynamicSiteContext(await params);
     const forcedTheme = await getThemeFromMiddleware();
+    const visitorAuthToken = await getVisitorAuthTokenFromMiddleware();
 
     return (
         <CustomizationRootLayout customization={context.customization}>
@@ -20,9 +26,20 @@ export default async function SiteDynamicLayout({
                 context={context}
                 forcedTheme={forcedTheme}
                 withTracking={!GITBOOK_DISABLE_TRACKING}
+                visitorAuthToken={visitorAuthToken}
             >
                 {children}
             </SiteLayout>
         </CustomizationRootLayout>
     );
 }
+
+export async function generateViewport({ params }: SiteDynamicLayoutProps) {
+    const context = await getDynamicSiteContext(await params);
+    return generateSiteLayoutViewport(context);
+}
+
+export async function generateMetadata({ params }: SiteDynamicLayoutProps) {
+    const context = await getDynamicSiteContext(await params);
+    return generateSiteLayoutMetadata(context);
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,5 +0,0 @@
-import { SitePageSkeleton } from '@/components/SitePage';
-
-export default function Loading() {
-    return <SitePageSkeleton />;
-}

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

@@ -1,12 +1,12 @@
-import { unstable_cacheTag as cacheTag } from 'next/cache';
-import { getSiteCacheTag } from '@v2/lib/cache';
-import { getPagePathFromParams, getStaticSiteContext, RouteParams } from '@v2/app/utils';
 import {
+    SitePage,
     generateSitePageMetadata,
     generateSitePageViewport,
-    SitePage,
 } from '@/components/SitePage';
-import { Metadata, Viewport } from 'next';
+import { getCacheTag } from '@gitbook/cache-tags';
+import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
+import type { Metadata, Viewport } from 'next';
+import { unstable_cacheTag as cacheTag } from 'next/cache';
 
 export const dynamic = 'force-static';
 
@@ -21,7 +21,12 @@ 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} />;
 }

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

@@ -1,28 +1,52 @@
-import { unstable_cacheTag as cacheTag } from 'next/cache';
-import { getSiteCacheTag } from '@v2/lib/cache';
-import { getStaticSiteContext, RouteLayoutParams } from '@v2/app/utils';
 import { CustomizationRootLayout } from '@/components/RootLayout';
-import { SiteLayout } from '@/components/SiteLayout';
+import {
+    SiteLayout,
+    generateSiteLayoutMetadata,
+    generateSiteLayoutViewport,
+} from '@/components/SiteLayout';
+import { getCacheTag } from '@gitbook/cache-tags';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
 import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
+import { unstable_cacheTag as cacheTag } from 'next/cache';
+
+interface SiteStaticLayoutProps {
+    params: Promise<RouteLayoutParams>;
+}
 
 export default async function SiteStaticLayout({
     params,
     children,
-}: {
-    params: Promise<RouteLayoutParams>;
-    children: React.ReactNode;
-}) {
+}: React.PropsWithChildren<SiteStaticLayoutProps>) {
     'use cache';
 
     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>
     );
 }
+
+export async function generateViewport({ params }: SiteStaticLayoutProps) {
+    const context = await getStaticSiteContext(await params);
+    return generateSiteLayoutViewport(context);
+}
+
+export async function generateMetadata({ params }: SiteStaticLayoutProps) {
+    const context = await getStaticSiteContext(await params);
+    return generateSiteLayoutMetadata(context);
+}

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

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

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

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

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

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

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

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

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

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

packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/~gitbook/ogimage/[pageId]/route.ts

@@ -0,0 +1,15 @@
+import type { NextRequest } from 'next/server';
+
+import type { PageIdParams } from '@/components/SitePage';
+import { serveOGImage } from '@/routes/ogimage';
+import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
+
+export const dynamic = 'force-static';
+
+export async function GET(
+    _request: NextRequest,
+    { params }: { params: Promise<RouteLayoutParams & PageIdParams> }
+) {
+    const context = await getStaticSiteContext(await params);
+    return serveOGImage(context, await params);
+}

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

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

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

@@ -0,0 +1,36 @@
+import { type NextRequest, NextResponse } from 'next/server';
+
+import {
+    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_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/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,5 +1,7 @@
-import {
+import { getSiteStructureSections } from '@/lib/sites';
+import type {
     ChangeRequest,
+    PublishedSiteContentLookup,
     RevisionPage,
     RevisionPageDocument,
     Site,
@@ -11,12 +13,12 @@ import {
     SiteStructure,
     Space,
 } from '@gitbook/api';
+import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
 import { redirect } from 'next/navigation';
 import { assert } from 'ts-essentials';
-import { getSiteStructureSections } from '@/lib/sites';
-import { createDataFetcher, GitBookDataFetcher } from '@v2/lib/data';
-import { GitBookSpaceLinker, appendPrefixToLinker } from './links';
-import { ImageResizer } from './images';
+import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from './env';
+import { type ImageResizer, createImageResizer } from './images';
+import { type GitBookSpaceLinker, createLinker } from './links';
 
 /**
  * Generic context when rendering content.
@@ -35,7 +37,7 @@ export type GitBookBaseContext = {
     /**
      * Image resizer to resize images.
      */
-    imageResizer: ImageResizer;
+    imageResizer?: ImageResizer;
 };
 
 /**
@@ -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,57 @@ 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 ?? GITBOOK_API_TOKEN,
+        apiEndpoint: GITBOOK_API_URL,
+    });
+    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
+
+    const linker =
+        urlMode === 'url-host'
+            ? createLinker({
+                  host: url.host,
+                  pathname: url.pathname,
+              })
+            : createLinker({
+                  protocol: gitbookURL?.protocol,
+                  host: gitbookURL?.host,
+                  pathname: `/url/${url.host}${url.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}`;
+        };
+    }
+
+    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,
+    };
+}
+
 /**
  * Fetch the context of a site for a given URL and a base context.
  */
@@ -111,24 +161,36 @@ export async function fetchSiteContextByURL(
         url: string;
         visitorAuthToken: string | null;
         redirectOnError: boolean;
-    },
+    }
 ): Promise<GitBookSiteContext> {
     const { dataFetcher } = baseContext;
-    const data = await dataFetcher.getPublishedContentByUrl({
-        url: input.url,
-        visitorAuthToken: input.visitorAuthToken,
-        redirectOnError: input.redirectOnError,
-    });
+    const data = await throwIfDataError(
+        dataFetcher.getPublishedContentByUrl({
+            url: input.url,
+            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({
-                apiEndpoint: dataFetcher.apiEndpoint,
+            dataFetcher: dataFetcher.withToken({
                 apiToken: data.apiToken,
             }),
         },
@@ -141,16 +203,8 @@ export async function fetchSiteContextByURL(
             shareKey: data.shareKey,
             changeRequest: data.changeRequest,
             revision: data.revision,
-            visitorAuthToken: input.visitorAuthToken,
-        },
+        }
     );
-
-    const siteContext = {
-        ...context,
-        linker: appendPrefixToLinker(context.linker, data.basePath),
-    };
-
-    return siteContext;
 }
 
 /**
@@ -167,18 +221,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({
-                organizationId: ids.organization,
-                siteId: ids.site,
-                siteShareKey: ids.shareKey,
-            }),
+            throwIfDataError(
+                dataFetcher.getPublishedContentSite({
+                    organizationId: ids.organization,
+                    siteId: ids.site,
+                    siteShareKey: ids.shareKey,
+                })
+            ),
             fetchSpaceContextByIds(baseContext, ids),
         ]);
 
@@ -189,7 +244,9 @@ export async function fetchSiteContextByIds(
         ...(customizations.site?.title ? { title: customizations.site.title } : {}),
     };
 
-    const sections = ids.siteSection ? parseSiteSectionsList(siteStructure, ids.siteSection) : null;
+    const sections = ids.siteSection
+        ? parseSiteSectionsAndGroups(siteStructure, ids.siteSection)
+        : null;
 
     const siteSpace = (
         siteStructure.type === 'siteSpaces' && siteStructure.structure
@@ -211,11 +268,13 @@ export async function fetchSiteContextByIds(
             if (siteSpaceSettings) {
                 return siteSpaceSettings;
             }
+
             // We got the pointer from an API and customizations from another.
             // It's possible that the two are unsynced leading to not found customizations for the space.
             // It's better to fallback on customization of the site that displaying an error.
             console.warn('Customization not found for site space', ids.siteSpace);
         }
+
         return customizations.site;
     })();
 
@@ -229,7 +288,6 @@ export async function fetchSiteContextByIds(
         structure: siteStructure,
         sections,
         scripts,
-        visitorAuthToken: ids.visitorAuthToken,
     };
 }
 
@@ -243,32 +301,38 @@ export async function fetchSpaceContextByIds(
         shareKey: string | undefined;
         changeRequest: string | undefined;
         revision: string | undefined;
-    },
+    }
 ): Promise<GitBookSpaceContext> {
     const { dataFetcher } = baseContext;
 
     const [space, changeRequest] = await Promise.all([
-        dataFetcher.getSpace({
-            spaceId: ids.space,
-            shareKey: ids.shareKey,
-        }),
+        throwIfDataError(
+            dataFetcher.getSpace({
+                spaceId: ids.space,
+                shareKey: ids.shareKey,
+            })
+        ),
         ids.changeRequest
-            ? dataFetcher.getChangeRequest({
-                  spaceId: ids.space,
-                  changeRequestId: ids.changeRequest,
-              })
+            ? throwIfDataError(
+                  dataFetcher.getChangeRequest({
+                      spaceId: ids.space,
+                      changeRequestId: ids.changeRequest,
+                  })
+              )
             : null,
     ]);
 
     const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision;
 
-    const pages = await dataFetcher.getRevisionPages({
-        spaceId: ids.space,
-        revisionId,
-        // We only care about the Git metadata when the Git sync is enabled,
-        // otherwise we can optimize performance by not fetching it
-        metadata: !!space.gitSync,
-    });
+    const pages = await throwIfDataError(
+        dataFetcher.getRevisionPages({
+            spaceId: ids.space,
+            revisionId,
+            // We only care about the Git metadata when the Git sync is enabled,
+            // otherwise we can optimize performance by not fetching it
+            metadata: !!space.gitSync,
+        })
+    );
 
     return {
         ...baseContext,
@@ -281,9 +345,39 @@ export async function fetchSpaceContextByIds(
     };
 }
 
-function parseSiteSectionsList(structure: SiteStructure, siteSectionId: string) {
-    const sections = getSiteStructureSections(structure);
-    const section = sections.find((section) => section.id === siteSectionId);
-    assert(section, 'A section must be defined when there are multiple sections');
-    return { list: sections, current: section } satisfies SiteSections;
+/**
+ * Check if the context is the root one for a site.
+ * Meaning we are on the default section / space.
+ */
+export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {
+    const { structure } = context;
+    switch (structure.type) {
+        case 'sections': {
+            return getSiteStructureSections(structure, { ignoreGroups: true }).some(
+                (structure) =>
+                    structure.default &&
+                    structure.id === context.sections?.current.id &&
+                    structure.siteSpaces.some(
+                        (siteSpace) => siteSpace.default && siteSpace.id === context.siteSpace.id
+                    )
+            );
+        }
+        case 'siteSpaces': {
+            return structure.structure.some(
+                (siteSpace) => siteSpace.default && siteSpace.id === context.siteSpace.id
+            );
+        }
+    }
+}
+
+function parseSiteSectionsAndGroups(structure: SiteStructure, siteSectionId: string) {
+    const sectionsAndGroups = getSiteStructureSections(structure, { ignoreGroups: false });
+    const section = parseCurrentSection(structure, siteSectionId);
+    assert(section, 'A section must be defined when there are multiple sections');
+    return { list: sectionsAndGroups, current: section } satisfies SiteSections;
+}
+
+function parseCurrentSection(structure: SiteStructure, siteSectionId: string) {
+    const sections = getSiteStructureSections(structure, { ignoreGroups: true });
+    return sections.find((section) => section.id === siteSectionId);
 }

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

@@ -1,14 +1,9 @@
-import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
-import { ComputedContentSource, GitBookAPI } from '@gitbook/api';
+import { type ComputedContentSource, GitBookAPI } from '@gitbook/api';
+import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
 import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
-import { GitBookDataFetcher } from './types';
-import {
-    getChangeRequestCacheTag,
-    getHostnameCacheTag,
-    getOpenAPISpecCacheTag,
-    getSiteCacheTag,
-    getSpaceCacheTag,
-} from '../cache';
+import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
+import { wrapDataFetcherError } from './errors';
+import type { GitBookDataFetcher } from './types';
 
 interface DataFetcherInput {
     /**
@@ -35,6 +30,17 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
     return {
         apiEndpoint: input.apiEndpoint,
 
+        async api() {
+            return getAPI(input);
+        },
+
+        withToken({ apiToken }) {
+            return createDataFetcher({
+                ...input,
+                apiToken,
+            });
+        },
+
         //
         // API that are tied to the token
         //
@@ -114,10 +120,20 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
         },
         getComputedDocument(params) {
             return getComputedDocument(input, {
+                organizationId: params.organizationId,
                 spaceId: params.spaceId,
                 source: params.source,
             });
         },
+        getEmbedByUrl(params) {
+            return getEmbedByUrl(input, {
+                url: params.url,
+                spaceId: params.spaceId,
+            });
+        },
+        searchSiteContent(params) {
+            return searchSiteContent(input, params);
+        },
 
         //
         // API that are not tied to the token
@@ -139,16 +155,12 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
 async function getUserById(input: DataFetcherInput, userId: string) {
     'use cache';
 
-    try {
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
         const res = await getAPI(input).users.getUserById(userId);
         return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
+    });
 }
 
 async function getSpace(
@@ -156,16 +168,24 @@ async function getSpace(
     params: {
         spaceId: string;
         shareKey: string | undefined;
-    },
+    }
 ) {
     'use cache';
 
-    cacheTag(getSpaceCacheTag(params.spaceId));
+    cacheLife('days');
+    cacheTag(
+        getCacheTag({
+            tag: 'space',
+            space: params.spaceId,
+        })
+    );
 
-    const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
-        shareKey: params.shareKey,
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
+            shareKey: params.shareKey,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getChangeRequest(
@@ -173,24 +193,26 @@ async function getChangeRequest(
     params: {
         spaceId: string;
         changeRequestId: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheLife('minutes');
+
+    return wrapDataFetcherError(async () => {
         const res = await getAPI(input).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(
@@ -199,14 +221,18 @@ async function getRevision(
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
-        metadata: params.metadata,
+    cacheLife('max');
+
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
+            metadata: params.metadata,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getRevisionPages(
@@ -215,18 +241,22 @@ async function getRevisionPages(
         spaceId: string;
         revisionId: string;
         metadata: boolean;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.listPagesInRevisionById(
-        params.spaceId,
-        params.revisionId,
-        {
-            metadata: params.metadata,
-        },
-    );
-    return res.data.pages;
+    cacheLife('max');
+
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).spaces.listPagesInRevisionById(
+            params.spaceId,
+            params.revisionId,
+            {
+                metadata: params.metadata,
+            }
+        );
+        return res.data.pages;
+    });
 }
 
 async function getRevisionFile(
@@ -235,24 +265,20 @@ async function getRevisionFile(
         spaceId: string;
         revisionId: string;
         fileId: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheLife('max');
+
+    return wrapDataFetcherError(async () => {
         const res = await getAPI(input).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(
@@ -261,27 +287,22 @@ async function getRevisionPageByPath(
         spaceId: string;
         revisionId: string;
         path: string;
-    },
+    }
 ) {
     'use cache';
 
-    const encodedPath = encodeURIComponent(params.path);
+    cacheLife('max');
 
-    try {
+    const encodedPath = encodeURIComponent(params.path);
+    return wrapDataFetcherError(async () => {
         const res = await getAPI(input).spaces.getPageInRevisionByPath(
             params.spaceId,
             params.revisionId,
-            encodedPath,
+            encodedPath
         );
 
         return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
+    });
 }
 
 async function getDocument(
@@ -289,27 +310,46 @@ async function getDocument(
     params: {
         spaceId: string;
         documentId: string;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
-    return res.data;
+    cacheLife('max');
+
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
+        return res.data;
+    });
 }
 
 async function getComputedDocument(
     input: DataFetcherInput,
     params: {
         spaceId: string;
+        organizationId: string;
         source: ComputedContentSource;
-    },
+    }
 ) {
     'use cache';
 
-    const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
-        source: params.source,
+    cacheLife('days');
+
+    cacheTag(
+        ...getComputedContentSourceCacheTags(
+            {
+                spaceId: params.spaceId,
+                organizationId: params.organizationId,
+            },
+            params.source
+        )
+    );
+
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
+            source: params.source,
+        });
+        return res.data;
     });
-    return res.data;
 }
 
 async function getReusableContent(
@@ -318,24 +358,20 @@ async function getReusableContent(
         spaceId: string;
         revisionId: string;
         reusableContentId: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheLife('max');
+
+    return wrapDataFetcherError(async () => {
         const res = await getAPI(input).spaces.getReusableContentInRevisionById(
             params.spaceId,
             params.revisionId,
-            params.reusableContentId,
+            params.reusableContentId
         );
         return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
+    });
 }
 
 async function getLatestOpenAPISpecVersionContent(
@@ -343,25 +379,26 @@ async function getLatestOpenAPISpecVersionContent(
     params: {
         organizationId: string;
         slug: string;
-    },
+    }
 ) {
     '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(
             params.organizationId,
-            params.slug,
+            params.slug
         );
         return res.data;
-    } catch (error) {
-        if (checkHasErrorCode(error, 404)) {
-            return null;
-        }
-
-        throw error;
-    }
+    });
 }
 
 async function getPublishedContentByUrl(
@@ -370,26 +407,39 @@ async function getPublishedContentByUrl(
         url: string;
         visitorAuthToken: string | null;
         redirectOnError: boolean;
-    },
+    }
 ) {
     'use cache';
 
     const { url, visitorAuthToken, redirectOnError } = params;
 
     const hostname = new URL(url).hostname;
-    cacheTag(getHostnameCacheTag(hostname));
+    cacheTag(
+        getCacheTag({
+            tag: 'url',
+            hostname,
+        })
+    );
+    cacheLife('days');
 
-    const res = await getAPI(input).urls.getPublishedContentByUrl({
-        url,
-        visitorAuthToken: visitorAuthToken ?? undefined,
-        redirectOnError,
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).urls.getPublishedContentByUrl({
+            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(
@@ -398,18 +448,28 @@ async function getPublishedContentSite(
         organizationId: string;
         siteId: string;
         siteShareKey: string | undefined;
-    },
+    }
 ) {
     'use cache';
-    cacheTag(getSiteCacheTag(params.siteId));
-    const res = await getAPI(input).orgs.getPublishedContentSite(
-        params.organizationId,
-        params.siteId,
-        {
-            shareKey: params.siteShareKey,
-        },
+
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: params.siteId,
+        })
     );
-    return res.data;
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).orgs.getPublishedContentSite(
+            params.organizationId,
+            params.siteId,
+            {
+                shareKey: params.siteShareKey,
+            }
+        );
+        return res.data;
+    });
 }
 
 async function getSiteRedirectBySource(
@@ -419,34 +479,67 @@ async function getSiteRedirectBySource(
         siteId: string;
         siteShareKey: string | undefined;
         source: string;
-    },
+    }
 ) {
     'use cache';
 
-    try {
+    cacheTag(
+        getCacheTag({
+            tag: 'site',
+            site: params.siteId,
+        })
+    );
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
         const res = await getAPI(input).orgs.getSiteRedirectBySource(
             params.organizationId,
             params.siteId,
             {
                 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(
+    input: DataFetcherInput,
+    params: {
+        url: string;
+        spaceId: string;
     }
+) {
+    'use cache';
+
+    cacheLife('weeks');
+
+    return wrapDataFetcherError(async () => {
+        const api = getAPI(input);
+        const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
+        return res.data;
+    });
+}
+
+async function searchSiteContent(
+    input: DataFetcherInput,
+    params: Parameters<GitBookDataFetcher['searchSiteContent']>[0]
+) {
+    'use cache';
+
+    const { organizationId, siteId, query, scope } = params;
+
+    cacheLife('days');
+
+    return wrapDataFetcherError(async () => {
+        const res = await getAPI(input).orgs.searchSiteContent(organizationId, siteId, {
+            query,
+            ...scope,
+        });
+        return res.data.items;
+    });
 }
 
 function getAPI(input: DataFetcherInput) {
@@ -459,7 +552,3 @@ function getAPI(input: DataFetcherInput) {
 
     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,112 @@
+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),
+        };
+    }
+}
+
+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,118 @@
+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';
+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<
+    | { 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;
+}

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,5 +1,20 @@
 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.
@@ -10,10 +25,22 @@ export interface GitBookDataFetcher {
      */
     apiEndpoint: string;
 
+    /**
+     * Get an API client for the current context.
+     */
+    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 +49,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 +58,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 +73,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 +82,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 +91,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 +100,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 +109,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 +134,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 +142,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,5 +152,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<
+        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.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect } from 'bun:test';
+import { describe, expect, it } from 'bun:test';
 
 import { getURLLookupAlternatives, normalizeURL } from './urls';
 
@@ -68,7 +68,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before the variant for a variant url', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://test.gitbook.io/v/variant/space')),
+            getURLLookupAlternatives(new URL('https://test.gitbook.io/v/variant/space'))
         ).toEqual({
             revision: undefined,
             changeRequest: undefined,
@@ -85,7 +85,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before the variant for a variant in a share link', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space')),
+            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space'))
         ).toEqual({
             revision: undefined,
             changeRequest: undefined,
@@ -103,8 +103,8 @@ describe('getURLLookupAlternatives', () => {
     it('should not match before a revision in a variant', () => {
         expect(
             getURLLookupAlternatives(
-                new URL('https://test.gitbook.io/v/variant/~/revisions/id/rest'),
-            ),
+                new URL('https://test.gitbook.io/v/variant/~/revisions/id/rest')
+            )
         ).toEqual({
             revision: 'id',
             changeRequest: undefined,
@@ -121,7 +121,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before a revision ID', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/revisions/id/a/b/c')),
+            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/revisions/id/a/b/c'))
         ).toEqual({
             revision: 'id',
             changeRequest: undefined,
@@ -138,7 +138,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should not match before a change request ID', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/changes/id/hello')),
+            getURLLookupAlternatives(new URL('https://docs.mycompany.com/~/changes/id/hello'))
         ).toEqual({
             revision: undefined,
             changeRequest: 'id',
@@ -195,7 +195,7 @@ describe('getURLLookupAlternatives', () => {
 
     it('should match a variant in a share-link', () => {
         expect(
-            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space')),
+            getURLLookupAlternatives(new URL('https://test.gitbook.io/sharelink/v/variant/space'))
         ).toEqual({
             revision: undefined,
             changeRequest: undefined,
@@ -213,8 +213,8 @@ describe('getURLLookupAlternatives', () => {
     it('should match a revision in a variant in a share-link', () => {
         expect(
             getURLLookupAlternatives(
-                new URL('https://test.gitbook.io/sharelink/v/variant/~/revisions/id/a/b/c'),
-            ),
+                new URL('https://test.gitbook.io/sharelink/v/variant/~/revisions/id/a/b/c')
+            )
         ).toEqual({
             revision: 'id',
             changeRequest: undefined,
@@ -232,8 +232,8 @@ describe('getURLLookupAlternatives', () => {
     it('should match a change request in a variant in a share-link', () => {
         expect(
             getURLLookupAlternatives(
-                new URL('https://test.gitbook.io/sharelink/v/variant/~/changes/id/a/b/c'),
-            ),
+                new URL('https://test.gitbook.io/sharelink/v/variant/~/changes/id/a/b/c')
+            )
         ).toEqual({
             revision: undefined,
             changeRequest: 'id',
@@ -367,13 +367,13 @@ describe('getURLLookupAlternatives', () => {
 describe('normalizeURL', () => {
     it('should remove trailing slashes', () => {
         expect(normalizeURL(new URL('https://docs.mycompany.com/hello/'))).toEqual(
-            new URL('https://docs.mycompany.com/hello'),
+            new URL('https://docs.mycompany.com/hello')
         );
     });
 
     it('should remove duplicate slashes', () => {
         expect(normalizeURL(new URL('https://docs.mycompany.com//hello//there'))).toEqual(
-            new URL('https://docs.mycompany.com/hello/there'),
+            new URL('https://docs.mycompany.com/hello/there')
         );
     });
 });

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

@@ -1,125 +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);
-
-    console.log(
-        `lookup content for url "${url.toString()}", with ${lookup.urls.length} alternatives`,
-    );
-
-    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.
@@ -155,7 +33,7 @@ export function getURLLookupAlternatives(input: URL) {
                 throw new Error(
                     `Invalid extraPath ${extraPath} for url ${adding.toString()}, already set to ${
                         existing.extraPath
-                    }`,
+                    }`
                 );
             }
             return;

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

@@ -1,19 +0,0 @@
-import { RevisionPageDocument } from '@gitbook/api';
-import { 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 });
-    } else if (page.computed) {
-        return dataFetcher.getComputedDocument({ spaceId, source: page.computed });
-    }
-
-    return null;
-}

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

@@ -1,38 +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 ??
-          '');
-
-/**
- * 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',
-);

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

@@ -0,0 +1,84 @@
+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 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

@@ -1,8 +1,9 @@
 import 'server-only';
 
+import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY, GITBOOK_IMAGE_RESIZE_URL } from '../env';
+import type { GitBookSpaceLinker } from '../links';
+import { type SignatureVersion, generateImageSignature } from './signatures';
 import type { ImageResizer } from './types';
-import { generateImageSignature, SignatureVersion } from './signatures';
-import { GitBookSpaceLinker } from '../links';
 
 interface CloudflareImageJsonFormat {
     width: number;
@@ -40,8 +41,12 @@ export function createImageResizer({
     /** The host name of the current site. */
     host: string;
 }): ImageResizer {
+    if (!GITBOOK_IMAGE_RESIZE_URL || !GITBOOK_IMAGE_RESIZE_SIGNING_KEY) {
+        return createNoopImageResizer();
+    }
+
     return {
-        resize: (urlInput) => {
+        getResizedImageURL: (urlInput) => {
             if (!checkIsSizableImageURL(urlInput)) {
                 return null;
             }
@@ -57,26 +62,27 @@ export function createImageResizer({
                     url: urlInput,
                 });
 
-                const url = new URL(linker.toAbsoluteURL('/~gitbook/image'));
-                url.searchParams.set('url', getImageAPIUrl(urlInput));
+                const url = linker.toAbsoluteURL(linker.toPathInContent('/~gitbook/image'));
+                const searchParams = new URLSearchParams();
+                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);
-                url.searchParams.set('sv', cachedSignature.version);
+                searchParams.set('sign', cachedSignature.signature);
+                searchParams.set('sv', cachedSignature.version);
 
-                return url.toString();
+                return `${url}?${searchParams.toString()}`;
             };
         },
 
@@ -95,18 +101,11 @@ export function createImageResizer({
  */
 export function createNoopImageResizer(): ImageResizer {
     return {
-        resize: () => null,
-        getImageSize: async (input) => null,
+        getResizedImageURL: () => null,
+        getImageSize: async (_input) => null,
     };
 }
 
-/**
- * Return true if images resizing is enabled.
- */
-export function isImageResizingEnabled(): boolean {
-    return !!process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY;
-}
-
 /**
  * Check if a URL is an HTTP URL.
  */
@@ -149,9 +148,9 @@ export function checkIsSizableImageURL(input: string): boolean {
  */
 export async function getImageSize(
     input: string,
-    defaultSize: Partial<CloudflareImageOptions> = {},
+    defaultSize: Partial<CloudflareImageOptions> = {}
 ): Promise<{ width: number; height: number } | null> {
-    if (!isImageResizingEnabled() || !checkIsSizableImageURL(input)) {
+    if (!checkIsSizableImageURL(input)) {
         return null;
     }
 
@@ -171,12 +170,7 @@ export async function getImageSize(
             width: json.original.width,
             height: json.original.height,
         };
-    } catch (error) {
-        console.error(
-            `failed to fetch image size for ${input}: ${
-                (error as Error).stack ?? (error as Error).message ?? error
-            }`,
-        );
+    } catch (_error) {
         return null;
     }
 }
@@ -188,7 +182,7 @@ export async function resizeImage(
     input: string,
     options: CloudflareImageOptions & {
         signal?: AbortSignal;
-    },
+    }
 ): Promise<Response> {
     const { signal, ...resizeOptions } = options;
 
@@ -203,33 +197,25 @@ export async function resizeImage(
 
     // Since Cloudflare Images options on fetch are not supported on Cloudflare Pages,
     // we need to use the Cloudflare Image Resize API directly.
-    if (process.env.GITBOOK_IMAGE_RESIZE_URL) {
-        const response = await fetch(
-            `${process.env.GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
-                resizeOptions,
-            )}/${encodeURIComponent(input)}`,
-            {
-                headers: {
-                    // Pass the `Accept` header, as Cloudflare uses this to validate the format.
-                    Accept:
-                        resizeOptions.format === 'json'
-                            ? 'application/json'
-                            : `image/${resizeOptions.format || 'jpeg'}`,
-                },
-                signal,
-            },
-        );
-
-        return response;
+    if (!GITBOOK_IMAGE_RESIZE_URL) {
+        throw new Error('GITBOOK_IMAGE_RESIZE_URL is not set');
     }
 
-    return fetch(parsed, {
-        // @ts-ignore
-        cf: {
-            image: resizeOptions,
-        },
-        signal,
-    });
+    return await fetch(
+        `${GITBOOK_IMAGE_RESIZE_URL}${stringifyOptions(
+            resizeOptions
+        )}/${encodeURIComponent(input)}`,
+        {
+            headers: {
+                // Pass the `Accept` header, as Cloudflare uses this to validate the format.
+                Accept:
+                    resizeOptions.format === 'json'
+                        ? 'application/json'
+                        : `image/${resizeOptions.format || 'jpeg'}`,
+            },
+            signal,
+        }
+    );
 }
 
 function stringifyOptions(options: CloudflareImageOptions): string {

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

@@ -2,6 +2,8 @@ import 'server-only';
 
 import fnv1a from '@sindresorhus/fnv1a';
 import type { MaybePromise } from 'p-map';
+import { assert } from 'ts-essentials';
+import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY } from '../env';
 
 /**
  * GitBook has supported different version of image signing in the past. To maintain backwards
@@ -26,7 +28,7 @@ type SignFn = (input: SignFnInput) => MaybePromise<string>;
  */
 export async function verifyImageSignature(
     input: SignFnInput,
-    { signature, version }: { signature: string; version: SignatureVersion },
+    { signature, version }: { signature: string; version: SignatureVersion }
 ): Promise<boolean> {
     const generator = IMAGE_SIGNATURE_FUNCTIONS[version];
     const generated = await generator(input);
@@ -55,10 +57,11 @@ const fnv1aUtf8Buffer = new Uint8Array(512);
  * The signature is relative to the current site being rendered to avoid serving images from other sites on the same domain.
  */
 const generateSignatureV2: SignFn = async (input) => {
+    assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
     const all = [
         input.url,
         input.host, // The hostname is used to avoid serving images from other sites on the same domain
-        process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
+        GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
     ]
         .filter(Boolean)
         .join(':');
@@ -74,7 +77,8 @@ const fnv1aUtf8BufferV1 = new Uint8Array(512);
  * to know that it was the algorithm that was used.
  */
 const generateSignatureV1: SignFn = async (input) => {
-    const all = [input.url, process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
+    assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
+    const all = [input.url, GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
     return fnv1a(all, { utf8Buffer: fnv1aUtf8BufferV1 }).toString(16);
 };
 
@@ -84,7 +88,8 @@ const generateSignatureV1: SignFn = async (input) => {
  * but still exist in previously generated and cached content.
  */
 const generateSignatureV0: SignFn = async (input) => {
-    const all = [input.url, process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
+    assert(GITBOOK_IMAGE_RESIZE_SIGNING_KEY, 'GITBOOK_IMAGE_RESIZE_SIGNING_KEY is not set');
+    const all = [input.url, GITBOOK_IMAGE_RESIZE_SIGNING_KEY].filter(Boolean).join(':');
     const hash = await crypto.subtle.digest('SHA-256', new TextEncoder().encode(all));
 
     // Convert ArrayBuffer to hex string

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

@@ -20,10 +20,10 @@ export type ImageResizer = {
      * @param input - The image URL to resize.
      * @param options - The options to resize the image.
      */
-    resize(input: string): null | ((options: ResizeImageOptions) => Promise<string>);
+    getResizedImageURL(imageURL: string): null | ((options: ResizeImageOptions) => Promise<string>);
 
     /**
      * Get the size of an image.
      */
-    getImageSize(input: string, options: GetImageSizeOptions): Promise<ImageSize | null>;
+    getImageSize(imageURL: string, options: GetImageSizeOptions): Promise<ImageSize | null>;
 };

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

@@ -1,14 +1,14 @@
-import { ImageResizer, ResizeImageOptions } from './types';
+import type { ImageResizer, ResizeImageOptions } from './types';
 
 /**
  * Quick utility to get a resized image URL.
  */
 export async function getResizedImageURL(
-    resizer: ImageResizer,
+    resizer: ImageResizer | undefined,
     url: string,
-    options: ResizeImageOptions,
+    options: ResizeImageOptions
 ) {
-    const getURL = resizer.resize(url);
+    const getURL = resizer?.getResizedImageURL(url);
     if (!getURL) {
         return url;
     }

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

@@ -0,0 +1,58 @@
+import { describe, expect, it } from 'bun:test';
+import { appendBasePathToLinker, createLinker } from './links';
+
+const root = createLinker({
+    host: 'docs.company.com',
+    pathname: '/',
+});
+
+const variantInSection = createLinker({
+    host: 'docs.company.com',
+    pathname: '/section/variant',
+});
+
+describe('toPathInContent', () => {
+    it('should return the correct path', () => {
+        expect(root.toPathInContent('some/path')).toBe('/some/path');
+        expect(variantInSection.toPathInContent('some/path')).toBe('/section/variant/some/path');
+    });
+
+    it('should handle leading slash', () => {
+        expect(root.toPathInContent('/some/path')).toBe('/some/path');
+        expect(variantInSection.toPathInContent('/some/path')).toBe('/section/variant/some/path');
+    });
+});
+
+describe('toAbsoluteURL', () => {
+    it('should return the correct path', () => {
+        expect(root.toAbsoluteURL('some/path')).toBe('https://docs.company.com/some/path');
+        expect(variantInSection.toAbsoluteURL('some/path')).toBe(
+            'https://docs.company.com/some/path'
+        );
+    });
+});
+
+describe('appendBasePathToLinker', () => {
+    const prefixedRoot = appendBasePathToLinker(root, '/section/variant');
+    const prefixedVariantInSection = appendBasePathToLinker(variantInSection, '/base');
+
+    describe('toPathInContent', () => {
+        it('should return the correct path', () => {
+            expect(prefixedRoot.toPathInContent('some/path')).toBe('/section/variant/some/path');
+            expect(prefixedVariantInSection.toPathInContent('some/path')).toBe(
+                '/section/variant/base/some/path'
+            );
+        });
+    });
+
+    describe('toAbsoluteURL', () => {
+        it('should return the correct path', () => {
+            expect(prefixedRoot.toAbsoluteURL('some/path')).toBe(
+                'https://docs.company.com/some/path'
+            );
+            expect(prefixedVariantInSection.toAbsoluteURL('some/path')).toBe(
+                'https://docs.company.com/some/path'
+            );
+        });
+    });
+});

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

@@ -1,17 +1,27 @@
-import { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
 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.
+ *
+ * URL levels:
+ *
+ * https://docs.company.com/section/variant/page
+ *
+ * toPathInContent('some/path') => /section/variant/some/path
+ * toPathForPage({ pages, page }) => /section/variant/some/path
+ * toAbsoluteURL('some/path') => https://docs.company.com/some/path
  */
 export interface GitBookSpaceLinker {
     /**
-     * Generate an absolute path for a relative path in the current space content.
+     * Generate an absolute path for a relative path to the current content.
      */
-    toPathInSpace(relativePath: string): string;
+    toPathInContent(relativePath: string): string;
 
     /**
-     * Generate an absolute path for a page in the current space.
+     * Generate an absolute path for a page in the current content.
+     * The result should NOT be passed to `toPathInContent`.
      */
     toPathForPage(input: {
         pages: RevisionPage[];
@@ -20,9 +30,14 @@ export interface GitBookSpaceLinker {
     }): string;
 
     /**
-     * Generate an absolute URL for a given path.
+     * Generate an absolute URL for a given path relative to the host of the current content.
      */
     toAbsoluteURL(absolutePath: string): string;
+
+    /**
+     * Generate a link (URL or path) for a GitBook content URL (url of another site)
+     */
+    toLinkForContent(url: string): string;
 }
 
 /**
@@ -32,25 +47,31 @@ 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('/')) {
-        throw new Error('Host cannot include a slash');
     }
+): GitBookSpaceLinker {
+    warnOnce(!servedOn.host, 'No host provided to createLinker. It can lead to issues with links.');
 
     const linker: GitBookSpaceLinker = {
-        toPathInSpace(relativePath: string): string {
+        toPathInContent(relativePath: string): string {
             return joinPaths(servedOn.pathname, relativePath);
         },
 
         toAbsoluteURL(absolutePath: string): string {
+            if (!servedOn.host) {
+                return absolutePath;
+            }
+
             return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
         },
 
         toPathForPage({ pages, page, anchor }) {
-            return linker.toPathInSpace(getPagePath(pages, page)) + (anchor ? '#' + anchor : '');
+            return linker.toPathInContent(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
+        },
+
+        toLinkForContent(url: string): string {
+            return url;
         },
     };
 
@@ -60,32 +81,36 @@ export function createLinker(
 /**
  * Append a prefix to a linker.
  */
-export function appendPrefixToLinker(
+export function appendBasePathToLinker(
     linker: GitBookSpaceLinker,
-    prefix: string,
+    basePath: string
 ): GitBookSpaceLinker {
     const linkerWithPrefix: GitBookSpaceLinker = {
-        toPathInSpace(relativePath: string): string {
-            return linker.toPathInSpace(joinPaths(prefix, relativePath));
+        toPathInContent(relativePath: string): string {
+            return linker.toPathInContent(joinPaths(basePath, relativePath));
         },
 
         toAbsoluteURL(absolutePath: string): string {
-            return linker.toAbsoluteURL(joinPaths(prefix, absolutePath));
+            return linker.toAbsoluteURL(absolutePath);
         },
 
         toPathForPage({ pages, page, anchor }) {
             return (
-                linkerWithPrefix.toPathInSpace(getPagePath(pages, page)) +
-                (anchor ? '#' + anchor : '')
+                linkerWithPrefix.toPathInContent(getPagePath(pages, page)) +
+                (anchor ? `#${anchor}` : '')
             );
         },
+
+        toLinkForContent(url: string): string {
+            return linker.toLinkForContent(url);
+        },
     };
 
     return linkerWithPrefix;
 }
 
 function joinPaths(prefix: string, path: string): string {
-    const prefixPath = prefix.endsWith('/') ? prefix : prefix + '/';
+    const prefixPath = prefix.endsWith('/') ? prefix : `${prefix}/`;
     const suffixPath = path.startsWith('/') ? path.slice(1) : path;
     return prefixPath + suffixPath;
 }

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

@@ -1,14 +1,46 @@
-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',
 }
 
 /**
  * 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 +52,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 +98,17 @@ 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;
+}

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,50 +1,74 @@
-import { NextResponse } from 'next/server';
+import { CustomizationThemeMode, GitBookAPIError } from '@gitbook/api';
 import type { NextRequest } from 'next/server';
-import { GitBookAPIError } from '@gitbook/api';
+import { NextResponse } from 'next/server';
 
-import { removeTrailingSlash } from '@/lib/paths';
-import { MiddlewareHeaders } from '@v2/lib/middleware';
+import { getContentSecurityPolicy } from '@/lib/csp';
+import { validateSerializedCustomization } from '@/lib/customization';
+import { removeLeadingSlash, removeTrailingSlash } from '@/lib/paths';
+import { getResponseCookiesForVisitorAuth, getVisitorToken } from '@/lib/visitor-token';
+import { serveResizedImage } from '@/routes/image';
 import { getPublishedContentByURL } 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) {
-    const extracted = extractURL(request);
-    if (extracted) {
-        return serveSiteByURL(request, extracted);
-    }
+    try {
+        // Route all requests to a site
+        const extracted = getSiteURLFromRequest(request);
+        if (extracted) {
+            /**
+             * 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 (extracted.url.pathname.endsWith('/~gitbook/image')) {
+                return await serveResizedImage(request, {
+                    host: extracted.url.host,
+                });
+            }
 
-    return NextResponse.next();
+            return await serveSiteByURL(request, extracted);
+        }
+
+        // Handle the rest with the router default logic
+        return NextResponse.next();
+    } catch (error) {
+        return serveErrorResponse(error as Error);
+    }
 }
 
 /**
  * Serve site by URL.
  */
 async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
-    const dynamicHeaders = getDynamicHeaders(request);
     const { url, mode } = urlWithMode;
 
+    // Visitor authentication
+    // @ts-ignore - request typing
+    const visitorToken = getVisitorToken(request, url);
+
     const result = await getPublishedContentByURL({
         url: url.toString(),
-        visitorAuthToken: null,
-        redirectOnError: false,
+        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',
     });
 
     if (result.error) {
-        if (result.error instanceof GitBookAPIError) {
-            return NextResponse.json(
-                {
-                    error: result.error.message,
-                },
-                { status: result.error.code },
-            );
-        } else {
-            throw result.error;
-        }
+        throw result.error;
     }
 
     const { data } = result;
@@ -53,59 +77,174 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
         return NextResponse.redirect(data.redirect);
     }
 
+    // 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);
-    if (dynamicHeaders) {
-        for (const [key, value] of Object.entries(dynamicHeaders)) {
-            requestHeaders.set(key, value);
-        }
+    requestHeaders.set(MiddlewareHeaders.SiteURL, `${url.origin}${data.basePath}`);
+    requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data));
+
+    // Preview of customization/theme
+    const customization = url.searchParams.get('customization');
+    if (customization && validateSerializedCustomization(customization)) {
+        routeType = 'dynamic';
+        requestHeaders.set(MiddlewareHeaders.Customization, customization);
     }
+    const theme = url.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 siteURL = `${url.host}${data.basePath}`;
 
     const route = [
         'sites',
-        dynamicHeaders ? 'dynamic' : 'static',
+        routeType,
         mode,
-        encodeURIComponent(url.host + data.basePath),
-        encodeURIComponent(removeTrailingSlash(data.pathname) || '/'),
+        encodeURIComponent(siteURL),
+        encodePathInSiteContent(data.pathname),
     ].join('/');
 
-    return NextResponse.rewrite(new URL('/' + route, request.url), {
-        headers: requestHeaders,
+    console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
+
+    const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
+    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-site-url', siteURL);
+
+    if (visitorToken) {
+        const cookies = getResponseCookiesForVisitorAuth(data.basePath, visitorToken);
+        for (const [key, value] of Object.entries(cookies)) {
+            response.cookies.set(key, value.value, value.options);
+        }
+    }
+
+    return response;
 }
 
 /**
- * The URL of the GitBook content can be passed in 2 different ways:
- * - Hostname is in the `X-GitBook-Host` header and the pathname is the path in the request URL.
- * - The request URL is matching `/url/:url`
+ * Serve an error response.
  */
-function extractURL(request: NextRequest): URLWithMode | null {
-    const xGitbookHost = request.headers.get('x-gitbook-host');
-    if (xGitbookHost) {
+function serveErrorResponse(error: Error) {
+    if (error instanceof GitBookAPIError) {
+        return new Response(error.errorMessage, {
+            status: error.code,
+            headers: { 'content-type': 'text/plain' },
+        });
+    }
+
+    throw error;
+}
+
+/**
+ * The URL of the GitBook content can be passed in 3 different ways (in order of priority):
+ * - The request has a `X-GitBook-URL` header:
+ *      URL is taken from the header.
+ * - 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 getSiteURLFromRequest(request: NextRequest): URLWithMode | null {
+    const xGitbookUrl = request.headers.get('x-gitbook-url');
+    if (xGitbookUrl) {
         return {
-            url: new URL(`https://${xGitbookHost}${request.nextUrl.pathname}`),
+            url: appendQueryParams(new URL(xGitbookUrl), request.nextUrl.searchParams),
             mode: 'url-host',
         };
     }
 
+    const isMainHost = isGitBookHostURL(request.url);
+    const isAssetsHost = isGitBookAssetsHostURL(request.url);
+
+    // /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',
         };
     }
 
+    // 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',
+        };
+    }
+
     return null;
 }
 
 /**
- * Evaluate if a request is dynamic or static.
+ * Encode path in a site content.
+ * Special paths are not encoded and passed to be handled by the route handlers.
  */
-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;
+function encodePathInSiteContent(rawPathname: string) {
+    const pathname = removeLeadingSlash(removeTrailingSlash(rawPathname));
+
+    if (pathname.match(/^~gitbook\/ogimage\/\S+$/)) {
+        return pathname;
+    }
+
+    switch (pathname) {
+        case '~gitbook/icon':
+        case '~gitbook/image':
+        case 'llms.txt':
+        case 'sitemap.xml':
+        case 'robots.txt':
+            return pathname;
+        default:
+            return 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;
 }

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,38 @@
 main = ".open-next/worker.js"
-name = "gitbook-v2"
+name = "gitbook-open-v2"
 compatibility_date = "2024-09-23"
 compatibility_flags = ["nodejs_compat"]
 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" }
+]
+
+[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" }
+]
+
+[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" }
+]

packages/gitbook/.eslintrc.json

@@ -1,31 +0,0 @@
-{
-    "extends": "next/core-web-vitals",
-    "plugins": ["import"],
-    "rules": {
-        "import/order": [
-            "error",
-            {
-                "groups": ["builtin", "external", ["internal", "parent", "sibling", "index"]],
-                "newlines-between": "always",
-                "distinctGroup": true,
-                "pathGroups": [
-                    {
-                        "pattern": "@/**",
-                        "group": "external",
-                        "position": "after"
-                    },
-                    {
-                        "pattern": "@gitbook/**",
-                        "group": "external",
-                        "position": "after"
-                    }
-                ],
-                "alphabetize": {
-                    "order": "asc",
-                    "caseInsensitive": true
-                }
-            }
-        ],
-        "@next/next/no-img-element": ["off"]
-    }
-}

packages/gitbook/CHANGELOG.md

@@ -1,5 +1,57 @@
 # gitbook
 
+## 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
+-   2ae76f9: Change how a site in proxy mode is resolved
+-   027a859: Add support for links style customization option
+-   3e11678: fix: lost section groups
+-   3319375: Support OpenAPI operation block
+-   Updated dependencies [722f02e]
+-   Updated dependencies [0924259]
+    -   @gitbook/react-openapi@1.0.4
+    -   @gitbook/openapi-parser@2.0.1
+
 ## 0.6.3
 
 ### Patch Changes

packages/gitbook/e2e/customers.spec.ts

@@ -1,4 +1,4 @@
-import { runTestCases, TestsCase, waitForCookiesDialog } from './util';
+import { type TestsCase, runTestCases } from './util';
 
 /** A list of test cases to run on the customers' docs sites. */
 const testCases: TestsCase[] = [
@@ -225,11 +225,6 @@ const testCases: TestsCase[] = [
         baseUrl: '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',

packages/gitbook/e2e/internal.spec.ts

@@ -9,12 +9,13 @@ import { expect } from '@playwright/test';
 import jwt from 'jsonwebtoken';
 
 import {
+    VISITOR_TOKEN_COOKIE,
     getVisitorAuthCookieName,
     getVisitorAuthCookieValue,
-    VISITOR_TOKEN_COOKIE,
 } from '@/lib/visitor-token';
 
 import {
+    type TestsCase,
     allDeprecatedThemePresets,
     allLocales,
     allSidebarBackgroundStyles,
@@ -24,7 +25,6 @@ import {
     getCustomizationURL,
     headerLinks,
     runTestCases,
-    TestsCase,
     waitForCookiesDialog,
 } from './util';
 
@@ -43,7 +43,7 @@ const testCases: TestsCase[] = [
                 url: '',
                 run: async (page) => {
                     await expect(page.locator('[data-testid="space-dropdown-button"]')).toHaveCount(
-                        0,
+                        0
                     );
                 },
             },
@@ -114,20 +114,20 @@ const testCases: TestsCase[] = [
                     await spaceDrowpdown.click();
 
                     const variantSelectionDropdown = page.locator(
-                        'css=[data-testid="space-dropdown-button"] + div',
+                        'css=[data-testid="space-dropdown-button"] + div'
                     );
                     // the customized space title
                     await expect(
                         variantSelectionDropdown.getByRole('link', {
                             name: 'Multi-Variants',
-                        }),
+                        })
                     ).toBeVisible();
 
                     // the NON-customized space title
                     await expect(
                         variantSelectionDropdown.getByRole('link', {
                             name: 'RFCs',
-                        }),
+                        })
                     ).toBeVisible();
                 },
             },
@@ -156,7 +156,7 @@ const testCases: TestsCase[] = [
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
                     await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions/2.0/reference/api-reference/pets?fallback=true',
+                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions/2.0/reference/api-reference/pets?fallback=true'
                     );
                 },
             },
@@ -179,7 +179,7 @@ const testCases: TestsCase[] = [
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
                     await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets?fallback=true',
+                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/2.0/reference/api-reference/pets?fallback=true'
                     );
                 },
             },
@@ -195,7 +195,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `api-multi-versions-va/reference/api-reference/pets?jwt_token=${token}`;
                 })(),
@@ -214,7 +214,38 @@ const testCases: TestsCase[] = [
 
                     // It should keep the current page path, i.e "reference/api-reference/pets" when navigating to the new variant
                     await page.waitForURL(
-                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-va/2.0/reference/api-reference/pets?fallback=true',
+                        'https://gitbook-open-e2e-sites.gitbook.io/api-multi-versions-va/2.0/reference/api-reference/pets?fallback=true'
+                    );
+                },
+            },
+        ],
+    },
+    {
+        name: 'GitBook Site (Sections and Section Groups)',
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
+        tests: [
+            {
+                name: 'Site with sections and section groups',
+                url: '',
+            },
+            {
+                name: 'Section group dropdown',
+                url: '',
+                run: async (page) => {
+                    await page.getByRole('button', { name: 'Test Section Group 1' }).hover();
+                    await expect(page.getByRole('link', { name: /Section B/ })).toBeVisible();
+                },
+            },
+            {
+                name: 'Section group link',
+                url: '',
+                screenshot: false,
+                run: async (page) => {
+                    const sectionGroupDropdown = await page.getByText('Test Section Group 1');
+                    await sectionGroupDropdown.hover();
+                    await page.getByText('Section B').click();
+                    await page.waitForURL(
+                        'https://gitbook-open-e2e-sites.gitbook.io/sections/sections-4'
                     );
                 },
             },
@@ -331,7 +362,7 @@ const testCases: TestsCase[] = [
                         for (const p of document.querySelectorAll('p')) {
                             if (
                                 p.textContent?.includes(
-                                    'This image has intrinsic 400px width, but renders as 300px:',
+                                    'This image has intrinsic 400px width, but renders as 300px:'
                                 )
                             ) {
                                 p.style.color = 'transparent';
@@ -413,7 +444,7 @@ const testCases: TestsCase[] = [
                     await page.waitForFunction(() => {
                         const fonts = Array.from(document.fonts.values());
                         const mjxFonts = fonts.filter(
-                            (font) => font.family === 'MJXZERO' || font.family === 'MJXTEX',
+                            (font) => font.family === 'MJXZERO' || font.family === 'MJXTEX'
                         );
                         return (
                             mjxFonts.length === 2 &&
@@ -505,17 +536,15 @@ const testCases: TestsCase[] = [
             },
             {
                 name: `With duotone icons - Theme mode ${themeMode}`,
-                url:
-                    'page-options/page-with-icon' +
-                    getCustomizationURL({
-                        styling: {
-                            icons: CustomizationIconsStyle.Duotone,
-                        },
-                        themes: {
-                            default: themeMode,
-                            toggeable: false,
-                        },
-                    }),
+                url: `page-options/page-with-icon${getCustomizationURL({
+                    styling: {
+                        icons: CustomizationIconsStyle.Duotone,
+                    },
+                    themes: {
+                        default: themeMode,
+                        toggeable: false,
+                    },
+                })}`,
                 run: waitForCookiesDialog,
             },
             {
@@ -643,7 +672,7 @@ const testCases: TestsCase[] = [
                     const sharedSpaceLink = page.locator('a.underline');
                     await sharedSpaceLink.click();
                     await expect(
-                        page.getByRole('heading', { level: 1, name: 'shared' }),
+                        page.getByRole('heading', { level: 1, name: 'shared' })
                     ).toBeVisible();
                     const url = page.url();
                     expect(url.includes('shared-space-uno')).toBeTruthy(); // same uno site
@@ -663,7 +692,7 @@ const testCases: TestsCase[] = [
                 run: async (page) => {
                     await page.locator('a.underline').click();
                     await expect(
-                        page.getByRole('heading', { level: 1, name: 'shared' }),
+                        page.getByRole('heading', { level: 1, name: 'shared' })
                     ).toBeVisible();
                     const url = page.url();
                     expect(url.includes('shared-space-dos')).toBeTruthy(); // same dos site
@@ -700,7 +729,7 @@ const testCases: TestsCase[] = [
                 url: 'invalid/',
                 run: async (page) => {
                     await expect(
-                        page.getByText('Authentication missing to access this content'),
+                        page.getByText('Authentication missing to access this content')
                     ).toBeVisible();
                 },
                 screenshot: false,
@@ -709,7 +738,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Space',
-        baseUrl: `https://gitbook.gitbook.io/gbo-va-space/`,
+        baseUrl: 'https://gitbook.gitbook.io/gbo-va-space/',
         tests: [
             {
                 name: 'First',
@@ -722,13 +751,13 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `first?jwt_token=${token}`;
                 })(),
                 run: async (page) => {
                     await expect(
-                        page.getByRole('heading', { level: 1, name: 'first' }),
+                        page.getByRole('heading', { level: 1, name: 'first' })
                     ).toBeVisible();
                 },
                 screenshot: false,
@@ -744,13 +773,13 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `second?jwt_token=${token}`;
                 })(),
                 run: async (page) => {
                     await expect(
-                        page.getByRole('heading', { level: 1, name: 'second' }),
+                        page.getByRole('heading', { level: 1, name: 'second' })
                     ).toBeVisible();
                 },
                 screenshot: false,
@@ -759,7 +788,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Collection',
-        baseUrl: `https://gitbook.gitbook.io/gbo-va-collection/`,
+        baseUrl: 'https://gitbook.gitbook.io/gbo-va-collection/',
         tests: [
             {
                 name: 'Root',
@@ -772,7 +801,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `?jwt_token=${token}`;
                 })(),
@@ -789,7 +818,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `spacea?jwt_token=${token}`;
                 })(),
@@ -806,7 +835,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `spaceb?jwt_token=${token}`;
                 })(),
@@ -823,7 +852,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `spacec?jwt_token=${token}`;
                 })(),
@@ -833,7 +862,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Space (custom domain)',
-        baseUrl: `https://test.gitbook.community/`,
+        baseUrl: 'https://test.gitbook.community/',
         tests: [
             {
                 name: 'Root',
@@ -846,7 +875,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `?jwt_token=${token}`;
                 })(),
@@ -863,13 +892,13 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `first?jwt_token=${token}`;
                 })(),
                 run: async (page) => {
                     await expect(
-                        page.getByRole('heading', { level: 1, name: 'first' }),
+                        page.getByRole('heading', { level: 1, name: 'first' })
                     ).toBeVisible();
                 },
                 screenshot: false,
@@ -885,7 +914,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `custom-page?jwt_token=${token}`;
                 })(),
@@ -902,7 +931,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `custom-page/inner-page?jwt_token=${token}`;
                 })(),
@@ -912,7 +941,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Visitor Auth - Site (redirects to fallback/auth URL)',
-        baseUrl: `https://gitbook-open-e2e-sites.gitbook.io/va-site-redirects-fallback/`,
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/va-site-redirects-fallback/',
         tests: [
             {
                 name: 'Redirect to fallback on invalid token pulled from cookie',
@@ -927,7 +956,7 @@ const testCases: TestsCase[] = [
                         'invalidKey',
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return [
                         {
@@ -952,13 +981,13 @@ const testCases: TestsCase[] = [
                         'invalidKey',
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     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.',
+                        'Error while validating the JWT token. Reason: The token signature is invalid.'
                     );
                 },
             },
@@ -985,7 +1014,7 @@ const testCases: TestsCase[] = [
         baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
         tests: [
             {
-                name: `Index by default`,
+                name: 'Index by default',
                 url: '?x-gitbook-search-indexation=true',
                 screenshot: false,
                 run: async (page) => {
@@ -1033,7 +1062,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Adaptive Content - VA',
-        baseUrl: `https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/`,
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/',
         tests: [
             {
                 name: 'isAlphaUser',
@@ -1047,7 +1076,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `?jwt_token=${token}`;
                 })(),
@@ -1074,7 +1103,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `?jwt_token=${token}`;
                 })(),
@@ -1102,7 +1131,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return `?jwt_token=${token}`;
                 })(),
@@ -1121,7 +1150,7 @@ const testCases: TestsCase[] = [
     },
     {
         name: 'Adaptive Content - Public',
-        baseUrl: `https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-public/`,
+        baseUrl: 'https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-public/',
         tests: [
             {
                 name: 'No custom cookie',
@@ -1154,7 +1183,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return [
                         {
@@ -1193,7 +1222,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return [
                         {
@@ -1233,7 +1262,7 @@ const testCases: TestsCase[] = [
                         privateKey,
                         {
                             expiresIn: '24h',
-                        },
+                        }
                     );
                     return [
                         {
@@ -1274,25 +1303,21 @@ const testCases: TestsCase[] = [
             },
             {
                 name: 'Table with straight corners',
-                url:
-                    'blocks/tables' +
-                    getCustomizationURL({
-                        styling: {
-                            corners: CustomizationCorners.Straight,
-                        },
-                    }),
+                url: `blocks/tables${getCustomizationURL({
+                    styling: {
+                        corners: CustomizationCorners.Straight,
+                    },
+                })}`,
                 run: waitForCookiesDialog,
                 fullPage: true,
             },
             {
                 name: 'Table with primary color',
-                url:
-                    'blocks/tables' +
-                    getCustomizationURL({
-                        styling: {
-                            tint: { color: { light: '#346DDB', dark: '#346DDB' } },
-                        },
-                    }),
+                url: `blocks/tables${getCustomizationURL({
+                    styling: {
+                        tint: { color: { light: '#346DDB', dark: '#346DDB' } },
+                    },
+                })}`,
                 run: waitForCookiesDialog,
                 fullPage: true,
             },
@@ -1300,46 +1325,40 @@ const testCases: TestsCase[] = [
             ...allThemeModes.flatMap((theme) => [
                 {
                     name: `Table in ${theme} mode`,
-                    url:
-                        'blocks/tables' +
-                        getCustomizationURL({
-                            themes: {
-                                default: theme,
-                                toggeable: false,
-                            },
-                        }),
+                    url: `blocks/tables${getCustomizationURL({
+                        themes: {
+                            default: theme,
+                            toggeable: false,
+                        },
+                    })}`,
                     run: waitForCookiesDialog,
                     fullPage: true,
                 },
                 {
                     name: `Table with straight corners in ${theme} mode`,
-                    url:
-                        'blocks/tables' +
-                        getCustomizationURL({
-                            styling: {
-                                corners: CustomizationCorners.Straight,
-                            },
-                            themes: {
-                                default: theme,
-                                toggeable: false,
-                            },
-                        }),
+                    url: `blocks/tables${getCustomizationURL({
+                        styling: {
+                            corners: CustomizationCorners.Straight,
+                        },
+                        themes: {
+                            default: theme,
+                            toggeable: false,
+                        },
+                    })}`,
                     run: waitForCookiesDialog,
                     fullPage: true,
                 },
                 {
                     name: `Table with primary color in ${theme} mode`,
-                    url:
-                        'blocks/tables' +
-                        getCustomizationURL({
-                            styling: {
-                                tint: { color: { light: '#346DDB', dark: '#346DDB' } },
-                            },
-                            themes: {
-                                default: theme,
-                                toggeable: false,
-                            },
-                        }),
+                    url: `blocks/tables${getCustomizationURL({
+                        styling: {
+                            tint: { color: { light: '#346DDB', dark: '#346DDB' } },
+                        },
+                        themes: {
+                            default: theme,
+                            toggeable: false,
+                        },
+                    })}`,
                     run: waitForCookiesDialog,
                     fullPage: true,
                 },

packages/gitbook/e2e/util.ts

@@ -3,7 +3,7 @@ import {
     CustomizationBackground,
     CustomizationCorners,
     CustomizationFont,
-    CustomizationHeaderItem,
+    type CustomizationHeaderItem,
     CustomizationHeaderPreset,
     CustomizationIconsStyle,
     CustomizationLinksStyle,
@@ -11,14 +11,14 @@ import {
     CustomizationSidebarBackgroundStyle,
     CustomizationSidebarListStyle,
     CustomizationTheme,
-    CustomizationThemedColor,
     CustomizationThemeMode,
-    SiteCustomizationSettings,
+    type CustomizationThemedColor,
+    type SiteCustomizationSettings,
 } from '@gitbook/api';
-import { BrowserContext, expect, Page, test } from '@playwright/test';
+import { type BrowserContext, type Page, expect, test } from '@playwright/test';
 import deepMerge from 'deepmerge';
 import rison from 'rison';
-import { DeepPartial } from 'ts-essentials';
+import type { DeepPartial } from 'ts-essentials';
 
 import { getContentTestURL } from '../tests/utils';
 
@@ -151,9 +151,25 @@ export function runTestCases(testCases: TestsCase[]) {
                                 ...cookie,
                                 domain: new URL(url).host,
                                 path: '/',
-                            })),
+                            }))
                         );
                     }
+
+                    // 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);
@@ -231,11 +247,11 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
             font: CustomizationFont.Inter,
             background: CustomizationBackground.Plain,
             icons: CustomizationIconsStyle.Regular,
+            links: CustomizationLinksStyle.Default,
             sidebar: {
                 background: CustomizationSidebarBackgroundStyle.Default,
                 list: CustomizationSidebarListStyle.Default,
             },
-            links: CustomizationLinksStyle.Default,
         },
         internationalization: {
             locale: CustomizationLocale.En,
@@ -296,7 +312,7 @@ async function waitForIcons(page: Page) {
             return new Promise((resolve, reject) => {
                 const img = new Image();
                 img.onload = () => resolve(img);
-                img.onerror = (error) => reject(new Error(`Failed to load image: ${src}`));
+                img.onerror = (_error) => reject(new Error(`Failed to load image: ${src}`));
                 img.src = src;
             });
         }
@@ -312,7 +328,7 @@ async function waitForIcons(page: Page) {
                     throw new Error('No mask-image');
                 }
                 await loadImage(url);
-            }),
+            })
         );
     });
 }
@@ -327,7 +343,7 @@ async function waitForTOCScrolling(page: Page) {
         await expect(toc).toBeVisible();
         await page.evaluate(() => {
             const tocScrollContainer = document.querySelector(
-                '[data-testid="table-of-contents"] [data-testid="toc-scroll-container"]',
+                '[data-testid="table-of-contents"] [data-testid="toc-scroll-container"]'
             );
             if (!tocScrollContainer) {
                 throw new Error('TOC scroll container not found');

packages/gitbook/next.config.js

@@ -34,7 +34,7 @@ module.exports = withSentryConfig(
                         __RRWEB_EXCLUDE_IFRAME__: true,
                         __RRWEB_EXCLUDE_SHADOW_DOM__: true,
                         __SENTRY_EXCLUDE_REPLAY_WORKER__: true,
-                    }),
+                    })
                 );
             }
 
@@ -79,5 +79,5 @@ module.exports = withSentryConfig(
         // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load)
         tunnelRoute: '/~gitbook/monitoring',
         disableLogger: true,
-    },
+    }
 );

packages/gitbook/package.json

@@ -1,13 +1,12 @@
 {
     "name": "gitbook",
-    "version": "0.6.3",
+    "version": "0.7.1",
     "private": true,
     "scripts": {
         "dev": "env-cmd --silent -f ../../.env.local next dev",
         "build": "next build",
         "build:cloudflare": "next-on-pages --custom-entrypoint=./src/cloudflare-entrypoint.ts",
         "start": "next start",
-        "lint": "next lint",
         "typecheck": "tsc --noEmit",
         "e2e": "playwright test e2e/internal.spec.ts",
         "e2e-customers": "playwright test e2e/customers.spec.ts",
@@ -17,8 +16,9 @@
         "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math"
     },
     "dependencies": {
-        "@gitbook/api": "^0.96.0",
+        "@gitbook/api": "0.96.1",
         "@gitbook/cache-do": "workspace:*",
+        "@gitbook/cache-tags": "workspace:*",
         "@gitbook/colors": "workspace:*",
         "@gitbook/emoji-codepoints": "workspace:*",
         "@gitbook/icons": "workspace:*",
@@ -38,7 +38,6 @@
         "assert-never": "^1.2.1",
         "bun-types": "^1.1.20",
         "classnames": "^2.5.1",
-        "content-security-policy-merger": "^1.0.0",
         "framer-motion": "^10.16.14",
         "js-cookie": "^3.0.5",
         "jsontoxml": "^1.0.1",
@@ -64,7 +63,9 @@
         "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",
@@ -86,9 +87,6 @@
         "autoprefixer": "^10",
         "deepmerge": "^4.3.1",
         "env-cmd": "^10.1.0",
-        "eslint": "^8",
-        "eslint-config-next": "^14.2.5",
-        "eslint-plugin-import": "^2.29.1",
         "jsonwebtoken": "^9.0.2",
         "postcss": "^8",
         "psi": "^4.1.0",

packages/gitbook/src/app/(global)/~gitbook/image/route.ts

@@ -1,124 +1,9 @@
-import {
-    resizeImage,
-    checkIsSizableImageURL,
-    CloudflareImageOptions,
-    CURRENT_SIGNATURE_VERSION,
-    isSignatureVersion,
-    SignatureVersion,
-    verifyImageSignature,
-    parseImageAPIURL,
-} from '@v2/lib/images';
-import { NextRequest, NextResponse } from 'next/server';
+import type { NextRequest } from 'next/server';
 
-import { getHost } from '@/lib/links';
+import { serveResizedImage } from '@/routes/image';
 
 export const runtime = 'edge';
 
-/**
- * Only on Cloudflare Workers:
- *
- * Fetch and resize an image.
- */
 export async function GET(request: NextRequest) {
-    let urlParam = request.nextUrl.searchParams.get('url');
-    const signature = request.nextUrl.searchParams.get('sign');
-
-    if (!urlParam || !signature) {
-        return new Response('Missing url/sign parameters', { status: 400 });
-    }
-
-    const signatureVersion = parseSignatureVersion(request.nextUrl.searchParams.get('sv'));
-    if (!signatureVersion) {
-        return new Response(`Invalid sv parameter`, { status: 400 });
-    }
-
-    const url = parseImageAPIURL(urlParam);
-
-    // Check again if the image can be sized, even though we checked when rendering the Image component
-    // Otherwise, it's possible to pass just any link to this endpoint and trigger HTML injection on the domain
-    // Also prevent infinite redirects.
-    if (!checkIsSizableImageURL(url)) {
-        return new Response('Invalid url parameter', { status: 400 });
-    }
-
-    // Verify the signature
-    const verified = await verifyImageSignature(
-        {
-            url,
-            host: await getHost(),
-        },
-        { signature, version: signatureVersion },
-    );
-    if (!verified) {
-        return new Response(`Invalid signature "${signature ?? ''}" for "${url}"`, { status: 400 });
-    }
-
-    if (signatureVersion !== CURRENT_SIGNATURE_VERSION) {
-        return NextResponse.redirect(url, 302);
-    }
-
-    // Cloudflare-specific options are in the cf object.
-    const options: CloudflareImageOptions = {
-        fit: 'scale-down',
-        format: 'jpeg',
-        quality: 100,
-    };
-
-    const width = request.nextUrl.searchParams.get('width');
-    if (width) {
-        options.width = Number(width);
-    }
-
-    const height = request.nextUrl.searchParams.get('height');
-    if (height) {
-        options.height = Number(height);
-    }
-
-    const dpr = request.nextUrl.searchParams.get('dpr');
-    if (dpr) {
-        options.dpr = Number(dpr);
-    }
-
-    const quality = request.nextUrl.searchParams.get('quality');
-    if (quality) {
-        options.quality = Number(quality);
-    }
-
-    // Check the Accept header to handle content negotiation
-    const accept = request.headers.get('accept');
-    if (accept && /image\/avif/.test(accept)) {
-        options.format = 'avif';
-    } else if (accept && /image\/webp/.test(accept)) {
-        options.format = 'webp';
-    }
-
-    try {
-        const response = await resizeImage(url, options);
-        if (!response.ok) {
-            throw new Error('Failed to resize image');
-        }
-
-        return response;
-    } catch (error) {
-        // Redirect to the original image if resizing fails
-        return NextResponse.redirect(url, 302);
-    }
-}
-
-/**
- * Parse the image signature version from a query param. Returns null if the version is invalid.
- */
-function parseSignatureVersion(input: string | null): SignatureVersion | null {
-    // Before introducing the sv parameter, all signatures were generated with version 0.
-    if (!input) {
-        return '0';
-    }
-
-    // If the query param explicitly asks for a signature version.
-    if (isSignatureVersion(input)) {
-        return input;
-    }
-
-    // Otherwise the version is invalid.
-    return null;
+    return serveResizedImage(request);
 }

packages/gitbook/src/app/(global)/~gitbook/revalidate/route.ts

@@ -1,4 +1,4 @@
-import { NextRequest, NextResponse } from 'next/server';
+import { type NextRequest, NextResponse } from 'next/server';
 
 import { revalidateTags } from '@/lib/cache';
 
@@ -21,7 +21,7 @@ export async function POST(req: NextRequest) {
             {
                 error: 'tags must be an array',
             },
-            { status: 400 },
+            { status: 400 }
         );
     }
 

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

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

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

@@ -1,11 +1,10 @@
-import { Metadata, Viewport } from 'next';
-import React from 'react';
+import type { Metadata, Viewport } from 'next';
 
 import {
+    type PagePathParams,
+    SitePage,
     generateSitePageMetadata,
     generateSitePageViewport,
-    SitePage,
-    PagePathParams,
 } from '@/components/SitePage';
 import { getSiteContentPointer } from '@/lib/pointer';
 import { fetchV1ContextForSitePointer } from '@/lib/v1';

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

@@ -1,13 +1,12 @@
-import { getThemeFromMiddleware } from '@v2/lib/middleware';
-import { Metadata, Viewport } from 'next';
-import React from 'react';
+import { getThemeFromMiddleware, getVisitorAuthTokenFromMiddleware } from '@v2/lib/middleware';
+import type { Metadata, Viewport } from 'next';
+import type React from 'react';
 
 import {
+    SiteLayout,
     generateSiteLayoutMetadata,
     generateSiteLayoutViewport,
-    SiteLayout,
 } from '@/components/SiteLayout';
-import { getContentSecurityPolicyNonce } from '@/lib/csp';
 import { getSiteContentPointer } from '@/lib/pointer';
 import { shouldTrackEvents } from '@/lib/tracking';
 import { fetchV1ContextForSitePointer } from '@/lib/v1';
@@ -21,16 +20,16 @@ export const dynamic = 'force-dynamic';
 export default async function ContentLayout(props: { children: React.ReactNode }) {
     const { children } = props;
 
-    const nonce = await getContentSecurityPolicyNonce();
     const context = await fetchLayoutData();
     const queryStringTheme = await getThemeFromMiddleware();
+    const visitorAuthToken = await getVisitorAuthTokenFromMiddleware();
 
     return (
         <SiteLayout
             context={context}
-            nonce={nonce}
             forcedTheme={queryStringTheme}
             withTracking={await shouldTrackEvents()}
+            visitorAuthToken={visitorAuthToken}
         >
             {children}
         </SiteLayout>

packages/gitbook/src/app/middleware/(site)/(core)/llms.txt/route.ts

@@ -1,154 +1,14 @@
-import { SiteSection, SiteSpace, SiteStructure } from '@gitbook/api';
-import assertNever from 'assert-never';
-import { ListItem, Paragraph, Root, RootContent } from 'mdast';
-import { toMarkdown } from 'mdast-util-to-markdown';
-import { NextRequest } from 'next/server';
+import type { NextRequest } from 'next/server';
 
-import { getPublishedContentSite, getRevisionPages } from '@/lib/api';
-import { getAbsoluteHref } from '@/lib/links';
-import { getPagePath } from '@/lib/pages';
-import { joinPath } from '@/lib/paths';
-import { checkIsRootPointer, getSiteContentPointer } from '@/lib/pointer';
-import { getIndexablePages } from '@/lib/sitemap';
-import { getSiteStructureSections } from '@/lib/sites';
+import { getSiteContentPointer } from '@/lib/pointer';
+import { fetchV1ContextForSitePointer } from '@/lib/v1';
+import { serveLLMsTxt } from '@/routes/llms';
 
 export const runtime = 'edge';
 
-/**
- * Generate a llms.txt file for the site.
- */
-export async function GET(req: NextRequest) {
+export async function GET(_req: NextRequest) {
     const pointer = await getSiteContentPointer();
+    const context = await fetchV1ContextForSitePointer(pointer);
 
-    const { structure: siteStructure, site } = await getPublishedContentSite({
-        organizationId: pointer.organizationId,
-        siteId: pointer.siteId,
-        siteShareKey: pointer.siteShareKey,
-    });
-
-    if (!checkIsRootPointer(pointer, siteStructure)) {
-        return new Response('llms.txt is only served from the root of the site', { status: 404 });
-    }
-
-    const tree: Root = {
-        type: 'root',
-        children: [
-            {
-                type: 'heading',
-                depth: 1,
-                children: [{ type: 'text', value: site.title }],
-            },
-            ...(await getNodesFromSiteStructure(siteStructure)),
-        ],
-    };
-
-    return new Response(
-        toMarkdown(tree, {
-            bullet: '-',
-        }),
-        {
-            headers: {
-                'Content-Type': 'text/plain; charset=utf-8',
-            },
-        },
-    );
-}
-
-/**
- * Get MDAST nodes from site structure.
- */
-async function getNodesFromSiteStructure(siteStructure: SiteStructure): Promise<RootContent[]> {
-    switch (siteStructure.type) {
-        case 'sections':
-            return getNodesFromSections(getSiteStructureSections(siteStructure));
-        case 'siteSpaces':
-            return getNodesFromSiteSpaces(siteStructure.structure, { heading: true });
-        default:
-            assertNever(siteStructure);
-    }
-}
-
-/**
- * Get MDAST nodes from site sections.
- */
-async function getNodesFromSections(siteSections: SiteSection[]): Promise<RootContent[]> {
-    const all = await Promise.all(
-        siteSections.map(async (siteSection): Promise<RootContent[]> => {
-            const siteSpaceNodes = await getNodesFromSiteSpaces(siteSection.siteSpaces, {
-                heading: false,
-            });
-            return [
-                {
-                    type: 'heading',
-                    depth: 2,
-                    children: [{ type: 'text', value: siteSection.title }],
-                },
-                ...siteSpaceNodes,
-            ];
-        }),
-    );
-    return all.flat();
-}
-
-/**
- * Get MDAST nodes from site spaces.
- */
-async function getNodesFromSiteSpaces(
-    siteSpaces: SiteSpace[],
-    options: {
-        /**
-         * Includes a heading for each site space.
-         */
-        heading?: boolean;
-    },
-): Promise<RootContent[]> {
-    const all = await Promise.all(
-        siteSpaces.map(async (siteSpace): Promise<RootContent[]> => {
-            const siteSpaceUrl = siteSpace.urls.published;
-            if (!siteSpaceUrl) {
-                return [];
-            }
-            const rootPages = await getRevisionPages(siteSpace.space.id, siteSpace.space.revision, {
-                metadata: false,
-            });
-            const pages = getIndexablePages(rootPages);
-            const listChildren = await Promise.all(
-                pages.map(async ({ page }): Promise<ListItem> => {
-                    const url = await getAbsoluteHref(
-                        joinPath(new URL(siteSpaceUrl).pathname, getPagePath(rootPages, page)),
-                        true,
-                    );
-                    const children: Paragraph['children'] = [
-                        {
-                            type: 'link',
-                            url,
-                            children: [{ type: 'text', value: page.title }],
-                        },
-                    ];
-                    if (page.description) {
-                        children.push({ type: 'text', value: `: ${page.description}` });
-                    }
-                    return {
-                        type: 'listItem',
-                        children: [{ type: 'paragraph', children }],
-                    };
-                }),
-            );
-            const nodes: RootContent[] = [];
-            if (options.heading) {
-                nodes.push({
-                    type: 'heading',
-                    depth: 2,
-                    children: [{ type: 'text', value: siteSpace.title }],
-                });
-            }
-            nodes.push({
-                type: 'list',
-                spread: false,
-                children: listChildren,
-            });
-            return nodes;
-        }),
-    );
-    return all.flat();
+    return serveLLMsTxt(context);
 }

packages/gitbook/src/app/middleware/(site)/(core)/robots.txt/route.ts

@@ -1,31 +1,14 @@
-import { NextRequest } from 'next/server';
+import type { NextRequest } from 'next/server';
 
-import { getSite } from '@/lib/api';
-import { getAbsoluteHref } from '@/lib/links';
 import { getSiteContentPointer } from '@/lib/pointer';
-import { isSiteIndexable } from '@/lib/seo';
+import { fetchV1ContextForSitePointer } from '@/lib/v1';
+import { serveRobotsTxt } from '@/routes/robots';
 
 export const runtime = 'edge';
 
-/**
- * Generate a robots.txt for the current space.
- */
-export async function GET(req: NextRequest) {
+export async function GET(_request: NextRequest) {
     const pointer = await getSiteContentPointer();
-    const site = await getSite(pointer.organizationId, pointer.siteId);
+    const context = await fetchV1ContextForSitePointer(pointer);
 
-    const lines = [
-        `User-agent: *`,
-        'Disallow: /~gitbook/',
-        ...((await isSiteIndexable(site))
-            ? [`Allow: /`, `Sitemap: ${await getAbsoluteHref(`/sitemap.xml`, true)}`]
-            : [`Disallow: /`]),
-    ];
-    const content = lines.join('\n');
-
-    return new Response(content, {
-        headers: {
-            'Content-Type': 'text/plain',
-        },
-    });
+    return serveRobotsTxt(context);
 }

packages/gitbook/src/app/middleware/(site)/(core)/sitemap-pages.xml/route.ts

@@ -1,66 +1,12 @@
-import jsontoxml from 'jsontoxml';
-
-import { getRevisionPages, getSpace } from '@/lib/api';
-import { getAbsoluteHref } from '@/lib/links';
-import { getPagePath } from '@/lib/pages';
 import { getSiteContentPointer } from '@/lib/pointer';
-import { getIndexablePages } from '@/lib/sitemap';
+import { fetchV1ContextForSitePointer } from '@/lib/v1';
+import { servePagesSitemap } from '@/routes/sitemap';
 
 export const runtime = 'edge';
 
-/**
- * Generate a sitemap.xml for the current section / space.
- */
 export async function GET() {
     const pointer = await getSiteContentPointer();
+    const context = await fetchV1ContextForSitePointer(pointer);
 
-    const revisionId =
-        pointer.revisionId ?? (await getSpace(pointer.spaceId, pointer.siteShareKey)).revision;
-
-    const rootPages = await getRevisionPages(pointer.spaceId, revisionId, { metadata: false });
-
-    const pages = getIndexablePages(rootPages);
-
-    const urls = await Promise.all(
-        pages.map(async ({ page, depth }) => {
-            // Decay priority with depth
-            const priority = Math.pow(2, -0.25 * depth);
-            // Normalize to keep 2 decimals
-            const normalizedPriority = Math.floor(100 * priority) / 100;
-            const lastModified = page.updatedAt || page.createdAt;
-
-            const url: { loc: string; priority: number; lastmod?: string } = {
-                priority: normalizedPriority,
-                loc: await getAbsoluteHref(getPagePath(rootPages, page), true),
-            };
-
-            if (lastModified) {
-                url.lastmod = new Date(lastModified).toISOString();
-            }
-
-            return { url };
-        }),
-    );
-
-    const xml = jsontoxml(
-        [
-            {
-                name: 'urlset',
-                children: urls,
-                attrs: {
-                    xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9',
-                },
-            },
-        ],
-        {
-            xmlHeader: true,
-            prettyPrint: true,
-        },
-    );
-
-    return new Response(xml, {
-        headers: {
-            'Content-Type': 'application/xml',
-        },
-    });
+    return servePagesSitemap(context);
 }

packages/gitbook/src/app/middleware/(site)/(core)/sitemap.xml/route.ts

@@ -1,98 +1,12 @@
-import { SiteSection, SiteSpace, SiteStructure } from '@gitbook/api';
-import assertNever from 'assert-never';
-import jsontoxml from 'jsontoxml';
-
-import { getPublishedContentSite } from '@/lib/api';
-import { joinPath } from '@/lib/paths';
-import { checkIsRootPointer, getSiteContentPointer } from '@/lib/pointer';
-import { getSiteStructureSections } from '@/lib/sites';
-import { filterOutNullable } from '@/lib/typescript';
+import { getSiteContentPointer } from '@/lib/pointer';
+import { fetchV1ContextForSitePointer } from '@/lib/v1';
+import { serveRootSitemap } from '@/routes/sitemap';
 
 export const runtime = 'edge';
 
-/**
- * Generate a root sitemap that point to all sitemap-pages.xml.
- */
 export async function GET() {
     const pointer = await getSiteContentPointer();
+    const context = await fetchV1ContextForSitePointer(pointer);
 
-    const { structure: siteStructure } = await getPublishedContentSite({
-        organizationId: pointer.organizationId,
-        siteId: pointer.siteId,
-        siteShareKey: pointer.siteShareKey,
-    });
-
-    if (!checkIsRootPointer(pointer, siteStructure)) {
-        return new Response('Root sitemap is only served from the root of the site', {
-            status: 404,
-        });
-    }
-
-    const urls = await getUrlsFromSiteStructure(siteStructure);
-
-    const xml = jsontoxml(
-        [
-            {
-                name: 'sitemapindex',
-                children: urls.map((url) => ({
-                    name: 'sitemap',
-                    children: [{ name: 'loc', text: url }],
-                })),
-                attrs: {
-                    xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9',
-                },
-            },
-        ],
-        {
-            xmlHeader: true,
-            prettyPrint: true,
-        },
-    );
-
-    return new Response(xml, {
-        headers: {
-            'Content-Type': 'application/xml',
-        },
-    });
-}
-
-/**
- * Get Sitemap URLs from site structure.
- */
-async function getUrlsFromSiteStructure(siteStructure: SiteStructure): Promise<string[]> {
-    switch (siteStructure.type) {
-        case 'sections':
-            return getUrlsFromSiteSections(getSiteStructureSections(siteStructure));
-        case 'siteSpaces':
-            return getUrlsFromSiteSpaces(siteStructure.structure);
-        default:
-            assertNever(siteStructure);
-    }
-}
-
-/**
- * Get Sitemap URLs from site sections.
- */
-async function getUrlsFromSiteSections(siteSections: SiteSection[]): Promise<string[]> {
-    const urls = await Promise.all(
-        siteSections.map(async (siteSection) => getUrlsFromSiteSpaces(siteSection.siteSpaces), []),
-    );
-    return urls.flat();
-}
-
-/**
- * Get Sitemap URLs from site spaces.
- */
-async function getUrlsFromSiteSpaces(siteSpaces: SiteSpace[]): Promise<string[]> {
-    const urls = await Promise.all(
-        siteSpaces.map(async (siteSpace) => {
-            if (!siteSpace.urls.published) {
-                return null;
-            }
-            const url = new URL(siteSpace.urls.published);
-            url.pathname = joinPath(url.pathname, 'sitemap-pages.xml');
-            return url.toString();
-        }, []),
-    );
-    return urls.filter(filterOutNullable);
+    return serveRootSitemap(context);
 }

packages/gitbook/src/app/middleware/(site)/(core)/~gitbook/icon/route.tsx

@@ -1,93 +1,14 @@
-import { notFound } from 'next/navigation';
-import { ImageResponse } from 'next/og';
-import { NextRequest } from 'next/server';
-import React from 'react';
+import type { NextRequest } from 'next/server';
 
-import { getEmojiForCode } from '@/lib/emojis';
 import { getSiteContentPointer } from '@/lib/pointer';
-import { tcls } from '@/lib/tailwind';
 import { fetchV1ContextForSitePointer } from '@/lib/v1';
+import { serveIcon } from '@/routes/icon';
 
 export const runtime = 'edge';
 
-const SIZES = {
-    /** Size for a favicon */
-    small: {
-        width: 48,
-        height: 48,
-        textSize: 'text-[32px]',
-        boxStyle: 'rounded-[8px]',
-    },
-    /** Size for display as an app icon or in the header */
-    medium: {
-        width: 256,
-        height: 256,
-        textSize: 'text-[164px]',
-        boxStyle: 'rounded-[32px]',
-    },
-};
-
-/**
- * Render an icon for the space.
- */
 export async function GET(req: NextRequest) {
-    const options = getOptions(req.url);
-    const size = SIZES[options.size];
-
     const pointer = await getSiteContentPointer();
+    const context = await fetchV1ContextForSitePointer(pointer);
 
-    const { site, customization } = await fetchV1ContextForSitePointer(pointer);
-    const contentTitle = site.title;
-
-    return new ImageResponse(
-        (
-            <div
-                tw={tcls(options.theme === 'light' ? 'bg-white' : 'bg-black', size.boxStyle)}
-                style={{
-                    width: '100%',
-                    height: '100%',
-                    display: 'flex',
-                    alignItems: 'center',
-                    justifyContent: 'center',
-                }}
-            >
-                <h2
-                    tw={tcls(
-                        size.textSize,
-                        'font-bold',
-                        'tracking-tight',
-                        options.theme === 'light' ? 'text-black' : 'text-white',
-                    )}
-                >
-                    {'emoji' in customization.favicon
-                        ? getEmojiForCode(customization.favicon.emoji)
-                        : contentTitle.slice(0, 1).toUpperCase()}
-                </h2>
-            </div>
-        ),
-        {
-            width: size.width,
-            height: size.height,
-        },
-    );
-}
-
-function getOptions(inputUrl: string): {
-    size: keyof typeof SIZES;
-    theme: 'light' | 'dark';
-} {
-    const url = new URL(inputUrl);
-    const sizeParam = (url.searchParams.get('size') ?? 'small') as keyof typeof SIZES;
-    const themeParam = url.searchParams.get('theme') ?? 'light';
-
-    if (!SIZES[sizeParam] || !['light', 'dark'].includes(themeParam)) {
-        notFound();
-    }
-
-    return {
-        // @ts-ignore
-        size: sizeParam,
-        // @ts-ignore
-        theme: themeParam,
-    };
+    return serveIcon(context, req);
 }

packages/gitbook/src/app/middleware/(site)/(core)/~gitbook/ogimage/[pageId]/route.tsx

@@ -1,232 +1,15 @@
-import { CustomizationHeaderPreset } from '@gitbook/api';
-import { colorContrast } from '@gitbook/colors';
-import { redirect } from 'next/navigation';
-import { ImageResponse } from 'next/og';
-import { NextRequest } from 'next/server';
-import React from 'react';
+import type { NextRequest } from 'next/server';
 
-import { PageIdParams, fetchPageData } from '@/components/SitePage';
-import { googleFontsMap } from '@/fonts';
-import { getAbsoluteHref } from '@/lib/links';
+import type { PageIdParams } from '@/components/SitePage';
 import { getSiteContentPointer } from '@/lib/pointer';
-import { filterOutNullable } from '@/lib/typescript';
 import { fetchV1ContextForSitePointer } from '@/lib/v1';
+import { serveOGImage } from '@/routes/ogimage';
 
 export const runtime = 'edge';
 
-async function loadGoogleFont(input: { fontFamily: string; text: string; weight: 400 | 700 }) {
-    const { fontFamily, text, weight } = input;
-
-    if (!text.trim()) {
-        return null;
-    }
-
-    const url = new URL('https://fonts.googleapis.com/css2');
-    url.searchParams.set('family', `${fontFamily}:wght@${weight}`);
-    url.searchParams.set('text', text);
-
-    const result = await fetch(url.href);
-
-    if (!result.ok) {
-        return null;
-    }
-
-    const css = await result.text();
-    const resource = css.match(/src: url\((.+)\) format\('(opentype|truetype)'\)/);
-    const resourceUrl = resource ? resource[1] : null;
-
-    if (resourceUrl) {
-        const response = await fetch(resourceUrl);
-        if (response.ok) {
-            const data = await response.arrayBuffer();
-            return {
-                name: fontFamily,
-                data,
-                style: 'normal' as const,
-                weight,
-            };
-        }
-    }
-
-    // If for some reason we can't load the font, we'll just use the default one
-    return null;
-}
-
-/**
- * Render the OpenGraph image for a space.
- */
-export async function GET(req: NextRequest, { params }: { params: Promise<PageIdParams> }) {
+export async function GET(_req: NextRequest, { params }: { params: Promise<PageIdParams> }) {
     const pointer = await getSiteContentPointer();
     const baseContext = await fetchV1ContextForSitePointer(pointer);
 
-    const { context, pageTarget } = await fetchPageData(baseContext, await params);
-    const { customization, site } = context;
-    const page = pageTarget?.page;
-
-    // If user configured a custom social preview, we redirect to it.
-    if (customization.socialPreview.url) {
-        redirect(customization.socialPreview.url);
-    }
-
-    // Compute all text to load only the necessary fonts
-    const contentTitle = customization.header.logo ? '' : site.title;
-    const pageTitle = page
-        ? page.title.length > 64
-            ? page.title.slice(0, 64) + '...'
-            : page.title
-        : 'Not found';
-    const pageDescription =
-        page?.description && page?.title.length <= 64
-            ? page.description.length > 164
-                ? page.description.slice(0, 164) + '...'
-                : page.description
-            : '';
-
-    const fontFamily = googleFontsMap[customization.styling.font] ?? 'Inter';
-
-    const regularText = pageDescription;
-    const boldText = `${contentTitle}${pageTitle}`;
-
-    const fonts = (
-        await Promise.all([
-            loadGoogleFont({ fontFamily, text: regularText, weight: 400 }),
-            loadGoogleFont({ fontFamily, text: boldText, weight: 700 }),
-        ])
-    ).filter(filterOutNullable);
-
-    const theme = customization.themes.default;
-    const useLightTheme = theme === 'light';
-
-    // We have no access to CSS variables, so we'll have to hardcode some values
-    const baseColors = { light: '#ffffff', dark: '#111827' };
-
-    let colors = {
-        background: baseColors[theme],
-        gradient: customization.styling.primaryColor[theme],
-        title: customization.styling.primaryColor[theme],
-        body: baseColors[useLightTheme ? 'dark' : 'light'], // Invert text on background
-    };
-
-    const [gridWhite, gridBlack] = await Promise.all([
-        getAbsoluteHref('~gitbook/static/images/ogimage-grid-white.png', true),
-        getAbsoluteHref('~gitbook/static/images/ogimage-grid-black.png', true),
-    ]);
-
-    let gridAsset = useLightTheme ? gridBlack : gridWhite;
-
-    switch (customization.header.preset) {
-        case CustomizationHeaderPreset.Custom:
-            colors = {
-                background: customization.header.backgroundColor?.[theme] || colors.background,
-                gradient: customization.header.linkColor?.[theme] || colors.gradient,
-                title: customization.header.linkColor?.[theme] || colors.title,
-                body: colorContrast(
-                    customization.header.backgroundColor?.[theme] || colors.background,
-                    [baseColors.light, baseColors.dark],
-                ),
-            };
-            gridAsset = colors.body == baseColors.light ? gridWhite : gridBlack;
-            break;
-
-        case CustomizationHeaderPreset.Bold:
-            colors = {
-                background: customization.styling.primaryColor[theme],
-                gradient: colorContrast(customization.styling.primaryColor[theme], [
-                    baseColors.light,
-                    baseColors.dark,
-                ]),
-                title: colorContrast(customization.styling.primaryColor[theme], [
-                    baseColors.light,
-                    baseColors.dark,
-                ]),
-                body: colorContrast(customization.styling.primaryColor[theme], [
-                    baseColors.light,
-                    baseColors.dark,
-                ]),
-            };
-            gridAsset = colors.body == baseColors.light ? gridWhite : gridBlack;
-            break;
-    }
-
-    const favicon = await (async () => {
-        if ('icon' in customization.favicon)
-            return (
-                <img
-                    src={customization.favicon.icon[theme]}
-                    width={40}
-                    height={40}
-                    tw="mr-4"
-                    alt="Icon"
-                />
-            );
-        if ('emoji' in customization.favicon)
-            return (
-                <span tw="text-4xl mr-4">
-                    {String.fromCodePoint(parseInt('0x' + customization.favicon.emoji))}
-                </span>
-            );
-        const src = await getAbsoluteHref(
-            `~gitbook/icon?size=medium&theme=${customization.themes.default}`,
-            true,
-        );
-        return <img src={src} alt="Icon" width={40} height={40} tw="mr-4" />;
-    })();
-
-    return new ImageResponse(
-        (
-            <div
-                tw={`justify-between p-20 relative w-full h-full flex flex-col bg-[${colors.background}] text-[${colors.body}]`}
-                style={{
-                    fontFamily,
-                }}
-            >
-                {/* Gradient */}
-                <div
-                    tw="absolute inset-0"
-                    style={{
-                        backgroundImage: `radial-gradient(ellipse 100% 100% at top right , ${colors.gradient}, ${colors.gradient}00)`,
-                        opacity: 0.5,
-                    }}
-                ></div>
-
-                {/* Grid */}
-                <img tw="absolute inset-0 w-[100vw] h-[100vh]" src={gridAsset} alt="Grid" />
-
-                {/* Logo */}
-                {customization.header.logo ? (
-                    <img
-                        alt="Logo"
-                        height={60}
-                        src={
-                            useLightTheme
-                                ? customization.header.logo.light
-                                : customization.header.logo.dark
-                        }
-                    />
-                ) : (
-                    <div tw="flex">
-                        {favicon}
-                        <h3 tw="text-4xl my-0 font-bold">{contentTitle}</h3>
-                    </div>
-                )}
-
-                {/* Title and description */}
-                <div tw="flex flex-col">
-                    <h1
-                        tw={`text-8xl my-0 tracking-tight leading-none text-left text-[${colors.title}] font-bold`}
-                    >
-                        {pageTitle}
-                    </h1>
-                    {pageDescription ? (
-                        <h2 tw="text-4xl mb-0 mt-8 w-[75%] font-normal">{pageDescription}</h2>
-                    ) : null}
-                </div>
-            </div>
-        ),
-        {
-            width: 1200,
-            height: 630,
-            fonts: fonts.length ? fonts : undefined,
-        },
-    );
+    return serveOGImage(baseContext, await params);
 }

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

@@ -32,7 +32,7 @@ export default function ErrorPage(props: {
                 'flex',
                 'items-center',
                 'justify-center',
-                'p-7',
+                'p-7'
             )}
         >
             <div>

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

@@ -50,7 +50,7 @@ export function PageControlButtons(props: {
                     'flex-col',
                     'gap-2',
                     'print:hidden',
-                    'z-50',
+                    'z-50'
                 )}
             >
                 {singlePageMode ? null : (
@@ -84,7 +84,7 @@ export function PageControlButtons(props: {
                     'items-end',
                     'gap-2',
                     'print:hidden',
-                    'z-50',
+                    'z-50'
                 )}
             >
                 {total !== pageIds.length ? (
@@ -102,7 +102,7 @@ export function PageControlButtons(props: {
                             'border',
                             'rounded-md',
                             'p-4',
-                            'max-w-sm',
+                            'max-w-sm'
                         )}
                     >
                         <Icon
@@ -140,7 +140,7 @@ export function PageControlButtons(props: {
                         'rounded-full',
                         'shadow-sm',
                         'border-slate-300',
-                        'border',
+                        'border'
                     )}
                 >
                     {t(language, 'pdf_page_of', activeIndex, pageIds.length)}

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

@@ -2,7 +2,7 @@
 
 import * as React from 'react';
 
-import { PolymorphicComponentProp } from '@/components/utils/types';
+import type { PolymorphicComponentProp } from '@/components/utils/types';
 
 export function PrintButton(props: PolymorphicComponentProp<'button'>) {
     const { className, children, ...rest } = props;