Merge branch 'main' into stevenh/fix-empty-href

.changeset/angry-melons-sparkle.md

@@ -1,5 +0,0 @@
----
-"@gitbook/embed": patch
----
-
-Initial version of the embed SDK.

.changeset/big-rockets-sniff.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Improve `Button` and `ButtonGroup` styling

.changeset/breezy-toes-raise.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fix scroll of page outline

.changeset/chatty-rivers-move.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Support "objectivec" as alias for Objective C syntax

.changeset/cold-buckets-divide.md

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

.changeset/cool-jars-matter.md

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

.changeset/cool-seas-approve.md

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

.changeset/curly-pears-study.md

@@ -1,5 +0,0 @@
----
-"gitbook": minor
----
-
-Support custom AI providers

.changeset/eleven-melons-smash.md

@@ -1,5 +0,0 @@
----
-"@gitbook/browser-types": minor
----
-
-First version of the public package for typing script integrations.

.changeset/fair-schools-grin.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fix AI Search follow-up question closing search

.changeset/fast-trees-battle.md

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

.changeset/few-bobcats-bake.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Small fixes to search modal

.changeset/fifty-houses-reflect.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fixes to `PageAside`

.changeset/gorgeous-cycles-cheat.md

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

.changeset/healthy-chicken-end.md

@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Fix invalid HTML on an Announcement banner without a CTA.

.changeset/honest-eagles-judge.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Tweaks to AIChatButton and AIChatInput

.changeset/modern-laws-kick.md

@@ -1,5 +0,0 @@
----
-"gitbook": minor
----
-
-Allow integrations to provide tools to the Docs Assistant

.changeset/moody-badgers-teach.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Improve vertical alignment of site items and fix floating page aside

.changeset/nasty-moles-visit.md

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

.changeset/orange-buses-provide.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fix search bar layout shift caused by ToC

.changeset/rotten-seals-rush.md

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

.changeset/rude-tomatoes-hunt.md

@@ -1,5 +0,0 @@
----
-"gitbook": minor
----
-
-Emit a <link rel="alternate"> for the markdown version of a page

.changeset/serious-pumas-clap.md

@@ -1,5 +0,0 @@
----
-'gitbook': patch
----
-
-Support new coverDefinitionDark for cards & image type

.changeset/shy-dancers-crash.md

@@ -1,5 +0,0 @@
----
-"@gitbook/icons": minor
----
-
-Update icons set to the latest version

.changeset/slow-lizards-obey.md

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

.changeset/soft-bikes-warn.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Clear AI chat properly

.changeset/spicy-baboons-buy.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fix bug in search highlight in GBO

.changeset/stupid-plums-perform.md

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

.changeset/sweet-garlics-do.md

@@ -1,5 +0,0 @@
----
-"gitbook": minor
----
-
-Start routes for embeddable version of the assistant and docs pages.

.changeset/thick-chefs-repeat.md

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

.changeset/thin-buckets-grow.md

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

.changeset/three-queens-pretend.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Page outline: scroll to active item

.changeset/tough-beers-own.md

@@ -1,6 +0,0 @@
----
-"@gitbook/openapi-parser": patch
-"gitbook": patch
----
-
-Improve OpenAPI parsing errors

.changeset/violet-schools-care.md

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

.changeset/weak-kiwis-type.md

@@ -1,6 +0,0 @@
----
-"@gitbook/browser-types": patch
-"gitbook": patch
----
-
-Custom assistants followup

.changeset/wise-gifts-smash.md

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

.changeset/young-goats-begin.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fix Custom logo not rendering on the published site

.github/CODEOWNERS

@@ -1,3 +0,0 @@
-# Changes to the API data cache functions can invalidate all existing data cache
-# causing a massive amount of revalidation, impacting our API.
-packages/gitbook/src/lib/data/api.ts   @SamyPesse

.github/CONTRIBUTING.md

@@ -53,40 +53,17 @@ After forking this repository, you'll want to [create a branch](https://docs.git
 
 #### 3. Install dependencies and run the project locally
 
-##### Prerequisites:
-- Node.js (Version: >=20.6)
-  - Use `nvm` for easy Node management
-- [Bun](https://bun.sh/) (Version: >=1.2.15)
-  - We use a text-based lockfile which isn't supported below 1.2.15
+GitBook uses [Bun](https://bun.sh/) to run the project. Make sure you're using the specified version of `node` before running any of the development commands to ensure a smooth development experience.
 
-##### Setup steps:
+You can easily do this by running the command `nvm use`.
 
-1. Ensure you are using the project's version of Node:
-```bash
-nvm use
-```
-
-2. Install dependencies using Bun:
-```bash
-bun install
-```
-
-3. Start the development server:
-```bash
-bun dev
-```
-
-Additional development commands:
-- `bun format`: Format the code using Biome
-- `bun typecheck`: Run TypeScript type checking
-- `bun unit`: Run unit tests
-- `bun e2e`: Run end-to-end tests
+To start your local version of GitBook, run the command `bun dev`.
 
 #### 4. Preview your changes
 
-When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/url`.
+When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.
 
-For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/url/gitbook.com/docs` after running the development server.
+For example, our published docs can be viewed using the local version by visiting `http://localhost:3000/gitbook.com/docs` after running the development server.
 
 You can visit any published GitBook site behind your development server. Please make sure your site is [published publicly](https://gitbook.com/docs/published-documentation/publish-your-content-as-a-docs-site) to ensure you can view the site correctly in your development version.
 

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

@@ -32,7 +32,7 @@ runs:
             workingDirectory: ./
             wranglerVersion: '4.10.0'
             environment: ${{ inputs.environment }}
-            command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+            command: deployments status --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
 
       # This step is used to get the version ID that is currently deployed to Cloudflare.
       - id: extract_current_version
@@ -51,7 +51,7 @@ runs:
             workingDirectory: ./
             wranglerVersion: '4.10.0'
             environment: ${{ inputs.environment }}
-            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
 
       # Since we use version overrides headers, we can directly deploy the middleware to 100%.
       - id: deploy_middleware
@@ -63,7 +63,7 @@ runs:
             workingDirectory: ./
             wranglerVersion: '4.10.0'
             environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
+            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc
 
       - name: Deploy server to Cloudflare at 100%
         uses: cloudflare/wrangler-action@v3.14.0
@@ -73,7 +73,7 @@ runs:
             workingDirectory: ./
             wranglerVersion: '4.10.0'
             environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
 
       - name: Outputs
         shell: bash

.github/actions/setup-playwright/action.yml

@@ -0,0 +1,37 @@
+name: 'Setup Playwright'
+description: 'Install Playwright and dependencies'
+runs:
+    using: 'composite'
+    steps:
+        # Run npm ci and get Playwright version
+        - name: 🏗 Prepare Playwright env
+          shell: bash
+          run: |
+              PLAYWRIGHT_VERSION=$(npm ls --json @playwright/test | jq --raw-output '.dependencies["gitbook"].dependencies["@playwright/test"].version')
+              echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
+
+        # Cache browser binaries, cache key is based on Playwright version and OS
+        - name: 🧰 Cache Playwright browser binaries
+          uses: actions/cache@v4
+          id: playwright-cache
+          with:
+              path: '~/.cache/ms-playwright'
+              key: '${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}'
+              restore-keys: |
+                  ${{ runner.os }}-playwright-
+
+        # Install browser binaries & OS dependencies if cache missed
+        - name: 🏗 Install Playwright browser binaries & OS dependencies
+          if: steps.playwright-cache.outputs.cache-hit != 'true'
+          shell: bash
+          working-directory: packages/gitbook
+          run: |
+              bun x playwright install --with-deps chromium
+
+        # Install only the OS dependencies if cache hit
+        - name: 🏗 Install Playwright OS dependencies
+          if: steps.playwright-cache.outputs.cache-hit == 'true'
+          shell: bash
+          working-directory: packages/gitbook
+          run: |
+              bun x playwright install-deps

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

@@ -59,7 +59,7 @@ runs:
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
             GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build worker
-          run: bun run turbo build:cloudflare
+          run: bun run turbo build:v2:cloudflare
           env:
             GITBOOK_RUNTIME: cloudflare
           shell: bash
@@ -72,7 +72,7 @@ runs:
               workingDirectory: ./
               wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
+              command: deploy --config ./packages/gitbook-v2/openNext/customWorkers/doWrangler.jsonc
 
         - id: upload_server
           name: Upload server to Cloudflare
@@ -83,7 +83,7 @@ runs:
               workingDirectory: ./
               wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
 
         - name: Extract server version worker ID
           shell: bash
@@ -95,7 +95,7 @@ runs:
         - name: Run updateWrangler scripts
           shell: bash
           run: |
-              bun run ./packages/gitbook/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
+              bun run ./packages/gitbook-v2/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
 
         - id: upload_middleware
           name: Upload middleware to Cloudflare
@@ -106,7 +106,7 @@ runs:
               workingDirectory: ./
               wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
+              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc
         
         - name: Extract middleware version worker ID
           shell: bash

.github/workflows/deploy-preview.yaml

@@ -7,6 +7,53 @@ on:
 env:
     NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
+    deploy-v1-cloudflare:
+        name: Deploy v1 to Cloudflare Pages
+        runs-on: ubuntu-latest
+        environment:
+          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
+          url: ${{ steps.deploy.outputs.deployment-url }}
+        permissions:
+            contents: read
+            deployments: write
+            issues: write
+            pull-requests: write
+            checks: write
+            statuses: write
+        outputs:
+            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
+            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Sets env vars for production
+              if: github.ref == 'refs/heads/main'
+              run: |
+                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
+            - name: Build Next.js with next-on-pages
+              run: bun run turbo gitbook#build:cloudflare
+              env:
+                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
+                  GITBOOK_RUNTIME: cloudflare
+            - id: deploy
+              name: Deploy to Cloudflare
+              uses: cloudflare/wrangler-action@v3.14.0
+              with:
+                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  workingDirectory: ./
+                  wranglerVersion: '3.112.0'
+                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
+            - name: Outputs
+              run: |
+                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
     deploy-v2-vercel:
         name: Deploy v2 to Vercel (preview)
         runs-on: ubuntu-latest
@@ -67,6 +114,7 @@ jobs:
         name: Comment Deployments (preview)
         if: always() && !startsWith(github.ref, 'refs/heads/main')
         needs:
+            - deploy-v1-cloudflare
             - deploy-v2-vercel
             - deploy-v2-cloudflare
         steps:
@@ -86,6 +134,15 @@ jobs:
                   body: |
                       Summary of the deployments:
 
+                      ### Version 1
+
+                      | Version | URL | Status |
+                      | --- | --- | --- |
+                      | Latest commit | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
+                      | PR | [${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}](${{ needs.deploy-v1-cloudflare.outputs.deployment-alias-url }}) | ${{ needs.deploy-v1-cloudflare.result == 'success' && '✅' || '❌' }} |
+
+                      ### Version 2
+
                       | Version | URL | Status |
                       | --- | --- | --- |
                       | Vercel | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}](${{ needs.deploy-v2-vercel.outputs.deployment-url }}) | ${{ needs.deploy-v2-vercel.result == 'success' && '✅' || '❌' }} |
@@ -93,16 +150,16 @@ jobs:
 
                       ### Test content
 
-                      | Site | `2v` | `2c` |
-                      | --- | --- | --- |
-                      | GitBook | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) |
-                      | E2E | [${{ needs.deploy-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) |
+                      | Site | `v1` | `2v` | `2c` |
+                      | --- | --- | --- | --- |
+                      | GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.com/docs](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.com/docs) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.com/docs) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.com/docs) |
+                      | E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
                   edit-mode: replace
