update

.changeset/forty-kangaroos-joke.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix alignment of `prominent` search bar on full-width pages

.changeset/new-pots-applaud.md

@@ -0,0 +1,6 @@
+---
+"@gitbook/openapi-parser": patch
+"@gitbook/react-openapi": patch
+---
+
+Update scalar

.changeset/silver-sheep-repeat.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Restyle section group dropdown

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

@@ -19,12 +19,6 @@ inputs:
   deploy:
     description: 'Deploy as main version for all traffic instead of uploading versions'
     required: true
-  commitTag:
-    description: 'Commit branch to associate with the deployment'
-    required: true
-  commitMessage:
-    description: 'Commit message to associate with the deployment'
-    required: true
 outputs:
     deployment-url: 
       description: "Deployment URL"
@@ -55,13 +49,9 @@ runs:
             GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
             GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
             GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
-            GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
-            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build worker
           run: bun run turbo build:v2:cloudflare
-          env:
-            GITBOOK_RUNTIME: cloudflare
           shell: bash
         - id: deploy
           name: Deploy to Cloudflare
@@ -70,9 +60,9 @@ runs:
               apiToken: ${{ inputs.apiToken }}
               accountId: ${{ inputs.accountId }}
               workingDirectory: ./
-              wranglerVersion: '4.10.0'
+              wranglerVersion: '3.112.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
+              command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
         - name: Outputs
           shell: bash
           env:

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

@@ -54,16 +54,13 @@ runs:
             GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
             GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
             GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
-            GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
-            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build Project Artifacts
           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
@@ -77,4 +74,3 @@ runs:
           shell: bash
           run: |
               echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
-

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

@@ -3,6 +3,15 @@ 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:

.github/workflows/deploy-preview.yaml

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

.github/workflows/deploy-production.yaml

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

.github/workflows/deploy-staging.yaml

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

.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:

.vscode/settings.json

@@ -13,8 +13,5 @@
     "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

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

package.json

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

packages/cache-do/package.json

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

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

packages/cache-tags/package.json

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

packages/cache-tags/src/index.ts

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

packages/colors/CHANGELOG.md

@@ -1,17 +1,5 @@
 # @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

packages/colors/package.json

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

packages/colors/src/transformations.ts

@@ -220,7 +220,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/gitbook-v2/CHANGELOG.md

@@ -1,33 +1,5 @@
 # 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

packages/gitbook-v2/next.config.mjs

@@ -5,15 +5,7 @@
  */
 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
-        staleTimes: {
-            dynamic: 3600, // 1 hour
-            static: 3600, // 1 hour
-        },
     },
 
     env: {
@@ -31,9 +23,6 @@ const nextConfig = {
         GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
         GITBOOK_SECRET: process.env.GITBOOK_SECRET,
         GITBOOK_IMAGE_RESIZE_SIGNING_KEY: process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
-        GITBOOK_IMAGE_RESIZE_MODE: process.env.GITBOOK_IMAGE_RESIZE_MODE,
-        GITBOOK_FONTS_URL: process.env.GITBOOK_FONTS_URL,
-        GITBOOK_RUNTIME: process.env.GITBOOK_RUNTIME,
 
         // Next.js envs
         NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
@@ -53,24 +42,6 @@ const nextConfig = {
             },
         ],
     },
-
-    async headers() {
-        return [
-            {
-                source: '/~gitbook/static/:path*',
-                headers: [
-                    {
-                        key: 'Cache-Control',
-                        value: 'public, max-age=31536000, immutable',
-                    },
-                    {
-                        key: 'Access-Control-Allow-Origin',
-                        value: '*',
-                    },
-                ],
-            },
-        ];
-    },
 };
 
 export default nextConfig;

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

@@ -1,18 +1,10 @@
 import { defineCloudflareConfig } from '@opennextjs/cloudflare';
-import r2IncrementalCache from '@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache';
+import d1TagCache from '@opennextjs/cloudflare/d1-tag-cache';
-import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
+import kvIncrementalCache from '@opennextjs/cloudflare/kv-cache';
-import doQueue from '@opennextjs/cloudflare/overrides/queue/do-queue';
+import memoryQueue from '@opennextjs/cloudflare/memory-queue';
-import doShardedTagCache from '@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache';
 
 export default defineCloudflareConfig({
-    incrementalCache: withRegionalCache(r2IncrementalCache, { mode: 'long-lived' }),
+    incrementalCache: kvIncrementalCache,
-    tagCache: doShardedTagCache({
+    queue: memoryQueue,
-        baseShardSize: 12,
+    tagCache: d1TagCache,
-        regionalCache: true,
-        shardReplication: {
-            numberOfSoftReplicas: 2,
-            numberOfHardReplicas: 1,
-        },
-    }),
-    queue: doQueue,
 });

packages/gitbook-v2/package.json

@@ -1,24 +1,20 @@
 {
     "name": "gitbook-v2",
-    "version": "0.2.5",
+    "version": "0.2.1",
     "private": true,
     "dependencies": {
-        "next": "canary",
+        "next": "^15.2.1",
         "react": "^19.0.0",
         "react-dom": "^19.0.0",
         "@gitbook/api": "*",
         "@gitbook/cache-tags": "workspace:*",
         "@sindresorhus/fnv1a": "^3.1.0",
         "server-only": "^0.0.1",
-        "warn-once": "^0.1.1",
+        "warn-once": "^0.1.1"
-        "rison": "^0.1.1",
-        "jwt-decode": "^4.0.0",
-        "assert-never": "^1.2.1"
     },
     "devDependencies": {
         "gitbook": "*",
-        "@opennextjs/cloudflare": "^1.0.0-beta.3",
+        "@opennextjs/cloudflare": "^0.5.10",
-        "@types/rison": "^0.0.9",
         "tailwindcss": "^3.4.0",
         "postcss": "^8"
     },
@@ -28,7 +24,7 @@
         "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",
         "unit": "bun test",
         "typecheck": "tsc --noEmit"

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

@@ -13,20 +13,20 @@ type PageProps = {
 
 export default async function Page(props: PageProps) {
     const params = await props.params;
-    const { context } = await getDynamicSiteContext(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);
+    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 context = await getDynamicSiteContext(params);
     const pathname = getPagePathFromParams(params);
 
     return generateSitePageMetadata({

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

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

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

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

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

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

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

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

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

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

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

@@ -7,6 +7,6 @@ export async function GET(
     request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams> }
 ) {
-    const { context } = await getDynamicSiteContext(await params);
+    const context = await getDynamicSiteContext(await params);
     return serveIcon(context, request);
 }

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

@@ -8,6 +8,6 @@ export async function GET(
     _request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams & PageIdParams> }
 ) {
-    const { context } = await getDynamicSiteContext(await params);
+    const context = await getDynamicSiteContext(await params);
     return serveOGImage(context, await params);
 }

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

@@ -6,7 +6,7 @@ export default async function RootLayout(props: {
     children: React.ReactNode;
 }) {
     const { params, children } = props;
-    const { context } = await getDynamicSiteContext(await params);
+    const context = await getDynamicSiteContext(await params);
 
     return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
 }

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

@@ -6,7 +6,7 @@ export async function generateMetadata({
 }: {
     params: Promise<RouteLayoutParams>;
 }) {
-    const { context } = await getDynamicSiteContext(await params);
+    const context = await getDynamicSiteContext(await params);
     return generatePDFMetadata(context);
 }
 
@@ -15,6 +15,6 @@ export default async function Page(props: {
     searchParams: Promise<{ [key: string]: string }>;
 }) {
     const { params, searchParams } = props;
-    const { context } = await getDynamicSiteContext(await params);
+    const context = await getDynamicSiteContext(await params);
     return <PDFPage context={context} searchParams={await searchParams} />;
 }

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

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

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]/layout.tsx

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

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

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

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

@@ -9,6 +9,6 @@ export async function GET(
     _request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams> }
 ) {
-    const { context } = await getStaticSiteContext(await params);
+    const context = await getStaticSiteContext(await params);
     return serveRobotsTxt(context);
 }

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

@@ -9,6 +9,6 @@ export async function GET(
     _request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams> }
 ) {
-    const { context } = await getStaticSiteContext(await params);
+    const context = await getStaticSiteContext(await params);
     return servePagesSitemap(context);
 }

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

@@ -9,6 +9,6 @@ export async function GET(
     _request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams> }
 ) {
-    const { context } = await getStaticSiteContext(await params);
+    const context = await getStaticSiteContext(await params);
     return serveRootSitemap(context);
 }

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

@@ -9,6 +9,6 @@ export async function GET(
     request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams> }
 ) {
-    const { context } = await getStaticSiteContext(await params);
+    const context = await getStaticSiteContext(await params);
     return serveIcon(context, request);
 }

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

@@ -10,6 +10,6 @@ export async function GET(
     _request: NextRequest,
     { params }: { params: Promise<RouteLayoutParams & PageIdParams> }
 ) {
-    const { context } = await getStaticSiteContext(await params);
+    const context = await getStaticSiteContext(await params);
     return serveOGImage(context, await params);
 }

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

@@ -1,9 +1,9 @@
-import { getVisitorAuthClaims, getVisitorAuthClaimsFromToken } from '@/lib/adaptive';
+import {
-import type { SiteAPIToken } from '@gitbook/api';
+    fetchSiteContextByURL,
-import { type SiteURLData, fetchSiteContextByURLLookup, getBaseContext } from '@v2/lib/context';
+    fetchSiteContextByURLLookup,
-import { jwtDecode } from 'jwt-decode';
+    getBaseContext,
-import { forbidden } from 'next/navigation';
+} from '@v2/lib/context';
-import rison from 'rison';
+import { getSiteURLDataFromMiddleware } from '@v2/lib/middleware';
 
 export type RouteParamMode = 'url-host' | 'url';
 
