Upgrade API client

.bun-version

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

.changeset/beige-spoons-grab.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Remove unused search api method from gitbook/api/lib

.changeset/happy-plants-grab.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Hide x-gitbook-\* symbols in OpenAPI blocks

.changeset/perfect-donuts-hear.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Add support for new OpenAPI ref

.changeset/poor-rats-trade.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Fix ID not set when there is no operation summary

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

@@ -1,81 +0,0 @@
-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
-  commitTag:
-    description: 'Commit branch to associate with the deployment'
-    required: true
-  commitMessage:
-    description: 'Commit message to associate with the deployment'
-    required: true
-outputs:
-    deployment-url: 
-      description: "Deployment URL"
-      value: ${{ steps.deploy.outputs.deployment-url }}
-runs:
-    using: 'composite'
-    steps:
-        - name: Setup Bun
-          uses: ./.github/composite/setup-bun
-        - name: Install dependencies
-          run: bun install --frozen-lockfile
-          shell: bash
-          env:
-              PUPPETEER_SKIP_DOWNLOAD: 1
-        - name: Load secret
-          uses: 1password/load-secrets-action@v2
-          env:
-            OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
-            GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
-            GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
-            GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
-            NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.opItem }}/NEXT_SERVER_ACTIONS_ENCRYPTION_KEY
-            GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
-            GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
-            GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
-            GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
-            GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
-            GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
-            GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
-            GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
-            GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
-            GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
-            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
-        - name: Build worker
-          run: bun run turbo build:v2:cloudflare
-          env:
-            GITBOOK_RUNTIME: cloudflare
-          shell: bash
-        - id: deploy
-          name: Deploy to Cloudflare
-          uses: cloudflare/wrangler-action@v3.14.0
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              workingDirectory: ./
-              wranglerVersion: '4.10.0'
-              environment: ${{ inputs.environment }}
-              command: ${{ inputs.deploy == 'true' && 'deploy' || format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/wrangler.jsonc
-        - name: Outputs
-          shell: bash
-          env:
-            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
-          run: |
-              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

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

@@ -1,80 +0,0 @@
-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_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
-            GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
-            GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
-            GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
-            GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
-            GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
-            GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
-            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
-        - name: Build Project Artifacts
-          run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
-          shell: bash
-          env:
-            VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
-            VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
-            GITBOOK_RUNTIME: vercel
-        - 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

@@ -3,7 +3,16 @@ description: 'Install Bun and cache dependencies'
 runs:
     using: 'composite'
     steps:
+        # We cache dependencies even if Bun is fast to avoid downloading fontawesome too many times
+        # and impacting bandwidth there.
+        - name: Cache bun
+          uses: actions/cache@v4
+          with:
+              path: ~/.bun/install/cache
+              key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/bun.lock') }}
+              restore-keys: |
+                  ${{ runner.os }}-bun-
         - name: Setup bun
           uses: oven-sh/setup-bun@v2
           with:
-              bun-version-file: 'package.json'
+              bun-version-file: '.bun-version'

.github/workflows/ci.yaml

@@ -7,10 +7,298 @@ 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 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.11.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_ASSETS_PREFIX=https://static.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 --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_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 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.11.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 }}/static/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/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 }}/static/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/static/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
@@ -21,10 +309,22 @@ 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
@@ -39,7 +339,6 @@ 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:
@@ -55,7 +354,6 @@ jobs:
     typecheck:
         runs-on: ubuntu-latest
         name: Typecheck
-        timeout-minutes: 6
         steps:
             - name: Checkout
               uses: actions/checkout@v4

.github/workflows/deploy-preview.yaml

@@ -1,300 +0,0 @@
-name: Preview
-on:
-    pull_request:
-    push:
-      branches:
-        - main
-env:
-    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
-jobs:
-    deploy-v1-cloudflare:
-        name: Deploy v1 to Cloudflare Pages
-        runs-on: ubuntu-latest
-        environment:
-          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
-          url: ${{ steps.deploy.outputs.deployment-url }}
-        permissions:
-            contents: read
-            deployments: write
-            issues: write
-            pull-requests: write
-            checks: write
-            statuses: write
-        outputs:
-            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
-            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Sets env vars for production
-              if: github.ref == 'refs/heads/main'
-              run: |
-                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
-            - name: Build Next.js with next-on-pages
-              run: bun run turbo gitbook#build:cloudflare
-              env:
-                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
-                  GITBOOK_RUNTIME: cloudflare
-            - 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.extract-worker-id.outputs.worker-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 }}
-                  commitTag: ${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
-                  commitMessage: ${{ github.sha }}
-            - name: Extract Worker ID
-              id: extract-worker-id
-              if: ${{ !steps.deploy.outputs.deployment-url }}
-              run: |
-                if [[ "${{ steps.deploy.outputs.command-output }}" =~ Worker\ Version\ ID:\ ([0-9a-f]{8})-([0-9a-f-]+) ]]; then
-                  WORKER_ID_FIRST_PART="${BASH_REMATCH[1]}"
-                  echo "worker-url=https://${WORKER_ID_FIRST_PART}-gitbook-open-v2-preview.gitbook.workers.dev/" >> $GITHUB_OUTPUT
-                fi
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-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
-
-                      | 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
-
-                      | 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` | `2v` | `2c` |
-                      | --- | --- | --- | --- |
-                      | 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) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-cloudflare.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) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
-                  edit-mode: replace
-    visual-testing-v1:
-        runs-on: ubuntu-latest
-        name: Visual Testing v1
-        needs: deploy-v1-cloudflare
-        timeout-minutes: 8
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e
-              env:
-                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-    visual-testing-v2-vercel:
-        runs-on: ubuntu-latest
-        name: Visual Testing v2
-        needs: deploy-v2-vercel
-        timeout-minutes: 10
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'v2-vercel'
-    visual-testing-v2-cloudflare:
-        runs-on: ubuntu-latest
-        name: Visual Testing v2 (Cloudflare)
-        needs: deploy-v2-cloudflare
-        timeout-minutes: 10
-        if: startsWith(github.head_ref || github.ref_name, 'cloudflare/') || github.ref == 'refs/heads/main'
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'v2-cloudflare'
-    visual-testing-customers-v1:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers v1
-        needs: deploy-v1-cloudflare
-        timeout-minutes: 8
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{ needs.deploy-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: 8
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers-v2'
-    visual-testing-customers-v2-cloudflare:
-        runs-on: ubuntu-latest
-        name: Visual Testing Customers v2 (Cloudflare)
-        needs: deploy-v2-cloudflare
-        timeout-minutes: 8
-        if: startsWith(github.head_ref || github.ref_name, 'cloudflare/') || github.ref == 'refs/heads/main'
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers-v2'
-    pagespeed-testing-v1:
-        runs-on: ubuntu-latest
-        name: PageSpeed Testing v1
-        needs: deploy-v1-cloudflare
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run pagespeed tests
-              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
-              env:
-                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
-                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/deploy-production.yaml

@@ -1,55 +0,0 @@
-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
-              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 }}
-                  commitTag: main
-                  commitMessage: ${{ github.sha }}
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/deploy-staging.yaml

@@ -1,55 +0,0 @@
-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
-              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 }}
-                  commitTag: main
-                  commitMessage: ${{ github.sha }}
-            - name: Outputs
-              run: |
-                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

.github/workflows/publish.yaml

@@ -5,9 +5,6 @@ on:
         branches:
             - main
 
-env:
-    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
-    
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
@@ -31,7 +28,6 @@ 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

.gitignore

@@ -22,6 +22,3 @@ yarn-error.log*
 
 # Env files
 .env.local
-
-# TypeScript
-*.tsbuildinfo

.prettierignore

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

.prettierrc.json

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

.vscode/extensions.json

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

.vscode/settings.json

@@ -7,14 +7,5 @@
         ["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"
-    },
-    "[typescript]": {
-        "editor.defaultFormatter": "biomejs.biome"
-    }
 }

README.md

@@ -59,15 +59,15 @@ bun install
 4. Start your local development server.
 
 ```
-bun dev:v2
+bun dev
 ```
 
 5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
 
 examples:
 
--   http://localhost:3000/url/docs.gitbook.com
+-   http://localhost:3000/docs.gitbook.com
--   http://localhost:3000/url/open-source.gitbook.io/midjourney
+-   http://localhost:3000/open-source.gitbook.io/midjourney
 
 Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.
 

biome.json

@@ -1,176 +0,0 @@
-{
-    "$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/**/*",
-            "packages/emoji-codepoints/index.ts",
-            "packages/icons/src/data/*.json",
-            "packages/cache-do/worker-configuration.d.ts"
-        ]
-    },
-    "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

@@ -0,0 +1,22 @@
+# 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,17 +2,16 @@
     "name": "gitbook",
     "version": "0.1.0",
     "devDependencies": {
-        "@biomejs/biome": "^1.9.4",
         "@changesets/cli": "^2.27.12",
-        "turbo": "^2.5.0",
+        "prettier": "^3.0.3",
+        "turbo": "^2.4.1-canary.2",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.2.8",
+    "packageManager": "bun@1.1.18",
     "overrides": {
         "@codemirror/state": "6.4.1",
         "react": "18.3.1",
-        "react-dom": "18.3.1",
+        "react-dom": "18.3.1"
-        "@gitbook/api": "0.111.0"
     },
     "private": true,
     "scripts": {
@@ -21,20 +20,23 @@
         "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": "biome check --write ./",
+        "format": "prettier ./ --ignore-unknown --write",
-        "format:check": "biome check --diagnostic-level=error ./",
+        "format:check": "prettier ./ --ignore-unknown --list-different",
         "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,15 +21,22 @@
     },
     "devDependencies": {
         "typescript": "^5.5.3",
-        "wrangler": "^4.10.0"
+        "wrangler": "3.82.0"
     },
     "scripts": {
-        "generate": "wrangler types",
+        "generate": "wrangler types --experimental-include-runtime",
         "build": "tsc",
         "typecheck": "tsc --noEmit",
         "dev": "tsc -w",
         "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) => {
-            const result = new Set<string>();
+            let result = new Set<string>();
 
             try {
                 // List all the keys in the cache object.
@@ -149,7 +149,11 @@ export class CacheObject extends DurableObject {
                 entries.forEach((exp) => {
                     result.add(exp.k);
                 });
-            } catch (_error) {}
+            } 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);
+            }
 
             await this.reset();
             return Array.from(result);
@@ -170,7 +174,7 @@ export class CacheObject extends DurableObject {
                 const toDeleteSet = new Set<string>();
 
                 for (const [key, exp] of entries) {
-                    const timestamp = Number.parseInt(key.split('.')[1]);
+                    const timestamp = parseInt(key.split('.')[1]);
                     if (timestamp < Date.now()) {
                         toDeleteSet.add(key);
                         for (let i = 0; i < exp.c; i++) {
@@ -190,7 +194,10 @@ export class CacheObject extends DurableObject {
                 if (toDelete.length) {
                     await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
                 }
-            } catch (_error) {
+            } 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);
                 await this.reset();
             }
         });
@@ -211,10 +218,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();
-        const update: Record<string, unknown> = {};
+        let update: Record<string, unknown> = {};
         const start = performance.now();
         try {
             return await fn((arg) => {
@@ -258,7 +265,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 = Number.parseInt(key.split('.').pop()!);
+            const index = 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 } from './CacheObject';
+import type { CacheObject, CacheObjectDescriptor } 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-do/tsconfig.json

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

packages/cache-do/turbo.json

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

packages/cache-tags/CHANGELOG.md

@@ -1,25 +0,0 @@
-# @gitbook/cache-tags
-
-## 0.3.1
-
-### Patch Changes
-
-- 77397ca: Fix version of @gitbook/api referenced in package.json
-
-## 0.3.0
-
-### Minor Changes
-
-- 116575c: Improve typing of getComputedContentSourceCacheTags to match latest API specification
-
-## 0.2.0
-
-### Minor Changes
-
-- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
-
-## 0.1.0
-
-### Minor Changes
-
-- 05ffd0e: Initial version of the package

packages/cache-tags/README.md

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

packages/cache-tags/src/index.ts

@@ -1,209 +0,0 @@
-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;
-              sourceType: 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;
-          }
-        /**
-         * All data related to a translation
-         */
-        | {
-              tag: 'translation';
-              organization: string;
-              translationSettings: 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.sourceType}`;
-        case 'site':
-            return `site:${spec.site}`;
-        case 'integration':
-            return `integration:${spec.integration}`;
-        case 'openapi':
-            return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
-        case 'translation':
-            return `organization:${spec.organization}:translation:${spec.translationSettings}`;
-        default:
-            assertNever(spec);
-    }
-}
-
-/**
- * Get the cache tag for a given URL.
- */
-export function getCacheTagForURL(url: string | URL) {
-    const parsedURL = url instanceof URL ? url : new URL(url);
-    return getCacheTag({
-        tag: 'url',
-        hostname: parsedURL.hostname,
-    });
-}
-
-/**
- * Get the tags for a computed content source.
- */
-export function getComputedContentSourceCacheTags(
-    inContext: {
-        spaceId: string;
-        organizationId: string;
-    },
-    source: ComputedContentSource
-) {
-    const tags: string[] = [];
-
-    // We add the dependencies as tags, to ensure that the computed content is invalidated
-    // when the dependencies are updated.
-    const dependencies = Object.values(source.dependencies ?? {});
-    if (dependencies.length > 0) {
-        dependencies.forEach((dependency) => {
-            switch (dependency.ref.kind) {
-                case 'space':
-                    tags.push(
-                        getCacheTag({
-                            tag: 'space',
-                            space: dependency.ref.space,
-                        })
-                    );
-                    break;
-                case 'openapi':
-                    tags.push(
-                        getCacheTag({
-                            tag: 'openapi',
-                            organization: inContext.organizationId,
-                            openAPISpec: dependency.ref.spec,
-                        })
-                    );
-                    break;
-                case 'translation-language':
-                    tags.push(
-                        getCacheTag({
-                            tag: 'translation',
-                            organization: inContext.organizationId,
-                            translationSettings: dependency.ref.translationSettings,
-                        })
-                    );
-                    break;
-                default:
-                    // Do not throw for unknown dependency types
-                    // as it might mean we are lacking behind the API version
-                    break;
-            }
-        });
-    } else {
-        // Push a dummy tag, as the v1 is only using the first tag
-        tags.push(
-            getCacheTag({
-                tag: 'computed-document',
-                space: inContext.spaceId,
-                sourceType: source.type,
-            })
-        );
-    }
-
-    // We invalidate the computed content when a new version of the integration is deployed.
-
-    if (source.type.startsWith('integration:')) {
-        const integration = source.type.split(':')[1];
-        tags.push(
-            getCacheTag({
-                tag: 'integration',
-                integration,
-            })
-        );
-    }
-
-    return tags;
-}