-    visual-testing-v2-vercel:
+    visual-testing-v1:
         runs-on: ubuntu-latest
-        name: Visual Testing v2
-        needs: deploy-v2-vercel
-        timeout-minutes: 15
+        name: Visual Testing v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -110,8 +167,27 @@ jobs:
               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:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+    visual-testing-v2-vercel:
+        runs-on: ubuntu-latest
+        name: Visual Testing v2
+        needs: deploy-v2-vercel
+        timeout-minutes: 10
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
             - name: Run Playwright tests
               run: bun e2e
               env:
@@ -123,7 +199,7 @@ jobs:
         runs-on: ubuntu-latest
         name: Visual Testing v2 (Cloudflare)
         needs: deploy-v2-cloudflare
-        timeout-minutes: 15
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -131,8 +207,8 @@ jobs:
               uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
             - name: Run Playwright tests
               run: bun e2e
               env:
@@ -140,11 +216,11 @@ jobs:
                   SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                   ARGOS_BUILD_NAME: 'v2-cloudflare'
-    visual-testing-customers-v2:
+    visual-testing-customers-v1:
         runs-on: ubuntu-latest
-        name: Visual Testing Customers v2
-        needs: deploy-v2-vercel
-        timeout-minutes: 15
+        name: Visual Testing Customers v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -152,8 +228,28 @@ jobs:
               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:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
+                  ARGOS_BUILD_NAME: 'customers-v1'
+    visual-testing-customers-v2:
+        runs-on: ubuntu-latest
+        name: Visual Testing Customers v2
+        needs: deploy-v2-vercel
+        timeout-minutes: 8
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
             - name: Run Playwright tests
               run: bun e2e-customers
               env:
@@ -165,7 +261,7 @@ jobs:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v2 (Cloudflare)
         needs: deploy-v2-cloudflare
-        timeout-minutes: 15
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -173,8 +269,8 @@ jobs:
               uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
-              env:
-                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
             - name: Run Playwright tests
               run: bun e2e-customers
               env:
@@ -182,10 +278,10 @@ jobs:
                   SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                   ARGOS_BUILD_NAME: 'customers-v2'
-    pagespeed-testing-v2:
+    pagespeed-testing-v1:
         runs-on: ubuntu-latest
         name: PageSpeed Testing v1
-        needs: deploy-v2-vercel
+        needs: deploy-v1-cloudflare
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -198,5 +294,5 @@ jobs:
             - name: Run pagespeed tests
               run: bun ./packages/gitbook/tests/pagespeed-testing.ts
               env:
-                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
+                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
                   PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/publish.yaml

@@ -39,4 +39,22 @@ jobs:
                   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
                   CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                   CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-
+    release-preview:
+        # For now it releases the cache-do to both preview and production
+        # Once we changed to deploy the app only on release, we should change `release:preview` in `cache-do`
+        name: Release Preview
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v3
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+              env:
+                  PUPPETEER_SKIP_DOWNLOAD: 1
+            - name: Release preview packages
+              run: bun run release:preview
+              env:
+                  CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+                  CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}

README.md

@@ -1,7 +1,7 @@
 <h1 align="center">GitBook</h1>
 
 <p align="center">
-  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> - <a href="https://github.com/orgs/GitbookIO/discussions/categories/feature-requests">Feature requests</a> 
+  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> 
 </p>
 
 <p align="center">
@@ -35,10 +35,10 @@ To run a local version of this project, please follow these simple steps.
 
 ### Prerequisites
 