@@ -12,9 +12,6 @@ export type RouteLayoutParams = {
 
     /** URL encoded site URL */
     siteURL: string;
-
-    /** URL and Rison encoded site data from getPublishedContentByUrl */
-    siteData: string;
 };
 
 export type RouteParams = RouteLayoutParams & {
@@ -24,30 +21,19 @@ export type RouteParams = RouteLayoutParams & {
 /**
  * Get the static context when rendering statically a site.
  */
-export async function getStaticSiteContext(params: RouteLayoutParams) {
+export function getStaticSiteContext(params: RouteLayoutParams) {
     const siteURL = getSiteURLFromParams(params);
-    const siteURLData = getSiteURLDataFromParams(params);
+    return fetchSiteContextByURL(
-
-    // 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
+        {
+            url: siteURL.toString(),
+            visitorAuthToken: null,
+            redirectOnError: false,
+        }
     );
-
-    return {
-        context,
-        visitorAuthClaims: getVisitorAuthClaimsFromToken(decoded),
-    };
 }
 
 /**
@@ -56,21 +42,15 @@ export async function getStaticSiteContext(params: RouteLayoutParams) {
  */
 export async function getDynamicSiteContext(params: RouteLayoutParams) {
     const siteURL = getSiteURLFromParams(params);
-    const siteURLData = getSiteURLDataFromParams(params);
+    const siteURLData = await getSiteURLDataFromMiddleware();
 
-    const context = await fetchSiteContextByURLLookup(
+    return fetchSiteContextByURLLookup(
         getBaseContext({
             siteURL,
-            siteURLData,
             urlMode: getModeFromParams(params.mode),
         }),
         siteURLData
     );
-
-    return {
-        context,
-        visitorAuthClaims: getVisitorAuthClaims(siteURLData),
-    };
 }
 
 /**
@@ -94,11 +74,3 @@ function getModeFromParams(mode: string): RouteParamMode {
 
     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

@@ -7,7 +7,6 @@ import {
     GITBOOK_APP_URL,
     GITBOOK_ASSETS_URL,
     GITBOOK_DISABLE_TRACKING,
-    GITBOOK_FONTS_URL,
     GITBOOK_ICONS_URL,
     GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
     GITBOOK_INTEGRATIONS_HOST,
@@ -26,7 +25,6 @@ export async function GET(_req: NextRequest) {
         GITBOOK_API_URL,
         GITBOOK_API_PUBLIC_URL,
         GITBOOK_ASSETS_URL,
-        GITBOOK_FONTS_URL,
         GITBOOK_ICONS_URL,
         GITBOOK_USER_AGENT,
         GITBOOK_INTEGRATIONS_HOST,

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

@@ -20,10 +20,8 @@ export async function getSpacePDFContext(
 
     const apiToken = await getAPITokenFromMiddleware();
 
-    const basePath = getPDFRoutePath(params);
     const linker = createLinker({
-        spaceBasePath: basePath,
+        pathname: getPDFRoutePath(params),
-        siteBasePath: basePath,
     });
     const dataFetcher = createDataFetcher({
         apiToken: apiToken,

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

@@ -1,7 +1,7 @@
 import { getSiteStructureSections } from '@/lib/sites';
 import type {
     ChangeRequest,
-    PublishedSiteContent,
+    PublishedSiteContentLookup,
     RevisionPage,
     RevisionPageDocument,
     Site,
@@ -13,41 +13,12 @@ import type {
     SiteStructure,
     Space,
 } from '@gitbook/api';
-import {
+import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
-    type GitBookDataFetcher,
+import { redirect } from 'next/navigation';
-    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';
+import { type GitBookSpaceLinker, createLinker } from './links';
-
-/**
- * Data about the site URL. Provided by the middleware.
- * These data are stable between pages in the same site space.
- */
-export type SiteURLData = Pick<
-    PublishedSiteContent,
-    | 'organization'
-    | 'apiToken'
-    | 'site'
-    | 'siteSpace'
-    | 'space'
-    | 'revision'
-    | 'changeRequest'
-    | 'shareKey'
-    | 'siteSection'
-    | 'siteBasePath'
-    | 'basePath'
-> & {
-    /**
-     * Identifier used for image resizing.
-     */
-    imagesContextId: string;
-};
 
 /**
  * Generic context when rendering content.
@@ -61,7 +32,7 @@ export type GitBookBaseContext = {
     /**
      * Linker to generate links in the current space.
      */
-    linker: GitBookLinker;
+    linker: GitBookSpaceLinker;
 
     /**
      * Image resizer to resize images.
@@ -131,45 +102,27 @@ export type GitBookPageContext = (GitBookSpaceContext | GitBookSiteContext) & {
 };
 
 /**
- * Get the base context for a request on a site.
+ * Get the base context for a request.
  */
 export function getBaseContext(input: {
     siteURL: URL | string;
-    siteURLData: SiteURLData;
     urlMode: 'url' | 'url-host';
+    apiToken?: string | null;
 }) {
-    const { urlMode, siteURLData } = input;
+    const url = typeof input.siteURL === 'string' ? new URL(input.siteURL) : input.siteURL;
-    const siteURL = typeof input.siteURL === 'string' ? new URL(input.siteURL) : input.siteURL;
+    const urlMode = input.urlMode;
 
     const dataFetcher = createDataFetcher({
-        apiToken: siteURLData.apiToken ?? null,
+        apiToken: input.apiToken ?? null,
     });
 
-    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
+    const linker = getLinkerForSiteURL({
-    const linker =
+        siteURL: url,
-        urlMode === 'url-host'
+        urlMode,
-            ? 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,
+        host: url.host,
         // To ensure image resizing work for proxied sites,
         // we serve images from the root of the site.
         linker: linker,
@@ -182,23 +135,92 @@ export function getBaseContext(input: {
     };
 }
 
+/**
+ * Get the linker for a given site URL.
+ */
+export function getLinkerForSiteURL(input: {
+    siteURL: URL;
+    urlMode: 'url' | 'url-host';
+}) {
+    const { siteURL, urlMode } = input;
+
+    const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
+    const linker =
+        urlMode === 'url-host'
+            ? createLinker({
+                  host: siteURL.host,
+                  pathname: siteURL.pathname,
+              })
+            : createLinker({
+                  protocol: gitbookURL?.protocol,
+                  host: gitbookURL?.host,
+                  pathname: `/url/${siteURL.host}${siteURL.pathname}`,
+              });
+
+    if (urlMode === 'url') {
+        // Create link in the same format for links to other sites/sections.
+        linker.toLinkForContent = (rawURL: string) => {
+            const urlObject = new URL(rawURL);
+            return `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`;
+        };
+    }
+
+    return linker;
+}
+
+/**
+ * Fetch the context of a site for a given URL and a base context.
+ */
+export async function fetchSiteContextByURL(
+    baseContext: GitBookBaseContext,
+    input: {
+        url: string;
+        visitorAuthToken: string | null;
+        redirectOnError: boolean;
+    }
+): Promise<GitBookSiteContext> {
+    const { dataFetcher } = baseContext;
+    const data = await throwIfDataError(
+        dataFetcher.getPublishedContentByUrl({
+            url: input.url,
+            visitorAuthToken: input.visitorAuthToken,
+            redirectOnError: input.redirectOnError,
+        })
+    );
+
+    return fetchSiteContextByURLLookup(baseContext, data);
+}
+
 /**
  * Fetch the context of a site using the resolution of a URL
  */
 export async function fetchSiteContextByURLLookup(
     baseContext: GitBookBaseContext,
-    data: SiteURLData
+    data: PublishedSiteContentLookup
 ): Promise<GitBookSiteContext> {
-    return await fetchSiteContextByIds(baseContext, {
+    const { dataFetcher } = baseContext;
-        organization: data.organization,
+    if ('redirect' in data) {
-        site: data.site,
+        redirect(data.redirect);
-        siteSection: data.siteSection,
+    }
-        siteSpace: data.siteSpace,
+
-        space: data.space,
+    return await fetchSiteContextByIds(
-        shareKey: data.shareKey,
+        {
-        changeRequest: data.changeRequest,
+            ...baseContext,
-        revision: data.revision,
+            dataFetcher: dataFetcher.withToken({
-    });
+                apiToken: data.apiToken,
+            }),
+        },
+        {
+            organization: data.organization,
+            site: data.site,
+            siteSection: data.siteSection,
+            siteSpace: data.siteSpace,
+            space: data.space,
+            shareKey: data.shareKey,
+            changeRequest: data.changeRequest,
+            revision: data.revision,
+        }
+    );
 }
 
 /**
@@ -307,7 +329,7 @@ export async function fetchSpaceContextByIds(
             })
         ),
         ids.changeRequest
-            ? getDataOrNull(
+            ? throwIfDataError(
                   dataFetcher.getChangeRequest({
                       spaceId: ids.space,
                       changeRequestId: ids.changeRequest,
@@ -316,30 +338,17 @@ export async function fetchSpaceContextByIds(
             : null,
     ]);
 
-    if (ids.changeRequest && !changeRequest) {
+    const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision;
-        // 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 throwIfDataError(
-
-    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,

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

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

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

@@ -4,5 +4,3 @@ 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,5 +1,5 @@
 import { race, tryCatch } from '@/lib/async';
-import { joinPath, joinPathWithBaseURL } from '@/lib/paths';
+import { joinPath } from '@/lib/paths';
 import { trace } from '@/lib/tracing';
 import type { PublishedSiteContentLookup } from '@gitbook/api';
 import { apiClient } from './api';
@@ -15,14 +15,13 @@ 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 api = await apiClient();
 
         const callResult = await trace(
             {
@@ -36,13 +35,6 @@ export async function getPublishedContentByURL(input: {
                             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,
@@ -102,16 +94,12 @@ export async function getPublishedContentByURL(input: {
          * 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),
+                changeRequest: data.changeRequest ?? lookup.changeRequest,
+                revision: data.revision ?? lookup.revision,
                 basePath: joinPath(data.basePath, lookup.basePath ?? ''),
                 pathname: joinPath(data.pathname, alternative.extraPath),
-                ...(changeRequest ? { changeRequest } : {}),
-                ...(revision ? { revision } : {}),
             };
             return { data: siteResult };
         }

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

@@ -15,13 +15,12 @@ export async function getPageDocument(
             dataFetcher.getDocument({ spaceId: space.id, documentId: page.documentId })
         );
     }
-    if ('computed' in page && page.computed) {
+    if (page.computed) {
         return getDataOrNull(
             dataFetcher.getComputedDocument({
                 organizationId: space.organization,
                 spaceId: space.id,
                 source: page.computed,
-                seed: page.computedSeed,
             })
         );
     }

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

@@ -37,6 +37,15 @@ export interface GitBookDataFetcher {
      */
     getUserById(userId: string): Promise<DataFetcherResponse<api.User>>;
 
+    /**
+     * Get a published content by its URL.
+     */
+    getPublishedContentByUrl(params: {
+        url: string;
+        visitorAuthToken: string | null;
+        redirectOnError: boolean;
+    }): Promise<DataFetcherResponse<api.PublishedSiteContentLookup>>;
+
     /**
      * Get a published content site by its organization ID and site ID.
      */
@@ -97,15 +106,6 @@ export interface GitBookDataFetcher {
         path: string;
     }): Promise<DataFetcherResponse<api.RevisionPageDocument | api.RevisionPageGroup>>;
 
-    /**
-     * Get the markdown content of a page by its path.
-     */
-    getRevisionPageMarkdown(params: {
-        spaceId: string;
-        revisionId: string;
-        pageId: string;
-    }): Promise<DataFetcherResponse<string>>;
-
     /**
      * Get a document by its space ID and document ID.
      */
@@ -120,7 +120,6 @@ export interface GitBookDataFetcher {
         organizationId: string;
         spaceId: string;
         source: api.ComputedContentSource;
-        seed: string;
     }): Promise<DataFetcherResponse<api.JSONDocument>>;
 
     /**
@@ -171,23 +170,4 @@ export interface GitBookDataFetcher {
         /** 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/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/globals.ts

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

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

packages/gitbook-v2/src/lib/images/getImageResizingContextId.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;
-}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,51 +1,25 @@
 import { describe, expect, it } from 'bun:test';
-import { createLinker } from './links';
+import { appendBasePathToLinker, createLinker } from './links';
 
 const root = createLinker({
     host: 'docs.company.com',
-    spaceBasePath: '/',
+    pathname: '/',
-    siteBasePath: '/',
 });
 
 const variantInSection = createLinker({
     host: 'docs.company.com',
-    spaceBasePath: '/section/variant',
+    pathname: '/section/variant',
-    siteBasePath: '/',
-});
-
-const siteGitBookIO = createLinker({
-    host: 'org.gitbook.io',
-    spaceBasePath: '/sitename/variant/',
-    siteBasePath: '/sitename/',
 });
 
 describe('toPathInContent', () => {
     it('should return the correct path', () => {
-        expect(root.toPathInSpace('some/path')).toBe('/some/path');
+        expect(root.toPathInContent('some/path')).toBe('/some/path');
-        expect(variantInSection.toPathInSpace('some/path')).toBe('/section/variant/some/path');
+        expect(variantInSection.toPathInContent('some/path')).toBe('/section/variant/some/path');
     });
 
     it('should handle leading slash', () => {
-        expect(root.toPathInSpace('/some/path')).toBe('/some/path');
+        expect(root.toPathInContent('/some/path')).toBe('/some/path');
-        expect(variantInSection.toPathInSpace('/some/path')).toBe('/section/variant/some/path');
+        expect(variantInSection.toPathInContent('/some/path')).toBe('/section/variant/some/path');
-    });
-});
-
-describe('toPathInSite', () => {
-    it('should return the correct path', () => {
-        expect(root.toPathInSite('some/path')).toBe('/some/path');
-        expect(siteGitBookIO.toPathInSite('some/path')).toBe('/sitename/some/path');
-    });
-});
-
-describe('toRelativePathInSite', () => {
-    it('should return the correct path', () => {
-        expect(root.toRelativePathInSite('/some/path')).toBe('some/path');
-        expect(siteGitBookIO.toRelativePathInSite('/sitename/some/path')).toBe('some/path');
-    });
-
-    it('should preserve absolute paths outside of the site', () => {
-        expect(siteGitBookIO.toRelativePathInSite('/outside/some/path')).toBe('/outside/some/path');
     });
 });
 
@@ -58,17 +32,27 @@ describe('toAbsoluteURL', () => {
     });
 });
 
-describe('toLinkForContent', () => {
+describe('appendBasePathToLinker', () => {
-    it('should return the correct path', () => {
+    const prefixedRoot = appendBasePathToLinker(root, '/section/variant');
-        expect(root.toLinkForContent('https://docs.company.com/some/path')).toBe('/some/path');
+    const prefixedVariantInSection = appendBasePathToLinker(variantInSection, '/base');
-        expect(siteGitBookIO.toLinkForContent('https://org.gitbook.io/sitename/some/path')).toBe(
+
-            '/sitename/some/path'
+    describe('toPathInContent', () => {
-        );
+        it('should return the correct path', () => {
+            expect(prefixedRoot.toPathInContent('some/path')).toBe('/section/variant/some/path');
+            expect(prefixedVariantInSection.toPathInContent('some/path')).toBe(
+                '/section/variant/base/some/path'
+            );
+        });
     });
 
-    it('should preserve an absolute URL if the site is not the same', () => {
+    describe('toAbsoluteURL', () => {
-        expect(siteGitBookIO.toLinkForContent('https://org.gitbook.io/anothersite/some/path')).toBe(
+        it('should return the correct path', () => {
-            'https://org.gitbook.io/anothersite/some/path'
+            expect(prefixedRoot.toAbsoluteURL('some/path')).toBe(
-        );
+                'https://docs.company.com/some/path'
+            );
+            expect(prefixedVariantInSection.toAbsoluteURL('some/path')).toBe(
+                'https://docs.company.com/some/path'
+            );
+        });
     });
 });

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

@@ -1,5 +1,4 @@
 import { getPagePath } from '@/lib/pages';
-import { withLeadingSlash, withTrailingSlash } from '@/lib/paths';
 import type { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
 import warnOnce from 'warn-once';
 
@@ -8,28 +7,17 @@ import warnOnce from 'warn-once';
  *
  * URL levels:
  *
- * https://docs.company.com/basename/section/variant/page
+ * https://docs.company.com/section/variant/page
  *
- * toPathInSpace('some/path') => /basename/section/variant/some/path
+ * toPathInContent('some/path') => /section/variant/some/path
- * toPathInSite('some/path') => /basename/some/path
+ * toPathForPage({ pages, page }) => /section/variant/some/path
- * toPathForPage({ pages, page }) => /basename/section/variant/some/path
  * toAbsoluteURL('some/path') => https://docs.company.com/some/path
  */
-export interface GitBookLinker {
+export interface GitBookSpaceLinker {
     /**
      * Generate an absolute path for a relative path to the current content.
      */
-    toPathInSpace(relativePath: string): string;
+    toPathInContent(relativePath: string): string;
-
-    /**
-     * Generate an absolute path for a relative path to the current site.
-     */
-    toPathInSite(relativePath: string): string;
-
-    /**
-     * Transform an absolute path in a site, to a relative path from the root of the site.
-     */
-    toRelativePathInSite(absolutePath: string): string;
 
     /**
      * Generate an absolute path for a page in the current content.
@@ -60,36 +48,14 @@ export function createLinker(
     servedOn: {
         protocol?: string;
         host?: string;
-
+        pathname: string;
-        /** The base path of the space */
-        spaceBasePath: string;
-
-        /** The base path of the site */
-        siteBasePath: string;
     }
-): GitBookLinker {
+): GitBookSpaceLinker {
     warnOnce(!servedOn.host, 'No host provided to createLinker. It can lead to issues with links.');
 
-    const siteBasePath = withTrailingSlash(withLeadingSlash(servedOn.siteBasePath));
+    const linker: GitBookSpaceLinker = {
-    const spaceBasePath = withTrailingSlash(withLeadingSlash(servedOn.spaceBasePath));
+        toPathInContent(relativePath: string): string {
-
+            return joinPaths(servedOn.pathname, relativePath);
-    const linker: GitBookLinker = {
-        toPathInSpace(relativePath: string): string {
-            return joinPaths(spaceBasePath, relativePath);
-        },
-
-        toPathInSite(relativePath: string): string {
-            return joinPaths(siteBasePath, relativePath);
-        },
-
-        toRelativePathInSite(absolutePath: string): string {
-            const normalizedPath = withLeadingSlash(absolutePath);
-
-            if (!normalizedPath.startsWith(servedOn.siteBasePath)) {
-                return normalizedPath;
-            }
-
-            return normalizedPath.slice(servedOn.siteBasePath.length);
         },
 
         toAbsoluteURL(absolutePath: string): string {
@@ -101,25 +67,48 @@ export function createLinker(
         },
 
         toPathForPage({ pages, page, anchor }) {
-            return linker.toPathInSpace(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
+            return linker.toPathInContent(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
         },
 
-        toLinkForContent(rawURL: string): string {
+        toLinkForContent(url: string): string {
-            const url = new URL(rawURL);
+            return url;
-
-            // If the link points to a content in the same site, we return an absolute path
-            // instead of a full URL; it makes it possible to use router navigation
-            if (url.hostname === servedOn.host && url.pathname.startsWith(servedOn.siteBasePath)) {
-                return url.pathname;
-            }
-
-            return rawURL;
         },
     };
 
     return linker;
 }
 
+/**
+ * Append a prefix to a linker.
+ */
+export function appendBasePathToLinker(
+    linker: GitBookSpaceLinker,
+    basePath: string
+): GitBookSpaceLinker {
+    const linkerWithPrefix: GitBookSpaceLinker = {
+        toPathInContent(relativePath: string): string {
+            return linker.toPathInContent(joinPaths(basePath, relativePath));
+        },
+
+        toAbsoluteURL(absolutePath: string): string {
+            return linker.toAbsoluteURL(absolutePath);
+        },
+
+        toPathForPage({ pages, page, anchor }) {
+            return (
+                linkerWithPrefix.toPathInContent(getPagePath(pages, page)) +
+                (anchor ? `#${anchor}` : '')
+            );
+        },
+
+        toLinkForContent(url: string): string {
+            return linker.toLinkForContent(url);
+        },
+    };
+
+    return linkerWithPrefix;
+}
+
 function joinPaths(prefix: string, path: string): string {
     const prefixPath = prefix.endsWith('/') ? prefix : `${prefix}/`;
     const suffixPath = path.startsWith('/') ? path.slice(1) : path;

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

@@ -1,6 +1,5 @@
-import { CustomizationThemeMode } from '@gitbook/api';
+import { CustomizationThemeMode, type PublishedSiteContent } from '@gitbook/api';
 import { headers } from 'next/headers';
-import type { SiteURLData } from './context';
 
 export enum MiddlewareHeaders {
     /**
@@ -33,6 +32,11 @@ export enum MiddlewareHeaders {
      */
     Customization = 'x-gitbook-customization',
 
+    /**
+     * The visitor token used to access this content
+     */
+    VisitorAuthToken = 'x-gitbook-visitor-token',
+
     /**
      * The API token used to fetch the content.
      * This should only be passed for non-site dynamic routes.
@@ -58,7 +62,7 @@ export async function getURLModeFromMiddleware(): Promise<'url' | 'url-host'> {
  * Get the site URL data from the middleware headers.
  * This function should only be called in a server action or a dynamic route.
  */
-export async function getSiteURLDataFromMiddleware(): Promise<SiteURLData> {
+export async function getSiteURLDataFromMiddleware(): Promise<PublishedSiteContent> {
     const headersList = await headers();
     const siteURLData = headersList.get(MiddlewareHeaders.SiteURLData);
 
@@ -101,6 +105,20 @@ export async function getThemeFromMiddleware() {
         : CustomizationThemeMode.Dark;
 }
 
+/**
+ * Get the visitor auth token from the middleware headers.
+ * This function should only be called in a dynamic route.
+ */
+export async function getVisitorAuthTokenFromMiddleware(): Promise<string | null> {
+    const headersList = await headers();
+    const visitorAuthToken = headersList.get(MiddlewareHeaders.VisitorAuthToken);
+    if (!visitorAuthToken) {
+        return null;
+    }
+
+    return visitorAuthToken;
+}
+
 /**
  * Get the API token from the middleware headers.
  * This function should only be called in a dynamic route.

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

@@ -16,8 +16,8 @@ export async function getServerActionBaseContext() {
 
     return getBaseContext({
         siteURL,
-        siteURLData,
         urlMode,
+        apiToken: siteURLData.apiToken,
     });
 }
 

packages/gitbook-v2/src/middleware.ts

@@ -1,7 +1,6 @@
 import { CustomizationThemeMode } from '@gitbook/api';
 import type { NextRequest } from 'next/server';
 import { NextResponse } from 'next/server';
-import rison from 'rison';
 
 import { getContentSecurityPolicy } from '@/lib/csp';
 import { validateSerializedCustomization } from '@/lib/customization';
@@ -14,17 +13,16 @@ import {
     normalizeVisitorAuthURL,
 } from '@/lib/visitor-token';
 import { serveResizedImage } from '@/routes/image';
+import { getLinkerForSiteURL } from '@v2/lib/context';
 import {
     DataFetcherError,
     getPublishedContentByURL,
-    getVisitorAuthBasePath,
     normalizeURL,
     throwIfDataError,
 } from '@v2/lib/data';
 import { isGitBookAssetsHostURL, isGitBookHostURL } from '@v2/lib/env';
-import { getImageResizingContextId } from '@v2/lib/images';
 import { MiddlewareHeaders } from '@v2/lib/middleware';
-import type { SiteURLData } from './lib/context';
+
 export const config = {
     matcher: [
         '/((?!_next/static|_next/image|~gitbook/static|~gitbook/revalidate|~gitbook/monitoring|~scalar/proxy).*)',
@@ -43,7 +41,7 @@ export async function middleware(request: NextRequest) {
             return NextResponse.redirect(normalized.toString());
         }
 
-        for (const handler of [serveSiteRoutes, serveSpacePDFRoutes]) {
+        for (const handler of [serveSiteRoutes, servePreviewRoutes]) {
             const result = await handler(requestURL, request);
             if (result) {
                 return result;
@@ -65,8 +63,7 @@ async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
         return null;
     }
 
-    const { url: siteRequestURL, mode } = match;
+    const { url: siteURL, mode } = match;
-    const imagesContextId = getImageResizingContextId(siteRequestURL);
 
     /**
      * Serve image resizing requests (all requests containing `/~gitbook/image`).
@@ -76,9 +73,9 @@ async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
      * In GitBook v1: image resizing was done at the root of the hostname (docs.company.com/~gitbook/image)
      * In GitBook v2: image resizing is done at the content level (docs.company.com/section/variant/~gitbook/image)
      */
-    if (siteRequestURL.pathname.endsWith('/~gitbook/image')) {
+    if (siteURL.pathname.endsWith('/~gitbook/image')) {
         return await serveResizedImage(request, {
-            imagesContextId: imagesContextId,
+            host: siteURL.host,
         });
     }
 
@@ -86,223 +83,181 @@ async function serveSiteRoutes(requestURL: URL, request: NextRequest) {
     // Detect and extract the visitor authentication token from the request
     //
     // @ts-ignore - request typing
-    const visitorToken = getVisitorToken({
+    const visitorToken = getVisitorToken(request, siteURL);
-        cookies: request.cookies.getAll(),
-        url: siteRequestURL,
-    });
 
-    const withAPIToken = async (apiToken: string | null) => {
+    const data = await throwIfDataError(
-        const siteURLData = await throwIfDataError(
+        getPublishedContentByURL({
-            getPublishedContentByURL({
+            url: siteURL.toString(),
-                url: siteRequestURL.toString(),
+            visitorAuthToken: visitorToken?.token ?? null,
-                visitorAuthToken: visitorToken?.token ?? null,
+            // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
-                // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
+            // redirecting when the token is invalid as we could be dealing with stale token stored in the cookie.
-                // redirecting when the token is invalid as we could be dealing with stale token stored in the cookie.
+            // For example when the VA backend signature has changed but the token stored in the cookie is not yet expired.
-                // For example when the VA backend signature has changed but the token stored in the cookie is not yet expired.
+            redirectOnError: visitorToken?.source === 'visitor-auth-cookie',
-                redirectOnError: visitorToken?.source === 'visitor-auth-cookie',
+        })
+    );
+    let cookies: ResponseCookies = {};
 
-                // Use the API token passed in the request, if any
+    //
-                // as it could be used for .preview hostnames
+    // Handle redirects
-                apiToken,
+    //
-            })
+    if ('redirect' in data) {
-        );
+        // biome-ignore lint/suspicious/noConsole: we want to log the redirect
-        const cookies: ResponseCookies = [];
+        console.log('redirect', data.redirect);
+        if (data.target === 'content') {
+            // For content redirects, we use the linker to redirect the optimal URL
+            // during development and testing in 'url' mode.
+            const linker = getLinkerForSiteURL({
+                siteURL,
+                urlMode: mode,
+            });
 
-        //
+            const contentRedirect = new URL(linker.toLinkForContent(data.redirect), request.url);
-        // Handle redirects
-        //
-        if ('redirect' in siteURLData) {
-            // biome-ignore lint/suspicious/noConsole: we want to log the redirect
-            console.log('redirect', siteURLData.redirect);
-            if (siteURLData.target === 'content') {
-                let contentRedirect = new URL(siteURLData.redirect, request.url);
 
-                // For content redirects, we redirect using the /url/:url format
+            // Keep the same search params as the original request
-                // during development and testing in 'url' mode.
+            // as it might contain a VA token
-                if (mode === 'url') {
+            contentRedirect.search = request.nextUrl.search;
-                    const urlObject = new URL(siteURLData.redirect);
-                    contentRedirect = new URL(
-                        `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`,
-                        request.url
-                    );
-                }
 
-                // Keep the same search params as the original request
+            return NextResponse.redirect(contentRedirect);
-                // as it might contain a VA token
-                contentRedirect.search = request.nextUrl.search;
-
-                return NextResponse.redirect(contentRedirect);
-            }
-
-            return NextResponse.redirect(siteURLData.redirect);
         }
 
-        cookies.push(
+        return NextResponse.redirect(data.redirect);
-            ...getResponseCookiesForVisitorAuth(
+    }
-                getVisitorAuthBasePath(siteRequestURL, siteURLData),
-                visitorToken
-            )
-        );
 
-        // We use the host/origin from the canonical URL to ensure the links are
+    cookies = {
-        // correctly generated when the site is proxied. e.g. https://proxy.gitbook.com/site/siteId/...
+        ...cookies,
-        const siteCanonicalURL = new URL(siteURLData.canonicalUrl);
+        ...getResponseCookiesForVisitorAuth(data.basePath, visitorToken),
-
-        let incomingURL = requestURL;
-        // For cases where the site is proxied, we use the canonical URL
-        // as the incoming URL along with all the search params from the request.
-        if (mode !== 'url') {
-            incomingURL = siteCanonicalURL;
-            incomingURL.search = requestURL.search;
-        }
-        //
-        // Make sure the URL is clean of any va token after a successful lookup
-        // The token is stored in a cookie that is set on the redirect response
-        //
-        const incomingURLWithoutToken = normalizeVisitorAuthURL(incomingURL);
-        if (incomingURLWithoutToken.toString() !== incomingURL.toString()) {
-            return writeResponseCookies(
-                NextResponse.redirect(incomingURLWithoutToken.toString()),
-                cookies
-            );
-        }
-
-        //
-        // Render and serve the content
-        //
-
-        // The route is static, except when using dynamic parameters from query params
-        // (customization override, theme, etc)
-        let routeType: 'dynamic' | 'static' = 'static';
-
-        // We pick only stable data from the siteURL data to prevent re-rendering of
-        // the root layout when changing pages..
-        const stableSiteURLData: SiteURLData = {
-            site: siteURLData.site,
-            siteSection: siteURLData.siteSection,
-            siteSpace: siteURLData.siteSpace,
-            siteBasePath: siteURLData.siteBasePath,
-            basePath: siteURLData.basePath,
-            space: siteURLData.space,
-            organization: siteURLData.organization,
-            changeRequest: siteURLData.changeRequest,
-            revision: siteURLData.revision,
-            shareKey: siteURLData.shareKey,
-            apiToken: siteURLData.apiToken,
-            imagesContextId: imagesContextId,
-        };
-
-        const requestHeaders = new Headers(request.headers);
-        requestHeaders.set(MiddlewareHeaders.RouteType, routeType);
-        requestHeaders.set(MiddlewareHeaders.URLMode, mode);
-        requestHeaders.set(
-            MiddlewareHeaders.SiteURL,
-            `${siteCanonicalURL.origin}${siteURLData.basePath}`
-        );
-        requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(stableSiteURLData));
-
-        // Preview of customization/theme
-        const customization = siteRequestURL.searchParams.get('customization');
-        if (customization && validateSerializedCustomization(customization)) {
-            routeType = 'dynamic';
-            requestHeaders.set(MiddlewareHeaders.Customization, customization);
-        }
-        const theme = siteRequestURL.searchParams.get('theme');
-        if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
-            routeType = 'dynamic';
-            requestHeaders.set(MiddlewareHeaders.Theme, theme);
-        }
-
-        // We support forcing dynamic routes by setting a `gitbook-dynamic-route` cookie
-        // This is useful for testing dynamic routes.
-        if (request.cookies.has('gitbook-dynamic-route')) {
-            routeType = 'dynamic';
-        }
-
-        // Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied
-        requestHeaders.set('x-forwarded-host', request.nextUrl.host);
-        requestHeaders.set('origin', request.nextUrl.origin);
-
-        const siteURLWithoutProtocol = `${siteCanonicalURL.host}${siteURLData.basePath}`;
-        const { pathname, routeType: routeTypeFromPathname } = encodePathInSiteContent(
-            siteURLData.pathname
-        );
-        routeType = routeTypeFromPathname ?? routeType;
-
-        const route = [
-            'sites',
-            routeType,
-            mode,
-            encodeURIComponent(siteURLWithoutProtocol),
-            encodeURIComponent(
-                rison.encode(
-                    // rison can't encode undefined values
-                    Object.fromEntries(
-                        Object.entries(stableSiteURLData).filter(
-                            ([_, v]) => typeof v !== 'undefined'
-                        )
-                    )
-                )
-            ),
-            pathname,
-        ].join('/');
-
-        console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
-
-        const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
-        const response = NextResponse.rewrite(rewrittenURL, {
-            request: {
-                headers: requestHeaders,
-            },
-        });
-
-        // Add Content Security Policy header
-        response.headers.set('content-security-policy', getContentSecurityPolicy());
-        // Basic security headers
-        response.headers.set('strict-transport-security', 'max-age=31536000');
-        response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
-        response.headers.set('x-content-type-options', 'nosniff');
-        // Debug header
-        response.headers.set('x-gitbook-route-type', routeType);
-        response.headers.set('x-gitbook-route-site', siteURLWithoutProtocol);
-
-        return writeResponseCookies(response, cookies);
     };
 
-    // For https://preview/<siteURL> requests,
+    //
-    if (siteRequestURL.hostname === 'preview') {
+    // Make sure the URL is clean of any va token after a successful lookup
-        return serveWithQueryAPIToken(
+    // The token is stored in a cookie that is set on the redirect response
-            // We scope the API token to the site ID.
+    //
-            `${siteRequestURL.hostname}/${requestURL.pathname.slice(1).split('/')[0]}`,
+    const requestURLWithoutToken = normalizeVisitorAuthURL(requestURL);
-            request,
+    if (requestURLWithoutToken.toString() !== requestURL.toString()) {
-            withAPIToken
+        return writeResponseCookies(
+            NextResponse.redirect(requestURLWithoutToken.toString()),
+            cookies
         );
     }
 
-    return withAPIToken(null);
+    //
+    // Render and serve the content
+    //
+
+    // When visitor has authentication (adaptive content or VA), we serve dynamic routes.
+    let routeType = visitorToken ? 'dynamic' : 'static';
+
+    const requestHeaders = new Headers(request.headers);
+    requestHeaders.set(MiddlewareHeaders.RouteType, routeType);
+    requestHeaders.set(MiddlewareHeaders.URLMode, mode);
+    requestHeaders.set(MiddlewareHeaders.SiteURL, `${siteURL.origin}${data.basePath}`);
+    requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data));
+
+    // Preview of customization/theme
+    const customization = siteURL.searchParams.get('customization');
+    if (customization && validateSerializedCustomization(customization)) {
+        routeType = 'dynamic';
+        requestHeaders.set(MiddlewareHeaders.Customization, customization);
+    }
+    const theme = siteURL.searchParams.get('theme');
+    if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
+        routeType = 'dynamic';
+        requestHeaders.set(MiddlewareHeaders.Theme, theme);
+    }
+
+    // We support forcing dynamic routes by setting a `gitbook-dynamic-route` cookie
+    // This is useful for testing dynamic routes.
+    if (request.cookies.has('gitbook-dynamic-route')) {
+        routeType = 'dynamic';
+    }
+
+    // Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied
+    requestHeaders.set('x-forwarded-host', request.nextUrl.host);
+    requestHeaders.set('origin', request.nextUrl.origin);
+
+    const siteURLWithoutProtocol = `${siteURL.host}${data.basePath}`;
+    const { pathname, routeType: routeTypeFromPathname } = encodePathInSiteContent(data.pathname);
+    routeType = routeTypeFromPathname ?? routeType;
+
+    const route = [
+        'sites',
+        routeType,
+        mode,
+        encodeURIComponent(siteURLWithoutProtocol),
+        pathname,
+    ].join('/');
+
+    console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
+
+    const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
+    const response = NextResponse.rewrite(rewrittenURL, {
+        request: {
+            headers: requestHeaders,
+        },
+    });
+
+    // Add Content Security Policy header
+    response.headers.set('content-security-policy', getContentSecurityPolicy());
+    // Basic security headers
+    response.headers.set('strict-transport-security', 'max-age=31536000');
+    response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
+    response.headers.set('x-content-type-options', 'nosniff');
+    // Debug header
+    response.headers.set('x-gitbook-route-type', routeType);
+    response.headers.set('x-gitbook-route-site', siteURLWithoutProtocol);
+
+    return writeResponseCookies(response, cookies);
 }
 
 /**
- * Serve routes for PDF export for a space: /~space/:spaceId/~gitbook/pdf
+ * Serve routes for previewing unpublished content.
+ * Routes are:
+ *   - PDF export for a space: /~space/:spaceId/~gitbook/pdf
+ *   - Preview of an unpublished site: /~site/:siteId/
  */
-async function serveSpacePDFRoutes(requestURL: URL, request: NextRequest) {
+async function servePreviewRoutes(requestURL: URL, request: NextRequest) {
     const pathnameParts = requestURL.pathname.slice(1).split('/');
+
     if (pathnameParts[0] !== '~space' && pathnameParts[0] !== '~site') {
         return null;
     }
 
-    return serveWithQueryAPIToken(
+    // We store the API token in a cookie that is scoped to the specific preview route
-        pathnameParts.slice(0, 2).join('/'),
+    // to avoid errors when multiple previews are opened in different tabs.
-        request,
+    const cookieName = getPathScopedCookieName(
-        async (apiToken) => {
+        'gitbook-api-token',
-            // Handle the rest with the router default logic
+        pathnameParts.slice(0, 2).join('/')
-            return NextResponse.next({
-                headers: {
-                    [MiddlewareHeaders.APIToken]: apiToken,
-                },
-            });
-        }
     );
+
+    // Extract a potential GitBook API token passed in the request
+    // If found, we redirect to the same URL but with the token in the cookie
+    const queryAPIToken = requestURL.searchParams.get('token');
+    if (queryAPIToken) {
+        requestURL.searchParams.delete('token');
+        return writeResponseCookies(NextResponse.redirect(requestURL.toString()), {
+            [cookieName]: {
+                value: queryAPIToken,
+                options: {
+                    httpOnly: true,
+                    sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
+                    secure: process.env.NODE_ENV === 'production',
+                    maxAge: 60 * 60, // 1 hour
+                },
+            },
+        });
+    }
+
+    const apiToken = request.cookies.get(cookieName)?.value;
+    if (!apiToken) {
+        throw new DataFetcherError('Missing API token', 400);
+    }
+
+    // Handle the rest with the router default logic
+    return NextResponse.next({
+        headers: {
+            [MiddlewareHeaders.APIToken]: apiToken,
+        },
+    });
 }
 
 /**
@@ -319,45 +274,6 @@ function serveErrorResponse(error: Error) {
     throw error;
 }
 
-/**
- * Server a response with an API token obtained from the query params.
- */
-async function serveWithQueryAPIToken(
-    scopePath: string,
-    request: NextRequest,
-    serve: (apiToken: string) => Promise<NextResponse>
-) {
-    // We store the API token in a cookie that is scoped to the specific route
-    // to avoid errors when multiple previews are opened in different tabs.
-    const cookieName = getPathScopedCookieName('gitbook-api-token', scopePath);
-
-    // Extract a potential GitBook API token passed in the request
-    // If found, we redirect to the same URL but with the token in the cookie
-    const queryAPIToken = request.nextUrl.searchParams.get('token');
-    if (queryAPIToken) {
-        request.nextUrl.searchParams.delete('token');
-        return writeResponseCookies(NextResponse.redirect(request.nextUrl.toString()), [
-            {
-                name: cookieName,
-                value: queryAPIToken,
-                options: {
-                    httpOnly: true,
-                    sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
-                    secure: process.env.NODE_ENV === 'production',
-                    maxAge: 60 * 60, // 1 hour
-                },
-            },
-        ]);
-    }
-
-    const apiToken = request.cookies.get(cookieName)?.value;
-    if (!apiToken) {
-        throw new DataFetcherError('Missing API token', 400);
-    }
-
-    return serve(apiToken);
-}
-
 /**
  * The URL of the GitBook content can be passed in 3 different ways (in order of priority):
  * - The request has a `X-GitBook-URL` header:
@@ -426,26 +342,12 @@ function encodePathInSiteContent(rawPathname: string): {
         return { pathname };
     }
 
-    // If the pathname is a markdown file, we rewrite it to ~gitbook/markdown/:pathname
-    if (pathname.match(/\.md$/)) {
-        const pagePathWithoutMD = pathname.slice(0, -3);
-        return {
-            pathname: `~gitbook/markdown/${encodeURIComponent(pagePathWithoutMD)}`,
-            // The markdown content is always static and doesn't depend on the dynamic parameter (customization, theme, etc)
-            routeType: 'static',
-        };
-    }
-
     switch (pathname) {
         case '~gitbook/icon':
-            return { pathname };
         case 'llms.txt':
         case 'sitemap.xml':
-        case 'sitemap-pages.xml':
         case 'robots.txt':
-            // LLMs.txt, sitemap, sitemap-pages and robots.txt are always static
+            return { pathname };
-            // as they only depend on the site structure / pages.
-            return { pathname, routeType: 'static' };
         case '~gitbook/pdf':
             // PDF routes are always dynamic as they depend on the search params.
             return { pathname, routeType: 'dynamic' };
@@ -469,8 +371,8 @@ function appendQueryParams(url: URL, from: URLSearchParams) {
  * Write the cookies to a response.
  */
 function writeResponseCookies<R extends NextResponse>(response: R, cookies: ResponseCookies): R {
-    cookies.forEach((cookie) => {
+    Object.entries(cookies).forEach(([key, { value, options }]) => {
-        response.cookies.set(cookie.name, cookie.value, cookie.options);
+        response.cookies.set(key, value, options);
     });
 
     return response;

packages/gitbook-v2/wrangler.jsonc

@@ -1,137 +0,0 @@
-{
-    "main": ".open-next/worker.js",
-    "name": "gitbook-open-v2",
-    "compatibility_date": "2025-04-14",
-    "compatibility_flags": ["nodejs_compat", "allow_importable_env"],
-    "assets": {
-        "directory": ".open-next/assets",
-        "binding": "ASSETS"
-    },
-    "observability": {
-        "enabled": true
-    },
-    "env": {
-        "preview": {
-            "r2_buckets": [
-                {
-                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
-                    "bucket_name": "gitbook-open-v2-cache-preview"
-                }
-            ],
-            "services": [
-                {
-                    "binding": "WORKER_SELF_REFERENCE",
-                    "service": "gitbook-open-v2-preview"
-                },
-                {
-                    "binding": "GITBOOK_API",
-                    "service": "gitbook-x-prod-api-cache"
-                }
-            ]
-            // No durable objects on preview, as they block the generation of preview URLs
-            // and we don't need tags invalidation on preview
-        },
-        "staging": {
-            "routes": [
-                {
-                    "pattern": "open-2c.gitbook-staging.com/*",
-                    "zone_name": "gitbook-staging.com"
-                },
-                {
-                    "pattern": "static-2c.gitbook-staging.com/*",
-                    "zone_name": "gitbook-staging.com"
-                }
-            ],
-            "r2_buckets": [
-                {
-                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
-                    "bucket_name": "gitbook-open-v2-cache-staging"
-                }
-            ],
-            "services": [
-                {
-                    "binding": "WORKER_SELF_REFERENCE",
-                    "service": "gitbook-open-v2-staging"
-                },
-                {
-                    "binding": "GITBOOK_API",
-                    "service": "gitbook-x-staging-api-cache"
-                }
-            ],
-            "tail_consumers": [
-                {
-                    "service": "gitbook-x-staging-tail"
-                }
-            ],
-            "durable_objects": {
-                "bindings": [
-                    {
-                        "name": "NEXT_CACHE_DO_QUEUE",
-                        "class_name": "DOQueueHandler"
-                    },
-                    {
-                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
-                        "class_name": "DOShardedTagCache"
-                    }
-                ]
-            },
-            "migrations": [
-                {
-                    "tag": "v1",
-                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache"]
-                }
-            ]
-        },
-        "production": {
-            "routes": [
-                {
-                    "pattern": "open-2c.gitbook.com/*",
-                    "zone_name": "gitbook.com"
-                },
-                {
-                    "pattern": "static-2c.gitbook.com/*",
-                    "zone_name": "gitbook.com"
-                }
-            ],
-            "r2_buckets": [
-                {
-                    "binding": "NEXT_INC_CACHE_R2_BUCKET",
-                    "bucket_name": "gitbook-open-v2-cache-production"
-                }
-            ],
-            "services": [
-                {
-                    "binding": "WORKER_SELF_REFERENCE",
-                    "service": "gitbook-open-v2-production"
-                },
-                {
-                    "binding": "GITBOOK_API",
-                    "service": "gitbook-x-prod-api-cache"
-                }
-            ],
-            "tail_consumers": [
-                {
-                    "service": "gitbook-x-prod-tail"
-                }
-            ],
-            "durable_objects": {
-                "bindings": [
-                    {
-                        "name": "NEXT_CACHE_DO_QUEUE",
-                        "class_name": "DOQueueHandler"
-                    },
-                    {
-                        "name": "NEXT_TAG_CACHE_DO_SHARDED",
-                        "class_name": "DOShardedTagCache"
-                    }
-                ]
-            },
-            "migrations": [
-                {
-                    "tag": "v1",
-                    "new_sqlite_classes": ["DOQueueHandler", "DOShardedTagCache"]
-                }
-            ]
-        }
-    }
-}

packages/gitbook-v2/wrangler.toml

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

packages/gitbook/CHANGELOG.md

@@ -1,160 +1,5 @@
 # gitbook
 
-## 0.11.1
-
-### Patch Changes
-
-- Updated dependencies [ebc39e9]
-- Updated dependencies [b6b09d4]
-  - @gitbook/react-openapi@1.2.1
-
-## 0.11.0
-
-### Minor Changes
-
-- d67699a: Add OpenAPI Webhook block
-
-### Patch Changes
-
-- 4b8a621: Show sections tabs only if there is at least two sections
-- 8ed1bda: Translate OpenAPI blocks
-- 7588cfe: Improve OpenAPIResponses examples and schemas
-- Updated dependencies [eeb977f]
-- Updated dependencies [3363a18]
-- Updated dependencies [d67699a]
-- Updated dependencies [8ed1bda]
-- Updated dependencies [7588cfe]
-- Updated dependencies [ad1dc0b]
-  - @gitbook/react-openapi@1.2.0
-
-## 0.10.1
-
-### Patch Changes
-
-- Updated dependencies [77397ca]
-  - @gitbook/cache-tags@0.3.1
-
-## 0.10.0
-
-### Minor Changes
-
-- b62b101: Do not set cookie to identify visitor for insights when disabled.
-
-### Patch Changes
-
-- 95ea22d: Cache AI Page Link summary
-- daf41fc: Tweak footer design (and refactor)
-- de53946: Fix security issue with injection of "javacript:` url in the back button of PDFs
-- b92ecfa: Implement retry logic for the DO cache to prevent when revalidating content.
-- 528eee3: Add superscript and subscript text rendering
-- aa3357a: Fix OpenAPISchemas description padding
-- 168a4fa: Add support for buttons to GitBook.
-- 70c4182: Improve OpenAPI schema style
-- 2b6c593: Remove stable from x-stability
-- 580f7ad: Improve the error message returned by the revalidate endpoint.
-- cbd768a: Improve OpenAPI codesample (add OpenAPISelect component)
-- c765463: Fix ogimage generation crashing when site is using a custom WOFF2 font
-- e59076a: Improve OpenAPI schemas block ungrouped style. Classnames have changed, please refer to this PR to update GBX.
-- 29aaba5: Override Scalar's overscroll-behavior
-- 90ead98: Better error handling in cache revalidation.
-- Updated dependencies [116575c]
-- Updated dependencies [cdffd7c]
-- Updated dependencies [70c4182]
-- Updated dependencies [2b6c593]
-- Updated dependencies [cbd768a]
-- Updated dependencies [e59076a]
-- Updated dependencies [eedefdd]
-- Updated dependencies [23cedd2]
-  - @gitbook/cache-tags@0.3.0
-  - @gitbook/colors@0.3.2
-  - @gitbook/react-openapi@1.1.10
-  - @gitbook/openapi-parser@2.1.3
-
-## 0.9.2
-
-### Patch Changes
-
-- da7b369: Fix missing headers in OpenAPIResponses
-- 139a805: Fix OpenAPI enum display
-- Updated dependencies [da7b369]
-- Updated dependencies [da485f5]
-- Updated dependencies [139a805]
-  - @gitbook/react-openapi@1.1.9
-
-## 0.9.1
-
-### Patch Changes
-
-- fb90eb0: Limit tinted background on bold theme to sites with filled sidebar
-- 7d0b422: Handle grouped OpenAPISchemas
-- Updated dependencies [7d0b422]
-- Updated dependencies [fb90eb0]
-  - @gitbook/react-openapi@1.1.8
-  - @gitbook/colors@0.3.1
-
-## 0.9.0
-
-### Minor Changes
-
-- 77fd393: Track event when visitor is opening a search result.
-- d70d566: Support site announcement banner
-- 77fd393: Track event when clicking announcement banner link.
-
-### Patch Changes
-
-- e84a46a: Fix OpenAPI tabs indicator overflow
-- bc90adb: Fix favicon not being displayed in Google because `robots.txt` was preventing the indexation of the image route
-- 434af90: Fix image resizing when using the proxy feature in a site.
-- c756761: Add breadcrumbs to search results
-- 40e8e69: Disallow crawling by web-robots of search/ask URLs
-- 77fd393: Fix clicking search results when the site is embedded in an iframe.
-- 1505ddb: Fix multiple request examples selector not showing
-- 61db166: Add OpenAPI write-only indicator
-- 6f71da8: Fix padding in schemas
-- fa91eb7: Fix PDF generation when user has dark mode configured.
-- 5b1e01c: Support for x-stability property
-- 57ca4e0: Fix a crash when a page contains a block of an integration that is no longer installed
-- d236bf0: Fix flash when loading sites with dark mode as default theme
-- cd99ed5: Fix spec properties rendering and missing keys
-- 813b2af: Support for x-enumDescriptions and x-gitbook-enum
-- e9fa50d: Trim the search query to avoid showing a loading state when typing
-- Updated dependencies [bd35348]
-- Updated dependencies [ae78fc5]
-- Updated dependencies [7bb37c7]
-- Updated dependencies [373183a]
-- Updated dependencies [1505ddb]
-- Updated dependencies [61db166]
-- Updated dependencies [5b1e01c]
-- Updated dependencies [cd99ed5]
-- Updated dependencies [813b2af]
-- Updated dependencies [a25fded]
-  - @gitbook/react-openapi@1.1.7
-  - @gitbook/openapi-parser@2.1.2
-
-## 0.8.2
-
-### Patch Changes
-
-- ed07206: Fix OpenAPI path overflow on mobile
-- 4dab1c5: Fix alignment of `prominent` search bar on full-width pages
-- 6eae764: Support body examples
-- 54ee014: Add initial support for loading custom fonts
-- d2facb2: Mark properties as optional if not required
-- bba2e52: Fix site redirects when it includes a section/variant path
-- 4723f03: Restyle section group dropdown
-- 24b7808: Fix `prominent` search bar width on `md` screens
-- 1fe3286: Fix OpenAPI block overflow issue
-- Updated dependencies [48c18c0]
-- Updated dependencies [6eae764]
-- Updated dependencies [7212973]
-- Updated dependencies [d2facb2]
-- Updated dependencies [73e2b47]
-- Updated dependencies [70be2c6]
-- Updated dependencies [fc00b51]
-- Updated dependencies [a84b06b]
-  - @gitbook/openapi-parser@2.1.1
-  - @gitbook/react-openapi@1.1.6
-
 ## 0.8.1
 
 ### Patch Changes

packages/gitbook/e2e/customers.spec.ts

@@ -1,4 +1,4 @@
-import { type TestsCase, runTestCases, waitForCookiesDialog } from './util';
+import { type TestsCase, runTestCases } from './util';
 
 /** A list of test cases to run on the customers' docs sites. */
 const testCases: TestsCase[] = [
@@ -6,22 +6,15 @@ const testCases: TestsCase[] = [
         name: 'Snyk',
         contentBaseURL: 'https://docs.snyk.io',
         tests: [
-            { name: 'Home', url: '/', run: waitForCookiesDialog },
+            { name: 'Home', url: '/' },
-            { name: 'OpenAPI', url: '/snyk-api/reference/apps', run: waitForCookiesDialog },
+            { name: 'OpenAPI', url: '/snyk-api/reference/apps' },
         ],
     },
-    // {
+    {
-    //     name: 'Nexthink',
+        name: 'Nexthink',
-    //     contentBaseURL: 'https://docs.nexthink.com',
+        contentBaseURL: 'https://docs.nexthink.com',
-    //     tests: [
+        tests: [{ name: 'Home', url: '/', screenshot: { waitForTOCScrolling: false } }],
-    //         {
+    },
-    //             name: 'Home',
-    //             url: '/',
-    //             screenshot: { waitForTOCScrolling: false },
-    //             run: waitForCookiesDialog,
-    //         },
-    //     ],
-    // },
     {
         name: 'asiksupport-stg.dto.kemkes.go.id',
         contentBaseURL: 'https://asiksupport-stg.dto.kemkes.go.id',
@@ -40,7 +33,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.dify.ai',
         contentBaseURL: 'https://docs.dify.ai',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'seeddao.gitbook.io',
@@ -70,27 +63,32 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.portainer.io',
         contentBaseURL: 'https://docs.portainer.io',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.chirptoken.io',
         contentBaseURL: 'https://docs.chirptoken.io',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.dexscreener.com',
         contentBaseURL: 'https://docs.dexscreener.com',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.pancakeswap.finance',
         contentBaseURL: 'https://docs.pancakeswap.finance',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'book.character.ai',
         contentBaseURL: 'https://book.character.ai',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
+    },
+    {
+        name: 'docs.tradeonnova.io',
+        contentBaseURL: 'https://docs.tradeonnova.io',
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'azcoiner.gitbook.io',
@@ -105,7 +103,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.keeper.io',
         contentBaseURL: 'https://docs.keeper.io',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'adiblar.gitbook.io',
@@ -140,12 +138,12 @@ const testCases: TestsCase[] = [
     {
         name: 'meshnet.nordvpn.com',
         contentBaseURL: 'https://meshnet.nordvpn.com',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'manual.bubble.io',
         contentBaseURL: 'https://manual.bubble.io',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.tickettool.xyz',
@@ -157,15 +155,15 @@ const testCases: TestsCase[] = [
         contentBaseURL: 'https://wiki.redmodding.org',
         tests: [{ name: 'Home', url: '/' }],
     },
-    // {
+    {
-    //     name: 'docs.cherry-ai.com',
+        name: 'docs.cherry-ai.com',
-    //     contentBaseURL: 'https://docs.cherry-ai.com',
+        contentBaseURL: 'https://docs.cherry-ai.com',
-    //     tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
-    // },
+    },
     {
         name: 'docs.snyk.io',
         contentBaseURL: 'https://docs.snyk.io',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.realapp.link',
@@ -190,14 +188,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.umbraco.com',
         contentBaseURL: 'https://docs.umbraco.com',
-        tests: [
+        tests: [{ name: 'Home', url: '/welcome', screenshot: { waitForTOCScrolling: false } }],
-            {
-                name: 'Home',
-                url: '/welcome',
-                run: waitForCookiesDialog,
-                screenshot: { waitForTOCScrolling: false },
-            },
-        ],
     },
     {
         name: 'sosovalue-white-paper.gitbook.io',
@@ -207,12 +198,12 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.revrobotics.com',
         contentBaseURL: 'https://docs.revrobotics.com',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'chartschool.stockcharts.com',
         contentBaseURL: 'https://chartschool.stockcharts.com',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.soniclabs.com',
@@ -227,7 +218,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.thousandeyes.com',
         contentBaseURL: 'https://docs.thousandeyes.com',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
     },
     {
         name: 'docs.raydium.io',
@@ -237,16 +228,7 @@ const testCases: TestsCase[] = [
     {
         name: 'docs.fluentbit.io',
         contentBaseURL: 'https://docs.fluentbit.io',
-        tests: [{ name: 'Home', url: '/', run: waitForCookiesDialog }],
+        tests: [{ name: 'Home', url: '/' }],
-    },
-    {
-        name: 'run-ai-docs.nvidia.com',
-        contentBaseURL: 'https://run-ai-docs.nvidia.com',
-        skip: process.env.ARGOS_BUILD_NAME !== 'customers-v2',
-        tests: [
-            { name: 'Home', url: '/' },
-            { name: 'OG Image', url: '/~gitbook/ogimage/h17zQIFwy3MaafVNmItO', mode: 'image' },
-        ],
     },
 ];
 

packages/gitbook/e2e/internal.spec.ts

@@ -28,7 +28,6 @@ import {
     headerLinks,
     runTestCases,
     waitForCookiesDialog,
-    waitForNotFound,
 } from './util';
 
 const testCases: TestsCase[] = [
@@ -309,18 +308,6 @@ const testCases: TestsCase[] = [
                 url: '~/revisions/S55pwsEr5UVoroaOiWnP/blocks/headings',
                 run: waitForCookiesDialog,
             },
-            {
-                name: 'Invalid revision',
-                url: '~/revisions/idnotfound/blocks/headings',
-                run: waitForNotFound,
-                screenshot: false,
-            },
-            {
-                name: 'Invalid change request',
-                url: '~/changes/idnotfound/blocks/headings',
-                run: waitForNotFound,
-                screenshot: false,
-            },
         ],
     },
     {
@@ -380,82 +367,6 @@ const testCases: TestsCase[] = [
             },
         ],
     },
-    {
-        name: 'Site Preview',
-        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
-        tests: [
-            {
-                name: 'Main content',
-                url: async () => {
-                    const data = await getSiteAPIToken(
-                        'https://gitbook.gitbook.io/test-gitbook-open/'
-                    );
-
-                    const searchParams = new URLSearchParams();
-                    searchParams.set('token', data.apiToken);
-
-                    return `url/preview/${data.site}/?${searchParams.toString()}`;
-                },
-                screenshot: false,
-                run: async (page) => {
-                    await expect(page.locator('[data-testid="table-of-contents"]')).toBeVisible();
-                },
-            },
-        ],
-    },
-    {
-        name: 'Markdown page',
-        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
-        contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
-        tests: [
-            {
-                name: 'Text page',
-                url: 'text-page.md',
-                screenshot: false,
-                run: async (_page, response) => {
-                    expect(response?.status()).toBe(200);
-                    expect(response?.headers()['content-type']).toContain('text/markdown');
-                },
-            },
-        ],
-    },
-    {
-        name: 'Site subdirectory (proxy)',
-        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
-        contentBaseURL: 'https://nextjs-gbo-proxy.vercel.app/documentation/',
-        tests: [
-            {
-                name: 'Main',
-                url: '',
-                fullPage: true,
-            },
-        ],
-    },
-    {
-        name: 'Site subdirectory (proxy) with VA',
-        skip: process.env.ARGOS_BUILD_NAME !== 'v2-vercel',
-        contentBaseURL: 'https://nextjs-gbo-proxy-va.vercel.app/va/docs/',
-        tests: [
-            {
-                name: 'Main',
-                url: () => {
-                    const privateKey =
-                        'rqSfA6x7eAKx1qDRCDq9aCXwivpUvQ8YkXeDdFvCCUa9QchIcM7pF1iJ4o7AGOU49spmOWjKoIPtX0pVUVQ81w==';
-                    const token = jwt.sign(
-                        {
-                            name: 'gitbook-open-tests',
-                        },
-                        privateKey,
-                        {
-                            expiresIn: '24h',
-                        }
-                    );
-                    return `?jwt_token=${token}`;
-                },
-                fullPage: true,
-            },
-        ],
-    },
     {
         name: 'Content tests',
         contentBaseURL: 'https://gitbook.gitbook.io/test-gitbook-open/',
@@ -475,7 +386,7 @@ const testCases: TestsCase[] = [
                 url: 'blocks/block-images',
                 run: waitForCookiesDialog,
                 fullPage: true,
-                screenshot: { threshold: 0.9 },
+                screenshot: { threshold: 0.8 },
             },
             {
                 name: 'Images (with zoom)',
@@ -486,6 +397,7 @@ const testCases: TestsCase[] = [
                     await zoomImage.first().click();
                     await expect(page.getByTestId('zoom-image-modal')).toBeVisible();
                 },
+                fullPage: true,
                 screenshot: { threshold: 0.8 },
             },
             {
@@ -520,12 +432,7 @@ const testCases: TestsCase[] = [
             {
                 name: 'Integration Blocks',
                 url: 'blocks/integrations',
-                run: async (page) => {
+                run: waitForCookiesDialog,
-                    await waitForCookiesDialog(page);
-                    const mermaidIframe = page.locator('iframe[title*="mermaid"]').contentFrame();
-                    await expect(mermaidIframe.getByText('Mermaid', { exact: true })).toBeVisible();
-                    await expect(mermaidIframe.getByText('Diagram', { exact: true })).toBeVisible();
-                },
             },
             {
                 name: 'Tables',
@@ -874,35 +781,6 @@ const testCases: TestsCase[] = [
             },
         ],
     },
-    {
-        name: 'Content Redirects',
-        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/gitbook-doc/',
-        tests: [
-            {
-                name: 'Redirect to new location',
-                url: '/content-editor/editing-content/inline/redirect-test',
-                run: async (page) => {
-                    await expect(page.locator('h1')).toHaveText('Redirect test');
-                },
-                screenshot: false,
-            },
-        ],
-    },
-    {
-        name: 'Site Redirects with sections',
-        contentBaseURL: 'https://gitbook-open-e2e-sites.gitbook.io/sections/',
-        tests: [
-            {
-                // This test that a redirect that incudes a section path works
-                name: 'Redirect to Quickstart page',
-                url: 'sections-2/redirect-test',
-                run: async (page) => {
-                    await expect(page.locator('h1')).toHaveText('Quickstart');
-                },
-                screenshot: false,
-            },
-        ],
-    },
     {
         name: 'Share links',
         contentBaseURL: 'https://gitbook.gitbook.io/gbo-tests-share-links/',

packages/gitbook/e2e/util.ts

@@ -16,7 +16,7 @@ import {
     type CustomizationThemedColor,
     type SiteCustomizationSettings,
 } from '@gitbook/api';
-import { type BrowserContext, type Page, type Response, expect, test } from '@playwright/test';
+import { type BrowserContext, type Page, expect, test } from '@playwright/test';
 import deepMerge from 'deepmerge';
 import rison from 'rison';
 import type { DeepPartial } from 'ts-essentials';
@@ -33,11 +33,7 @@ export interface Test {
     /**
      * Test to run
      */
-    run?: (page: Page, response: Response | null) => Promise<unknown>;
+    run?: (page: Page) => Promise<unknown>;
-    /**
-     * Mode for the test.
-     */
-    mode?: 'page' | 'image';
     /**
      * Whether the test should be fullscreened during testing.
      */
@@ -67,7 +63,6 @@ export interface Test {
 
 export type TestsCase = {
     name: string;
-    skip?: boolean;
     tests: Array<Test>;
     contentBaseURL?: string;
 };
@@ -138,13 +133,11 @@ export const headerLinks: CustomizationHeaderItem[] = [
 ];
 
 export async function waitForCookiesDialog(page: Page) {
-    const dialog = page.getByTestId('cookies-dialog');
+    const dialog = page.getByRole('dialog', { name: 'Cookies' });
-    await expect(dialog).toBeVisible();
+    const accept = dialog.getByRole('button', { name: 'Accept' });
-}
+    const reject = dialog.getByRole('button', { name: 'Reject' });
-
+    await expect(accept).toBeVisible();
-export async function waitForNotFound(_page: Page, response: Response | null) {
+    await expect(reject).toBeVisible();
-    expect(response).not.toBeNull();
-    expect(response?.status()).toBe(404);
 }
 
 /**
@@ -152,13 +145,8 @@ export async function waitForNotFound(_page: Page, response: Response | null) {
  */
 export function runTestCases(testCases: TestsCase[]) {
     for (const testCase of testCases) {
-        if (testCase.skip) {
-            continue;
-        }
-
         test.describe(testCase.name, () => {
             for (const testEntry of testCase.tests) {
-                const { mode = 'page' } = testEntry;
                 const testFn = testEntry.only ? test.only : test;
                 testFn(testEntry.name, async ({ page, context }) => {
                     const testEntryPathname =
@@ -193,39 +181,29 @@ export function runTestCases(testCases: TestsCase[]) {
                         }
                     });
 
-                    const response = await page.goto(url);
+                    await page.goto(url);
                     if (testEntry.run) {
-                        await testEntry.run(page, response);
+                        await testEntry.run(page);
                     }
                     const screenshotOptions = testEntry.screenshot;
                     if (screenshotOptions !== false) {
-                        const screenshotName = `${testCase.name} - ${testEntry.name}`;
+                        await argosScreenshot(page, `${testCase.name} - ${testEntry.name}`, {
-                        if (mode === 'image') {
+                            viewports: ['macbook-16', 'macbook-13', 'ipad-2', 'iphone-x'],
-                            await argosScreenshot(page, screenshotName, {
+                            argosCSS: `
-                                viewports: ['macbook-13'],
+                        /* Hide Intercom */
-                                threshold: screenshotOptions?.threshold ?? undefined,
+                        .intercom-lightweight-app {
-                                fullPage: true,
+                            display: none !important;
-                            });
-                        } else {
-                            await argosScreenshot(page, screenshotName, {
-                                viewports: ['macbook-16', 'macbook-13', 'ipad-2', 'iphone-x'],
-                                argosCSS: `
-                            /* Hide Intercom */
-                            .intercom-lightweight-app {
-                                display: none !important;
                             }
                             `,
-                                threshold: screenshotOptions?.threshold ?? undefined,
+                            threshold: screenshotOptions?.threshold ?? undefined,
-                                fullPage: testEntry.fullPage ?? false,
+                            fullPage: testEntry.fullPage ?? false,
-                                beforeScreenshot: async ({ runStabilization }) => {
+                            beforeScreenshot: async () => {
-                                    await runStabilization();
+                                await waitForIcons(page);
-                                    if (screenshotOptions?.waitForTOCScrolling !== false) {
+                                if (screenshotOptions?.waitForTOCScrolling !== false) {
-                                        await waitForTOCScrolling(page);
+                                    await waitForTOCScrolling(page);
-                                    }
+                                }
-                                    await waitForIcons(page);
+                            },
-                                },
+                        });
-                            });
-                        }
                     }
                 });
             }
@@ -290,9 +268,6 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
         internationalization: {
             locale: CustomizationLocale.En,
         },
-        insights: {
-            trackingCookie: true,
-        },
         favicon: {},
         header: {
             preset: CustomizationHeaderPreset.Default,
@@ -344,79 +319,29 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
  * Wait for all icons present on the page to be loaded.
  */
 async function waitForIcons(page: Page) {
-    await page.waitForFunction(() => {
+    await page.waitForFunction(async () => {
-        const urlStates: Record<string, 'pending' | 'loaded'> =
+        function loadImage(src: string) {
-            (window as any).__ICONS_STATES__ || {};
+            return new Promise((resolve, reject) => {
-        (window as any).__ICONS_STATES__ = urlStates;
+                const img = new Image();
-
+                img.onload = () => resolve(img);
-        const loadUrl = (url: string) => {
+                img.onerror = (_error) => reject(new Error(`Failed to load image: ${src}`));
-            // Mark the URL as pending.
+                img.src = src;
-            urlStates[url] = 'pending';
+            });
-
+        }
-            const img = new Image();
-            img.onload = () => {
-                urlStates[url] = 'loaded';
-            };
-            img.src = url;
-        };
 
         const icons = Array.from(document.querySelectorAll('svg.gb-icon'));
-        const results = icons.map((icon) => {
+        await Promise.all(
-            if (!(icon instanceof SVGElement)) {
+            icons.map(async (icon) => {
-                throw new Error('Icon is not an SVGElement');
+                // url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/light/moon.svg?v=2&token=a463935e93")
-            }
+                const maskImage = window.getComputedStyle(icon).getPropertyValue('mask-image');
-
+                const urlMatch = maskImage.match(/url\("([^"]+)"\)/);
-            // Ignore icons that are not visible.
+                const url = urlMatch ? urlMatch[1] : null;
-            if (!icon.checkVisibility()) {
+                if (!url) {
-                return true;
+                    throw new Error('No mask-image');
-            }
-
-            const state = icon.getAttribute('data-argos-state');
-
-            if (state === 'pending') {
-                return false;
-            }
-
-            if (state === 'loaded') {
-                return true;
-            }
-
-            // url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/light/moon.svg?v=2&token=a463935e93")
-            const maskImage = window.getComputedStyle(icon).getPropertyValue('mask-image');
-            const urlMatch = maskImage.match(/url\("([^"]+)"\)/);
-            const url = urlMatch?.[1];
-
-            // If URL is invalid we throw an error.
-            if (!url) {
-                throw new Error('No mask-image');
-            }
-
-            // If the URL is already queued for loading, we return the state.
-            if (urlStates[url]) {
-                if (urlStates[url] === 'loaded') {
-                    icon.setAttribute('data-argos-state', 'pending');
-                    const bckMaskImage = icon.style.maskImage;
-                    const bckDisplay = icon.style.display;
-                    icon.style.maskImage = '';
-                    icon.style.display = 'none';
-                    requestAnimationFrame(() => {
-                        icon.style.maskImage = bckMaskImage;
-                        icon.style.display = bckDisplay;
-                        requestAnimationFrame(() => {
-                            icon.setAttribute('data-argos-state', 'loaded');
-                        });
-                    });
-                    return false;
                 }
-
+                await loadImage(url);
-                return false;
+            })
-            }
+        );
-
-            loadUrl(url);
-            return false;
-        });
-
-        return results.every((x) => x);
     });
 }
 

packages/gitbook/next.config.js

@@ -5,7 +5,6 @@ module.exports = {
         GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
         GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
         NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
-        GITBOOK_RUNTIME: process.env.GITBOOK_RUNTIME,
     },
 
     webpack(config) {

packages/gitbook/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.11.1",
+    "version": "0.8.1",
     "private": true,
     "scripts": {
         "dev": "env-cmd --silent -f ../../.env.local next dev",
@@ -29,23 +29,24 @@
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-navigation-menu": "^1.2.3",
         "@radix-ui/react-popover": "^1.0.7",
-        "@radix-ui/react-tooltip": "^1.1.8",
         "@sindresorhus/fnv1a": "^3.1.0",
         "@tailwindcss/container-queries": "^0.1.1",
         "@tailwindcss/typography": "^0.5.16",
-        "ai": "^4.2.2",
+        "@upstash/redis": "^1.27.1",
+        "ajv": "^8.12.0",
         "assert-never": "^1.2.1",
         "bun-types": "^1.1.20",
         "classnames": "^2.5.1",
         "framer-motion": "^10.16.14",
         "js-cookie": "^3.0.5",
         "jsontoxml": "^1.0.1",
-        "jwt-decode": "^4.0.0",
         "katex": "^0.16.9",
         "mathjax": "^3.2.2",
         "mdast-util-to-markdown": "^2.1.2",
-        "memoizee": "^0.4.17",
+        "memoizee": "^0.4.15",
-        "next": "14.2.26",
+        "micromark": "^4.0.1",
+        "micromark-extension-gfm": "^3.0.0",
+        "next": "14.2.23",
         "next-themes": "^0.2.1",
         "nuqs": "^2.2.3",
         "object-hash": "^3.0.0",
@@ -55,30 +56,22 @@
         "react": "18.3.1",
         "react-dom": "18.3.1",
         "react-hotkeys-hook": "^4.4.1",
-        "rehype-sanitize": "^6.0.0",
-        "rehype-stringify": "^10.0.1",
-        "remark-gfm": "^4.0.1",
-        "remark-parse": "^11.0.0",
-        "remark-rehype": "^11.1.1",
         "rison": "^0.1.1",
         "server-only": "^0.0.1",
         "shiki": "^3.2.0",
         "tailwind-merge": "^2.2.0",
         "tailwind-shades": "^1.1.2",
-        "unified": "^11.0.5",
         "url-join": "^5.0.0",
         "usehooks-ts": "^3.1.0",
-        "zod": "^3.24.2",
+        "ai": "^4.1.46",
-        "zod-to-json-schema": "^3.24.5",
+        "jwt-decode": "^4.0.0"
-        "event-iterator": "^2.0.0",
-        "partial-json": "^0.1.7",
-        "zustand": "^5.0.3"
     },
     "devDependencies": {
-        "@argos-ci/playwright": "^5.0.3",
+        "@argos-ci/playwright": "^3.10.0",
         "@cloudflare/next-on-pages": "1.13.7",
+        "vercel": "^39.3.0",
         "@cloudflare/workers-types": "^4.20241230.0",
-        "@playwright/test": "^1.51.1",
+        "@playwright/test": "^1.49.1",
         "@types/js-cookie": "^3.0.6",
         "@types/jsontoxml": "^1.0.5",
         "@types/jsonwebtoken": "^9.0.6",
@@ -96,10 +89,8 @@
         "jsonwebtoken": "^9.0.2",
         "postcss": "^8",
         "psi": "^4.1.0",
-        "stylelint": "^16.16.0",
         "tailwindcss": "^3.4.0",
         "ts-essentials": "^10.0.1",
-        "typescript": "^5.5.3",
+        "typescript": "^5.5.3"
-        "vercel": "^39.3.0"
     }
 }

packages/gitbook/playwright.config.ts

@@ -18,8 +18,5 @@ export default defineConfig({
     use: {
         trace: 'on-first-retry',
         screenshot: 'only-on-failure',
-        contextOptions: {
-            reducedMotion: 'reduce',
-        },
     },
 });

packages/gitbook/public/_headers

@@ -1,7 +1,3 @@
 # GitBook immutable static assets
-# Duplicated from next.config.mjs until OpenNext supports generating static headers
 /~gitbook/static/*
   cache-control: public,max-age=31536000,immutable
-  Access-Control-Allow-Origin: *
-/_next/static/*
-  Access-Control-Allow-Origin: *

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

@@ -14,15 +14,7 @@ interface JsonBody {
  * The body should be a JSON with { tags: string[] }
  */
 export async function POST(req: NextRequest) {
-    let json: JsonBody;
+    const json = (await req.json()) as JsonBody;
-
-    try {
-        json = await req.json();
-    } catch (err) {
-        return NextResponse.json({
-            error: `invalid json body: ${err}`,
-        });
-    }
 
     if (!json.tags || !Array.isArray(json.tags)) {
         return NextResponse.json(
@@ -33,18 +25,10 @@ export async function POST(req: NextRequest) {
         );
     }
 
-    try {
+    const result = await revalidateTags(json.tags);
-        const result = await revalidateTags(json.tags);
+
-        return NextResponse.json({
+    return NextResponse.json({
-            success: true,
+        success: true,
-            stats: result.stats,
+        stats: result.stats,
-        });
+    });
-    } catch (err: unknown) {
-        return NextResponse.json(
-            {
-                error: `${err}`,
-            },
-            { status: 500 }
-        );
-    }
 }

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

@@ -11,7 +11,7 @@ import { useScrollPage } from '@/components/hooks';
 export function PageClientLayout(props: { withSections?: boolean }) {
     // We use this hook in the page layout to ensure the elements for the blocks
     // are rendered before we scroll to a hash or to the top of the page
-    useScrollPage({ scrollMarginTop: props.withSections ? 48 : undefined });
+    useScrollPage({ scrollMarginTop: props.withSections ? 50 : undefined });
 
     useStripFallbackQueryParam();
     return null;

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

@@ -1,4 +1,4 @@
-import { getSiteURLDataFromMiddleware, getThemeFromMiddleware } from '@v2/lib/middleware';
+import { getThemeFromMiddleware, getVisitorAuthTokenFromMiddleware } from '@v2/lib/middleware';
 import type { Metadata, Viewport } from 'next';
 import type React from 'react';
 
@@ -7,7 +7,6 @@ import {
     generateSiteLayoutMetadata,
     generateSiteLayoutViewport,
 } from '@/components/SiteLayout';
-import { getVisitorAuthClaims } from '@/lib/adaptive';
 import { getSiteContentPointer } from '@/lib/pointer';
 import { shouldTrackEvents } from '@/lib/tracking';
 import { fetchV1ContextForSitePointer } from '@/lib/v1';
@@ -23,14 +22,14 @@ export default async function ContentLayout(props: { children: React.ReactNode }
 
     const context = await fetchLayoutData();
     const queryStringTheme = await getThemeFromMiddleware();
-    const siteData = await getSiteURLDataFromMiddleware();
+    const visitorAuthToken = await getVisitorAuthTokenFromMiddleware();
 
     return (
         <SiteLayout
             context={context}
             forcedTheme={queryStringTheme}
             withTracking={await shouldTrackEvents()}
-            visitorAuthClaims={getVisitorAuthClaims(siteData)}
+            visitorAuthToken={visitorAuthToken}
         >
             {children}
         </SiteLayout>

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

@@ -1,7 +1,7 @@
 'use client';
 
 import { Button } from '@/components/primitives/Button';
-import { t, tString, useLanguage } from '@/intl/client';
+import { t, useLanguage } from '@/intl/client';
 import { tcls } from '@/lib/tailwind';
 
 export default function ErrorPage(props: {
@@ -35,8 +35,9 @@ export default function ErrorPage(props: {
                         }}
                         variant="secondary"
                         size="small"
-                        label={tString(language, 'unexpected_error_retry')}
+                    >
-                    />
+                        {t(language, 'unexpected_error_retry')}
+                    </Button>
                 </div>
             </div>
         </div>

packages/gitbook/src/components/Adaptive/AIPageLinkSummary.tsx

@@ -1,190 +0,0 @@
-'use client';
-import { useLanguage } from '@/intl/client';
-import { t } from '@/intl/translate';
-import { Icon } from '@gitbook/icons';
-import { useEffect } from 'react';
-import { create } from 'zustand';
-import { useShallow } from 'zustand/react/shallow';
-import { useVisitedPages } from '../Insights';
-import { usePageContext } from '../PageContext';
-import { Loading } from '../primitives';
-import { streamLinkPageSummary } from './server-actions/streamLinkPageSummary';
-
-/**
- * Get a unique cache key for a page summary
- */
-function getCacheKey(targetSpaceId: string, targetPageId: string): string {
-    return `${targetSpaceId}:${targetPageId}`;
-}
-
-/**
- * Global state for the summaries.
- */
-const useSummaries = create<{
-    /**
-     * Cache of all summaries generated so far.
-     */
-    cache: Map<string, string>;
-
-    /**
-     * Get a summary for a page.
-     */
-    getSummary: (params: { targetSpaceId: string; targetPageId: string }) => string;
-
-    /**
-     * Stream the generation of a summary for a page.
-     */
-    streamSummary: (params: {
-        currentSpaceId: string;
-        currentPageId: string;
-        currentPageTitle: string;
-        targetSpaceId: string;
-        targetPageId: string;
-        linkPreview?: string;
-        linkTitle?: string;
-        visitedPages: { spaceId: string; pageId: string }[];
-    }) => Promise<void>;
-}>((set, get) => ({
-    cache: new Map(),
-
-    getSummary: ({
-        targetSpaceId,
-        targetPageId,
-    }: {
-        targetSpaceId: string;
-        targetPageId: string;
-    }) => {
-        return get().cache.get(getCacheKey(targetSpaceId, targetPageId)) ?? '';
-    },
-
-    streamSummary: async ({
-        currentSpaceId,
-        currentPageId,
-        currentPageTitle,
-        targetSpaceId,
-        targetPageId,
-        linkPreview,
-        linkTitle,
-        visitedPages,
-    }) => {
-        const cacheKey = getCacheKey(targetSpaceId, targetPageId);
-
-        if (get().cache.has(cacheKey)) {
-            // Already generated or generating
-            return;
-        }
-
-        const update = (summary: string) => {
-            set((prev) => {
-                const newCache = new Map(prev.cache);
-                newCache.set(cacheKey, summary);
-                return { cache: newCache };
-            });
-        };
-
-        update('');
-        const stream = await streamLinkPageSummary({
-            currentSpaceId,
-            currentPageId,
-            currentPageTitle,
-            targetSpaceId,
-            targetPageId,
-            linkPreview,
-            linkTitle,
-            visitedPages,
-        });
-
-        let generatedSummary = '';
-        for await (const highlight of stream) {
-            generatedSummary = highlight ?? '';
-            update(generatedSummary);
-        }
-    },
-}));
-
-/**
- * Summarise a page's content for use in a link preview
- */
-export function AIPageLinkSummary(props: {
-    targetSpaceId: string;
-    targetPageId: string;
-    linkPreview?: string;
-    linkTitle?: string;
-    showTrademark: boolean;
-}) {
-    const { targetSpaceId, targetPageId, linkPreview, linkTitle, showTrademark = true } = props;
-
-    const currentPage = usePageContext();
-    const language = useLanguage();
-    const visitedPages = useVisitedPages((state) => state.pages);
-    const { summary, streamSummary } = useSummaries(
-        useShallow((state) => {
-            return {
-                summary: state.getSummary({ targetSpaceId, targetPageId }),
-                streamSummary: state.streamSummary,
-            };
-        })
-    );
-
-    useEffect(() => {
-        streamSummary({
-            currentSpaceId: currentPage.spaceId,
-            currentPageId: currentPage.pageId,
-            currentPageTitle: currentPage.title,
-            targetSpaceId,
-            targetPageId,
-            linkPreview,
-            linkTitle,
-            visitedPages,
-        });
-    }, [
-        currentPage.pageId,
-        currentPage.spaceId,
-        currentPage.title,
-        targetSpaceId,
-        targetPageId,
-        linkPreview,
-        linkTitle,
-        visitedPages,
-        streamSummary,
-    ]);
-
-    const shimmerBlocks = [
-        'w-[20%] [animation-delay:-1s]',
-        'w-[35%] [animation-delay:-0.8s]',
-        'w-[25%] [animation-delay:-0.6s]',
-        'w-[10%] [animation-delay:-0.4s]',
-        'w-[40%] [animation-delay:-0.2s]',
-        'w-[30%] [animation-delay:0s]',
-    ];
-
-    return (
-        <div className="flex flex-col gap-1">
-            <div className="flex w-screen items-center gap-1 font-semibold text-tint text-xs uppercase leading-tight tracking-wide">
-                {showTrademark ? (
-                    <Loading className="size-4" busy={!summary || summary.length === 0} />
-                ) : (
-                    <Icon icon="sparkle" className="size-3" />
-                )}
-                <h6 className="text-tint">{t(language, 'link_tooltip_ai_summary')}</h6>
-            </div>
-            {summary.length > 0 ? (
-                <p className="animate-fadeIn">{summary}</p>
-            ) : (
-                <div className="mt-2 flex flex-wrap gap-2">
-                    {shimmerBlocks.map((block, index) => (
-                        <div
-                            key={`${index}-${block}`}
-                            className={`${block} h-4 animate-pulse rounded straight-corners:rounded-none bg-tint-active`}
-                        />
-                    ))}
-                </div>
-            )}
-            {summary.length > 0 ? (
-                <div className="animate-fadeIn text-tint-subtle text-xs">
-                    {t(language, 'link_tooltip_ai_summary_description')}
-                </div>
-            ) : null}
-        </div>
-    );
-}

packages/gitbook/src/components/Adaptive/index.ts

@@ -1 +0,0 @@
-export * from './AIPageLinkSummary';