packages/colors/CHANGELOG.md

@@ -1,25 +1,7 @@
 # @gitbook/colors
 
-## 0.3.2
-
-### Patch Changes
-
-- cdffd7c: Desaturate text colors by decreasing chroma for the last steps of the color scale
-
-## 0.3.1
-
-### Patch Changes
-
-- fb90eb0: Reduce chroma of first color scale step
-
-## 0.3.0
-
-### Minor Changes
-
-- 4f0a772: Override tint lightness if supplied color is out of bounds
-
 ## 0.2.0
 
 ### Minor Changes
 
-- 445baaa: Initial release
+-   445baaa: Initial release

packages/colors/package.json

@@ -8,7 +8,7 @@
             "default": "./dist/index.js"
         }
     },
-    "version": "0.3.2",
+    "version": "0.2.0",
     "devDependencies": {
         "typescript": "^5.5.3"
     },
@@ -17,5 +17,10 @@
         "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, DEFAULT_TINT_COLOR, LIGHT_BASE } from './colors';
+import { DARK_BASE, LIGHT_BASE, DEFAULT_TINT_COLOR } from './colors';
 
 type ColorShades = {
     [key: string]: string;
@@ -178,13 +178,12 @@ 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;
     const foregroundColor = rgbToOklch(hexToRgbArray(foreground));
     const backgroundColor = rgbToOklch(hexToRgbArray(background));
-    let mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
 
     if (mixColor && mix?.ratio && mix.ratio > 0) {
         // If defined, we mix in a (tiny) bit of the mix color with the base color.
@@ -193,20 +192,7 @@ export function colorScale(
         baseColor.H = mix.color === DEFAULT_TINT_COLOR ? baseColor.H : mixColor.H;
     }
 
-    if (
+    const mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
-        (darkMode && baseColor.L < backgroundColor.L) ||
-        (!darkMode && baseColor.L > backgroundColor.L)
-    ) {
-        // If the supplied color is outside of our lightness bounds, use the supplied color's lightness.
-        // This is mostly used to allow darker-than-dark backgrounds for brands that specifically want that look.
-        const difference = (backgroundColor.L - baseColor.L) / backgroundColor.L;
-        backgroundColor.L = baseColor.L;
-        // At the edges of the scale, the subtle lightness changes stop being perceptible. We need to amp up our mapping to still stand out.
-        const amplifier = 1;
-        mapping = mapping.map((step, index) =>
-            index < 9 ? step + step * amplifier * difference : step
-        );
-    }
 
     const result = [];
 
@@ -220,7 +206,7 @@ export function colorScale(
             continue;
         }
 
-        const chromaRatio = index === 8 || index === 9 ? 1 : index * 0.05;
+        const chromaRatio = index < 8 ? (index + 1) * 0.05 : 1;
 
         const shade = {
             L: targetL, // Blend lightness

packages/colors/tsconfig.json

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

packages/emoji-codepoints/build.ts

@@ -17,11 +17,12 @@ 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/.gitignore

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

packages/gitbook-v2/CHANGELOG.md

@@ -1,62 +1,7 @@
 # gitbook-v2
 
-## 0.2.5
-
-### Patch Changes
-
-- Updated dependencies [77397ca]
-  - @gitbook/cache-tags@0.3.1
-
-## 0.2.4
-
-### Patch Changes
-
-- 4234289: Fix incoming URL for requests that were proxied
-- Updated dependencies [116575c]
-  - @gitbook/cache-tags@0.3.0
-
-## 0.2.3
-
-### Patch Changes
-
-- 5b2bf82: Use stable site URL data for route rewrite in the middleware
-
-## 0.2.2
-
-### Patch Changes
-
-- 54ee014: Add initial support for loading custom fonts
-- bba2e52: Fix site redirects when it includes a section/variant path
-
-## 0.2.1
-
-### Patch Changes
-
-- Updated dependencies [f32bf1f]
-  - @gitbook/cache-tags@0.2.0
-
-## 0.2.0
-
-### Minor Changes
-
-- 76c7974: Add route to revalidate cached data
-
-## 0.1.2
-
-### Patch Changes
-
-- 05ffd0e: Improving data cache management for computed content
-- Updated dependencies [05ffd0e]
-  - @gitbook/cache-tags@0.1.0
-
-## 0.1.1
-
-### Patch Changes
-
-- 3e11678: fix: lost section groups
-
 ## 0.1.0
 
 ### Minor Changes
 
-- cfccc44: Setup structure and deployment for new version
+-   cfccc44: Setup structure and deployment for new version

packages/gitbook-v2/README.md

@@ -0,0 +1,104 @@
+# GitBook V2
+
+This package contains the code for an experiment new version of the GitBook renderer.
+
+The goals of this new version are:
+
+- Optimize rendering to leverage Next.js ISR and static rendering
+- Leverage Node.js runtime and bigger instances to render bigger content
+- Evaluate Vercel and Cloudflare deployment options
+
+## Deployment
+
+#### Vercel
+
+The new version is deployed automatically to Vercel using a Github Action on every push.
+
+#### Cloudflare with Opennext-js
+
+The new version is deployed automatically to Cloudflare using a Github Action on every push.
+
+## Potential issues
+
+- [ ] We can't use `dynamicIO` because our root layout needs to fetch the params (https://github.com/vercel/next.js/discussions/71927)
+- [ ] How to do `nonce` for static resources when we can't use `headers()` (dynamic API) (https://nextjs.org/docs/app/building-your-application/configuring/content-security-policy)
+
+## Structure
+
+#### Middleware:
+
+Goals:
+- Route between dynamic and static routes
+  - If a token is in the cookies => dynamic route
+  - If a token is in the url => dynamic route
+  - Else => static route
+- High performances:
+  - It should not rely on data fetching
+
+#### URLs to support:
+
+Content URLs:
+
+- `docs.company.com/page`
+  - Middleware: rewrite to `/static/url/docs.company.com/page`
+  - Page component renders the page
+- `docs.company2.com/section/page`
+  - Middleware: rewrite to `/static/url/docs.company2.com/section/page`
+  - Page component renders the page
+- `docs.company3.com/section/sitespace/page`
+  - Middleware: rewrite to `/static/url/docs.company3.com/section/sitespace/page`
+  - Page component renders the page
+
+Content URLs (adaptive content or visitor authentication):
+
+- `docs.company.com/page`
+  - Middleware:
+    - If a token is in the cookies or url => dynamic route
+    - Else => rewrite to `/dynamic/url/docs.company.com/page`
+  - Page component renders the page
+    - Read the token from the url query params or cookies
+
+
+PDF export URLs:
+
+- `docs.company.com/page/~gitbook/pdf`
+  - Middleware: rewrite to `/dynamic/pdf/docs.company.com/page`
+  - Page component renders the page
+
+Images resizing:
+
+- `docs.company.com/~gitbook/image`
+  - Middleware: rewrite to `/dynamic/image/docs.company.com`
+  - Route handlers process the request
+
+Preview URLs:
+
+- `open.gitbook.com/sites/site_abc/page` (or `open.gitbook.com/~site/site_abc/page` to stay compatible?)
+  - Middleware: no rewrite
+  - Page component renders the page (dynamic?)
+     - Read the token from the url query params
+     - Read customizations override from the url query params
+
+
+Space PDF URLs:
+
+- `open.gitbook.com/spaces/space_abc/pdf`
+  - Middleware: no rewrite
+  - Page component renders the page (dynamic?)
+     - Read the token from the url query params
+     - Read customizations override from the url query params
+
+Development:
+
+- `localhost:3000/sites/site_abc/page`
+
+#### Routes:
+
+- Content
+    - [ ] `/static/url/[[...url]]/page.tsx`
+    - [ ] `/dynamic/url/[[...url]]/page.tsx`
+- Images resizing
+    - [ ] `/dynamic/image/[hostname]/route.ts`
+- PDF export
+    - [ ] `/dynamic/pdf/[[...url]]/page.tsx`
+    - [ ] `/spaces/[space]/pdf/page.tsx`

packages/gitbook-v2/next.config.mjs

@@ -5,71 +5,10 @@
  */
 const nextConfig = {
     experimental: {
-        // This is needed to throw "forbidden" when the api token expired during revalidation
-        authInterrupts: true,
         useCache: true,
 
-        // Content is fully static, we can cache it in the session memory cache for a long time
+        // We can't use dynamicIO because it doesn't accept reading params in the root layout
-        staleTimes: {
+        // dynamicIO: true,
-            dynamic: 3600, // 1 hour
-            static: 3600, // 1 hour
-        },
-    },
-
-    env: {
-        BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
-
-        // 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,
-        GITBOOK_IMAGE_RESIZE_MODE: process.env.GITBOOK_IMAGE_RESIZE_MODE,
-        GITBOOK_FONTS_URL: process.env.GITBOOK_FONTS_URL,
-        GITBOOK_RUNTIME: process.env.GITBOOK_RUNTIME,
-
-        // Next.js envs
-        NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
-
-        // Used to detect if the app is running in V2 mode
-        GITBOOK_V2: 'true',
-    },
-
-    assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
-    poweredByHeader: false,
-
-    images: {
-        remotePatterns: [
-            {
-                protocol: 'https',
-                hostname: '*.gitbook.io',
-            },
-        ],
-    },
-
-    async headers() {
-        return [
-            {
-                source: '/~gitbook/static/:path*',
-                headers: [
-                    {
-                        key: 'Cache-Control',
-                        value: 'public, max-age=31536000, immutable',
-                    },
-                    {
-                        key: 'Access-Control-Allow-Origin',
-                        value: '*',
-                    },
-                ],
-            },
-        ];
     },
 };
 

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

@@ -1,18 +1,30 @@
-import { defineCloudflareConfig } from '@opennextjs/cloudflare';
+// default open-next.config.ts file created by @opennextjs/cloudflare
-import r2IncrementalCache from '@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache';
-import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
-import doQueue from '@opennextjs/cloudflare/overrides/queue/do-queue';
-import doShardedTagCache from '@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache';
 
-export default defineCloudflareConfig({
+import cache from '@opennextjs/cloudflare/kvCache';
-    incrementalCache: withRegionalCache(r2IncrementalCache, { mode: 'long-lived' }),
+
-    tagCache: doShardedTagCache({
+const config = {
-        baseShardSize: 12,
+    default: {
-        regionalCache: true,
+        override: {
-        shardReplication: {
+            wrapper: 'cloudflare-node',
-            numberOfSoftReplicas: 2,
+            converter: 'edge',
-            numberOfHardReplicas: 1,
+            incrementalCache: async () => cache,
+            tagCache: 'dummy',
+            queue: 'dummy',
         },
-    }),
+    },
-    queue: doQueue,
+
-});
+    middleware: {
+        external: true,
+        override: {
+            wrapper: 'cloudflare-edge',
+            converter: 'edge',
+            proxyExternalRequest: 'fetch',
+        },
+    },
+
+    dangerous: {
+        enableCacheInterception: false,
+    },
+};
+
+export default config;

packages/gitbook-v2/package.json

@@ -1,36 +1,22 @@
 {
     "name": "gitbook-v2",
-    "version": "0.2.5",
+    "version": "0.1.0",
     "private": true,
     "dependencies": {
         "next": "canary",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
-        "@gitbook/api": "*",
+        "@gitbook/api": "^0.93.0"
-        "@gitbook/cache-tags": "workspace:*",
-        "@sindresorhus/fnv1a": "^3.1.0",
-        "server-only": "^0.0.1",
-        "warn-once": "^0.1.1",
-        "rison": "^0.1.1",
-        "jwt-decode": "^4.0.0",
-        "assert-never": "^1.2.1"
     },
     "devDependencies": {
-        "gitbook": "*",
+        "@opennextjs/cloudflare": "^0.4.3"
-        "@opennextjs/cloudflare": "^1.0.0-beta.3",
-        "@types/rison": "^0.0.9",
-        "tailwindcss": "^3.4.0",
-        "postcss": "^8"
     },
     "scripts": {
-        "generate": "rm -rf ./public && cp -r ../gitbook/public ./public",
+        "dev:v2": "next",
-        "dev:v2": "env-cmd --silent -f ../../.env.local next --turbopack",
         "build": "next build",
         "build:v2": "next build",
         "start": "next start",
-        "build:v2:cloudflare": "opennextjs-cloudflare build",
+        "build:v2:cloudflare": "opennextjs-cloudflare",
-        "dev:v2:cloudflare": "wrangler dev --port 8771",
+        "dev:v2:cloudflare": "wrangler dev --port 8771"
-        "unit": "bun test",
-        "typecheck": "tsc --noEmit"
     }
 }

packages/gitbook-v2/postcss.config.js

@@ -1,6 +0,0 @@
-module.exports = {
-    plugins: {
-        tailwindcss: {},
-        autoprefixer: {},
-    },
-};

packages/gitbook-v2/src/app/dynamic/url/[...url]/layout.tsx

@@ -0,0 +1,15 @@
+import { SiteContentLayout } from '@/components/routes/SiteContentLayout';
+import { createDynamicSiteContext } from '@/lib/context';
+
+export default async function RootLayout({
+    params,
+    children,
+}: {
+    params: Promise<{ url: string[] }>;
+    children: React.ReactNode;
+}) {
+    const { url } = await params;
+    const context = await createDynamicSiteContext(url);
+
+    return <SiteContentLayout context={context}>{children}</SiteContentLayout>;
+}

packages/gitbook-v2/src/app/dynamic/url/[...url]/page.tsx

@@ -0,0 +1,9 @@
+import { SiteContentPage } from '@/components/routes/SiteContentPage';
+import { createDynamicSiteContext } from '@/lib/context';
+
+export default async function Page({ params }: { params: Promise<{ url: string[] }> }) {
+    const { url } = await params;
+    const context = await createDynamicSiteContext(url);
+
+    return <SiteContentPage context={context} />;
+}

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

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

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

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

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

@@ -1,36 +0,0 @@
-import {
-    SitePage,
-    generateSitePageMetadata,
-    generateSitePageViewport,
-} from '@/components/SitePage';
-import { type RouteParams, getDynamicSiteContext, getPagePathFromParams } from '@v2/app/utils';
-import type { Metadata, Viewport } from 'next';
-
-type PageProps = {
-    params: Promise<RouteParams>;
-    searchParams: Promise<{ fallback?: string }>;
-};
-
-export default async function Page(props: PageProps) {
-    const params = await props.params;
-    const { context } = await getDynamicSiteContext(params);
-    const pathname = getPagePathFromParams(params);
-
-    return <SitePage context={context} pageParams={{ pathname }} />;
-}
-
-export async function generateViewport(props: PageProps): Promise<Viewport> {
-    const { context } = await getDynamicSiteContext(await props.params);
-    return generateSitePageViewport(context);
-}
-
-export async function generateMetadata(props: PageProps): Promise<Metadata> {
-    const params = await props.params;
-    const { context } = await getDynamicSiteContext(params);
-    const pathname = getPagePathFromParams(params);
-
-    return generateSitePageMetadata({
-        context,
-        pageParams: { pathname },
-    });
-}

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

@@ -1,44 +0,0 @@
-import { CustomizationRootLayout } from '@/components/RootLayout';
-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';
-
-interface SiteDynamicLayoutProps {
-    params: Promise<RouteLayoutParams>;
-}
-
-export default async function SiteDynamicLayout({
-    params,
-    children,
-}: React.PropsWithChildren<SiteDynamicLayoutProps>) {
-    const { context, visitorAuthClaims } = await getDynamicSiteContext(await params);
-    const forcedTheme = await getThemeFromMiddleware();
-
-    return (
-        <CustomizationRootLayout forcedTheme={forcedTheme} customization={context.customization}>
-            <SiteLayout
-                context={context}
-                forcedTheme={forcedTheme}
-                withTracking={!GITBOOK_DISABLE_TRACKING}
-                visitorAuthClaims={visitorAuthClaims}
-            >
-                {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]/[siteData]/~gitbook/icon/route.ts

@@ -1,12 +0,0 @@
-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]/[siteData]/~gitbook/ogimage/[pageId]/route.ts

@@ -1,13 +0,0 @@
-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/dynamic/[mode]/[siteURL]/[siteData]/~gitbook/pdf/layout.tsx

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

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

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

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

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

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

@@ -1,38 +0,0 @@
-import {
-    SitePage,
-    generateSitePageMetadata,
-    generateSitePageViewport,
-} from '@/components/SitePage';
-import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
-
-import type { Metadata, Viewport } from 'next';
-
-export const dynamic = 'force-static';
-
-type PageProps = {
-    params: Promise<RouteParams>;
-};
-
-export default async function Page(props: PageProps) {
-    const params = await props.params;
-    const { context } = await getStaticSiteContext(params);
-    const pathname = getPagePathFromParams(params);
-
-    return <SitePage context={context} pageParams={{ pathname }} />;
-}
-
-export async function generateViewport(props: PageProps): Promise<Viewport> {
-    const { context } = await getStaticSiteContext(await props.params);
-    return generateSitePageViewport(context);
-}
-
-export async function generateMetadata(props: PageProps): Promise<Metadata> {
-    const params = await props.params;
-    const { context } = await getStaticSiteContext(params);
-    const pathname = getPagePathFromParams(params);
-
-    return generateSitePageMetadata({
-        context,
-        pageParams: { pathname },
-    });
-}

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

@@ -1,41 +0,0 @@
-import { CustomizationRootLayout } from '@/components/RootLayout';
-import {
-    SiteLayout,
-    generateSiteLayoutMetadata,
-    generateSiteLayoutViewport,
-} from '@/components/SiteLayout';
-import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
-import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
-
-interface SiteStaticLayoutProps {
-    params: Promise<RouteLayoutParams>;
-}
-
-export default async function SiteStaticLayout({
-    params,
-    children,
-}: React.PropsWithChildren<SiteStaticLayoutProps>) {
-    const { context, visitorAuthClaims } = await getStaticSiteContext(await params);
-
-    return (
-        <CustomizationRootLayout customization={context.customization}>
-            <SiteLayout
-                context={context}
-                withTracking={!GITBOOK_DISABLE_TRACKING}
-                visitorAuthClaims={visitorAuthClaims}
-            >
-                {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]/[siteData]/llms.txt/route.ts

@@ -1,14 +0,0 @@
-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, { withMarkdownPages: true });
-}

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

@@ -1,14 +0,0 @@
-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]/[siteData]/sitemap-pages.xml/route.ts

@@ -1,14 +0,0 @@
-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]/[siteData]/sitemap.xml/route.ts

@@ -1,14 +0,0 @@
-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]/[siteData]/~gitbook/icon/route.ts

@@ -1,14 +0,0 @@
-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]/[siteData]/~gitbook/markdown/[pagePath]/route.ts

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

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

@@ -1,15 +0,0 @@
-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/static/url/[...url]/layout.tsx

@@ -0,0 +1,21 @@
+import { unstable_cacheTag as cacheTag } from 'next/cache';
+import { SiteContentLayout } from '@/components/routes/SiteContentLayout';
+import { getSiteCacheTag } from '@/lib/cache';
+import { createStaticSiteContext } from '@/lib/context';
+
+export default async function RootLayout({
+    params,
+    children,
+}: {
+    params: Promise<{ url: string[] }>;
+    children: React.ReactNode;
+}) {
+    'use cache';
+
+    const { url } = await params;
+    const context = await createStaticSiteContext(url);
+
+    cacheTag(getSiteCacheTag(context.siteId));
+
+    return <SiteContentLayout context={context}>{children}</SiteContentLayout>;
+}

packages/gitbook-v2/src/app/static/url/[...url]/page.tsx

@@ -0,0 +1,15 @@
+import { unstable_cacheTag as cacheTag } from 'next/cache';
+import { createStaticSiteContext } from '@/lib/context';
+import { getSiteCacheTag } from '@/lib/cache';
+import { SiteContentPage } from '@/components/routes/SiteContentPage';
+
+export default async function Page({ params }: { params: Promise<{ url: string[] }> }) {
+    'use cache';
+
+    const { url } = await params;
+    const context = await createStaticSiteContext(url);
+
+    cacheTag(getSiteCacheTag(context.siteId));
+
+    return <SiteContentPage context={context} />;
+}

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

@@ -1,104 +0,0 @@
-import { getVisitorAuthClaims, getVisitorAuthClaimsFromToken } from '@/lib/adaptive';
-import type { SiteAPIToken } from '@gitbook/api';
-import { type SiteURLData, fetchSiteContextByURLLookup, getBaseContext } from '@v2/lib/context';
-import { jwtDecode } from 'jwt-decode';
-import { forbidden } from 'next/navigation';
-import rison from 'rison';
-
-export type RouteParamMode = 'url-host' | 'url';
-
-export type RouteLayoutParams = {
-    mode: string;
-
-    /** URL encoded site URL */
-    siteURL: string;
-
-    /** URL and Rison encoded site data from getPublishedContentByUrl */
-    siteData: string;
-};
-
-export type RouteParams = RouteLayoutParams & {
-    pagePath: string;
-};
-
-/**
- * Get the static context when rendering statically a site.
- */
-export async function getStaticSiteContext(params: RouteLayoutParams) {
-    const siteURL = getSiteURLFromParams(params);
-    const siteURLData = getSiteURLDataFromParams(params);
-
-    // For static routes, we check the expiration of the JWT token
-    // as the route might be revalidated after expiration
-    const decoded = jwtDecode<SiteAPIToken & { exp: number }>(siteURLData.apiToken);
-    if (decoded.exp && decoded.exp < Date.now() / 1000 + 120) {
-        forbidden();
-    }
-
-    const context = await fetchSiteContextByURLLookup(
-        getBaseContext({
-            siteURL,
-            siteURLData,
-            urlMode: getModeFromParams(params.mode),
-        }),
-        siteURLData
-    );
-
-    return {
-        context,
-        visitorAuthClaims: getVisitorAuthClaimsFromToken(decoded),
-    };
-}
-
-/**
- * Get the site context when rendering dynamically.
- * The context will depend on the request.
- */
-export async function getDynamicSiteContext(params: RouteLayoutParams) {
-    const siteURL = getSiteURLFromParams(params);
-    const siteURLData = getSiteURLDataFromParams(params);
-
-    const context = await fetchSiteContextByURLLookup(
-        getBaseContext({
-            siteURL,
-            siteURLData,
-            urlMode: getModeFromParams(params.mode),
-        }),
-        siteURLData
-    );
-
-    return {
-        context,
-        visitorAuthClaims: getVisitorAuthClaims(siteURLData),
-    };
-}
-
-/**
- * Get the decoded page path from the params.
- */
-export function getPagePathFromParams(params: RouteParams) {
-    const decoded = decodeURIComponent(params.pagePath);
-    return decoded;
-}
-
-function getSiteURLFromParams(params: RouteLayoutParams) {
-    const decoded = decodeURIComponent(params.siteURL);
-    const url = new URL(`https://${decoded}`);
-    return url;
-}
-
-function getModeFromParams(mode: string): RouteParamMode {
-    if (mode === 'url-host') {
-        return 'url-host';
-    }
-
-    return 'url';
-}
-
-/**
- * Get the decoded site data from the params.
- */
-function getSiteURLDataFromParams(params: RouteLayoutParams): SiteURLData {
-    const decoded = decodeURIComponent(params.siteData);
-    return rison.decode(decoded);
-}

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

@@ -1,40 +0,0 @@
-import { type NextRequest, NextResponse } from 'next/server';
-
-import {
-    GITBOOK_API_PUBLIC_URL,
-    GITBOOK_API_TOKEN,
-    GITBOOK_API_URL,
-    GITBOOK_APP_URL,
-    GITBOOK_ASSETS_URL,
-    GITBOOK_DISABLE_TRACKING,
-    GITBOOK_FONTS_URL,
-    GITBOOK_ICONS_URL,
-    GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
-    GITBOOK_INTEGRATIONS_HOST,
-    GITBOOK_SECRET,
-    GITBOOK_URL,
-    GITBOOK_USER_AGENT,
-} from '@v2/lib/env';
-
-/**
- * Output the public environment variables for this deployment
- */
-export async function GET(_req: NextRequest) {
-    return NextResponse.json({
-        GITBOOK_URL,
-        GITBOOK_APP_URL,
-        GITBOOK_API_URL,
-        GITBOOK_API_PUBLIC_URL,
-        GITBOOK_ASSETS_URL,
-        GITBOOK_FONTS_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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

packages/gitbook-v2/src/components/routes/SiteContentLayout.tsx

@@ -0,0 +1,27 @@
+import { GitBookSiteContext } from '@/lib/context';
+
+/**
+ * Layout component to render the site content.
+ */
+export async function SiteContentLayout({
+    context,
+    children,
+}: {
+    context: GitBookSiteContext;
+    children: React.ReactNode;
+}) {
+    const { api } = context;
+    const { data: publishedSite } = await api.orgs.getPublishedContentSite(
+        context.organizationId,
+        context.siteId,
+    );
+
+    return (
+        <html lang="en">
+            <body>
+                <h1>{publishedSite.site.title}</h1>
+                {children}
+            </body>
+        </html>
+    );
+}

packages/gitbook-v2/src/components/routes/SiteContentPage.tsx

@@ -0,0 +1,12 @@
+import { GitBookSiteContext } from '@/lib/context';
+
+export async function SiteContentPage({ context }: { context: GitBookSiteContext }) {
+    const { api } = context;
+    const { data } = await api.orgs.getPublishedContentSite(context.organizationId, context.siteId);
+
+    return (
+        <div>
+            <p>Found site {data.site.id}</p>
+        </div>
+    );
+}

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

@@ -0,0 +1,3 @@
+export function getSiteCacheTag(siteId: string) {
+    return `sites/${siteId}`;
+}

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

@@ -1,390 +1,112 @@
-import { getSiteStructureSections } from '@/lib/sites';
+import { headers } from 'next/headers';
-import type {
+import { redirect } from 'next/navigation';
-    ChangeRequest,
+import { GitBookAPI } from '@gitbook/api';
-    PublishedSiteContent,
+import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@/lib/env';
-    RevisionPage,
-    RevisionPageDocument,
-    Site,
-    SiteCustomizationSettings,
-    SiteIntegrationScript,
-    SiteSection,
-    SiteSectionGroup,
-    SiteSpace,
-    SiteStructure,
-    Space,
-} from '@gitbook/api';
-import {
-    type GitBookDataFetcher,
-    createDataFetcher,
-    getDataOrNull,
-    throwIfDataError,
-} from '@v2/lib/data';
-import { notFound } from 'next/navigation';
-import { assert } from 'ts-essentials';
-import { GITBOOK_URL } from './env';
-import { type ImageResizer, createImageResizer } from './images';
-import { type GitBookLinker, createLinker } from './links';
 
 /**
- * Data about the site URL. Provided by the middleware.
+ * Generic context about rendering content.
- * These data are stable between pages in the same site space.
  */
-export type SiteURLData = Pick<
+export interface GitBookContext {
-    PublishedSiteContent,
-    | 'organization'
-    | 'apiToken'
-    | 'site'
-    | 'siteSpace'
-    | 'space'
-    | 'revision'
-    | 'changeRequest'
-    | 'shareKey'
-    | 'siteSection'
-    | 'siteBasePath'
-    | 'basePath'
-> & {
     /**
-     * Identifier used for image resizing.
+     * API client to fetch data from GitBook.
      */
-    imagesContextId: string;
+    api: GitBookAPI;
-};
+}
-
-/**
- * Generic context when rendering content.
- */
-export type GitBookBaseContext = {
-    /**
-     * Data fetcher to fetch data from GitBook.
-     */
-    dataFetcher: GitBookDataFetcher;
-
-    /**
-     * Linker to generate links in the current space.
-     */
-    linker: GitBookLinker;
-
-    /**
-     * Image resizer to resize images.
-     */
-    imageResizer?: ImageResizer;
-};
-
-/**
- * Any context when rendering content.
- */
-export type GitBookAnyContext = GitBookSpaceContext | GitBookSiteContext | GitBookPageContext;
-
-/**
- * Context when rendering a space content.
- */
-export type GitBookSpaceContext = GitBookBaseContext & {
-    organizationId: string;
-
-    space: Space;
-    changeRequest: ChangeRequest | null;
-
-    /** ID of the current revision. */
-    revisionId: string;
-
-    /** Pages of the space. */
-    pages: RevisionPage[];
-
-    /** Share key of the space. */
-    shareKey: string | undefined;
-};
-
-export type SiteSections = {
-    list: (SiteSectionGroup | SiteSection)[];
-    current: SiteSection;
-};
 
 /**
  * Context when rendering a site.
  */
-export type GitBookSiteContext = GitBookSpaceContext & {
+export interface GitBookSiteContext extends GitBookContext {
-    site: Site;
+    /**
+     * ID of the organization.
+     */
+    organizationId: string;
 
-    /** Current site space. */
+    /**
-    siteSpace: SiteSpace;
+     * Site ID.
-
+     */
-    /** All site spaces in the current section / or entire site */
+    siteId: string;
-    siteSpaces: SiteSpace[];
-
-    /** Sections of the site. */
-    sections: null | SiteSections;
-
-    /** Customizations of the site. */
-    customization: SiteCustomizationSettings;
-
-    /** Structure of the site. */
-    structure: SiteStructure;
-
-    /** Scripts to load for the site. */
-    scripts: SiteIntegrationScript[];
-};
-
-/**
- * Context when rendering a page.
- */
-export type GitBookPageContext = (GitBookSpaceContext | GitBookSiteContext) & {
-    page: RevisionPageDocument;
-};
-
-/**
- * Get the base context for a request on a site.
- */
-export function getBaseContext(input: {
-    siteURL: URL | string;
-    siteURLData: SiteURLData;
-    urlMode: 'url' | 'url-host';
-}) {
-    const { urlMode, siteURLData } = input;
-    const siteURL = typeof input.siteURL === 'string' ? new URL(input.siteURL) : input.siteURL;
-
-    const dataFetcher = createDataFetcher({
-        apiToken: siteURLData.apiToken ?? null,
-    });
-
-    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
-    const linker =
-        urlMode === 'url-host'
-            ? createLinker({
-                  host: siteURL.host,
-                  siteBasePath: siteURLData.siteBasePath,
-                  spaceBasePath: siteURLData.basePath,
-              })
-            : createLinker({
-                  protocol: gitbookURL?.protocol,
-                  host: gitbookURL?.host,
-                  siteBasePath: `/url/${siteURL.host}${siteURLData.siteBasePath}`,
-                  spaceBasePath: `/url/${siteURL.host}${siteURLData.basePath}`,
-              });
-
-    if (urlMode === 'url') {
-        // Create link in the same format for links to other sites/sections.
-        linker.toLinkForContent = (rawURL: string) => {
-            const urlObject = new URL(rawURL);
-            return `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`;
-        };
-    }
-
-    const imageResizer = createImageResizer({
-        imagesContextId: siteURLData.imagesContextId,
-        // 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 using the resolution of a URL
+ * Create a site context, when rendering a static page.
  */
-export async function fetchSiteContextByURLLookup(
+export async function createStaticSiteContext(url: string[]): Promise<GitBookSiteContext> {
-    baseContext: GitBookBaseContext,
+    const context = createStaticContext();
-    data: SiteURLData
+    return fetchSiteContext(url, context);
+}
+
+/**
+ * Create a site context, when rendering a dynamic page.
+ */
+export async function createDynamicSiteContext(url: string[]): Promise<GitBookSiteContext> {
+    const context = await createDynamicContext();
+    return fetchSiteContext(url, context);
+}
+
+/**
+ * Fetch the context of a site for a given URL and a base context.
+ */
+async function fetchSiteContext(
+    urlParts: string[],
+    baseContext: GitBookContext,
 ): Promise<GitBookSiteContext> {
-    return await fetchSiteContextByIds(baseContext, {
+    const { api } = baseContext;
-        organization: data.organization,
+    const url = getURLFromParams(urlParts);
-        site: data.site,
+    const { data } = await api.urls.getPublishedContentByUrl({
-        siteSection: data.siteSection,
+        url,
-        siteSpace: data.siteSpace,
-        space: data.space,
-        shareKey: data.shareKey,
-        changeRequest: data.changeRequest,
-        revision: data.revision,
     });
-}
 
-/**
+    if ('redirect' in data) {
- * Fetch a site context by IDs.
+        redirect(data.redirect);
- */
-export async function fetchSiteContextByIds(
-    baseContext: GitBookBaseContext,
-    ids: {
-        organization: string;
-        site: string;
-        siteSection: string | undefined;
-        siteSpace: string | undefined;
-        space: string;
-        shareKey: string | undefined;
-        changeRequest: string | undefined;
-        revision: string | undefined;
-    }
-): Promise<GitBookSiteContext> {
-    const { dataFetcher } = baseContext;
-
-    const [{ site: orgSite, structure: siteStructure, customizations, scripts }, spaceContext] =
-        await Promise.all([
-            throwIfDataError(
-                dataFetcher.getPublishedContentSite({
-                    organizationId: ids.organization,
-                    siteId: ids.site,
-                    siteShareKey: ids.shareKey,
-                })
-            ),
-            fetchSpaceContextByIds(baseContext, ids),
-        ]);
-
-    // override the title with the customization title
-    // TODO: remove this hack once we have a proper way to handle site customizations
-    const site = {
-        ...orgSite,
-        ...(customizations.site?.title ? { title: customizations.site.title } : {}),
-    };
-
-    const sections = ids.siteSection
-        ? parseSiteSectionsAndGroups(siteStructure, ids.siteSection)
-        : null;
-
-    const siteSpace = (
-        siteStructure.type === 'siteSpaces' && siteStructure.structure
-            ? siteStructure.structure
-            : sections?.current.siteSpaces
-    )?.find((siteSpace) => siteSpace.id === ids.siteSpace);
-    if (!siteSpace) {
-        throw new Error('Site space not found');
-    }
-
-    const siteSpaces =
-        siteStructure.type === 'siteSpaces'
-            ? siteStructure.structure
-            : (sections?.current.siteSpaces ?? []);
-
-    const customization = (() => {
-        if (ids.siteSpace) {
-            const siteSpaceSettings = customizations.siteSpaces[ids.siteSpace];
-            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;
-    })();
-
-    return {
-        ...spaceContext,
-        organizationId: ids.organization,
-        site,
-        siteSpaces,
-        siteSpace,
-        customization,
-        structure: siteStructure,
-        sections,
-        scripts,
-    };
-}
-
-/**
- * Fetch a space context by IDs.
- */
-export async function fetchSpaceContextByIds(
-    baseContext: GitBookBaseContext,
-    ids: {
-        space: string;
-        shareKey: string | undefined;
-        changeRequest: string | undefined;
-        revision: string | undefined;
-    }
-): Promise<GitBookSpaceContext> {
-    const { dataFetcher } = baseContext;
-
-    const [space, changeRequest] = await Promise.all([
-        throwIfDataError(
-            dataFetcher.getSpace({
-                spaceId: ids.space,
-                shareKey: ids.shareKey,
-            })
-        ),
-        ids.changeRequest
-            ? getDataOrNull(
-                  dataFetcher.getChangeRequest({
-                      spaceId: ids.space,
-                      changeRequestId: ids.changeRequest,
-                  })
-              )
-            : null,
-    ]);
-
-    if (ids.changeRequest && !changeRequest) {
-        // When trying to render a change request with an invalid / non-existing ID,
-        // we should return a 404.
-        notFound();
-    }
-
-    const revisionId = ids.revision ?? changeRequest?.revision ?? space.revision;
-
-    const pages = await getDataOrNull(
-        dataFetcher.getRevisionPages({
-            spaceId: ids.space,
-            revisionId,
-            // We only care about the Git metadata when the Git sync is enabled,
-            // otherwise we can optimize performance by not fetching it
-            metadata: !!space.gitSync,
-        }),
-
-        // When trying to render a revision with an invalid / non-existing ID,
-        // we should handle gracefully the 404 and throw notFound.
-        ids.revision ? [404] : undefined
-    );
-    if (!pages) {
-        notFound();
     }
 
     return {
         ...baseContext,
-        organizationId: space.organization,
+        api: new GitBookAPI({
-        space,
+            endpoint: api.endpoint,
-        pages,
+            authToken: data.apiToken,
-        changeRequest,
+            userAgent: api.userAgent,
-        revisionId,
+        }),
-        shareKey: ids.shareKey,
+        siteId: data.site,
+        organizationId: data.organization,
     };
 }
 
 /**
- * Check if the context is the root one for a site.
+ * Create the base context when rendering statically.
- * Meaning we are on the default section / space.
  */
-export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {
+function createStaticContext(): GitBookContext {
-    const { structure } = context;
+    const api = new GitBookAPI({
-    switch (structure.type) {
+        authToken: GITBOOK_API_TOKEN,
-        case 'sections': {
+        endpoint: GITBOOK_API_URL,
-            return getSiteStructureSections(structure, { ignoreGroups: true }).some(
+        userAgent: GITBOOK_USER_AGENT,
-                (structure) =>
+    });
-                    structure.default &&
+
-                    structure.id === context.sections?.current.id &&
+    return {
-                    structure.siteSpaces.some(
+        api,
-                        (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 });
+ * Create the base context when rendering dynamically.
-    const section = parseCurrentSection(structure, siteSectionId);
+ * The context will depend on the request.
-    assert(section, 'A section must be defined when there are multiple sections');
+ */
-    return { list: sectionsAndGroups, current: section } satisfies SiteSections;
+async function createDynamicContext(): Promise<GitBookContext> {
+    const headersSet = await headers();
+
+    const api = new GitBookAPI({
+        authToken: headersSet.get('x-gitbook-token') ?? GITBOOK_API_TOKEN,
+        endpoint: headersSet.get('x-gitbook-api') ?? GITBOOK_API_URL,
+        userAgent: GITBOOK_USER_AGENT,
+    });
+
+    return {
+        api,
+    };
 }
 
-function parseCurrentSection(structure: SiteStructure, siteSectionId: string) {
+function getURLFromParams(input: string[]) {
-    const sections = getSiteStructureSections(structure, { ignoreGroups: true });
+    const url = new URL('https://' + input.join('/'));
-    return sections.find((section) => section.id === siteSectionId);
+    return url.toString();
 }

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

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

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

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

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

@@ -1,8 +0,0 @@
-export * from './api';
-export * from './types';
-export * from './pages';
-export * from './urls';
-export * from './errors';
-export * from './lookup';
-export * from './proxy';
-export * from './visitor';

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

@@ -1,140 +0,0 @@
-import { race, tryCatch } from '@/lib/async';
-import { joinPath, joinPathWithBaseURL } from '@/lib/paths';
-import { trace } from '@/lib/tracing';
-import type { PublishedSiteContentLookup } from '@gitbook/api';
-import { apiClient } from './api';
-import { getExposableError } from './errors';
-import type { DataFetcherResponse } from './types';
-import { getURLLookupAlternatives, stripURLSearch } from './urls';
-
-/**
- * Lookup a content by its URL using the GitBook API.
- * To optimize caching, we try multiple lookup alternatives and return the first one that matches.
- */
-export async function getPublishedContentByURL(input: {
-    url: string;
-    visitorAuthToken: string | null;
-    redirectOnError: boolean;
-    apiToken: string | null;
-}): Promise<DataFetcherResponse<PublishedSiteContentLookup>> {
-    const lookupURL = new URL(input.url);
-    const url = stripURLSearch(lookupURL);
-    const lookup = getURLLookupAlternatives(url);
-
-    const result = await race(lookup.urls, async (alternative, { signal }) => {
-        const api = await apiClient({ apiToken: input.apiToken });
-
-        const callResult = await trace(
-            {
-                operation: 'getPublishedContentByURL',
-                name: alternative.url,
-            },
-            () =>
-                tryCatch(
-                    api.urls.getPublishedContentByUrl(
-                        {
-                            url: alternative.url,
-                            visitorAuthToken: input.visitorAuthToken ?? undefined,
-                            redirectOnError: input.redirectOnError,
-
-                            // As this endpoint is cached by our API, we version the request
-                            // to void getting stale data with missing properties.
-                            // this could be improved by ensuring our API cache layer is versioned
-                            // or invalidated when needed
-                            // @ts-expect-error - cacheVersion is not a real query param
-                            cacheVersion: 'v2',
-                        },
-                        {
-                            signal,
-                        }
-                    )
-                )
-        );
-
-        if (callResult.error) {
-            if (alternative.primary) {
-                // We only return an error for the primary alternative (full URL),
-                // as other parts could result in errors due to the URL being incomplete (share links, etc).
-                return { error: callResult.error };
-            }
-            return null;
-        }
-
-        const {
-            data: { data },
-        } = callResult;
-
-        if ('redirect' in data) {
-            if (alternative.primary) {
-                // Append the path to the redirect URL
-                // because we might have matched a shorter path and the redirect is relative to it
-                if (alternative.extraPath) {
-                    if (data.target === 'content') {
-                        const redirect = new URL(data.redirect);
-                        redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
-                        data.redirect = redirect.toString();
-                    } else {
-                        const redirect = new URL(data.redirect);
-                        if (redirect.searchParams.has('location')) {
-                            redirect.searchParams.set(
-                                'location',
-                                joinPath(
-                                    redirect.searchParams.get('location') ?? '',
-                                    alternative.extraPath
-                                )
-                            );
-                            data.redirect = redirect.toString();
-                        }
-                    }
-                }
-
-                return { data };
-            }
-
-            return null;
-        }
-
-        /**
-         * We use the following criteria to determine if the lookup result is the right one:
-         * - the primary alternative was resolved (because that's the longest or most inclusive path)
-         * - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
-         *
-         * In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
-         */
-        if (alternative.primary || ('site' in data && data.complete)) {
-            const changeRequest = data.changeRequest ?? lookup.changeRequest;
-            const revision = data.revision ?? lookup.revision;
-
-            const siteResult: PublishedSiteContentLookup = {
-                ...data,
-                canonicalUrl: joinPathWithBaseURL(data.canonicalUrl, alternative.extraPath),
-                basePath: joinPath(data.basePath, lookup.basePath ?? ''),
-                pathname: joinPath(data.pathname, alternative.extraPath),
-                ...(changeRequest ? { changeRequest } : {}),
-                ...(revision ? { revision } : {}),
-            };
-            return { data: siteResult };
-        }
-
-        return null;
-    });
-
-    if (!result) {
-        return {
-            error: {
-                code: 404,
-                message: 'No content found',
-            },
-        };
-    }
-
-    if (result.error) {
-        return {
-            error: getExposableError(result.error),
-        };
-    }
-
-    return {
-        data: result.data,
-    };
-}

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

@@ -1,52 +0,0 @@
-import { describe, expect, it, mock } from 'bun:test';
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { withCacheKey, withoutConcurrentExecution } from './memoize';
-
-describe('withoutConcurrentExecution', () => {
-    it('should memoize the function based on the cache key', async () => {
-        const fn = mock(async (_cacheKey: string, a: number, b: number) => a + b);
-        const memoized = withoutConcurrentExecution(() => null, fn);
-
-        const p1 = memoized('c1', 1, 2);
-        const p2 = memoized('c1', 1, 2);
-        const p3 = memoized('c3', 2, 3);
-
-        expect(await p1).toBe(await p2);
-        expect(await p1).not.toBe(await p3);
-        expect(fn.mock.calls.length).toBe(2);
-    });
-
-    it('should support caching per request', async () => {
-        const fn = mock(async () => Math.random());
-
-        const request1 = { id: 'request1' };
-        const request2 = { id: 'request2' };
-
-        const requestContext = new AsyncLocalStorage<{ id: string }>();
-
-        const memoized = withoutConcurrentExecution(() => requestContext.getStore(), fn);
-
-        // Both in the same request
-        const promise1 = requestContext.run(request1, () => memoized('c1'));
-        const promise2 = requestContext.run(request1, () => memoized('c1'));
-
-        // In a different request
-        const promise3 = requestContext.run(request2, () => memoized('c1'));
-
-        expect(await promise1).toBe(await promise2);
-        expect(await promise1).not.toBe(await promise3);
-        expect(fn.mock.calls.length).toBe(2);
-    });
-});
-
-describe('withCacheKey', () => {
-    it('should wrap the function by passing the cache key', async () => {
-        const fn = mock(
-            async (cacheKey: string, arg: { a: number; b: number }, c: number) =>
-                `${cacheKey}, result=${arg.a + arg.b + c}`
-        );
-        const memoized = withCacheKey(fn);
-        expect(await memoized({ a: 1, b: 2 }, 4)).toBe('[[["a",1],["b",2]],4], result=7');
-        expect(fn.mock.calls.length).toBe(1);
-    });
-});

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

@@ -1,87 +0,0 @@
-/**
- * Wrap a function by preventing concurrent executions of the same function.
- * With a logic to work per-request in Cloudflare Workers.
- */
-export function withoutConcurrentExecution<ArgsType extends any[], ReturnType>(
-    getGlobalContext: () => object | null | undefined,
-    wrapped: (key: string, ...args: ArgsType) => Promise<ReturnType>
-): (cacheKey: string, ...args: ArgsType) => Promise<ReturnType> {
-    const globalPromiseCache = new WeakMap<object, Map<string, Promise<ReturnType>>>();
-
-    return (key: string, ...args: ArgsType) => {
-        const globalContext = getGlobalContext() ?? globalThis;
-
-        /**
-         * Cache storage that is scoped to the current request when executed in Cloudflare Workers,
-         * to avoid "Cannot perform I/O on behalf of a different request" errors.
-         */
-        const promiseCache =
-            globalPromiseCache.get(globalContext) ?? new Map<string, Promise<ReturnType>>();
-        globalPromiseCache.set(globalContext, promiseCache);
-
-        const concurrent = promiseCache.get(key);
-        if (concurrent) {
-            return concurrent;
-        }
-
-        const promise = (async () => {
-            try {
-                const result = await wrapped(key, ...args);
-                return result;
-            } finally {
-                promiseCache.delete(key);
-            }
-        })();
-
-        promiseCache.set(key, promise);
-
-        return promise;
-    };
-}
-
-/**
- * Wrap a function by passing it a cache key that is computed from the function arguments.
- */
-export function withCacheKey<ArgsType extends any[], ReturnType>(
-    wrapped: (cacheKey: string, ...args: ArgsType) => Promise<ReturnType>
-): (...args: ArgsType) => Promise<ReturnType> {
-    return (...args: ArgsType) => {
-        const cacheKey = getCacheKey(args);
-        return wrapped(cacheKey, ...args);
-    };
-}
-
-/**
- * Compute a cache key from the function arguments.
- */
-function getCacheKey(args: any[]) {
-    return JSON.stringify(deepSortValue(args));
-}
-
-function deepSortValue(value: unknown): unknown {
-    if (
-        typeof value === 'string' ||
-        typeof value === 'number' ||
-        typeof value === 'boolean' ||
-        value === null ||
-        value === undefined
-    ) {
-        return value;
-    }
-
-    if (Array.isArray(value)) {
-        return value.map(deepSortValue);
-    }
-
-    if (value && typeof value === 'object') {
-        return Object.entries(value)
-            .map(([key, subValue]) => {
-                return [key, deepSortValue(subValue)] as const;
-            })
-            .sort((a, b) => {
-                return a[0].localeCompare(b[0]);
-            });
-    }
-
-    return value;
-}

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

@@ -1,30 +0,0 @@
-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 ('computed' in page && page.computed) {
-        return getDataOrNull(
-            dataFetcher.getComputedDocument({
-                organizationId: space.organization,
-                spaceId: space.id,
-                source: page.computed,
-                seed: page.computedSeed,
-            })
-        );
-    }
-
-    return null;
-}

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

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

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

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

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

@@ -1,193 +0,0 @@
-import type * as api from '@gitbook/api';
-
-export type DataFetcherErrorData = {
-    code: number;
-    message: string;
-};
-
-export type DataFetcherResponse<T> =
-    | {
-          data: T;
-          error?: undefined;
-      }
-    | {
-          error: DataFetcherErrorData;
-          data?: undefined;
-      };
-
-/**
- * Generic fetcher for GitBook data.
- * It is used between v1 and v2.
- */
-export interface GitBookDataFetcher {
-    /**
-     * 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<DataFetcherResponse<api.User>>;
-
-    /**
-     * Get a published content site by its organization ID and site ID.
-     */
-    getPublishedContentSite(params: {
-        organizationId: string;
-        siteId: string;
-        siteShareKey: string | undefined;
-    }): Promise<DataFetcherResponse<api.PublishedContentSite>>;
-
-    /**
-     * Get a space by its ID.
-     */
-    getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<
-        DataFetcherResponse<api.Space>
-    >;
-
-    /**
-     * Get a change request by its space ID and change request ID.
-     */
-    getChangeRequest(params: {
-        spaceId: string;
-        changeRequestId: string;
-    }): Promise<DataFetcherResponse<api.ChangeRequest>>;
-
-    /**
-     * Get the revision by its space ID and revision ID.
-     */
-    getRevision(params: {
-        spaceId: string;
-        revisionId: string;
-        metadata: boolean;
-    }): Promise<DataFetcherResponse<api.Revision>>;
-
-    /**
-     * Get the revision pages by its space ID and revision ID.
-     */
-    getRevisionPages(params: {
-        spaceId: string;
-        revisionId: string;
-        metadata: boolean;
-    }): Promise<DataFetcherResponse<api.RevisionPage[]>>;
-
-    /**
-     * Get a revision file by its space ID, revision ID and file ID.
-     */
-    getRevisionFile(params: {
-        spaceId: string;
-        revisionId: string;
-        fileId: string;
-    }): Promise<DataFetcherResponse<api.RevisionFile>>;
-
-    /**
-     * Get a revision page by its path.
-     */
-    getRevisionPageByPath(params: {
-        spaceId: string;
-        revisionId: string;
-        path: string;
-    }): Promise<DataFetcherResponse<api.RevisionPageDocument | api.RevisionPageGroup>>;
-
-    /**
-     * Get the markdown content of a page by its path.
-     */
-    getRevisionPageMarkdown(params: {
-        spaceId: string;
-        revisionId: string;
-        pageId: string;
-    }): Promise<DataFetcherResponse<string>>;
-
-    /**
-     * Get a document by its space ID and document ID.
-     */
-    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;
-        seed: string;
-    }): Promise<DataFetcherResponse<api.JSONDocument>>;
-
-    /**
-     * Get a reusable content by its space ID, revision ID and reusable content ID.
-     */
-    getReusableContent(params: {
-        spaceId: string;
-        revisionId: string;
-        reusableContentId: string;
-    }): Promise<DataFetcherResponse<api.RevisionReusableContent>>;
-
-    /**
-     * Get the latest OpenAPI spec version content by its organization ID and slug.
-     */
-    getLatestOpenAPISpecVersionContent(params: {
-        organizationId: string;
-        slug: string;
-    }): Promise<DataFetcherResponse<api.OpenAPISpecContent>>;
-
-    /**
-     * Get a site redirect by its source path.
-     */
-    getSiteRedirectBySource(params: {
-        organizationId: string;
-        siteId: string;
-        siteShareKey: string | undefined;
-        source: string;
-    }): 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[]>>;
-
-    /**
-     * Render an integration UI.
-     */
-    renderIntegrationUi(params: {
-        integrationName: string;
-        request: api.RenderIntegrationUI;
-    }): Promise<DataFetcherResponse<api.ContentKitRenderOutput>>;
-
-    /**
-     * Stream an AI response.
-     */
-    streamAIResponse(params: {
-        organizationId: string;
-        siteId: string;
-        input: api.AIMessageInput[];
-        output: api.AIOutputFormat;
-        model: api.AIModel;
-    }): AsyncGenerator<api.AIStreamResponse, void, unknown>;
-}

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

@@ -1,130 +0,0 @@
-/**
- * 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.
- *
- * The cases can be:
- *
- * Custom hostname
- *   - Public content has a custom hostname: docs.company.com/<path>
- *   - Public content has a custom hostname with a share-link: docs.company.com/<link>/<path>
- *   - Public content has a custom hostname with a variant: docs.company.com/v/<variant>/<path>
- *   - Public content has a custom hostname with a variant and a share-link: docs.company.com/<link>/v/<variant>/<path>
- *   - Revisions in a custom hostname: docs.company.com/~/revisions/<id>/<path>
- *   - Changes in a custom hostname: docs.company.com/~/changes/<id>/<path>
- *
- * Custom hostname in the organization or GitBook domain (company.gitbook.io)
- *   - Public content has a custom hostname in the organization: docs.company.com/<space>/<path>
- *   - Public content has a custom hostname in the organization with a share-link: docs.company.com/<space>/<link>/<path>
- *   - Public content has a custom hostname in the organization with a variant: docs.company.com/<space>/v/<variant>/<path>
- *   - Public content has a custom hostname in the organization with a variant and a share-link: docs.company.com/<space>/<link>/v/<variant>/<path>
- */
-export function getURLLookupAlternatives(input: URL) {
-    const url = normalizeURL(input);
-
-    let basePath: string | undefined = undefined;
-    let changeRequest: string | undefined = undefined;
-    let revision: string | undefined = undefined;
-    const alternatives: Array<{ url: string; extraPath: string; primary: boolean }> = [];
-
-    const pushAlternative = (adding: URL, extraPath: string) => {
-        const existing = alternatives.find((alt) => alt.url === adding.toString());
-        if (existing) {
-            if (existing.extraPath !== extraPath) {
-                throw new Error(
-                    `Invalid extraPath ${extraPath} for url ${adding.toString()}, already set to ${
-                        existing.extraPath
-                    }`
-                );
-            }
-            return;
-        }
-
-        alternatives.push({
-            url: adding.toString(),
-            extraPath,
-            primary: adding.toString() === url.toString(),
-        });
-    };
-
-    const pathSegments = url.pathname.slice(1).split('/');
-    const tildeIndex = pathSegments.indexOf('~');
-
-    // URL looks like a specific content url (with ~/revisions/ or ~/changes/ in the path)
-    // We only start matching after the ~/revisions/ or ~/changes/ segment and we ignore everything before it
-    if (
-        tildeIndex >= 0 &&
-        (pathSegments[tildeIndex + 1] === 'revisions' || pathSegments[tildeIndex + 1] === 'changes')
-    ) {
-        const tildeIndex = pathSegments.indexOf('~');
-        const revisionOrChangeIdIndex = tildeIndex + 2;
-
-        basePath = pathSegments.slice(tildeIndex, revisionOrChangeIdIndex + 1).join('/');
-        if (pathSegments[tildeIndex + 1] === 'revisions') {
-            revision = pathSegments[revisionOrChangeIdIndex];
-        } else {
-            changeRequest = pathSegments[revisionOrChangeIdIndex];
-        }
-
-        // Match up to the tilde
-        const contentURL = new URL(url);
-        contentURL.pathname = pathSegments.slice(0, tildeIndex).join('/');
-        pushAlternative(contentURL, pathSegments.slice(revisionOrChangeIdIndex + 1).join('/'));
-    }
-
-    // URL looks like a collection url (with /v/ in the path)
-    // We only start matching after the /v/ segment and we ignore everything before it
-    // to avoid potentially matching as a page not found under the default space in the collection
-    else if (pathSegments.includes('v')) {
-        const collectionURL = new URL(url);
-        const vIndex = pathSegments.indexOf('v');
-        collectionURL.pathname = pathSegments.slice(0, vIndex + 2).join('/');
-
-        pushAlternative(collectionURL, pathSegments.slice(vIndex + 2).join('/'));
-    } else {
-        // Match only with the host, if it can be a custom hostname
-        // It should cover most cases of custom domains, and with caching, it should be fast.
-        if (!url.hostname.includes('.gitbook.io') || pathSegments.length === 0) {
-            const noPathURL = new URL(url);
-            noPathURL.pathname = '/';
-
-            pushAlternative(noPathURL, url.pathname.slice(1));
-        }
-
-        // Otherwise match with the first four segments of the path
-        for (let i = 1; i <= 4; i++) {
-            if (pathSegments.length >= i) {
-                const shortURL = new URL(url);
-                shortURL.pathname = pathSegments.slice(0, i).join('/');
-
-                pushAlternative(shortURL, pathSegments.slice(i).join('/'));
-            }
-        }
-    }
-
-    // Mark the longuest entry to lookup as primary
-    alternatives.sort((a, b) => b.extraPath.length - a.extraPath.length);
-    if (alternatives.length > 0) {
-        alternatives[alternatives.length - 1].primary = true;
-    }
-
-    return { urls: alternatives, basePath, changeRequest, revision };
-}
-
-/**
- * Normalize a URL to remove duplicate slashes and trailing slashes
- * and transform the pathname to lowercase.
- */
-export function normalizeURL(url: URL) {
-    const result = new URL(url);
-    result.pathname = url.pathname.replace(/\/{2,}/g, '/').replace(/\/$/, '');
-    return result;
-}
-
-/**
- * Strip the search params from a URL
- */
-export function stripURLSearch(url: URL): URL {
-    const stripped = new URL(url.toString());
-    stripped.search = '';
-    return stripped;
-}

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

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

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * 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';

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

@@ -1,120 +0,0 @@
-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.
- */
-
-/**
- * Runtime environment.
- */
-export const GITBOOK_RUNTIME = (process.env.GITBOOK_RUNTIME ?? 'unknown') as
-    | 'vercel'
-    | 'cloudflare'
-    | 'unknown';
-
-/**
- * Main host on which GitBook is running.
- */
-export const GITBOOK_URL =
-    process.env.NODE_ENV === 'development'
-        ? 'http://localhost:3000'
-        : (process.env.GITBOOK_URL ??
-          (process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ??
-          '');
-
-/**
- * URL at which static assets are served.
- */
-export const GITBOOK_ASSETS_URL =
-    process.env.NODE_ENV === 'development'
-        ? 'http://localhost:3000'
-        : process.env.GITBOOK_ASSETS_PREFIX;
-
-/**
- * GitBook app URL.
- */
-export const GITBOOK_APP_URL = process.env.GITBOOK_APP_URL || 'https://app.gitbook.com';
-
-/**
- * Default GitBook API URL endpoint.
- */
-export const GITBOOK_API_URL = process.env.GITBOOK_API_URL || 'https://api.gitbook.com';
-
-/**
- * Default GitBook API URL endpoint, to be shared with the client.
- */
-export const GITBOOK_API_PUBLIC_URL = process.env.GITBOOK_API_PUBLIC_URL || GITBOOK_API_URL;
-
-/**
- * Default GitBook API token.
- * It can be use to avoid rate-limiting.
- */
-export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN || null;
-
-/**
- * User agent to use for API requests.
- */
-export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT || 'GitBook-Open/2.0.0';
-
-/**
- * Whether to disable tracking of events into site insights.
- * This is used to disable tracking in development mode.
- */
-export const GITBOOK_DISABLE_TRACKING = Boolean(
-    !!process.env.GITBOOK_DISABLE_TRACKING || process.env.NODE_ENV !== 'production'
-);
-
-/**
- * Hostname serving the integrations.
- */
-export const GITBOOK_INTEGRATIONS_HOST =
-    process.env.GITBOOK_INTEGRATIONS_HOST || 'integrations.gitbook.com';
-
-/**
- * Hostname for fonts.
- */
-export const GITBOOK_FONTS_URL = process.env.GITBOOK_FONTS_URL || 'https://fonts.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;
-
-/**
- * Mode used for resizing images.
- */
-export const GITBOOK_IMAGE_RESIZE_MODE = enforceEnum(
-    'GITBOOK_IMAGE_RESIZE_MODE',
-    process.env.GITBOOK_IMAGE_RESIZE_MODE || 'cdn-cgi',
-    ['cdn-cgi', 'cf-fetch']
-);
-
-/**
- * Endpoint where icons are served.
- */
-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;
-
-function enforceEnum<T extends string>(key: string, value: string, enumValues: T[]): T {
-    if (!enumValues.includes(value as T)) {
-        throw new Error(
-            `Invalid value for ${key}: "${value}", expected one of: ${enumValues.join(', ')}`
-        );
-    }
-    return value as T;
-}

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

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

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

@@ -1,45 +0,0 @@
-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/checkIsSizableImageURL.ts

@@ -1,27 +0,0 @@
-import { checkIsHttpURL } from '@/lib/urls';
-
-/**
- * Check if an image URL is resizable.
- * Skip it for non-http(s) URLs (data, etc).
- * Skip it for SVGs.
- * Skip it for GitBook images (to avoid recursion).
- */
-export function checkIsSizableImageURL(input: string): boolean {
-    if (!URL.canParse(input)) {
-        return false;
-    }
-
-    if (input.includes('/~gitbook/image')) {
-        return false;
-    }
-
-    const parsed = new URL(input);
-    if (parsed.pathname.endsWith('.svg') || parsed.pathname.endsWith('.avif')) {
-        return false;
-    }
-    if (!checkIsHttpURL(parsed)) {
-        return false;
-    }
-
-    return true;
-}

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

@@ -1,102 +0,0 @@
-import 'server-only';
-import { GITBOOK_IMAGE_RESIZE_SIGNING_KEY, GITBOOK_IMAGE_RESIZE_URL } from '../env';
-import type { GitBookLinker } from '../links';
-import { checkIsSizableImageURL } from './checkIsSizableImageURL';
-import { getImageSize } from './resizer';
-import { type SignatureVersion, generateImageSignature } from './signatures';
-import type { ImageResizer } from './types';
-
-/**
- * Create an image resizer for a rendering context.
- */
-export function createImageResizer({
-    imagesContextId,
-    linker,
-}: {
-    /** The linker to use to create URLs. */
-    linker: GitBookLinker;
-    /** The site identifier to use for verifying the image signature. */
-    imagesContextId: string;
-}): ImageResizer {
-    if (!GITBOOK_IMAGE_RESIZE_URL || !GITBOOK_IMAGE_RESIZE_SIGNING_KEY) {
-        return createNoopImageResizer();
-    }
-
-    return {
-        getResizedImageURL: (urlInput) => {
-            if (!checkIsSizableImageURL(urlInput)) {
-                return null;
-            }
-
-            let cachedSignature: {
-                signature: string;
-                version: SignatureVersion;
-            } | null = null;
-
-            return async (options) => {
-                cachedSignature ??= await generateImageSignature({
-                    imagesContextId,
-                    url: urlInput,
-                });
-
-                const url = linker.toAbsoluteURL(linker.toPathInSite('/~gitbook/image'));
-                const searchParams = new URLSearchParams();
-                searchParams.set('url', getImageAPIUrl(urlInput));
-
-                if (options.width) {
-                    searchParams.set('width', options.width.toString());
-                }
-                if (options.height) {
-                    searchParams.set('height', options.height.toString());
-                }
-                if (options.dpr) {
-                    searchParams.set('dpr', options.dpr.toString());
-                }
-                if (options.quality) {
-                    searchParams.set('quality', options.quality.toString());
-                }
-
-                searchParams.set('sign', cachedSignature.signature);
-                searchParams.set('sv', cachedSignature.version);
-
-                return `${url}?${searchParams.toString()}`;
-            };
-        },
-
-        getImageSize: async (input, options) => {
-            if (!checkIsSizableImageURL(input)) {
-                return null;
-            }
-
-            return getImageSize(input, options);
-        },
-    };
-}
-
-/**
- * Create an image resizer that doesn't do any resizing.
- */
-export function createNoopImageResizer(): ImageResizer {
-    return {
-        getResizedImageURL: () => null,
-        getImageSize: async (_input) => null,
-    };
-}
-
-/**
- * Because of a bug in Cloudflare, 127.0.0.1 is replaced by localhost.
- * We protect against it by converting to a special token, and then parsing
- * the token in the image API.
- */
-const GITBOOK_LOCALHOST_TOKEN = '$GITBOOK_LOCALHOST$';
-
-/**
- * Prepare a URL for the GitBook Open Image API.
- */
-export function getImageAPIUrl(url: string): string {
-    return url.replaceAll('127.0.0.1', GITBOOK_LOCALHOST_TOKEN);
-}
-
-export function parseImageAPIURL(url: string): string {
-    return url.replaceAll(GITBOOK_LOCALHOST_TOKEN, '127.0.0.1');
-}

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

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