-- Node.js (Version: >=20.6)
-    - Use nvm for easy Node management
-- [Bun](https://bun.sh/) (Version: >=1.2.15)
-  - We use a text-based lockfile which isn't supported below 1.2.15
+-   Node.js (Version: >=20.6)
+  - Use nvm for easy Node management
+-   Bun (Version: >=1.2.1)
+  - We use a text-based lockfile which isn't supported below 1.2.1
 
 ### Set up
 
@@ -59,10 +59,10 @@ bun install
 4. Start your local development server.
 
 ```
-bun dev
+bun dev:v2
 ```
 
-6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.
+5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
 
 examples:
 
@@ -71,6 +71,11 @@ examples:
 
 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.
 
+### Other development commands
+
+-   `bun format`: format the code
+-   `bun lint`: lint the code
+
 ### CI and testing
 
 All pull-requests will be tested against both visual and performances testing to prevent regressions.
@@ -145,11 +150,11 @@ See `LICENSE` for more information.
 </p>
 
 ```md
-[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link)
+[![GitBook](https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1)](https://gitbook.com/)
 ```
 
 ```html
-<a href="https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link">
+<a href="https://gitbook.com">
     <img
         src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"
     />

biome.json

@@ -21,8 +21,7 @@
             "packages/openapi-parser/src/fixtures/**/*",
             "packages/emoji-codepoints/index.ts",
             "packages/icons/src/data/*.json",
-            "packages/gitbook/worker-configuration.d.ts",
-            "**/*.css"
+            "packages/cache-do/worker-configuration.d.ts"
         ]
     },
     "formatter": {
@@ -128,6 +127,7 @@
         {
             "include": [
                 "packages/gitbook/**/*",
+                "packages/gitbook-v2/**/*",
                 "packages/react-openapi/**/*",
                 "packages/react-math/**/*",
                 "packages/react-contentkit/**/*",

package.json

@@ -7,17 +7,19 @@
         "turbo": "^2.5.0",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.2.15",
+    "packageManager": "bun@1.2.11",
     "overrides": {
         "@codemirror/state": "6.4.1",
+        "@gitbook/api": "^0.115.0",
         "react": "^19.0.0",
-        "react-dom": "^19.0.0",
-        "esbuild": "0.24.2"
+        "react-dom": "^19.0.0"
     },
     "private": true,
     "scripts": {
         "dev": "turbo run dev",
+        "dev:v2": "turbo run dev:v2",
         "build": "turbo run build",
+        "build:v2": "turbo run build:v2",
         "clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
         "typecheck": "turbo run typecheck",
         "format": "biome check --write ./",
@@ -28,16 +30,11 @@
         "changeset": "changeset",
         "changeset-version": "changeset version && bun run format",
         "release": "turbo run release && changeset publish",
+        "release:preview": "turbo run release:preview",
         "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
         "clean": "turbo run clean"
     },
-    "workspaces": {
-        "packages": ["packages/*"],
-        "catalog": {
-            "@gitbook/api": "^0.136.0",
-            "bidc": "^0.0.2"
-        }
-    },
+    "workspaces": ["packages/*"],
     "patchedDependencies": {
         "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
         "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"

packages/browser-types/.gitignore

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

packages/browser-types/README.md

@@ -1,3 +0,0 @@
-# `@gitbook/browser-types`
-
-Typescript types for the global variables available in a GitBook website. These types can be used by integrations embedding scripts.

packages/browser-types/package.json

@@ -1,24 +0,0 @@
-{
-    "name": "@gitbook/browser-types",
-    "description": "Typescript types for the global variables available in a GitBook website. These types can be used by integrations embedding scripts.",
-    "type": "module",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "default": "./dist/index.js"
-        }
-    },
-    "version": "0.0.0",
-    "dependencies": {
-        "@gitbook/api": "catalog:",
-        "@gitbook/icons": "workspace:"
-    },
-    "devDependencies": {
-        "typescript": "^5.5.3"
-    },
-    "scripts": {
-        "build": "tsc",
-        "typecheck": "tsc --noEmit"
-    },
-    "files": ["dist", "README.md", "CHANGELOG.md"]
-}

packages/browser-types/src/index.ts

@@ -1,84 +0,0 @@
-import type { AIToolCallResult, AIToolDefinition } from '@gitbook/api';
-import type { IconName } from '@gitbook/icons';
-
-export type GitBookIntegrationEvent = 'load' | 'unload';
-
-export type GitBookIntegrationEventCallback = (...args: any[]) => void;
-
-export type GitBookIntegrationTool = AIToolDefinition & {
-    /**
-     * Confirmation action to be displayed to the user before executing the tool.
-     */
-    confirmation?: {
-        icon?: IconName;
-        label: string;
-    };
-
-    /**
-     * Callback when the tool is executed.
-     * The input is provided by the AI assistant following the input schema of the tool.
-     */
-    execute: (input: object) => Promise<Pick<AIToolCallResult, 'output' | 'summary'>>;
-};
-
-export type GitBookAssistant = {
-    /**
-     * Name of the assistant displayed in the UI.
-     */
-    label: string;
-
-    /**
-     * Icon of the assistant displayed in the UI.
-     * Any FontAwesome icon name is supported.
-     * @example 'sparkle'
-     */
-    icon: string;
-
-    /**
-     * Callback when the assistant is opened.
-     */
-    open: (query?: string) => void;
-
-    /**
-     * Whether to display the triggers for this assistant in the UI.
-     * @default true
-     */
-    ui?: boolean;
-};
-
-export type GitBookGlobal = {
-    /**
-     * Register an event listener.
-     */
-    addEventListener: (
-        type: GitBookIntegrationEvent,
-        func: GitBookIntegrationEventCallback
-    ) => void;
-
-    /**
-     * Remove an event listener.
-     */
-    removeEventListener: (
-        type: GitBookIntegrationEvent,
-        func: GitBookIntegrationEventCallback
-    ) => void;
-
-    /**
-     * Register a custom tool to be exposed to the AI assistant.
-     */
-    registerTool: (tool: GitBookIntegrationTool) => void;
-
-    /**
-     * Register a custom assistant to be available on the site.
-     */
-    registerAssistant: (assistant: GitBookAssistant) => () => void;
-};
-
-declare global {
-    interface Window {
-        /**
-         * Global `window.GitBook` object accessible by integrations.
-         */
-        GitBook?: GitBookGlobal;
-    }
-}

packages/browser-types/tsconfig.json

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

packages/cache-do/.gitignore

@@ -0,0 +1,3 @@
+.wrangler
+worker-configuration.d.ts
+dist/

packages/cache-do/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @gitbook/cache-do
+
+## 0.1.1
+
+### Patch Changes
+
+-   b7a5106: Disable cloudflare observability in production
+
+## 0.1.0
+
+### Minor Changes
+
+-   9b8d519: Experiment with optimizing billable duration in Cloudflare by using multiple RPC sessions instead of one
+-   636b868: First version of a new cache backend powered by Cloudflare Durable Objects
+
+### Patch Changes
+
+-   56f5fa1: Enable Workers observability with a sampling of 0.1

packages/cache-do/README.md

@@ -0,0 +1,22 @@
+# `@gitbook/cache-do`
+
+Cache backend, powered by Cloudflare Durable Objects. The cache is optimized for GitBook use-cases.
+
+### Performances
+
+The cache backend is optimized for performances by being distributed and accessible close to the worker locations that are reading it.
+
+### Geo-distribution
+
+To achieve a good balance between **performances** and **consistency**, cache objects are distributed over 7 locations, representing continents.
+
+It makes it possible to purge all 7 locations in one go and achieve fast consistency.
+
+### Concepts
+
+**Cache tag**: unique tag in the cache environment. A cache tag groups multiple keys that should be purged together in one operation.
+Cache tags should not contain a large set of unique keys. Exceeding thousands could lead to performances or reliability issues.
+
+**Cache key**: unique key in the cache environment. Each key should be assigned to a `tag`.
+
+**Location**: cache is distributed over 7 unique locations, one for each continent.

packages/cache-do/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@gitbook/cache-do",
+    "type": "module",
+    "private": true,
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
+            "default": "./dist/index.js"
+        },
+        "./api": {
+            "types": "./dist/api.d.ts",
+            "development": "./src/api.ts",
+            "default": "./dist/api.js"
+        }
+    },
+    "version": "0.1.1",
+    "dependencies": {
+        "@msgpack/msgpack": "^3.0.0-beta2",
+        "lru_map": "^0.4.1"
+    },
+    "devDependencies": {
+        "typescript": "^5.5.3",
+        "wrangler": "^4.10.0"
+    },
+    "scripts": {
+        "generate": "wrangler types",
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "dev": "tsc -w",
+        "release": "wrangler deploy",
+        "release:preview": "wrangler deploy && wrangler deploy --env preview"
+    },
+    "files": ["dist", "src", "bin", "data", "README.md", "CHANGELOG.md"]
+}

packages/cache-do/src/CacheObject.ts

@@ -0,0 +1,292 @@
+import { DurableObject } from 'cloudflare:workers';
+import { decode, encode } from '@msgpack/msgpack';
+import { LRUMap } from 'lru_map';
+
+export interface CacheObjectDescriptor {
+    get: <Value = unknown>(key: string) => Promise<Value | undefined>;
+    set: <Value = unknown>(key: string, value: Value, expiresAt: number) => Promise<void>;
+}
+
+/**
+ * Value stored in a chunked binary msgpack format.
+ * Stored under the key `prop.${key}.${index}`.
+ */
+interface CacheObjectProp<Value = unknown> {
+    value: Value;
+    expiresAt: number;
+}
+
+/**
+ * Expiration clock stored under the key `exp.${expiresAt}.${key}`.
+ */
+interface CacheObjectExp {
+    /** Key of the property */
+    k: string;
+    /** Number of chunks */
+    c: number;
+}
+
+/**
+ * Durable Object class being deployed as a distributed cache.
+ */
+export class CacheObject extends DurableObject {
+    private lru = new LRUMap<string, { match: CacheObjectProp | undefined }>(500);
+
+    /**
+     * Open a descriptor to access the cache object.
+     * The goal is to minimize the amount of RPC sessions between the client and the cache object.
+     * One session is opened per request on the client side and used to perform multiple operations.
+     * https://developers.cloudflare.com/workers/runtime-apis/rpc/#return-functions-from-rpc-methods
+     */
+    public open(): CacheObjectDescriptor {
+        return {
+            get: async <Value = unknown>(key: string) => {
+                return this.get<Value>(key);
+            },
+            set: async <Value = unknown>(key: string, value: Value, expiresAt: number) => {
+                await this.set(key, value, expiresAt);
+            },
+        };
+    }
+
+    /**
+     * Get the value of a property.
+     */
+    public async get<Value = unknown>(key: string) {
+        return this.logOperation({ operation: 'get', key }, async (setLog) => {
+            // Try the memory state first.
+            const memoryEntry = this.lru.get(key);
+            if (memoryEntry) {
+                setLog({ memory: true });
+                setLog({ memoryMatch: !!memoryEntry.match });
+                if (!memoryEntry.match) {
+                    return;
+                }
+
+                const isExpired = memoryEntry.match.expiresAt < Date.now();
+                setLog({ memoryExpired: isExpired });
+
+                if (!isExpired) {
+                    return memoryEntry.match.value as Value;
+                }
+            }
+
+            return await this.getFromStorage<Value>(key);
+        });
+    }
+
+    /**
+     * Get the value of a property from the DO storage.
+     */
+    public async getFromStorage<Value = unknown>(key: string) {
+        return this.logOperation({ operation: 'getFromStorage', key }, async (setLog) => {
+            const entries = await this.ctx.storage.list<Uint8Array>({
+                prefix: getStoragePropKey(key),
+                noCache: true,
+            });
+            if (entries.size) {
+                const entry = decodeChunks<CacheObjectProp<Value>>(entries);
+                setLog({ chunks: entries.size, chunksSize: entry?.size ?? 0 });
+                if (entry && entry.value.expiresAt > Date.now()) {
+                    // Found
+                    this.lru.set(key, { match: entry.value });
+                    return entry.value.value;
+                }
+            }
+
+            // Not found
+            this.lru.set(key, { match: undefined });
+        });
+    }
+
+    /**
+     * Set a value in the cache object.
+     */
+    public async set<Value = unknown>(key: string, value: Value, expiresAt: number) {
+        return this.logOperation({ operation: 'set', key }, async (setLog) => {
+            const prop: CacheObjectProp<Value> = {
+                value,
+                expiresAt,
+            };
+
+            this.lru.set(key, { match: prop });
+            await this.ctx.storage.transaction(async (tx) => {
+                const entries = encodeChunks(key, prop);
+                const chunks = Object.keys(entries).length;
+                setLog({ chunks });
+
+                const clockValue: CacheObjectExp = {
+                    k: key,
+                    c: chunks,
+                };
+
+                await tx.put(getGCClockKey(key, expiresAt), clockValue);
+                await tx.put(entries);
+
+                const currentAlarm = await tx.getAlarm();
+                if (!currentAlarm) {
+                    // Set an alarm to garbage collect all entries that have expired in 12h.
+                    await tx.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
+                }
+            });
+        });
+    }
+
+    /**
+     * Purge all keys in the cache object.
+     */
+    public async purge() {
+        return this.logOperation({ operation: 'purge' }, async (setLog) => {
+            const result = new Set<string>();
+
+            try {
+                // List all the keys in the cache object.
+                const entries = await this.ctx.storage.list<CacheObjectExp>({
+                    prefix: 'exp.',
+                    noCache: true,
+                });
+                setLog({ entries: entries.size });
+                entries.forEach((exp) => {
+                    result.add(exp.k);
+                });
+            } catch (_error) {}
+
+            await this.reset();
+            return Array.from(result);
+        });
+    }
+
+    /**
+     * Alarm to garbage collect all entries that have expired.
+     */
+    async alarm() {
+        return this.logOperation({ operation: 'alarm' }, async (setLog) => {
+            try {
+                const entries = await this.ctx.storage.list<CacheObjectExp>({
+                    prefix: 'exp.',
+                    noCache: true,
+                });
+                setLog({ entries: entries.size });
+                const toDeleteSet = new Set<string>();
+
+                for (const [key, exp] of entries) {
+                    const timestamp = Number.parseInt(key.split('.')[1]);
+                    if (timestamp < Date.now()) {
+                        toDeleteSet.add(key);
+                        for (let i = 0; i < exp.c; i++) {
+                            toDeleteSet.add(getStoragePropChunkKey(exp.k, i));
+                        }
+                    }
+                }
+
+                // Delete the keys by batch of 128.
+                const toDelete = Array.from(toDeleteSet);
+                setLog({ toDelete: toDelete.length });
+                for (let i = 0; i < toDelete.length; i += 128) {
+                    await this.ctx.storage.delete(toDelete.slice(i, i + 128));
+                }
+
+                // If there are still keys to delete, set an alarm to continue the deletion in 12h.
+                if (toDelete.length) {
+                    await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
+                }
+            } catch (_error) {
+                await this.reset();
+            }
+        });
+    }
+
+    /**
+     * Reset the cache object.
+     */
+    async reset() {
+        return this.logOperation({ operation: 'reset' }, async () => {
+            this.lru.clear();
+            await this.ctx.storage.deleteAll();
+        });
+    }
+
+    /**
+     * Time and log an operation.
+     */
+    async logOperation<T>(
+        log: Record<string, unknown>,
+        fn: (update: (log: Record<string, unknown>) => void) => Promise<T>
+    ): Promise<T> {
+        const objectId = this.ctx.id.name ?? this.ctx.id.toString();
+        const update: Record<string, unknown> = {};
+        const start = performance.now();
+        try {
+            return await fn((arg) => {
+                Object.assign(update, arg);
+            });
+        } finally {
+            const duration = performance.now() - start;
+            console.log({ ...log, ...update, objectId, duration });
+        }
+    }
+}
+
+function getStoragePropKey(key: string): string {
+    return `prop.${key}.`;
+}
+
+function getStoragePropChunkKey(key: string, index: number): string {
+    return `${getStoragePropKey(key)}${index}`;
+}
+
+function getGCClockRootKey(timestamp: number): string {
+    return `exp.${timestamp}.`;
+}
+
+function getGCClockKey(key: string, expiresAt: number): string {
+    return `${getGCClockRootKey(expiresAt)}${key}`;
+}
+
+function encodeChunks<T>(key: string, value: T): Record<string, Uint8Array> {
+    const buf = encode(value);
+    const entries: Record<string, Uint8Array> = {};
+    const chunks = chunkUint8Array(buf, 128 * 1024);
+
+    for (let index = 0; index < chunks.length; index++) {
+        entries[getStoragePropChunkKey(key, index)] = chunks[index];
+    }
+
+    return entries;
+}
+
+function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
+    const chunks = Array.from(entries.entries())
+        .map(([key, value]) => {
+            const index = Number.parseInt(key.split('.').pop()!);
+            return [index, value] as const;
+        })
+        .sort(([a], [b]) => a - b)
+        .map(([, value]) => value);
+
+    if (chunks.length === 0) {
+        return;
+    }
+
+    const buf = mergeUint8Array(chunks);
+    return { value: decode(buf) as T, size: buf.length };
+}
+
+function chunkUint8Array(input: Uint8Array, chunkSize: number): Uint8Array[] {
+    const chunks: Uint8Array[] = [];
+    for (let i = 0; i < input.length; i += chunkSize) {
+        chunks.push(input.slice(i, i + chunkSize));
+    }
+    return chunks;
+}
+
+function mergeUint8Array(chunks: Uint8Array[]): Uint8Array {
+    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+        result.set(chunk, offset);
+        offset += chunk.length;
+    }
+    return result;
+}

packages/cache-do/src/CacheObjectStub.ts

@@ -0,0 +1,97 @@
+import type { CacheObject } from './CacheObject';
+
+export type CacheLocationId = ContinentCode;
+const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
+
+/**
+ * Location hint for the CacheObject durable object.
+ */
+const doLocationHints: {
+    [key in CacheLocationId]: DurableObjectLocationHint;
+} = {
+    AF: 'afr',
+    AS: 'apac',
+    NA: 'wnam',
+    SA: 'sam',
+    AN: 'oc',
+    EU: 'weur',
+    OC: 'oc',
+};
+
+/**
+ * Client to access a cache tag.
+ */
+export class CacheObjectStub {
+    private stub: DurableObjectStub<CacheObject>;
+
+    constructor(
+        /** Binding to the CacheObject durable object */
+        private doNamespace: DurableObjectNamespace<CacheObject>,
+        /** ID of the location to target */
+        private locationId: CacheLocationId,
+        /** Name of the tag */
+        private tag: string
+    ) {
+        const groupId = getCacheObjectIdName(this.locationId, this.tag);
+        this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
+            // Initialize the object with a locaiton hint,
+            // as we might want to purge all locations before the object is created.
+            // https://developers.cloudflare.com/durable-objects/reference/data-location/
+            locationHint: doLocationHints[this.locationId],
+        });
+    }
+
+    /**
+     * Open a descriptor to the cache object.
+     * It can be used to perform multiple operations in a single RPC session.
+     * Ex:
+     * ```ts
+     * using desc = cache.open();
+     * await desc.set('key', 'value', Date.now() + 1000);
+     * await desc.get('key');
+     * ```
+     */
+    async open() {
+        return await this.stub.open();
+    }
+
+    /**
+     * Get a value from the cache.
+     */
+    async get<Value = unknown>(key: string) {
+        return (await this.stub.get(key)) as Value | undefined;
+    }
+
+    /**
+     * Set a value in the cache.
+     */
+    async set<Value = unknown>(key: string, value: Value, expiresAt: number) {
+        return await this.stub.set(key, value, expiresAt);
+    }
+
+    /**
+     * Purge all keys in the cache tag.
+     */
+    async purge() {
+        const keys = new Set<string>();
+        await Promise.all(
+            allLocations.map(async (locationId) => {
+                const groupId = getCacheObjectIdName(locationId, this.tag);
+                const cacheGroup = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
+                    // Initialize the object with a locaiton hint,
+                    // as we might want to purge all locations before the object is created.
+                    // https://developers.cloudflare.com/durable-objects/reference/data-location/
+                    locationHint: doLocationHints[this.locationId],
+                });
+                const locationkeys = await cacheGroup.purge();
+                locationkeys.forEach((key) => keys.add(key));
+            })
+        );
+
+        return keys;
+    }
+}
+
+function getCacheObjectIdName(locationId: CacheLocationId, tag: string): string {
+    return `${locationId}:${tag}`;
+}

packages/cache-do/src/api.ts

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

packages/cache-do/src/index.ts

@@ -0,0 +1,9 @@
+import { WorkerEntrypoint } from 'cloudflare:workers';
+
+export * from './CacheObject';
+
+export default class Worker extends WorkerEntrypoint {
+    fetch() {
+        return new Response('Hello, world!');
+    }
+}

packages/cache-do/tsconfig.json

@@ -13,10 +13,9 @@
         "moduleResolution": "bundler",
         "resolveJsonModule": true,
         "isolatedModules": true,
-        "jsx": "react-jsx",
         "incremental": true,
-        "types": []
+        "types": ["./worker-configuration.d.ts"]
     },
-    "include": ["src/**/*.ts", "src/**/*.tsx"],
+    "include": ["src/**/*.ts"],
     "exclude": ["node_modules"]
 }

packages/cache-do/turbo.json

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

packages/cache-do/wrangler.toml

@@ -0,0 +1,27 @@
+main = "./src/index.ts"
+name = "gitbook-open-cache"
+compatibility_date = "2024-09-02"
+
+durable_objects.bindings = [
+  {name = "CACHE", class_name = "CacheObject"}
+]
+
+migrations = [
+  {tag = "v1", new_classes = ["CacheObject"]}
+]
+
+[observability]
+enabled = false
+
+[env.preview]
+name = "gitbook-open-cache-preview"
+durable_objects.bindings = [
+  {name = "CACHE", class_name = "CacheObject"}
+]
+migrations = [
+  {tag = "v1", new_classes = ["CacheObject"]}
+]
+
+[env.preview.observability]
+enabled = true
+head_sampling_rate = 0.1

packages/cache-tags/package.json

@@ -10,7 +10,7 @@
     },
     "version": "0.3.1",
     "dependencies": {
-        "@gitbook/api": "catalog:",
+        "@gitbook/api": "^0.115.0",
         "assert-never": "^1.2.1"
     },
     "devDependencies": {

packages/cache-tags/src/index.ts

@@ -90,7 +90,7 @@ export function getCacheTag(
         | {
               tag: 'translation';
               organization: string;
-              translation: string;
+              translationSettings: string;
           }
 ): string {
     switch (spec.tag) {
@@ -115,7 +115,7 @@ export function getCacheTag(
         case 'openapi':
             return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
         case 'translation':
-            return `organization:${spec.organization}:translation:${spec.translation}`;
+            return `organization:${spec.organization}:translation:${spec.translationSettings}`;
         default:
             assertNever(spec);
     }
@@ -144,10 +144,6 @@ export function getComputedContentSourceCacheTags(
 ) {
     const tags: string[] = [];
 
-    if (!('dependencies' in source)) {
-        return tags;
-    }
-
     // We add the dependencies as tags, to ensure that the computed content is invalidated
     // when the dependencies are updated.
     const dependencies = Object.values(source.dependencies ?? {});
@@ -171,12 +167,12 @@ export function getComputedContentSourceCacheTags(
                         })
                     );
                     break;
-                case 'translation':
+                case 'translation-language':
                     tags.push(
                         getCacheTag({
                             tag: 'translation',
                             organization: inContext.organizationId,
-                            translation: dependency.ref.translation,
+                            translationSettings: dependency.ref.translationSettings,
                         })
                     );
                     break;

packages/embed/.gitignore

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

packages/embed/README.md

@@ -1,49 +0,0 @@
-# `@gitbook/embed`
-
-Embed the GitBook Docs Assistant in your product or website.
-
-# Usage
-
-## As a script from your docs site
-
-All GitBook docs site includes a script to easily embed the docs assistant as a widget on your website.
-
-The script is served at `https://docs.company.com/~gitbook/embed/script.js`.
-
-You can find the embed script from your docs site settings, or you can copy the following and replace the `docs.company.com` by your docs site hostname.
-
-```html
-<script src="https://docs.company.com/~gitbook/embed/script.js"></script>
-<script>
-window.GitBook('show');
-</script>
-```
-
-## As a package from NPM
-
-Install the package: `npm install @gitbook/embed` and import it in your web application:
-
-```tsx
-import { createGitBook } from '@gitbook/embed';
-
-const gitbook = createGitBook({
-    siteURL: 'https://docs.company.com'
-});
-
-const iframe = document.createElement('iframe');
-iframe.src = gitbook.getFrameURL();
-
-const frame = gitbook.createFrame(iframe);
-```
-
-## As React components
-
-After installing the NPM package, you can import prebuilt React components:
-
-```tsx
-import { GitBookProvider, GitBookAssistantFrame } from '@gitbook/embed/react';
-
-<GitBookProvider siteURL="https://docs.company.com">
-    <GitBookAssistantFrame />
-</GitBookProvider>
-```

packages/embed/package.json

@@ -1,31 +0,0 @@
-{
-    "name": "@gitbook/embed",
-    "description": "Embeddable components for GitBook",
-    "type": "module",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "default": "./dist/index.js",
-            "standalone": "./dist/standalone/index.js",
-            "react": "./dist/react/index.js"
-        }
-    },
-    "version": "0.0.0",
-    "dependencies": {
-        "@gitbook/api": "catalog:",
-        "@gitbook/icons": "workspace:",
-        "bidc": "catalog:"
-    },
-    "peerDependencies": {
-        "react": "^18.0.0"
-    },
-    "devDependencies": {
-        "typescript": "^5.5.3",
-        "react": "^19.0.0"
-    },
-    "scripts": {
-        "build": "tsc && bun build src/standalone/index.ts --bundle --minify --outdir=standalone",
-        "typecheck": "tsc --noEmit"
-    },
-    "files": ["dist", "README.md", "CHANGELOG.md", "standalone"]
-}

packages/embed/src/client/createGitBook.ts

@@ -1,61 +0,0 @@
-import { type GitBookFrameClient, createGitBookFrame } from './createGitBookFrame';
-
-export type CreateGitBookOptions = {
-    /**
-     * URL of the GitBook site to embed.
-     */
-    siteURL: string;
-};
-
-export type GetFrameURLOptions = {
-    /**
-     * Authentication to use for the frame.
-     */
-    visitor?: {
-        /**
-         * Signed JWT token for Adaptive Content or Visitor Authentication to use.
-         */
-        token?: string;
-
-        /**
-         * Unsigned claims to pass to the frame.
-         * You can use these claims in dynamic expressions using `visitor.claims.unsigned.<claim-name>`.
-         */
-        unsignedClaims?: Record<string, unknown>;
-    };
-};
-
-export type GitBookClient = {
-    /**
-     * Get the URL for a GitBook frame.
-     */
-    getFrameURL: (options: GetFrameURLOptions) => string;
-    /**
-     * Create a new GitBook frame.
-     */
-    createFrame: (iframe: HTMLIFrameElement) => GitBookFrameClient;
-};
-
-export function createGitBook(options: CreateGitBookOptions) {
-    const client: GitBookClient = {
-        getFrameURL: (frameOptions) => {
-            const url = new URL(options.siteURL);
-            url.pathname = `${url.pathname.endsWith('/') ? url.pathname : `${url.pathname}/`}~gitbook/embed/assistant`;
-
-            if (frameOptions.visitor?.token) {
-                url.searchParams.set('token', frameOptions.visitor.token);
-            }
-
-            if (frameOptions.visitor?.unsignedClaims) {
-                Object.entries(frameOptions.visitor.unsignedClaims).forEach(([key, value]) => {
-                    url.searchParams.set(`visitor.${key}`, String(value));
-                });
-            }
-
-            return url.toString();
-        },
-        createFrame: (iframe) => createGitBookFrame(iframe),
-    };
-
-    return client;
-}

packages/embed/src/client/createGitBookFrame.ts

@@ -1,93 +0,0 @@
-import { createChannel } from 'bidc';
-import type {
-    FrameToParentMessage,
-    GitBookPlaceholderSettings,
-    GitBookToolDefinition,
-    ParentToFrameMessage,
-} from './protocol';
-
-export type GitBookFrameClient = {
-    /**
-     * Navigate to a page by its path.
-     */
-    navigateToPage: (path: string) => void;
-
-    /**
-     * Navigate to the assistant.
-     */
-    navigateToAssistant: () => void;
-
-    /**
-     * Post a message to the chat.
-     */
-    postUserMessage: (message: string) => void;
-
-    /**
-     * Register a custom tool.
-     */
-    registerTool: (tool: GitBookToolDefinition) => void;
-
-    /**
-     * Clear the chat.
-     */
-    clearChat: () => void;
-
-    /**
-     * Set the placeholder settings.
-     */
-    setPlaceholder: (placeholder: GitBookPlaceholderSettings) => void;
-
-    /**
-     * Register an event listener.
-     */
-    on: (event: string, listener: (...args: any[]) => void) => () => void;
-};
-
-/**
- * Create a client to communicate with the GitBook Assistant frame.
- */
-export function createGitBookFrame(iframe: HTMLIFrameElement): GitBookFrameClient {
-    if (!iframe.contentWindow) {
-        throw new Error('Iframe must have a content window');
-    }
-    const channel = createChannel(iframe.contentWindow);
-
-    channel.receive((message: FrameToParentMessage) => {
-        if (message.type === 'close') {
-            const listeners = events.get('close') || [];
-            if (listeners) {
-                listeners.forEach((listener) => listener());
-            }
-        }
-    });
-
-    const sendToFrame = (message: ParentToFrameMessage) => {
-        channel.send(message);
-    };
-
-    const events = new Map<string, Array<(...args: any[]) => void>>();
-
-    return {
-        navigateToPage: (pagePath) => {
-            sendToFrame({ type: 'navigateToPage', pagePath });
-        },
-        navigateToAssistant: () => {
-            sendToFrame({ type: 'navigateToAssistant' });
-        },
-        postUserMessage: (message) => sendToFrame({ type: 'postUserMessage', message }),
-        registerTool: (tool) => sendToFrame({ type: 'registerTool', tool }),
-        clearChat: () => sendToFrame({ type: 'clearChat' }),
-        setPlaceholder: (settings) => sendToFrame({ type: 'setPlaceholder', settings }),
-        on: (event, listener) => {
-            const listeners = events.get(event) || [];
-            listeners.push(listener);
-            events.set(event, listeners);
-            return () => {
-                events.set(
-                    event,
-                    listeners.filter((l) => l !== listener)
-                );
-            };
-        },
-    };
-}

packages/embed/src/client/index.ts

@@ -1,3 +0,0 @@
-export * from './createGitBook';
-export * from './createGitBookFrame';
-export * from './protocol';

packages/embed/src/client/protocol.ts

@@ -1,70 +0,0 @@
-import type { AIToolCallResult, AIToolDefinition } from '@gitbook/api';
-import type { IconName } from '@gitbook/icons';
-
-/**
- * Custom tool definition to be passed to the AI assistant.
- */
-export type GitBookToolDefinition = AIToolDefinition & {
-    /**
-     * Confirmation action to be displayed to the user before executing the tool.
-     */
-    confirmation?: {
-        icon?: IconName;
-        label: string;
-    };
-
-    /**
-     * Callback when the tool is executed.
-     * The input is provided by the AI assistant following the input schema of the tool.
-     */
-    execute: (input: object) => Promise<Pick<AIToolCallResult, 'output' | 'summary'>>;
-};
-
-/**
- * Placeholder settings.
- */
-export type GitBookPlaceholderSettings = {
-    /**
-     * Welcome message to be displayed in the placeholder.
-     */
-    welcomeMessage: string;
-
-    /**
-     * Suggestions to be displayed in the placeholder.
-     */
-    suggestions: string[];
-};
-
-/**
- * Messages sent from the parent to the frame.
- */
-export type ParentToFrameMessage =
-    | {
-          type: 'postUserMessage';
-          message: string;
-      }
-    | {
-          type: 'registerTool';
-          tool: GitBookToolDefinition;
-      }
-    | {
-          type: 'clearChat';
-      }
-    | {
-          type: 'setPlaceholder';
-          settings: GitBookPlaceholderSettings;
-      }
-    | {
-          type: 'navigateToPage';
-          pagePath: string;
-      }
-    | {
-          type: 'navigateToAssistant';
-      };
-
-/**
- * Messages sent from the frame to the parent.
- */
-export type FrameToParentMessage = {
-    type: 'close';
-};

packages/embed/src/index.ts

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

packages/embed/src/react/GitBookAssistantFrame.tsx

@@ -1,38 +0,0 @@
-import React from 'react';
-import type { GetFrameURLOptions, GitBookFrameClient } from '../client';
-import { useGitBook } from './GitBookProvider';
-
-export type GitBookAssistantFrameProps = {
-    title?: string;
-    className?: string;
-} & GetFrameURLOptions;
-
-/**
- * Render a frame with the GitBook Assistant in it.
- */
-export function GitBookAssistantFrame(props: GitBookAssistantFrameProps) {
-    const { title, className, ...frameOptions } = props;
-
-    const frameRef = React.useRef<HTMLIFrameElement>(null);
-    const gitbookFrameRef = React.useRef<GitBookFrameClient | null>(null);
-    const gitbook = useGitBook();
-    const frameURL = gitbook.getFrameURL(frameOptions);
-
-    React.useEffect(() => {
-        if (frameRef.current) {
-            gitbookFrameRef.current = gitbook.createFrame(frameRef.current);
-        }
-    }, [gitbook]);
-
-    return (
-        <div className={className}>
-            <iframe
-                title={title ?? 'GitBook Assistant'}
-                ref={frameRef}
-                src={frameURL}
-                width="100%"
-                height="100%"
-            />
-        </div>
-    );
-}

packages/embed/src/react/GitBookProvider.tsx

@@ -1,36 +0,0 @@
-'use client';
-
-import * as React from 'react';
-import { type CreateGitBookOptions, createGitBook } from '../client';
-import { GitBookContext } from './context';
-
-/**
- * Provider for the GitBook client.
- */
-export function GitBookProvider(props: React.PropsWithChildren<CreateGitBookOptions>) {
-    const { siteURL, children } = props;
-
-    const options = React.useMemo(
-        () => ({
-            siteURL,
-        }),
-        [siteURL]
-    );
-
-    const client = React.useMemo(() => createGitBook(options), [options]);
-
-    return <GitBookContext.Provider value={client}>{children}</GitBookContext.Provider>;
-}
-
-/**
- * Hook to access the GitBook client.
- */
-export function useGitBook() {
-    const context = React.useContext(GitBookContext);
-
-    if (!context) {
-        throw new Error('This component must be used within a <GitBookProvider />');
-    }
-
-    return context;
-}

packages/embed/src/react/context.ts

@@ -1,6 +0,0 @@
-'use client';
-
-import * as React from 'react';
-import type { GitBookClient } from '../client';
-
-export const GitBookContext = React.createContext<GitBookClient | null>(null);

packages/embed/src/react/index.ts

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

packages/embed/src/standalone/index.ts

@@ -1,158 +0,0 @@
-import './style.css';
-
-import {
-    type CreateGitBookOptions,
-    type GetFrameURLOptions,
-    type GitBookClient,
-    type GitBookFrameClient,
-    type GitBookPlaceholderSettings,
-    type GitBookToolDefinition,
-    createGitBook,
-} from '../client';
-
-export type GitBook = () => void;
-
-type StandaloneCalls =
-    // Initialize the widget
-    | ['init', CreateGitBookOptions, GetFrameURLOptions]
-    // Unload the widget
-    | ['unload']
-    // Show the widget
-    | ['show']
-    // Hide the widget
-    | ['hide']
-    // Open the window
-    | ['open']
-    // Close the window
-    | ['close']
-    // Toggle the window
-    | ['toggle']
-    // Post a user message
-    | ['postUserMessage', string]
-    // Register a tool
-    | ['registerTool', GitBookToolDefinition]
-    // Clear the chat
-    | ['clearChat']
-    // Configure the placeholder
-    | ['setPlaceholder', GitBookPlaceholderSettings]
-    // Navigate to a page
-    | ['navigateToPage', string]
-    // Navigate to the assistant
-    | ['navigateToAssistant'];
-
-export type GitBookStandalone = ((...args: StandaloneCalls) => void) & {
-    q?: StandaloneCalls[];
-};
-
-const widgetButton = document.createElement('button');
-widgetButton.id = 'gitbook-widget-button';
-widgetButton.addEventListener('click', () => {
-    GitBook('toggle');
-});
-widgetButton.innerHTML = `
-    <span id="gitbook-widget-button-icon"></span>
-    <span id="gitbook-widget-button-label">Ask</span>
-`;
-
-const widgetWindow = document.createElement('div');
-widgetWindow.id = 'gitbook-widget-window';
-widgetWindow.classList.add('hidden');
-
-document.body.appendChild(widgetButton);
-document.body.appendChild(widgetWindow);
-
-let widgetIframe: HTMLIFrameElement | undefined;
-let _client: GitBookClient | undefined;
-let _frame: GitBookFrameClient | undefined;
-let frameOptions: GetFrameURLOptions | undefined;
-
-function getClient() {
-    if (!_client) {
-        throw new Error(
-            'GitBook client not initialized. Call GitBook("init", { siteURL: "..." }) first.'
-        );
-    }
-    return _client;
-}
-
-function getIframe() {
-    if (!widgetIframe || !_frame) {
-        const client = getClient();
-
-        widgetIframe?.remove();
-        widgetIframe = document.createElement('iframe');
-        widgetIframe.id = 'gitbook-widget-iframe';
-        widgetIframe.src = client.getFrameURL({
-            ...frameOptions,
-        });
-        widgetWindow.appendChild(widgetIframe);
-
-        _frame = client.createFrame(widgetIframe);
-    }
-    return { iframe: widgetIframe, frame: _frame };
-}
-
-const GitBook = (...args: StandaloneCalls) => {
-    switch (args[0]) {
-        case 'init':
-            if (_client) {
-                throw new Error(
-                    'GitBook client already initialized. Call GitBook("unload") first.'
-                );
-            }
-            _client = createGitBook(args[1]);
-            frameOptions = args[2];
-            break;
-        case 'unload':
-            _client = undefined;
-            _frame = undefined;
-            widgetIframe?.remove();
-            widgetWindow.classList.add('hidden');
-            break;
-        case 'show':
-            widgetButton.classList.remove('hidden');
-            break;
-        case 'hide':
-            widgetButton.classList.add('hidden');
-            break;
-        case 'open':
-            widgetWindow.classList.remove('hidden');
-            widgetButton.classList.add('open');
-            getIframe();
-            break;
-        case 'toggle':
-            widgetWindow.classList.toggle('hidden');
-            widgetButton.classList.toggle('open');
-            getIframe();
-            break;
-        case 'close':
-            widgetWindow.classList.add('hidden');
-            widgetButton.classList.remove('open');
-            break;
-        case 'postUserMessage':
-            getIframe().frame.postUserMessage(args[1]);
-            break;
-        case 'registerTool':
-            getIframe().frame.registerTool(args[1]);
-            break;
-        case 'clearChat':
-            getIframe().frame.clearChat();
-            break;
-        case 'setPlaceholder':
-            getIframe().frame.setPlaceholder(args[1]);
-            break;
-        case 'navigateToPage':
-            getIframe().frame.navigateToPage(args[1]);
-            break;
-        case 'navigateToAssistant':
-            getIframe().frame.navigateToAssistant();
-            break;
-    }
-};
-
-// @ts-expect-error - GitBook is not defined in the global scope
-const precalls = (window.GitBook as GitBookStandalone | undefined)?.q ?? [];
-
-// @ts-expect-error - GitBook is not defined in the global scope
-window.GitBook = GitBook;
-precalls.forEach((call) => GitBook(...call));

packages/embed/src/standalone/style.css

@@ -1,170 +0,0 @@
-:root {
-    --gitbook-widget-top: 1rem;
-    --gitbook-widget-bottom: 1rem;
-    --gitbook-widget-right: 1rem;
-
-    --gitbook-widget-button-height: 46px;
-
-    --gitbook-widget-radius: .5rem;
-    --gitbook-widget-text-size: 1rem;
-    --gitbook-widget-text-color: #656973;
-    --gitbook-widget-border-color: #e5e5e5;
-
-    --gitbook-widget-background-translucent: rgba(255, 255, 255, 0.9);
-    --gitbook-widget-background-translucent-hover: rgba(250, 250, 250, 0.9);
-    --gitbook-widget-background-solid: #FFFFFF;
-    --gitbook-widget-background-solid-hover: #FBFBFB;
-
-    --gitbook-widget-icon-size: 1.25rem;
-
-    --gitbook-widget-window-width: 28rem; /* 448px */
-    --gitbook-widget-window-height: 40rem; /* 640px */
-    --gitbook-widget-window-spacing: .5rem; /* Spacing between the button and the window */
-    --gitbook-widget-window-bottom: calc(var(--gitbook-widget-bottom) + var(--gitbook-widget-button-height) + var(--gitbook-widget-window-spacing));
-
-    --gitbook-widget-transition-duration-fast: 0.2s;
-    --gitbook-widget-transition-duration-slow: 0.5s;
-    --gitbook-widget-easing: cubic-bezier(0.25, 1, 0.5, 1);
-    --gitbook-widget-easing-bounce: cubic-bezier(0.34, 1.56, 0.64, 1);
-}
-
-* {
-    box-sizing: border-box;
-}
-
-/* Button */
-#gitbook-widget-button {
-    position: fixed;
-    bottom: var(--gitbook-widget-bottom);
-    right: var(--gitbook-widget-right);
-    height: var(--gitbook-widget-button-height);
-    z-index: 9999;
-
-    display: flex;
-    align-items: center;
-    flex-direction: row-reverse;
-    gap: .5rem;
-    padding: .75rem 1rem;
-
-    border-radius: 100px;
-    border: 1px solid var(--gitbook-widget-border-color);
-    background-color: var(--gitbook-widget-background-translucent);
-    backdrop-filter: blur(16px);
-
-    font-size: var(--gitbook-widget-text-size);
-    color: var(--gitbook-widget-text-color);
-
-    box-shadow: 0 1px 3px 0 rgba(0,0,0,0.05), 0 1px 2px -1px rgba(0,0,0,0.05);
-    transition: all var(--gitbook-widget-transition-duration-fast) var(--gitbook-widget-easing);
-
-    cursor:pointer;
-    animation: gitbook-widget-present var(--gitbook-widget-transition-duration-slow) var(--gitbook-widget-easing-bounce);
-}
-
-#gitbook-widget-button:hover, #gitbook-widget-button:focus-visible {
-    background-color: var(--gitbook-widget-background-translucent-hover);
-}
-#gitbook-widget-button:hover, #gitbook-widget-button:focus-visible {
-    transform: translateY(-1px);
-    box-shadow: 0 4px 6px -1px rgba(0,0,0,0.1), 0 2px 4px -2px rgba(0,0,0,0.1);
-}
-#gitbook-widget-button:active {
-    transform: translateY(0);
-    box-shadow: 0 1px 3px 0 rgba(0,0,0,0.05), 0 1px 2px -1px rgba(0,0,0,0.05);
-}
-
-@media (prefers-contrast: more) {
-    #gitbook-widget-button {
-        background-color: var(--gitbook-widget-background-solid);
-    }
-    #gitbook-widget-button:hover, #gitbook-widget-button:focus-visible {
-        background-color: var(--gitbook-widget-background-solid-hover);
-    }
-}
-
-#gitbook-widget-button.hidden {
-    display: none;
-}
-
-#gitbook-widget-button.open {
-    padding: .75rem;
-    gap: 0;
-}
-
-/* Button: Icon */
-#gitbook-widget-button-icon {
-    width: var(--gitbook-widget-icon-size);
-    height: var(--gitbook-widget-icon-size);
-    mask-image: url("https://static-2v.gitbook.com/~gitbook/static/icons/svgs/custom-icons/gitbook-assistant.svg?v=2");
-    mask-size: contain;
-    mask-repeat: no-repeat;
-    mask-position: center;
-    background-color: currentColor;
-}
-
-#gitbook-widget-button.open #gitbook-widget-button-icon {
-    mask-image: url('https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/close.svg?v=2&token=a463935e93');
-}
-
-/* Button: Label */
-#gitbook-widget-button.open #gitbook-widget-button-label {
-    display: none;
-}
-
-/* Window */
-#gitbook-widget-window {
-    position: fixed;
-    bottom: var(--gitbook-widget-window-bottom);
-    right: var(--gitbook-widget-right);
-    z-index: 9998;
-    width: var(--gitbook-widget-window-width);
-    height: calc(min(var(--gitbook-widget-window-height), calc(100vh - var(--gitbook-widget-window-bottom) - var(--gitbook-widget-top))));
-    background-color: var(--gitbook-widget-background-solid);
-    border: 1px solid var(--gitbook-widget-border-color);
-    border-radius: var(--gitbook-widget-radius);
-    box-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);
-    overflow: hidden;
-    transition-property: transform, opacity, display;
-    transition-duration: var(--gitbook-widget-transition-duration-slow);
-    transition-timing-function: var(--gitbook-widget-easing-bounce);
-    transform-origin: bottom right;
-    transition-behavior: allow-discrete;
-}
-
-@starting-style {
-    #gitbook-widget-window {
-        opacity: 0;
-        transform: scale(0.9);
-    }
-}
-
-body:has(#gitbook-widget-button.hidden) #gitbook-widget-window {
-    bottom: var(--gitbook-widget-bottom);
-}
-
-#gitbook-widget-window.hidden {
-    transition-property: transform, opacity, display;
-    transition-duration: var(--gitbook-widget-transition-duration-fast);
-    transition-timing-function: var(--gitbook-widget-easing);
-    transition-behavior: allow-discrete;
-    display: none;
-    opacity: 0;
-    transform: scale(0.9);
-}
-
-#gitbook-widget-iframe {
-    width: 100%;
-    height: 100%;
-    border: none;
-}
-
-@keyframes gitbook-widget-present {
-    from {
-        opacity: 0;
-        transform: scale(0.9);
-    }
-    to {
-        opacity: 1;
-        transform: scale(1);
-    }
-}

packages/fonts/.gitignore

@@ -1,2 +0,0 @@
-dist/
-src/data/*.json

packages/fonts/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @gitbook/fonts
-
-## 0.1.0
-
-### Minor Changes
-
-- fbfcca5: Initial version of the package

packages/fonts/README.md

@@ -1,3 +0,0 @@
-# `@gitbook/fonts`
-
-Utilities to lookup default fonts supported by GitBook.

packages/fonts/bin/generate.ts

@@ -1,91 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-
-import { APIv2 } from 'google-font-metadata';
-
-import { CustomizationDefaultFont } from '@gitbook/api';
-
-import type { FontDefinitions } from '../src/types';
-
-const googleFontsMap: { [fontName in CustomizationDefaultFont]: string } = {
-    [CustomizationDefaultFont.Inter]: 'inter',
-    [CustomizationDefaultFont.FiraSans]: 'fira-sans-extra-condensed',
-    [CustomizationDefaultFont.IBMPlexSerif]: 'ibm-plex-serif',
-    [CustomizationDefaultFont.Lato]: 'lato',
-    [CustomizationDefaultFont.Merriweather]: 'merriweather',
-    [CustomizationDefaultFont.NotoSans]: 'noto-sans',
-    [CustomizationDefaultFont.OpenSans]: 'open-sans',
-    [CustomizationDefaultFont.Overpass]: 'overpass',
-    [CustomizationDefaultFont.Poppins]: 'poppins',
-    [CustomizationDefaultFont.Raleway]: 'raleway',
-    [CustomizationDefaultFont.Roboto]: 'roboto',
-    [CustomizationDefaultFont.RobotoSlab]: 'roboto-slab',
-    [CustomizationDefaultFont.SourceSansPro]: 'source-sans-3',
-    [CustomizationDefaultFont.Ubuntu]: 'ubuntu',
-    [CustomizationDefaultFont.ABCFavorit]: 'inter',
-};
-
-/**
- * Scripts to generate the list of all icons.
- */
-async function main() {
-    // @ts-expect-error - we build the object
-    const output: FontDefinitions = {};
-
-    for (const font of Object.values(CustomizationDefaultFont)) {
-        const googleFontName = googleFontsMap[font];
-        const fontMetadata = APIv2[googleFontName.toLowerCase()];
-        if (!fontMetadata) {
-            throw new Error(`Font ${googleFontName} not found`);
-        }
-
-        output[font] = {
-            font: googleFontName,
-            unicodeRange: fontMetadata.unicodeRange,
-            variants: {
-                '400': {},
-                '700': {},
-            },
-        };
-
-        Object.keys(output[font].variants).forEach((weight) => {
-            const variants = fontMetadata.variants[weight];
-            const normalVariant = variants.normal;
-            if (!normalVariant) {
-                throw new Error(`Font ${googleFontName} has no normal variant`);
-            }
-
-            output[font].variants[weight] = {};
-            Object.entries(normalVariant).forEach(([script, url]) => {
-                output[font].variants[weight][script] = url.url.woff;
-            });
-        });
-    }
-
-    await writeDataFile('fonts', JSON.stringify(output, null, 2));
-}
-
-/**
- * We write both in dist and src as the build process might have happen already
- * and tsc doesn't copy the files.
- */
-async function writeDataFile(name, content) {
-    const srcData = path.resolve(__dirname, '../src/data');
-    const distData = path.resolve(__dirname, '../dist/data');
-
-    // Ensure the directories exists
-    await Promise.all([
-        fs.mkdir(srcData, { recursive: true }),
-        fs.mkdir(distData, { recursive: true }),
-    ]);
-
-    await Promise.all([
-        fs.writeFile(path.resolve(srcData, `${name}.json`), content),
-        fs.writeFile(path.resolve(distData, `${name}.json`), content),
-    ]);
-}
-
-main().catch((error) => {
-    console.error(`Error generating icons list: ${error}`);
-    process.exit(1);
-});

packages/fonts/package.json

@@ -1,31 +0,0 @@
-{
-    "name": "@gitbook/fonts",
-    "type": "module",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "development": "./src/index.ts",
-            "default": "./dist/index.js"
-        }
-    },
-    "version": "0.1.0",
-    "dependencies": {
-        "@gitbook/api": "catalog:"
-    },
-    "devDependencies": {
-        "google-font-metadata": "^6.0.3",
-        "typescript": "^5.5.3"
-    },
-    "scripts": {
-        "generate": "bun ./bin/generate.js",
-        "build": "tsc --project tsconfig.build.json",
-        "typecheck": "tsc --noEmit",
-        "dev": "tsc -w",
-        "clean": "rm -rf ./dist && rm -rf ./src/data",
-        "unit": "bun test"
-    },
-    "files": ["dist", "src", "bin", "README.md", "CHANGELOG.md"],
-    "engines": {
-        "node": ">=20.0.0"
-    }
-}

packages/fonts/src/__snapshots__/getDefaultFont.test.ts.snap

@@ -1,57 +0,0 @@
-// Bun Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`getDefaultFont should return correct object for Latin text 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
-}
-`;
-
-exports[`getDefaultFont should return correct object for Cyrillic text 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
-}
-`;
-
-exports[`getDefaultFont should return correct object for Greek text 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhjp-Ek-_0ewmM.woff",
-}
-`;
-
-exports[`getDefaultFont should handle mixed script text 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
-}
-`;
-
-exports[`getDefaultFont should handle different font weights: regular 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
-}
-`;
-
-exports[`getDefaultFont should handle different font weights: bold 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuFuYAZ9hjp-Ek-_0ew.woff",
-}
-`;
-
-exports[`getDefaultFont should handle different fonts: inter 1`] = `
-{
-  "font": "Inter",
-  "url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
-}
-`;
-
-exports[`getDefaultFont should handle different fonts: roboto 1`] = `
-{
-  "font": "Roboto",
-  "url": "https://fonts.gstatic.com/s/roboto/v32/KFOmCnqEu92Fr1Mu4mxMKTU1Kg.woff",
-}
-`;

packages/fonts/src/fonts.ts

@@ -1,5 +0,0 @@
-import type { FontDefinitions } from './types';
-
-import rawFonts from './data/fonts.json' with { type: 'json' };
-
-export const fonts: FontDefinitions = rawFonts;

packages/fonts/src/getDefaultFont.test.ts

@@ -1,119 +0,0 @@
-import { describe, expect, it } from 'bun:test';
-import { CustomizationDefaultFont } from '@gitbook/api';
-import { getDefaultFont } from './getDefaultFont';
-
-describe('getDefaultFont', () => {
-    it('should return null for invalid font', () => {
-        const result = getDefaultFont({
-            font: 'invalid-font' as CustomizationDefaultFont,
-            text: 'Hello',
-            weight: 400,
-        });
-        expect(result).toBeNull();
-    });
-
-    it('should return null for invalid weight', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Hello',
-            weight: 999 as any,
-        });
-        expect(result).toBeNull();
-    });
-
-    it('should return null for text not supported by any script', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: '😀', // Emoji not supported by Inter
-            weight: 400,
-        });
-        expect(result).toBeNull();
-    });
-
-    it('should return correct object for Latin text', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Hello World',
-            weight: 400,
-        });
-        expect(result).not.toBeNull();
-        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
-        expect(result).toMatchSnapshot();
-    });
-
-    it('should return correct object for Cyrillic text', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Привет мир',
-            weight: 400,
-        });
-        expect(result).not.toBeNull();
-        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
-        expect(result).toMatchSnapshot();
-    });
-
-    it('should return correct object for Greek text', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Γεια σας',
-            weight: 400,
-        });
-        expect(result).not.toBeNull();
-        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
-        expect(result).toMatchSnapshot();
-    });
-
-    it('should handle mixed script text', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Hello Привет',
-            weight: 400,
-        });
-        expect(result).not.toBeNull();
-        expect(result?.font).toBe(CustomizationDefaultFont.Inter);
-        expect(result).toMatchSnapshot();
-    });
-
-    it('should handle different font weights', () => {
-        const regular = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Hello',
-            weight: 400,
-        });
-        const bold = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Hello',
-            weight: 700,
-        });
-        expect(regular).not.toBeNull();
-        expect(bold).not.toBeNull();
-        expect(regular).toMatchSnapshot('regular');
-        expect(bold).toMatchSnapshot('bold');
-    });
-
-    it('should handle empty string', () => {
-        const result = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: '',
-            weight: 400,
-        });
-        expect(result).toBeNull();
-    });
-
-    it('should handle different fonts', () => {
-        const inter = getDefaultFont({
-            font: CustomizationDefaultFont.Inter,
-            text: 'Hello',
-            weight: 400,
-        });
-        const roboto = getDefaultFont({
-            font: CustomizationDefaultFont.Roboto,
-            text: 'Hello',
-            weight: 400,
-        });
-        expect(inter).not.toBeNull();
-        expect(roboto).not.toBeNull();
-        expect(inter).toMatchSnapshot('inter');
-        expect(roboto).toMatchSnapshot('roboto');
-    });
-});

packages/fonts/src/getDefaultFont.ts

@@ -1,112 +0,0 @@
-import type { CustomizationDefaultFont } from '@gitbook/api';
-import { fonts } from './fonts';
-import type { FontWeight } from './types';
-
-/**
- * Get the URL to load a font for a text.
- */
-export function getDefaultFont(input: {
-    /**
-     * GitBook font to use.
-     */
-    font: CustomizationDefaultFont;
-
-    /**
-     * Text to display with the font.
-     */
-    text: string;
-
-    /**
-     * Font weight to use.
-     */
-    weight: FontWeight;
-}): { font: string; url: string } | null {
-    if (!input.text.trim()) {
-        return null;
-    }
-
-    const fontDefinition = fonts[input.font];
-    if (!fontDefinition) {
-        return null;
-    }
-
-    const variant = fontDefinition.variants[`${input.weight}`];
-    if (!variant) {
-        return null;
-    }
-
-    const script = getBestUnicodeRange(input.text, fontDefinition.unicodeRange);
-    if (!script) {
-        return null;
-    }
-
-    return variant[script]
-        ? {
-              font: input.font,
-              url: variant[script],
-          }
-        : null;
-}
-
-/**
- * Determine which named @font-face unicode-range covers
- * the greatest share of the characters in `text`.
- *
- * @param text   The text you want to inspect.
- * @param ranges An object whose keys are range names and whose
- *               values are CSS-style comma-separated unicode-range
- *               declarations (e.g. "U+0370-03FF,U+1F00-1FFF").
- * @returns      The key of the best-matching range, or `null`
- *               when nothing matches at all.
- */
-function getBestUnicodeRange(text: string, ranges: Record<string, string>): string | null {
-    // ---------- helper: parse "U+XXXX" or "U+XXXX-YYYY" ----------
-    const parseOne = (token: string): [number, number] | null => {
-        token = token.trim().toUpperCase();
-        if (!token.startsWith('U+')) return null;
-
-        const body = token.slice(2); // drop "U+"
-        const [startHex, endHex] = body.split('-');
-        const start = Number.parseInt(startHex, 16);
-        const end = endHex ? Number.parseInt(endHex, 16) : start;
-
-        if (Number.isNaN(start) || Number.isNaN(end) || end < start) return null;
-        return [start, end];
-    };
-
-    // ---------- helper: build lookup table ----------
-    const parsed: Record<string, [number, number][]> = {};
-    for (const [label, list] of Object.entries(ranges)) {
-        parsed[label] = list
-            .split(',')
-            .map(parseOne)
-            .filter((x): x is [number, number] => x !== null);
-    }
-
-    // ---------- tally code-point hits ----------
-    const hits: Record<string, number> = Object.fromEntries(Object.keys(parsed).map((k) => [k, 0]));
-
-    for (let i = 0; i < text.length; ) {
-        const cp = text.codePointAt(i)!;
-        i += cp > 0xffff ? 2 : 1; // advance by 1 UTF-16 code-unit (or 2 for surrogates)
-
-        for (const [label, rangesArr] of Object.entries(parsed)) {
-            if (rangesArr.some(([lo, hi]) => cp >= lo && cp <= hi)) {
-                hits[label]++;
-            }
-        }
-    }
-
-    // ---------- choose the "best" ----------
-    let winner: string | null = null;
-    let maxCount = 0;
-
-    for (const [label, count] of Object.entries(hits)) {
-        if (count > maxCount) {
-            maxCount = count;
-            winner = label;
-        }
-    }
-
-    return maxCount > 0 ? winner : null;
-}

packages/fonts/src/index.ts

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

packages/fonts/src/types.ts

@@ -1,17 +0,0 @@
-import type { CustomizationDefaultFont } from '@gitbook/api';
-
-export type FontWeight = 400 | 700;
-
-export type FontDefinition = {
-    font: string;
-    unicodeRange: {
-        [script: string]: string;
-    };
-    variants: {
-        [weight in string]: {
-            [script: string]: string;
-        };
-    };
-};
-
-export type FontDefinitions = { [fontName in CustomizationDefaultFont]: FontDefinition };

packages/fonts/tsconfig.build.json

@@ -1,4 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "exclude": ["node_modules", "src/**/*.test.ts"]
-}

packages/fonts/tsconfig.json

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

packages/fonts/turbo.json

@@ -1,9 +0,0 @@
-{
-    "extends": ["//"],
-    "tasks": {
-        "generate": {
-            "inputs": ["bin/**/*", "package.json"],
-            "outputs": ["src/data/*.json", "dist/data/*.json"]
-        }
-    }
-}

packages/gitbook-v2/.gitignore

@@ -0,0 +1,12 @@
+# next.js
+/.next/
+
+# vercel
+.vercel
+
+# cloudflare
+.open-next
+.wrangler
+
+# Symbolic links
+public

packages/gitbook-v2/CHANGELOG.md

@@ -0,0 +1,81 @@
+# gitbook-v2
+
+## 0.3.0
+
+### Minor Changes
+
+- 3119066: Add support for reusable content across spaces.
+- 7d7806d: Pass SVG images through image resizing without resizing them to serve them from optimal host.
+
+### Patch Changes
+
+- 1c8d9fe: keep data cache in OpenNext between deployment
+- 778624a: Only resize images with supported extensions.
+- e6ddc0f: Fix URL in sitemap
+- 5e975ab: Fix code highlighting for HTTP
+- e15757d: Fix crash on Cloudflare by using latest stable version of Next.js instead of canary
+- 634e0b4: Improve error messages around undefined site sections.
+- 97b7c79: Increase logging around caching behaviour causing page crashes.
+- 3f29206: Update the regex for validating site redirect
+- dd043df: Revert investigation work around URL caches.
+
+## 0.2.5
+
+### Patch Changes
+
+- Updated dependencies [77397ca]
+  - @gitbook/cache-tags@0.3.1
+
+## 0.2.4
+
+### Patch Changes
+
+- 4234289: Fix incoming URL for requests that were proxied
+- Updated dependencies [116575c]
+  - @gitbook/cache-tags@0.3.0
+
+## 0.2.3
+
+### Patch Changes
+
+- 5b2bf82: Use stable site URL data for route rewrite in the middleware
+
+## 0.2.2
+
+### Patch Changes
+
+- 54ee014: Add initial support for loading custom fonts
+- bba2e52: Fix site redirects when it includes a section/variant path
+
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies [f32bf1f]
+  - @gitbook/cache-tags@0.2.0
+
+## 0.2.0
+
+### Minor Changes
+
+- 76c7974: Add route to revalidate cached data
+
+## 0.1.2
+
+### Patch Changes
+
+- 05ffd0e: Improving data cache management for computed content
+- Updated dependencies [05ffd0e]
+  - @gitbook/cache-tags@0.1.0
+
+## 0.1.1
+
+### Patch Changes
+
+- 3e11678: fix: lost section groups
+
+## 0.1.0
+
+### Minor Changes
+
+- cfccc44: Setup structure and deployment for new version

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

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

packages/gitbook-v2/next.config.mjs

@@ -14,9 +14,6 @@ const nextConfig = {
             dynamic: 3600, // 1 hour
             static: 3600, // 1 hour
         },
-
-        // Since content is fully static, we don't want to fetch on hover again
-        optimisticClientCache: false,
     },
 
     env: {

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

@@ -6,7 +6,7 @@ export default {
             wrapper: 'cloudflare-node',
             converter: 'edge',
             proxyExternalRequest: 'fetch',
-            queue: () => import('./openNext/queue/middleware').then((m) => m.default),
+            queue: () => import('./openNext/queue/server').then((m) => m.default),
             incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
             tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
         },