Update documentation links

.changeset/big-clocks-rush.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Fix images in reusable content across spaces.

.changeset/breezy-bugs-dream.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix openapi-select hover in responses

.changeset/eight-vans-judge.md

@@ -0,0 +1,5 @@
+---
+"@gitbook/colors": patch
+---
+
+Update chroma ratio per step

.changeset/empty-badgers-happen.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Only resize images with supported extensions.

.changeset/fifty-pots-work.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Decrease rounding of header logo

.changeset/giant-dolphins-approve.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Fix openapi CR preview

.changeset/healthy-parrots-call.md

@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Fix URL in sitemap

.changeset/lemon-actors-sing.md

@@ -0,0 +1,6 @@
+---
+"@gitbook/react-openapi": minor
+"gitbook": minor
+---
+
+Design tweaks to code blocks and OpenAPI pages

.changeset/lemon-plants-vanish.md

@@ -0,0 +1,8 @@
+---
+"@gitbook/react-openapi": patch
+"gitbook-v2": patch
+"gitbook": patch
+"@gitbook/colors": patch
+---
+
+Fix code highlighting for HTTP

.changeset/markdown-ask-goal-param.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Support an optional `goal` query parameter on the markdown ask interface (`?ask=…&goal=…`), letting agents describe the broader end goal they are working towards so the answer can be steered towards it.

.changeset/modern-windows-type.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Fix crash on Cloudflare by using latest stable version of Next.js instead of canary

.changeset/moody-maps-chew.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix resolution of links in reusable contents

.changeset/polite-falcons-agree.md

@@ -0,0 +1,6 @@
+---
+"gitbook-v2": minor
+"gitbook": minor
+---
+
+Add support for reusable content across spaces.

.changeset/rare-radios-thank.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Better print layouts: wrap code blocks & force table column auto-sizing

.changeset/real-donkeys-invent.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix invalid sitemap.xml generated with relative URLs instead of absolute ones

.changeset/rich-eggs-talk.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Change OpenAPI schema-optional from `info` to `tint` color

.changeset/rich-lamps-compare.md

@@ -0,0 +1,5 @@
+---
+"@gitbook/colors": patch
+---
+
+Change lightness check for color step 9 to allow input colors with a higher-than-needed contrast

.changeset/section-dropdown-embedded-empty.md

@@ -1,5 +0,0 @@
----
-"gitbook": patch
----
-
-Fix grouped top-nav section dropdowns rendering empty when the site is embedded in an iframe (visitor-auth embeds, editor preview) or shown in the embeddable view. The dropdown viewport is composited and animated, and a clipped composited layer fails to rasterize its text in Chromium when painted inside a sub compositing root; the rounded-corner clipping is now done on an inner wrapper so the viewport itself is no longer clipped.

.changeset/sharp-falcons-punch.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Fix schemas disclosure label causing client error

.changeset/shy-plums-deny.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Missing top-level required OpenAPI alternatives

.changeset/silly-gorillas-teach.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Handle OpenAPI alternatives from schema.items

.changeset/smart-feet-argue.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Handle invalid OpenAPI Responses

.changeset/soft-planes-talk.md

@@ -0,0 +1,5 @@
+---
+"gitbook-v2": patch
+---
+
+Improve error messages around undefined site sections.

.changeset/sweet-schools-flow.md

@@ -0,0 +1,6 @@
+---
+"gitbook-v2": patch
+"gitbook": patch
+---
+
+Increase logging around caching behaviour causing page crashes.

.changeset/ten-apples-march.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/react-openapi': patch
+---
+
+Use default value if string number or boolean in generateSchemaExample

.changeset/thirty-donkeys-help.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Prevent section group popovers from opening on click

.changeset/tidy-rings-talk.md

@@ -0,0 +1,6 @@
+---
+"gitbook": patch
+"gitbook-v2": patch
+---
+
+Update the regex for validating site redirect

.changeset/tough-starfishes-grin.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Always link main logo to the root of the site

.changeset/twelve-beers-confess.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Change `Dropdown`s to use Radix's `DropdownMenu`

.changeset/twelve-news-joke.md

@@ -0,0 +1,5 @@
+---
+"@gitbook/react-openapi": patch
+---
+
+Fix Python code sample "null vs None"

.changeset/two-chairs-wait.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Add border to filled sidebar on gradient theme

.changeset/two-lions-tickle.md

@@ -0,0 +1,6 @@
+---
+"gitbook-v2": minor
+"gitbook": minor
+---
+
+Pass SVG images through image resizing without resizing them to serve them from optimal host.

.changeset/young-games-talk.md

@@ -0,0 +1,6 @@
+---
+"gitbook": patch
+"gitbook-v2": patch
+---
+
+Revert investigation work around URL caches.

.changeset/young-poets-cry.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix OpenAPI disclosure label ("Show properties") misalignment on mobile

.claude/launch.json

@@ -1,12 +0,0 @@
-{
-    "version": "0.0.1",
-    "configurations": [
-        {
-            "name": "🚀 Dev server",
-            "runtimeExecutable": "sh",
-            "runtimeArgs": ["-c", "bun install && bun dev"],
-            "port": 3000,
-            "autoPort": false
-        }
-    ]
-}

.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,39 +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:
+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.
 
-- [Node.js](https://nodejs.org/en) (see "engines" in `package.json`)
-- [Bun](https://bun.sh/) (see "packageManager" in `package.json`)
+You can easily do this by running the command `nvm use`.
 
-##### Setup steps:
-
-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

@@ -1,83 +0,0 @@
-name: Gradual Deploy to Cloudflare
-description: Use gradual deployment to deploy to Cloudflare. This action will upload the middleware and server versions to Cloudflare and kept them bound together
-inputs:
-  apiToken:
-    description: 'Cloudflare API token'
-    required: true
-  accountId:
-    description: 'Cloudflare account ID'
-    required: true
-  environment:
-    description: 'Cloudflare environment to deploy to (staging, production, preview)'
-    required: true
-  middlewareVersionId:
-    description: 'Middleware version ID to deploy'
-    required: true
-  serverVersionId:
-    description: 'Server version ID to deploy'
-    required: true
-outputs:
-  deployment-url: 
-    description: "Deployment URL"
-    value: ${{ steps.deploy_middleware.outputs.deployment-url }}
-runs:
-  using: 'composite'
-  steps:
-      - id: wrangler_status
-        name: Check wrangler deployment status
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.43.0'
-            environment: ${{ inputs.environment }}
-            command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-      # This step is used to get the version ID that is currently deployed to Cloudflare.
-      - id: extract_current_version
-        name: Extract current version
-        shell: bash
-        run: |
-          version_id=$(echo "${{ steps.wrangler_status.outputs.command-output }}" | grep -A 3 "(100%)" | grep -oP '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
-          echo "version_id=$version_id" >> $GITHUB_OUTPUT
-
-      - id: deploy_server
-        name: Deploy server to Cloudflare at 0%
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.43.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
-
-      # Since we use version overrides headers, we can directly deploy the middleware to 100%.
-      - id: deploy_middleware
-        name: Deploy middleware to Cloudflare at 100%
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.43.0'
-            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
-
-      - name: Deploy server to Cloudflare at 100%
-        uses: cloudflare/wrangler-action@v3.14.0
-        with:
-            apiToken: ${{ inputs.apiToken }}
-            accountId: ${{ inputs.accountId }}
-            workingDirectory: ./
-            wranglerVersion: '4.43.0'
-            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-      - name: Outputs
-        shell: bash
-        env:
-          DEPLOYMENT_URL: ${{ steps.deploy_middleware.outputs.deployment-url }}
-        run: |
-            echo "URL: ${{ steps.deploy_middleware.outputs.deployment-url }}"

.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

@@ -26,9 +26,9 @@ inputs:
     description: 'Commit message to associate with the deployment'
     required: true
 outputs:
-    deployment-url:
+    deployment-url: 
       description: "Deployment URL"
-      value: ${{ steps.upload_middleware.outputs.deployment-url }}
+      value: ${{ steps.deploy.outputs.deployment-url }}
 runs:
     using: 'composite'
     steps:
@@ -52,91 +52,30 @@ runs:
             GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
             GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
             GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
-            GITBOOK_OAUTH_SERVER_URL: ${{ inputs.opItem }}/GITBOOK_OAUTH_SERVER_URL
-            GITBOOK_PREVIEW_BASE_URL: ${{ inputs.opItem }}/GITBOOK_PREVIEW_BASE_URL
             GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
-            GITBOOK_INTEGRATIONS_CONTENT_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_CONTENT_HOST
             GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
             GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
             GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
             GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
         - name: Build worker
-          run: bun run turbo build:cloudflare
+          run: bun run turbo build:v2:cloudflare
           env:
             GITBOOK_RUNTIME: cloudflare
-            GITBOOK_BLOCK_SEARCH_INDEXATION: ${{ inputs.environment == 'preview' && 'true' || '' }}
           shell: bash
-
-        - name: Upload the DO worker
+        - id: deploy
+          name: Deploy to Cloudflare
           uses: cloudflare/wrangler-action@v3.14.0
           with:
               apiToken: ${{ inputs.apiToken }}
               accountId: ${{ inputs.accountId }}
               workingDirectory: ./
-              wranglerVersion: '4.43.0'
+              wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
-
-        - id: upload_server
-          name: Upload server to Cloudflare
-          uses: cloudflare/wrangler-action@v3.14.0
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              workingDirectory: ./
-              wranglerVersion: '4.43.0'
-              environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
-
-        - name: Extract server version worker ID
-          shell: bash
-          id: extract_server_version_id
-          run: |
-              version_id=$(echo '${{ steps.upload_server.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
-              echo "version_id=$version_id" >> $GITHUB_OUTPUT
-
-        - name: Run updateWrangler scripts
-          shell: bash
-          run: |
-              bun run ./packages/gitbook/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
-
-        - id: upload_middleware
-          name: Upload middleware to Cloudflare
-          uses: cloudflare/wrangler-action@v3.14.0
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              workingDirectory: ./
-              wranglerVersion: '4.43.0'
-              environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
-
-        - name: Extract middleware version worker ID
-          shell: bash
-          id: extract_middleware_version_id
-          run: |
-              version_id=$(echo '${{ steps.upload_middleware.outputs.command-output }}' | grep "Worker Version ID" | awk '{print $4}')
-              echo "version_id=$version_id" >> $GITHUB_OUTPUT
-
-        - name: Deploy server and middleware to Cloudflare
-          if: ${{ inputs.deploy == 'true' }}
-          uses: ./.github/actions/gradual-deploy-cloudflare
-          with:
-              apiToken: ${{ inputs.apiToken }}
-              accountId: ${{ inputs.accountId }}
-              opServiceAccount: ${{ inputs.opServiceAccount }}
-              opItem: ${{ inputs.opItem }}
-              environment: ${{ inputs.environment }}
-              serverVersionId: ${{ steps.extract_server_version_id.outputs.version_id }}
-              middlewareVersionId: ${{ steps.extract_middleware_version_id.outputs.version_id }}
-              deploy: ${{ inputs.deploy }}
-
-
+              command: ${{ inputs.deploy == 'true' && 'deploy' || format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/wrangler.jsonc
         - name: Outputs
           shell: bash
           env:
-            DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
+            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
           run: |
-              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
-              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"
+              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"

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

@@ -19,11 +19,8 @@ inputs:
   environment:
     description: 'Environment to deploy to'
     required: true
-  headSha:
-    description: 'Git ref to deploy, used for the deploymentId'
-    required: false
 outputs:
-    deployment-url:
+    deployment-url: 
       description: "Deployment URL"
       value: ${{ steps.deploy.outputs.deployment-url }}
 runs:
@@ -54,26 +51,12 @@ runs:
             GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
             GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
             GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
-            GITBOOK_OAUTH_SERVER_URL: ${{ inputs.opItem }}/GITBOOK_OAUTH_SERVER_URL
-            GITBOOK_PREVIEW_BASE_URL: ${{ inputs.opItem }}/GITBOOK_PREVIEW_BASE_URL
             GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
-            GITBOOK_INTEGRATIONS_CONTENT_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_CONTENT_HOST
             GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
             GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
             GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
             GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
             GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
-        - name: Inject build env vars
-          if: ${{ inputs.environment == 'preview' }}
-          shell: bash
-          run: |
-            HEAD_SHA=$(git rev-parse HEAD)
-            echo "resolved HEAD_SHA: $HEAD_SHA"
-            echo "GITBOOK_HEAD_SHA=$HEAD_SHA" >> .vercel/.env.${{ inputs.environment }}.local
-            echo "GITBOOK_RUNTIME=vercel" >> .vercel/.env.${{ inputs.environment }}.local
-            echo "GITBOOK_BLOCK_SEARCH_INDEXATION=true" >> .vercel/.env.${{ inputs.environment }}.local
-            echo "--- .vercel/.env.${{ inputs.environment }}.local after inject ---"
-            cat .vercel/.env.${{ inputs.environment }}.local
         - name: Build Project Artifacts
           run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
           shell: bash
@@ -81,7 +64,6 @@ runs:
             VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
             VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
             GITBOOK_RUNTIME: vercel
-            GITBOOK_HEAD_SHA: ${{ inputs.headSha }}
         - name: Deploy Project Artifacts to Vercel
           id: deploy
           shell: bash

.github/workflows/ci.yaml

@@ -4,7 +4,8 @@ on:
     push:
         branches:
             - main
-            - changeset-release/main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
     format:
         runs-on: ubuntu-latest
@@ -34,10 +35,13 @@ jobs:
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
             - run: bun unit
-    build:
+    build-oss:
+        # CI to check that the repository builds correctly on a machine without the credentials
         runs-on: ubuntu-latest
-        name: Build
+        name: Build (Open Source)
         timeout-minutes: 6
+        env:
+            NPM_TOKEN_READONLY: ''
         steps:
             - name: Checkout
               uses: actions/checkout@v4

.github/workflows/deploy-preview.yaml

@@ -1,25 +1,62 @@
 name: Preview
 on:
-    pull_request_target:
+    pull_request:
     push:
-        branches:
-            - main
+      branches:
+        - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
-    approval:
-        # Ensure that external contributors' PRs are manually approved before deployment
-        name: Approve Preview Deployment
+    deploy-v1-cloudflare:
+        name: Deploy v1 to Cloudflare Pages
         runs-on: ubuntu-latest
-        if: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.fork }}
         environment:
-          name: preview-approval
+          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: Approval gate
-              run: echo "Preview deployment approved."
+            - 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
-        needs: approval
-        if: ${{ always() && (needs.approval.result == 'success' || needs.approval.result == 'skipped') }}
         environment:
           name: 2v-preview
           url: ${{ steps.deploy.outputs.deployment-url }}
@@ -28,8 +65,6 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - name: Deploy to Vercel
               id: deploy
               uses: ./.github/composite/deploy-vercel
@@ -40,12 +75,9 @@ jobs:
                   vercelToken: ${{ secrets.VERCEL_TOKEN }}
                   opItem: op://gitbook-open/2v-preview
                   opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
-                  headSha: ${{ github.event.pull_request.head.sha || github.sha }}
     deploy-v2-cloudflare:
         name: Deploy v2 to Cloudflare Worker (preview)
         runs-on: ubuntu-latest
-        needs: approval
-        if: ${{ always() && (needs.approval.result == 'success' || needs.approval.result == 'skipped') }}
         environment:
           name: 2c-preview
           url: ${{ steps.deploy.outputs.deployment-url }}
@@ -54,8 +86,6 @@ jobs:
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - name: Deploy to Cloudflare
               id: deploy
               uses: ./.github/composite/deploy-cloudflare
@@ -82,8 +112,9 @@ jobs:
     comment-deployments:
         runs-on: ubuntu-latest
         name: Comment Deployments (preview)
-        if: always() && github.event_name != 'push'
+        if: always() && !startsWith(github.ref, 'refs/heads/main')
         needs:
+            - deploy-v1-cloudflare
             - deploy-v2-vercel
             - deploy-v2-cloudflare
         steps:
@@ -103,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' && '✅' || '❌' }} |
@@ -110,143 +150,149 @@ 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-v1:
+        runs-on: ubuntu-latest
+        name: Visual Testing v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Setup Bun
+              uses: ./.github/composite/setup-bun
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+            - name: Setup Playwright
+              uses: ./.github/actions/setup-playwright
+            - name: Run Playwright tests
+              run: bun e2e
+              env:
+                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
+                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
     visual-testing-v2-vercel:
         runs-on: ubuntu-latest
         name: Visual Testing v2
         needs: deploy-v2-vercel
-        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
-        timeout-minutes: 15
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - name: Setup Bun
               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:
                   BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
                   SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: v2-vercel
+                  ARGOS_BUILD_NAME: 'v2-vercel'
     visual-testing-v2-cloudflare:
         runs-on: ubuntu-latest
         name: Visual Testing v2 (Cloudflare)
         needs: deploy-v2-cloudflare
-        if: ${{ always() && needs.deploy-v2-cloudflare.result == 'success' }}
-        timeout-minutes: 15
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - name: Setup Bun
               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:
                   BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
                   SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: v2-cloudflare
-    visual-testing-customers-v2:
+                  ARGOS_BUILD_NAME: 'v2-cloudflare'
+    visual-testing-customers-v1:
         runs-on: ubuntu-latest
-        name: Visual Testing Customers v2
-        needs: deploy-v2-vercel
-        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
-        timeout-minutes: 15
+        name: Visual Testing Customers v1
+        needs: deploy-v1-cloudflare
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - 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:
-                  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:
                   BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
                   SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: customers-v2-vercel
+                  ARGOS_BUILD_NAME: 'customers-v2'
     visual-testing-customers-v2-cloudflare:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v2 (Cloudflare)
         needs: deploy-v2-cloudflare
-        if: ${{ always() && needs.deploy-v2-cloudflare.result == 'success' }}
-        timeout-minutes: 15
+        timeout-minutes: 8
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - name: Setup Bun
               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:
                   BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
                   SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: customers-v2-cloudflare
-    browserless-testing-v2-vercel:
+                  ARGOS_BUILD_NAME: 'customers-v2'
+    pagespeed-testing-v1:
         runs-on: ubuntu-latest
-        name: Browserless Testing v2 (Vercel)
-        needs: deploy-v2-vercel
-        if: ${{ always() && needs.deploy-v2-vercel.result == 'success' }}
+        name: PageSpeed Testing v1
+        needs: deploy-v1-cloudflare
         steps:
             - name: Checkout
               uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.event.pull_request.head.sha || github.sha }}
             - name: Setup Bun
               uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run tests
-              run: cd ./packages/gitbook && bun e2e-browserless
+            - name: Run pagespeed tests
+              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
               env:
-                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
-                  SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
-    # browserless-testing-v2-cloudflare:
-    #     runs-on: ubuntu-latest
-    #     name: Browserless Testing v2 (Cloudflare)
-    #     needs: deploy-v2-cloudflare
-    #     steps:
-    #         - name: Checkout
-    #           uses: actions/checkout@v4
-    #         - name: Setup Bun
-    #           uses: ./.github/composite/setup-bun
-    #         - name: Install dependencies
-    #           run: bun install --frozen-lockfile
-    #           env:
-    #               PUPPETEER_SKIP_DOWNLOAD: 1
-    #         - name: Run tests
-    #           run: cd ./packages/gitbook && bun e2e-browserless
-    #           env:
-    #               BASE_URL: ${{needs.deploy-v2-cloudflare.outputs.deployment-url}}
-    #               SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
+                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/deploy-production.yaml

@@ -3,6 +3,8 @@ on:
     push:
         branches:
             - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
     deploy-v2-vercel:
         name: Deploy v2 to Vercel (production)

.github/workflows/deploy-staging.yaml

@@ -3,6 +3,8 @@ on:
     push:
         branches:
             - main
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
     deploy-v2-vercel:
         name: Deploy v2 to Vercel (staging)

.github/workflows/publish.yaml

@@ -4,6 +4,9 @@ on:
     push:
         branches:
             - main
+
+env:
+    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
     
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
@@ -11,42 +14,47 @@ jobs:
     publish:
         name: Publish
         runs-on: ubuntu-latest
-        permissions:
-            id-token: write
-            pull-requests: write
-            contents: write
-        env:
-            # The repo is managed by Bun, but publishing uses npm for provenance.
-            # Keep Corepack from rejecting packageManager: bun@... when npm runs.
-            COREPACK_ENABLE_PROJECT_SPEC: 0
         steps:
             - name: Checkout Repo
               uses: actions/checkout@v3
               with:
                   # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
                   fetch-depth: 0
-            - name: Setup Node
-              uses: actions/setup-node@v4
-              with:
-                  node-version: 22
-                  registry-url: 'https://registry.npmjs.org'
-            - name: Update npm
-              run: |
-                  corepack enable npm
-                  corepack install -g npm@latest
             - name: Setup Bun
               uses: ./.github/composite/setup-bun
             - name: Install dependencies
               run: bun install --frozen-lockfile
               env:
                   PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Create Release Pull Request
+            - name: Create Release Pull Request or Publish to npm
               id: changesets
               uses: changesets/action@v1
               with:
-                  publish: bun run publish-all-packages
-                  version: bun run changeset-version
+                  publish: npm run release
+                  version: npm run changeset-version
               env:
                   # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                   # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
                   GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
+                  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 }}

.gitignore

@@ -25,7 +25,3 @@ yarn-error.log*
 
 # TypeScript
 *.tsbuildinfo
-.npmrc
-
-# Bun pack artifacts
-packages/*/*.tgz

.nvmrc

@@ -1 +1 @@
-v22.3
+v20.6

AGENTS.md

@@ -1,77 +0,0 @@
-# AGENTS Instructions
-
-## Commands
-
-```bash
-bun install          # Install dependencies
-bun dev              # Start dev server (all packages)
-bun run build        # Build all packages
-bun run format       # Format with Biome (run after every change)
-bun run typecheck    # Type-check all packages
-bun run unit         # Run unit tests
-```
-
-## Development
-
-The dev server proxies published GitBook sites locally. After `bun dev`, access any published site at:
-
-```
-http://localhost:3000/url/<published-gitbook-url>
-```
-
-Examples:
-- `http://localhost:3000/url/gitbook.com/docs`
-- `http://localhost:3000/url/open-source.gitbook.io/midjourney`
-
-## Architecture
-
-```
-packages/
-  gitbook/          # Main Next.js app
-    src/
-      app/          # Next.js App Router (sites/)
-      components/   # React components
-      lib/          # Server utilities, data fetching
-      intl/         # Internationalization (translations/)
-  openapi-parser/   # OpenAPI 3.0/3.1/Swagger parser
-  react-openapi/    # OpenAPI rendering components
-  react-contentkit/ # ContentKit component rendering
-  embed/            # Embeddable GitBook components
-  shared/           # Shared utilities
-  icons/            # Icon assets
-  fonts/            # Font assets
-  colors/           # Color tokens
-  expr/             # GitBook expression evaluator
-  cache-do/         # Cloudflare DO cache
-  cache-tags/       # Cache tag utilities
-```
-
-## Testing
-
-```bash
-bun run unit         # Unit tests via bun test (not vitest)
-bun run e2e          # Playwright e2e tests (requires built app)
-```
-
-Run a specific test file:
-```bash
-cd packages/gitbook && bun test src/lib/cache.test.ts
-```
-
-## Changesets
-
-After committing code changes, create a changeset for the affected package:
-
-```md
----
-"gitbook": patch
----
-
-Provide a short description of the change.
-```
-
-Save as `.changeset/<name>.md`, then commit it separately with message: `changeset`
-
-## Formatting
-
-Uses Biome (not ESLint/Prettier). Always run `bun run format` before committing.

CLAUDE.md

@@ -1 +0,0 @@
-@AGENTS.md

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://gitbook.com/docs/developers">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: >= 22.3)
-    - 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,13 +71,34 @@ 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.
 
 ## Fonts and Icons
 
-GitBook Open uses fontawesome. For self-hosting and local development, for licensing reasons, only the icons from the free version should be used.
+GitBook Open uses fontawesome. During development, your local environment will use the free version. However, only the pro version will be accepted by CI. If you see the following error:
+
+```
+The GitBook icon is missing. It indicates that the dependencies were installed without the correct font-awesome package. These changes have probably been persisted in the Bun lockfile. Read the README for more information.
+```
+
+It means that you've changed the GBO dependencies and bundled in the free version. Only GitBook staff can help with this - if you're not on the GitBook team, please ping us in the PR and we'll help get things moving.
+
+If you are GitBook staff, you'll need our NPM token in your local environment.
+
+```
+.env.local
+
+NPM_TOKEN_READONLY=xxx
+```
+
+and then reinstall dependencies.
 
 ## Contributing
 
@@ -97,7 +118,7 @@ Encounter a bug or find an issue you'd like to fix? Helping us fix issues relate
 
 ## Deployment
 
-> [!WARNING]  
+> [!WARNING]
 > While it is possible to self-host this project, we do not recommend this unless you are certain this option fits your need.
 >
 > _Looking to add a specific feature in GitBook? Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to get started._
@@ -129,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

@@ -18,13 +18,10 @@
             "**/.vercel/**/*",
             "**/.cache/**/*",
             "**/.wrangler/**/*",
-            "packages/embed/standalone/**/*",
             "packages/openapi-parser/src/fixtures/**/*",
             "packages/emoji-codepoints/index.ts",
             "packages/icons/src/data/*.json",
-            "packages/gitbook/worker-configuration.d.ts",
-            "gitbook/tsconfig.json",
-            "**/*.css"
+            "packages/cache-do/worker-configuration.d.ts"
         ]
     },
     "formatter": {
@@ -130,6 +127,7 @@
         {
             "include": [
                 "packages/gitbook/**/*",
+                "packages/gitbook-v2/**/*",
                 "packages/react-openapi/**/*",
                 "packages/react-math/**/*",
                 "packages/react-contentkit/**/*",

bunfig.toml

@@ -0,0 +1,2 @@
+[install.scopes]
+"gitbook" = { token = "$NPM_TOKEN_READONLY", url = "https://registry.npmjs.org" }

package.json

@@ -1,30 +1,25 @@
 {
     "name": "gitbook",
     "version": "0.1.0",
-    "engines": {
-        "node": "^22.3.0"
-    },
     "devDependencies": {
         "@biomejs/biome": "^1.9.4",
-        "@changesets/cli": "^2.31.0",
-        "turbo": "^2.9.18",
-        "vercel": "50.37.3"
+        "@changesets/cli": "^2.27.12",
+        "turbo": "^2.5.0",
+        "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.3.7",
+    "packageManager": "bun@1.2.8",
     "overrides": {
         "@codemirror/state": "6.4.1",
-        "@types/react": "catalog:",
-        "@types/react-dom": "catalog:",
-        "react": "catalog:",
-        "react-dom": "catalog:",
-        "esbuild": "0.27.3",
-        "axios": "1.8.4",
-        "@radix-ui/react-slot": "1.2.4"
+        "@gitbook/api": "^0.115.0",
+        "react": "^19.0.0",
+        "react-dom": "^19.0.0"
     },
     "private": true,
     "scripts": {
-        "dev": "turbo run dev --concurrency 20",
+        "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 ./",
@@ -33,35 +28,15 @@
         "e2e": "turbo run e2e",
         "e2e-customers": "turbo run e2e-customers",
         "changeset": "changeset",
-        "changeset-version": "changeset version && bun run format && bun update",
-        "publish-all-packages": "turbo run publish-to-npm --continue=dependencies-successful",
+        "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": {
-            "@tsconfig/strictest": "^2.0.6",
-            "@tsconfig/node20": "^20.1.6",
-            "@gitbook/api": "0.185.0",
-            "@scalar/api-client-react": "^1.3.46",
-            "@types/react": "^19.0.0",
-            "@types/react-dom": "^19.0.0",
-            "assert-never": "^1.4.0",
-            "bidc": "^0.0.2",
-            "bun-types": "^1.1.20",
-            "classnames": "^2.5.1",
-            "react": "^19.0.1",
-            "react-dom": "^19.0.1",
-            "tsdown": "^0.15.6",
-            "typescript": "^5.5.3",
-            "usehooks-ts": "^3.1.1",
-            "vercel": "^50.26.1"
-        }
-    },
+    "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",
-        "next@16.2.6": "patches/next@16.2.6.patch"
+        "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"
     }
 }

packages/browser-types/.gitignore

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

packages/browser-types/CHANGELOG.md

@@ -1,52 +0,0 @@
-# @gitbook/browser-types
-
-## 0.1.5
-
-### Patch Changes
-
-- 5f66860: Use isCookiesTrackingDisabled for cookie consent integrations
-- 2e495cb: Add Global Privacy Control (GPC) support
-
-## 0.1.4
-
-### Patch Changes
-
-- 7a11861: Add support for custom cookie banner registration
-- Updated dependencies [6f1db32]
-  - @gitbook/icons@0.4.3
-
-## 0.1.3
-
-### Patch Changes
-
-- 10995e0: Use NPM Trusted publishing for publishing the package.
-- Updated dependencies [10995e0]
-  - @gitbook/icons@0.3.4
-
-## 0.1.2
-
-### Patch Changes
-
-- 6142d6b: Mark as sideEffects, fix all package bundles
-- Updated dependencies [6142d6b]
-  - @gitbook/icons@0.3.3
-
-## 0.1.1
-
-### Patch Changes
-
-- 295f03d: Republish packages
-- Updated dependencies [295f03d]
-  - @gitbook/icons@0.3.2
-
-## 0.1.0
-
-### Minor Changes
-
-- cbc71a5: First version of the public package for typing script integrations.
-
-### Patch Changes
-
-- 854c448: Custom assistants followup
-- Updated dependencies [25e2b40]
-  - @gitbook/icons@0.3.0

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,36 +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"
-        }
-    },
-    "sideEffects": false,
-    "version": "0.1.5",
-    "dependencies": {
-        "@gitbook/api": "catalog:",
-        "@gitbook/icons": "workspace:"
-    },
-    "devDependencies": {
-        "bun-types": "catalog:",
-        "tsdown": "catalog:",
-        "typescript": "catalog:"
-    },
-    "scripts": {
-        "build": "tsdown",
-        "typecheck": "tsc --noEmit",
-        "dev": "bun run build -- --watch ./src",
-        "publish-to-npm": "../../scripts/publish-if-new.sh"
-    },
-    "files": ["dist", "README.md", "CHANGELOG.md"],
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.org/"
-    },
-    "repository": {
-        "url": "https://github.com/GitbookIO/gitbook"
-    }
-}

packages/browser-types/src/index.ts

@@ -1,108 +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 GitBookCookieBannerHandler = (options: {
-    onApprove: () => void;
-    onReject: () => void;
-}) => void;
-
-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;
-
-    /**
-     * Register a custom cookie banner handler.
-     * When registered, the built-in cookie banner will not be displayed.
-     */
-    registerCookieBanner: (handler: GitBookCookieBannerHandler) => void;
-
-    /**
-     * Indicates whether cookies tracking is disabled for the current user.
-     * Returns `true` when tracking is disabled, `false` when tracking is enabled,
-     * and `undefined` when the tracking preference is unknown or not yet determined.
-     */
-    isCookiesTrackingDisabled: () => boolean | undefined;
-
-    /**
-     * Indicates whether global privacy control is enabled for the current user.
-     * Returns `true` when global privacy control is enabled, `false` when it is disabled.
-     */
-    isGlobalPrivacyControlEnabled: () => boolean;
-};
-
-declare global {
-    interface Window {
-        /**
-         * Global `window.GitBook` object accessible by integrations.
-         */
-        GitBook?: GitBookGlobal;
-    }
-}

packages/browser-types/tsconfig.json

@@ -1,25 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "esnext",
-        "lib": ["dom", "dom.iterable", "esnext"],
-        "allowJs": true,
-        "skipLibCheck": true,
-        "strict": true,
-        "noUncheckedIndexedAccess": 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,12 +13,9 @@
         "moduleResolution": "bundler",
         "resolveJsonModule": true,
         "isolatedModules": true,
-        "jsx": "react-jsx",
         "incremental": true,
-        "types": [
-            "bun-types" // add Bun global
-        ]
+        "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/CHANGELOG.md

@@ -1,23 +1,5 @@
 # @gitbook/cache-tags
 
-## 0.3.4
-
-### Patch Changes
-
-- 10995e0: Use NPM Trusted publishing for publishing the package.
-
-## 0.3.3
-
-### Patch Changes
-
-- 6142d6b: Mark as sideEffects, fix all package bundles
-
-## 0.3.2
-
-### Patch Changes
-
-- 295f03d: Republish packages
-
 ## 0.3.1
 
 ### Patch Changes

packages/cache-tags/package.json

@@ -4,32 +4,22 @@
     "exports": {
         ".": {
             "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
             "default": "./dist/index.js"
         }
     },
-    "sideEffects": false,
-    "version": "0.3.4",
+    "version": "0.3.1",
     "dependencies": {
-        "@gitbook/api": "catalog:",
-        "assert-never": "catalog:"
+        "@gitbook/api": "^0.115.0",
+        "assert-never": "^1.2.1"
     },
     "devDependencies": {
-        "bun-types": "catalog:",
-        "tsdown": "catalog:",
-        "typescript": "catalog:"
+        "typescript": "^5.5.3"
     },
     "scripts": {
-        "build": "tsdown",
+        "build": "tsc",
         "typecheck": "tsc --noEmit",
-        "dev": "bun run build -- --watch ./src",
-        "publish-to-npm": "../../scripts/publish-if-new.sh"
+        "dev": "tsc -w"
     },
-    "files": ["dist", "README.md", "CHANGELOG.md"],
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.org/"
-    },
-    "repository": {
-        "url": "https://github.com/GitbookIO/gitbook"
-    }
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
 }

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,12 +115,23 @@ 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);
     }
 }
 
+/**
+ * Get the cache tag for a given URL.
+ */
+export function getCacheTagForURL(url: string | URL) {
+    const parsedURL = url instanceof URL ? url : new URL(url);
+    return getCacheTag({
+        tag: 'url',
+        hostname: parsedURL.hostname,
+    });
+}
+
 /**
  * Get the tags for a computed content source.
  */
@@ -133,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 ?? {});
@@ -160,18 +167,18 @@ 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;
                 default:
                     // Do not throw for unknown dependency types
-                    // as it might mean we are lagging behind the API version
+                    // as it might mean we are lacking behind the API version
                     break;
             }
         });
@@ -187,8 +194,9 @@ export function getComputedContentSourceCacheTags(
     }
 
     // We invalidate the computed content when a new version of the integration is deployed.
+
     if (source.type.startsWith('integration:')) {
-        const integration = source.type.split(':')[1]!;
+        const integration = source.type.split(':')[1];
         tags.push(
             getCacheTag({
                 tag: 'integration',

packages/cache-tags/tsconfig.json

@@ -5,7 +5,6 @@
         "allowJs": true,
         "skipLibCheck": true,
         "strict": true,
-        "noUncheckedIndexedAccess": true,
         "noEmit": false,
         "declaration": true,
         "outDir": "dist",

packages/colors/CHANGELOG.md

@@ -1,41 +1,5 @@
 # @gitbook/colors
 
-## 0.4.3
-
-### Patch Changes
-
-- 10995e0: Use NPM Trusted publishing for publishing the package.
-
-## 0.4.2
-
-### Patch Changes
-
-- 6142d6b: Mark as sideEffects, fix all package bundles
-
-## 0.4.1
-
-### Patch Changes
-
-- 295f03d: Republish packages
-
-## 0.4.0
-
-### Minor Changes
-
-- 17dd382: Add `original` background color step
-
-### Patch Changes
-
-- 193d591: Fix return type for `colorContrast`
-
-## 0.3.3
-
-### Patch Changes
-
-- c3f6b8c: Update chroma ratio per step
-- 5e975ab: Fix code highlighting for HTTP
-- f7a3470: Change lightness check for color step 9 to allow input colors with a higher-than-needed contrast
-
 ## 0.3.2
 
 ### Patch Changes

packages/colors/package.json

@@ -4,28 +4,18 @@
     "exports": {
         ".": {
             "types": "./dist/index.d.ts",
+            "development": "./src/index.ts",
             "default": "./dist/index.js"
         }
     },
-    "sideEffects": false,
-    "version": "0.4.3",
+    "version": "0.3.2",
     "devDependencies": {
-        "bun-types": "catalog:",
-        "tsdown": "catalog:",
-        "typescript": "catalog:"
+        "typescript": "^5.5.3"
     },
     "scripts": {
-        "build": "tsdown",
+        "build": "tsc",
         "typecheck": "tsc --noEmit",
-        "dev": "bun run build -- --watch ./src",
-        "publish-to-npm": "../../scripts/publish-if-new.sh"
+        "dev": "tsc -w"
     },
-    "files": ["dist", "README.md", "CHANGELOG.md"],
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.org/"
-    },
-    "repository": {
-        "url": "https://github.com/GitbookIO/gitbook"
-    }
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
 }

packages/colors/src/transformations.ts

@@ -8,7 +8,7 @@ type RGBColor = [number, number, number];
 type OKLABColor = { L: number; A: number; B: number };
 type OKLCHColor = { L: number; C: number; H: number };
 
-const D65 = [95.047, 100.0, 108.883] as const; // Reference white (D65)
+const D65 = [95.047, 100.0, 108.883]; // Reference white (D65)
 
 export enum ColorCategory {
     backgrounds = 'backgrounds',
@@ -19,7 +19,7 @@ export enum ColorCategory {
 }
 
 type ColorSubScale = {
-    [key: string]: number | string;
+    [key: string]: number;
 };
 
 /**
@@ -56,8 +56,6 @@ export const scale: Record<ColorCategory, ColorSubScale> = {
         solid: 9,
         /** Hovered solid backgrounds */
         'solid-hover': 10,
-        /** Original color */
-        original: 'original',
     },
     [ColorCategory.text]: {
         /** Very low-contrast text
@@ -213,8 +211,8 @@ export function colorScale(
     const result = [];
 
     for (let index = 0; index < mapping.length; index++) {
-        const step = mapping[index]!;
-        const targetL = foregroundColor.L * step + backgroundColor.L * (1 - step);
+        const targetL =
+            foregroundColor.L * mapping[index] + backgroundColor.L * (1 - mapping[index]);
 
         if (
             index === 8 &&
@@ -297,7 +295,7 @@ export function rgbArrayToHex(rgb: RGBColor): string {
 
 export function getColor(percentage: number, start: RGBColor, end: RGBColor) {
     const rgb = end.map((channel, index) => {
-        return Math.round(channel + percentage * (start[index]! - channel));
+        return Math.round(channel + percentage * (start[index] - channel));
     });
 
     return rgbArrayToHex(rgb as RGBColor);
@@ -394,14 +392,14 @@ export function xyzToLab65(xyz: [number, number, number]): {
     B: number;
 } {
     const [x, y, z] = xyz.map((v, i) => {
-        const scaled = v / D65[i]!;
+        const scaled = v / D65[i];
         return scaled > 0.008856 ? Math.cbrt(scaled) : 7.787 * scaled + 16 / 116;
     });
 
     return {
-        L: 116 * y! - 16,
-        A: 500 * (x! - y!),
-        B: 200 * (y! - z!),
+        L: 116 * y - 16,
+        A: 500 * (x - y),
+        B: 200 * (y - z),
     };
 }
 
@@ -421,10 +419,7 @@ export function dpsContrast(a: RGBColor, b: RGBColor) {
     return contrast < 7.5 ? 0 : contrast;
 }
 
-export function colorContrast(
-    background: string,
-    foreground: string[] = [LIGHT_BASE, DARK_BASE]
-): string {
+export function colorContrast(background: string, foreground: string[] = [LIGHT_BASE, DARK_BASE]) {
     const bg = hexToRgbArray(background);
 
     const best: { color?: RGBColor; contrast: number } = {
@@ -441,5 +436,5 @@ export function colorContrast(
         }
     }
 
-    return best.color ? rgbArrayToHex(best.color) : foreground[0] || LIGHT_BASE;
+    return best.color ? rgbArrayToHex(best.color) : foreground[0];
 }

packages/colors/tsconfig.json

@@ -5,7 +5,6 @@
         "allowJs": true,
         "skipLibCheck": true,
         "strict": true,
-        "noUncheckedIndexedAccess": true,
         "noEmit": false,
         "declaration": true,
         "outDir": "dist",

packages/embed/.gitignore

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

packages/embed/CHANGELOG.md

@@ -1,105 +0,0 @@
-# @gitbook/embed
-
-## 0.5.1
-
-### Patch Changes
-
-- 37a9453: Allow copying in embed
-- Updated dependencies [47c8ccb]
-  - @gitbook/icons@0.5.0
-
-## 0.5.0
-
-### Minor Changes
-
-- 88c38fa: Add Search tab to Docs Embed, refactor search
-
-### Patch Changes
-
-- 8d2a95b: Docs Embed: Better support light/dark mode overrides
-
-## 0.4.0
-
-### Minor Changes
-
-- b3875a1: Support `assistantName` property to override Assistant name
-
-## 0.3.0
-
-### Minor Changes
-
-- 370b731: Docs Embed: Make trademark optional
-
-## 0.2.2
-
-### Patch Changes
-
-- b4b471f: Fix unexpected error thrown when using the embed in standalone mode
-
-## 0.2.1
-
-### Patch Changes
-
-- 96e24a1: Fix signed JWT token usage
-- 0aa34cc: Fix Embed options in React
-- Updated dependencies [6f1db32]
-  - @gitbook/icons@0.4.3
-
-## 0.2.0
-
-### Minor Changes
-
-- 1430cee: Improve Docs Embed with separate Assistant and Docs tabs
-
-### Patch Changes
-
-- Updated dependencies [62438f4]
-  - @gitbook/icons@0.4.0
-
-## 0.1.5
-
-### Patch Changes
-
-- 10995e0: Use NPM Trusted publishing for publishing the package.
-- Updated dependencies [10995e0]
-  - @gitbook/icons@0.3.4
-
-## 0.1.4
-
-### Patch Changes
-
-- 6142d6b: Mark as sideEffects, fix all package bundles
-- Updated dependencies [6142d6b]
-  - @gitbook/icons@0.3.3
-
-## 0.1.3
-
-### Patch Changes
-
-- 295f03d: Republish packages
-- Updated dependencies [295f03d]
-  - @gitbook/icons@0.3.2
-
-## 0.1.2
-
-### Patch Changes
-
-- 7508674: Fix bundling of packages
-
-## 0.1.1
-
-### Patch Changes
-
-- 6f368b5: Fix embed assistant window width on small screens
-
-## 0.1.0
-
-### Minor Changes
-
-- 81a6bd7: Improve API to control the GitBook embed
-
-### Patch Changes
-
-- 8927e8f: Initial version of the embed SDK.
-- Updated dependencies [25e2b40]
-  - @gitbook/icons@0.3.0

packages/embed/README.md

@@ -1,497 +0,0 @@
-# GitBook Docs Embed (`@gitbook/embed`)
-
-Embed your GitBook docs in your product or website.
-
-The Docs Embed can contain three tabs:
-- **Assistant**: The [GitBook Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) - an AI-powered chat interface to help users find answers
-- **Search**: A search-focused surface for quickly finding pages and asking scoped questions
-- **Docs**: A browser for navigating your documentation site
-
-The embed is set up automatically based on your site's configuration. You can optionally customize and override the configuration with custom actions, tools, suggested questions, [Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access), and more. See the [Configuration](#configuration) section for all available options.
-
-# Usage
-
-## As a standalone script from your docs site
-
-All GitBook docs sites include a script to easily add the Docs Embed 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 `docs.company.com` with your docs site hostname.
-
-```html
-<script src="https://docs.company.com/~gitbook/embed/script.js"></script>
-<script>
-// Initialize with Authenticated Access (optional)
-window.GitBook('init', 
-    { siteURL: 'https://docs.company.com' },
-    { visitor: { token: 'your-jwt-token' } }
-);
-window.GitBook('show');
-</script>
-```
-
-The standalone script provides a global `GitBook` function. See the [API Reference](#api-reference) section for all available methods.
-
-### Example: Configuring the widget
-
-```javascript
-GitBook('configure', {
-    button: {
-        label: 'Ask',
-        icon: 'assistant' // 'assistant' | 'sparkle' | 'help' | 'book'
-    },
-    tabs: ['assistant', 'search', 'docs'],
-    actions: [
-        {
-            icon: 'circle-question',
-            label: 'Contact Support',
-            onClick: () => window.open('https://support.example.com', '_blank')
-        }
-    ],
-    greeting: { title: 'Welcome!', subtitle: 'How can I help?' },
-    assistantName: 'Support Assistant',
-    suggestions: ['What is GitBook?', 'How do I get started?'],
-    tools: [/* ... */],
-    closeButton: true,
-});
-```
-
-See the [Configuration](#configuration) section for all available options.
-
-## 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'
-});
-
-// Create an iframe and get its URL
-const iframe = document.createElement('iframe');
-iframe.src = gitbook.getFrameURL({
-    colorScheme: 'dark', // Optional: force the embed to render in dark mode
-    visitor: {
-        token: 'your-jwt-token', // Optional: for Adaptive Content or Authenticated Access
-        unsignedClaims: { // Optional: custom claims for dynamic expressions
-            userId: '123',
-            plan: 'premium'
-        }
-    }
-});
-
-// Create a frame client to communicate with the iframe
-const frame = gitbook.createFrame(iframe);
-
-// Use the frame client methods
-frame.navigateToPage('/getting-started'); // Navigate to a page in the docs tab
-frame.navigateToAssistant(); // Switch to the assistant tab
-frame.postUserMessage('How do I get started?');
-frame.clearChat();
-
-// Configure the embed (see Configuration section for all options)
-frame.configure({
-    tabs: ['assistant', 'search', 'docs'],
-    actions: [
-        {
-            icon: 'circle-question',
-            label: 'Contact Support',
-            onClick: () => window.open('https://support.example.com', '_blank')
-        }
-    ],
-    greeting: { title: 'Welcome!', subtitle: 'How can I help?' },
-    assistantName: 'Support Assistant',
-    suggestions: ['What is GitBook?', 'How do I get started?'],
-    tools: [/* ... */],
-    closeButton: true
-});
-
-// Listen to events
-frame.on('close', () => {
-    console.log('Frame closed');
-});
-```
-
-## As React components
-
-After installing the NPM package, you can import prebuilt React components:
-
-```tsx
-import { GitBookProvider, GitBookFrame } from '@gitbook/embed/react';
-
-<GitBookProvider siteURL="https://docs.company.com">
-    <GitBookFrame
-        colorScheme="dark"
-        visitor={{
-            token: 'your-jwt-token', // Optional: for Adaptive Content or Authenticated Access
-            unsignedClaims: { userId: '123' } // Optional: custom claims for dynamic expressions
-        }}
-        tabs={['assistant', 'search', 'docs']}
-        greeting={{ title: 'Welcome!', subtitle: 'How can I help?' }}
-        assistantName="Support Assistant"
-        suggestions={['What is GitBook?', 'How do I get started?']}
-        actions={[
-            {
-                icon: 'circle-question',
-                label: 'Contact Support',
-                onClick: () => window.open('https://support.example.com', '_blank')
-            }
-        ]}
-        tools={[/* ... */]}
-        closeButton
-    />
-</GitBookProvider>
-```
-
-You can also use the `useGitBook` hook to access the client:
-
-```tsx
-import { useGitBook } from '@gitbook/embed/react';
-
-function MyComponent() {
-    const gitbook = useGitBook();
-    const frameURL = gitbook.getFrameURL({ colorScheme: 'dark', visitor: { token: '...' } });
-    // ...
-}
-```
-
-# API Reference
-
-## Method Comparison
-
-| Method | Standalone Script | NPM Package | React Components |
-|--------|------------------|-------------|------------------|
-| **Initialize** | `GitBook('init', options, frameOptions)` | `createGitBook(options)` | `<GitBookProvider siteURL="...">` |
-| **Get frame URL** | ❌ (handled internally) | `client.getFrameURL(options)` | `useGitBook().getFrameURL(options)` |
-| **Create frame client** | ❌ (handled internally) | `client.createFrame(iframe)` | `useGitBook().createFrame(iframe)` |
-| **Show/Hide widget** | `GitBook('show')` / `GitBook('hide')` | ❌ | ❌ |
-| **Open/Close window** | `GitBook('open')` / `GitBook('close')` / `GitBook('toggle')` | ❌ | ❌ |
-| **Navigate to page** | `GitBook('navigateToPage', path)` | `frame.navigateToPage(path)` | Via frame client |
-| **Navigate to assistant** | `GitBook('navigateToAssistant')` | `frame.navigateToAssistant()` | Via frame client |
-| **Post message** | `GitBook('postUserMessage', message)` | `frame.postUserMessage(message)` | Via frame client |
-| **Clear chat** | `GitBook('clearChat')` | `frame.clearChat()` | Via frame client |
-| **Configure** | `GitBook('configure', settings)` | `frame.configure(settings)` | Props on `<GitBookFrame>` |
-| **Event listeners** | ❌ | `frame.on(event, listener)` | Via frame client |
-| **Unload** | `GitBook('unload')` | ❌ | ❌ |
-
-## Method Signatures
-
-### Standalone Script
-
-- `GitBook('init', options: { siteURL: string }, frameOptions?: { colorScheme?: 'light' | 'dark', visitor?: {...} })` - Initialize widget
-- `GitBook('show')` - Show widget button
-- `GitBook('hide')` - Hide widget button
-- `GitBook('open')` - Open widget window
-- `GitBook('close')` - Close widget window
-- `GitBook('toggle')` - Toggle widget window
-- `GitBook('navigateToPage', path: string)` - Navigate to page
-- `GitBook('navigateToAssistant')` - Navigate to assistant tab
-- `GitBook('postUserMessage', message: string)` - Post message to chat
-- `GitBook('clearChat')` - Clear chat history
-- `GitBook('configure', settings: {...})` - Configure widget
-- `GitBook('unload')` - Unload widget
-
-### NPM Package
-
-**Client Factory:**
-- `createGitBook(options: { siteURL: string })` → `GitBookClient`
-- `client.getFrameURL(options?: { colorScheme?: 'light' | 'dark', visitor?: {...} })` → `string`
-- `client.createFrame(iframe: HTMLIFrameElement)` → `GitBookFrameClient`
-
-**Frame Client:**
-- `frame.navigateToPage(path: string)` → `void`
-- `frame.navigateToAssistant()` → `void`
-- `frame.postUserMessage(message: string)` → `void`
-- `frame.clearChat()` → `void`
-- `frame.configure(settings: Partial<GitBookEmbeddableConfiguration>)` → `void`
-- `frame.on(event: string, listener: Function)` → `() => void` (unsubscribe)
-
-### React Components
-
-**Components:**
-- `<GitBookProvider siteURL: string>` - Provider component
-- `<GitBookFrame {...props}>` - Frame component (accepts all config options as props)
-
-**Hooks:**
-- `useGitBook()` → `GitBookClient` (must be used within `<GitBookProvider>`)
-
-# Configuration
-
-Configuration options are available across usage methods as follows:
-- **Standalone script**: via `GitBook('configure', {...})`
-- **NPM package**: via `frame.configure({...})`
-- **React components**: via props on `<GitBookFrame>`
-
-### `tabs`
-
-Available in: Standalone script, NPM package, React components
-
-Override which tabs are displayed. Defaults to your site's configuration.
-
-- **Type**: `('assistant' | 'search' | 'docs')[]`
-
-```javascript
-tabs: ['assistant', 'search', 'docs']
-```
-
-### `closeButton`
-
-Available in: Standalone script, NPM package, React components
-
-Display a close (`x`) button in the embed sidebar.
-
-- **Type**: `boolean`
-- **Default**: `false`
-
-```javascript
-closeButton: true
-```
-
-Behavior:
-- When clicked, the embed sends a `close` event to the parent page.
-- In the standalone script, this event is handled automatically and the widget closes.
-- In custom iframe integrations (NPM package), you must listen for the `close` event and decide how to hide/collapse your UI.
-- In React, this works automatically when using the standard widget flow. If you build custom frame wiring, handle `close` the same way as the NPM package.
-
-NPM package example:
-
-```typescript
-const frame = gitbook.createFrame(iframe);
-
-frame.configure({
-    closeButton: true
-});
-
-const unsubscribe = frame.on('close', () => {
-    // Hide your modal/drawer/container
-    container.classList.add('hidden');
-});
-```
-
-Notes:
-- The close button is rendered in the same sidebar area as tabs/actions.
-- If your UI hides that sidebar or doesn't render it, the button will not be visible.
-
-### `trademark`
-
-Available in: Standalone script, NPM package, React components
-
-Display GitBook branding in the embed. Defaults to true.
-
-- **Type**: `boolean`
-- **Default**: `true`
-
-```javascript
-trademark: true
-```
-
-### `actions`
-
-Available in: Standalone script, NPM package, React components
-
-Custom action buttons rendered in the sidebar alongside tabs. Each action button triggers a callback when clicked.
-
-**Note**: This prop was previously named `buttons`. Use `actions` instead, it has the same functionality.
-
-- **Type**: `GitBookEmbeddableActionDefinition[]`
-- **Properties**:
-  - `icon`: `string` - Icon name. Any [FontAwesome icon](https://fontawesome.com/search) is supported. (e.g., `'rocket'`, `'comments'`, `'user-circle'`, ...)
-  - `label`: `string` - Button label text
-  - `onClick`: `() => void | Promise<void>` - Callback function when clicked
-
-```javascript
-actions: [
-    {
-        icon: 'comments',
-        label: 'Contact Support',
-        onClick: () => window.open('https://support.example.com', '_blank')
-    },
-    {
-        icon: 'rocket',
-        label: 'Get started',
-        onClick: () => {
-            GitBook('navigateToPage', '/getting-started');
-        }
-    }
-]
-```
-
-### `greeting`
-
-Available in: Standalone script, NPM package, React components
-
-Welcome message displayed in the [Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) tab.
-
-- **Type**: `{ title: string, subtitle: string }`
-
-```javascript
-greeting: {
-    title: 'Welcome!',
-    subtitle: 'How can I help you today?'
-}
-```
-
-### `assistantName`
-
-Available in: Standalone script, NPM package, React components
-
-Override the assistant name displayed in the chat header and assistant entry points (for example, sidebar tabs and action labels). This name will be limited to 32 characters to prevent text overflow.
-
-- **Type**: `string`
-
-```javascript
-assistantName: 'Support Assistant'
-```
-
-### `suggestions`
-
-Available in: Standalone script, NPM package, React components
-
-Suggested questions displayed in the [Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) welcome screen.
-
-- **Type**: `string[]`
-
-```javascript
-suggestions: [
-    'What is GitBook?',
-    'How do I get started?',
-    'What can you do?'
-]
-```
-
-### `tools`
-
-Available in: Standalone script, NPM package, React components
-
-Custom AI tools to extend the [Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant). Tools allow the assistant to execute functions and integrate with your own systems.
-
-**Note**: In addition to custom tools, the Assistant will always have access to any [MCP servers you define](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant#extend-gitbook-assistant-with-mcp-servers) in your site's AI settings.
-
-- **Type**: `GitBookToolDefinition[]`
-- **Properties**:
-  - `name`: `string` - Unique tool identifier
-  - `description`: `string` - Description of what the tool does (used by the AI to decide when and how to use it).
-  - `inputSchema`: `object` - JSON schema defining the tool's input parameters
-  - `execute`: `(input: object) => Promise<{ output: any, summary: string }>` - Async function that executes the tool.
-    - `output`: The result of the tool execution, provided to the AI to continue working with. Not shown to the user.
-    - `summary`: The visual summary of the tool execution, shown in the user's chat window.
-  - `confirmation`: `{ icon?: string, label: string }` (optional) - Confirmation button shown before execution, useful for actions that require the user's express approval.
-
-```javascript
-tools: [
-    {
-        name: 'get_user_info',
-        description: 'Get information about the current user',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                userId: { 
-                    type: 'string', 
-                    description: 'The user ID to look up' 
-                }
-            },
-            required: ['userId']
-        },
-        execute: async (input) => {
-            const user = await fetch(`/api/users/${input.userId}`).then(r => r.json());
-            return {
-                output: { name: user.name, plan: user.plan },
-                summary: `Retrieved info for user ${user.name}`
-            };
-        }
-    },
-    {
-        name: 'create_ticket',
-        description: 'Create a support ticket',
-        confirmation: {
-            icon: 'circle-question',
-            label: 'Create support ticket?'
-        },
-        inputSchema: {
-            type: 'object',
-            properties: {
-                subject: { type: 'string' },
-                description: { type: 'string' }
-            },
-            required: ['subject', 'description']
-        },
-        execute: async (input) => {
-            const ticket = await fetch('/api/tickets', {
-                method: 'POST',
-                body: JSON.stringify(input)
-            }).then(r => r.json());
-            return {
-                output: { ticketId: ticket.id },
-                summary: `Created ticket #${ticket.id}`
-            };
-        }
-    }
-]
-```
-
-### `visitor` (Authenticated Access)
-
-Available in: Standalone script (via `init`), NPM package (via `getFrameURL()`), React components (as prop)
-
-[Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access) options passed when creating the frame URL. Used for [Adaptive Content](https://gitbook.com/docs/publishing-documentation/adaptive-content) and [Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access).
-
-**Note**: This is not a configuration option but rather a parameter when initializing the frame or creating the frame URL.
-
-**Standalone script**: Pass as the second argument to `GitBook('init', options, frameOptions)`
-**NPM package**: Pass to `getFrameURL({ visitor: {...} })`
-**React components**: Pass as the `visitor` prop on `<GitBookFrame>`
-
-- **Type**: `{ token?: string, unsignedClaims?: Record<string, unknown> }`
-- **Properties**:
-  - `token`: `string` (optional) - Signed JWT token for [Adaptive Content](https://gitbook.com/docs/publishing-documentation/adaptive-content) or [Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access)
-  - `unsignedClaims`: `Record<string, unknown>` (optional) - Unsigned claims that can be used in dynamic expressions via `visitor.claims.unsigned.<claim-name>`
-
-```javascript
-visitor: {
-    token: 'your-jwt-token',
-    unsignedClaims: {
-        userId: '123',
-        plan: 'premium',
-        role: 'admin'
-    }
-}
-```
-
-### `colorScheme`
-
-Available in: Standalone script (via `init`), NPM package (via `getFrameURL()`), React components (as prop)
-
-Override the embed's color scheme. When omitted, the embed follows the iframe's CSS `color-scheme`, which lets it inherit the parent page or browser preference.
-
-**Note**: This is not a configuration option but rather a parameter when initializing the frame or creating the frame URL.
-
-**Standalone script**: Pass as the second argument to `GitBook('init', options, frameOptions)`
-**NPM package**: Pass to `getFrameURL({ colorScheme: 'dark' })`
-**React components**: Pass as the `colorScheme` prop on `<GitBookFrame>`
-
-- **Type**: `'light' | 'dark'`
-
-```javascript
-colorScheme: 'dark'
-```
-
-### `button`
-
-Available in: Standalone script only
-
-Configure the widget button for the standalone script. This option is not available when using the NPM package or React components, since they can be customized completely.
-
-- **Type**: `{ label: string, icon: 'assistant' | 'sparkle' | 'help' | 'book' }`
-- **Properties**:
-  - `label`: `string` - Button label text
-  - `icon`: `'assistant' | 'sparkle' | 'help' | 'book'` - Icon displayed on the button. Choose from one of 4 presets.
-
-```javascript
-button: {
-    label: 'Ask',
-    icon: 'assistant'
-}
-```

packages/embed/package.json

@@ -1,50 +0,0 @@
-{
-    "name": "@gitbook/embed",
-    "description": "Embeddable components for GitBook",
-    "type": "module",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "default": "./dist/index.js"
-        },
-        "./react": {
-            "types": "./dist/react/index.d.ts",
-            "default": "./dist/react/index.js"
-        }
-    },
-    "sideEffects": false,
-    "version": "0.5.1",
-    "dependencies": {
-        "@gitbook/api": "catalog:",
-        "@gitbook/icons": "workspace:",
-        "bidc": "catalog:"
-    },
-    "peerDependencies": {
-        "react": "*"
-    },
-    "devDependencies": {
-        "bun-types": "catalog:",
-        "@types/react": "catalog:",
-        "tsdown": "catalog:",
-        "typescript": "catalog:",
-        "react": "catalog:"
-    },
-    "scripts": {
-        "build": "bun run build-lib && bun run build-standalone",
-        "build-lib": "tsdown",
-        "build-standalone": "bun build src/standalone/index.ts --bundle --minify --outdir=standalone",
-        "clean": "rm -rf ./dist",
-        "unit": "bun test",
-        "typecheck": "tsc --noEmit",
-        "dev": "bun run build -- --watch ./src",
-        "publish-to-npm": "../../scripts/publish-if-new.sh"
-    },
-    "files": ["dist", "README.md", "CHANGELOG.md"],
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.org/"
-    },
-    "repository": {
-        "url": "https://github.com/GitbookIO/gitbook"
-    }
-}

packages/embed/src/client/createGitBook.test.ts

@@ -1,51 +0,0 @@
-import { describe, expect, it } from 'bun:test';
-
-import { createGitBook } from './createGitBook';
-
-describe('createGitBook.getFrameURL', () => {
-    it('builds the embed URL when the site URL has no trailing slash', () => {
-        const client = createGitBook({ siteURL: 'https://example.com/docs' });
-
-        const url = new URL(client.getFrameURL({}));
-
-        expect(url.origin).toBe('https://example.com');
-        expect(url.pathname).toBe('/docs/~gitbook/embed');
-        expect(url.searchParams.toString()).toBe('');
-    });
-
-    it('handles a trailing slash and adds visitor parameters', () => {
-        const client = createGitBook({ siteURL: 'https://example.com/docs/' });
-
-        const url = new URL(
-            client.getFrameURL({
-                visitor: {
-                    token: 'signed-token',
-                    unsignedClaims: {
-                        role: 'editor',
-                        count: 3,
-                        enabled: false,
-                    },
-                },
-            })
-        );
-
-        expect(url.pathname).toBe('/docs/~gitbook/embed');
-        expect(url.searchParams.get('jwt_token')).toBe('signed-token');
-        expect(url.searchParams.get('visitor.role')).toBe('editor');
-        expect(url.searchParams.get('visitor.count')).toBe('3');
-        expect(url.searchParams.get('visitor.enabled')).toBe('false');
-    });
-
-    it('adds an explicit color scheme override when requested', () => {
-        const client = createGitBook({ siteURL: 'https://example.com/docs/' });
-
-        const url = new URL(
-            client.getFrameURL({
-                colorScheme: 'dark',
-            })
-        );
-
-        expect(url.pathname).toBe('/docs/~gitbook/embed');
-        expect(url.searchParams.get('theme')).toBe('dark');
-    });
-});

packages/embed/src/client/createGitBook.ts

@@ -1,71 +0,0 @@
-import { type GitBookFrameClient, createGitBookFrame } from './createGitBookFrame';
-
-export type CreateGitBookOptions = {
-    /**
-     * URL of the GitBook site to embed.
-     */
-    siteURL: string;
-};
-
-export type GetFrameURLOptions = {
-    /**
-     * Override the color scheme used by the embedded docs.
-     * When omitted, the embed follows the iframe's CSS `color-scheme`.
-     */
-    colorScheme?: 'light' | 'dark';
-
-    /**
-     * 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`;
-
-            if (frameOptions.colorScheme) {
-                url.searchParams.set('theme', frameOptions.colorScheme);
-            }
-
-            if (frameOptions.visitor?.token) {
-                url.searchParams.set('jwt_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,110 +0,0 @@
-import { createChannel } from 'bidc';
-import type {
-    FrameToParentMessage,
-    GitBookEmbeddableConfiguration,
-    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;
-
-    /**
-     * Clear the chat.
-     */
-    clearChat: () => void;
-
-    /**
-     * Set the placeholder settings.
-     */
-    configure: (settings: Partial<GitBookEmbeddableConfiguration>) => 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 allowTokens = iframe.allow
-        .split(';')
-        .map((token) => token.trim())
-        .filter(Boolean);
-
-    if (!allowTokens.includes('clipboard-write')) {
-        iframe.allow = [...allowTokens, 'clipboard-write'].join('; ');
-    }
-
-    const channel = createChannel(iframe.contentWindow);
-
-    channel.receive((message: FrameToParentMessage) => {
-        console.log('[gitbook:embed] received message', message);
-        if (message.type === 'close') {
-            const listeners = events.get('close') || [];
-            if (listeners) {
-                listeners.forEach((listener) => listener());
-            }
-        }
-    });
-
-    const sendToFrame = (message: ParentToFrameMessage) => {
-        console.log('[gitbook:embed] send message', message);
-        channel.send(message);
-    };
-
-    const events = new Map<string, Array<(...args: any[]) => void>>();
-
-    const configuration: GitBookEmbeddableConfiguration = {
-        tabs: ['assistant', 'search', 'docs'],
-        actions: [],
-        greeting: { title: '', subtitle: '' },
-        suggestions: [],
-        tools: [],
-        trademark: true,
-    };
-
-    return {
-        navigateToPage: (pagePath) => {
-            sendToFrame({ type: 'navigateToPage', pagePath });
-        },
-        navigateToAssistant: () => {
-            sendToFrame({ type: 'navigateToAssistant' });
-        },
-        postUserMessage: (message) => sendToFrame({ type: 'postUserMessage', message }),
-        configure: (settings) => {
-            Object.assign(configuration, settings);
-            sendToFrame({ type: 'configure', settings: configuration });
-        },
-        clearChat: () => sendToFrame({ type: 'clearChat' }),
-        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,116 +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'>>;
-};
-
-/**
- * Custom button definition to be passed to the embeddable GitBook.
- */
-export type GitBookEmbeddableActionDefinition = {
-    /**
-     * Icon to be displayed in the button.
-     */
-    icon: IconName;
-
-    /**
-     * Label to be displayed in the button.
-     */
-    label: string;
-
-    /**
-     * Callback when the button is clicked.
-     */
-    onClick: () => void | Promise<void>;
-};
-
-/**
- * Overall configuration for the layout of the GitBook embed.
- */
-export type GitBookEmbeddableConfiguration = {
-    /** Tabs to display in the embed (if enabled on the site). */
-    tabs: ('assistant' | 'docs' | 'search')[];
-
-    /** Additional buttons to be displayed in the header of the GitBook embed. */
-    actions: GitBookEmbeddableActionDefinition[];
-
-    /**
-     * Additional buttons to be displayed in the header of the GitBook embed.
-     * @deprecated Use `actions` instead.
-     */
-    buttons?: GitBookEmbeddableActionDefinition[];
-
-    /** Message to be displayed in the welcome page. */
-    greeting: {
-        title: string;
-        subtitle: string;
-    };
-
-    /**
-     * Override the assistant name displayed in the UI.
-     * Limited to 32 characters.
-     */
-    assistantName?: string;
-
-    /** Suggestions of questions to be displayed in the welcome page. */
-    suggestions: string[];
-
-    /** Tools to be provided to the assistant. */
-    tools: GitBookToolDefinition[];
-
-    /**
-     * Display GitBook branding in the embed.
-     */
-    trademark?: boolean;
-
-    /**
-     * Display a close button inside the assistant.
-     */
-    closeButton?: boolean;
-};
-
-/**
- * Messages sent from the parent to the frame.
- */
-export type ParentToFrameMessage =
-    | {
-          type: 'postUserMessage';
-          message: string;
-      }
-    | {
-          type: 'clearChat';
-      }
-    | {
-          type: 'configure';
-          settings: GitBookEmbeddableConfiguration;
-      }
-    | {
-          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,2 +0,0 @@
-export * from './client';
-export * from './standalone';

packages/embed/src/react/GitBookFrame.tsx

@@ -1,84 +0,0 @@
-'use client';
-
-import { useEffect, useMemo, useRef, useState } from 'react';
-import type {
-    GetFrameURLOptions,
-    GitBookEmbeddableConfiguration,
-    GitBookFrameClient,
-} from '../client';
-import { useGitBook } from './GitBookProvider';
-
-export type GitBookFrameProps = {
-    className?: string;
-} & GetFrameURLOptions &
-    Partial<GitBookEmbeddableConfiguration>;
-
-/**
- * Render a frame with the GitBook Assistant in it.
- */
-export function GitBookFrame(props: GitBookFrameProps) {
-    const {
-        className,
-        colorScheme,
-        visitor,
-        actions = [],
-        greeting,
-        suggestions = [],
-        tools = [],
-        tabs = ['assistant', 'search', 'docs'],
-        trademark = true,
-        closeButton = false,
-        assistantName,
-    } = props;
-
-    const frameRef = useRef<HTMLIFrameElement>(null);
-    const gitbook = useGitBook();
-    const [gitbookFrame, setGitbookFrame] = useState<GitBookFrameClient | null>(null);
-
-    const frameURL = useMemo(
-        () => gitbook.getFrameURL({ visitor, colorScheme }),
-        [gitbook, visitor, colorScheme]
-    );
-
-    useEffect(() => {
-        if (frameRef.current) {
-            setGitbookFrame(gitbook.createFrame(frameRef.current));
-        }
-    }, [gitbook]);
-
-    useEffect(() => {
-        gitbookFrame?.configure({
-            tabs,
-            actions,
-            greeting,
-            suggestions,
-            tools,
-            closeButton,
-            trademark,
-            assistantName,
-        });
-    }, [
-        gitbookFrame,
-        actions,
-        greeting,
-        suggestions,
-        tools,
-        tabs,
-        closeButton,
-        trademark,
-        assistantName,
-    ]);
-
-    return (
-        <iframe
-            title="GitBook"
-            ref={frameRef}
-            src={frameURL}
-            width="100%"
-            height="100%"
-            allow="clipboard-write"
-            className={className}
-            style={colorScheme ? { colorScheme } : undefined}
-        />
-    );
-}

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,2 +0,0 @@
-export * from './GitBookProvider';
-export * from './GitBookFrame';

packages/embed/src/standalone/index.ts

@@ -1,217 +0,0 @@
-import './style.css';
-
-import {
-    type CreateGitBookOptions,
-    type GetFrameURLOptions,
-    type GitBookClient,
-    type GitBookEmbeddableConfiguration,
-    type GitBookFrameClient,
-    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]
-    // Clear the chat
-    | ['clearChat']
-    // Configure the embed
-    | ['configure', Partial<GitBookEmbeddableConfiguration & StandaloneConfiguration>]
-    // Navigate to a page
-    | ['navigateToPage', string]
-    // Navigate to the assistant
-    | ['navigateToAssistant'];
-
-type StandaloneConfiguration = {
-    /** Configure the button to open the embed */
-    button: {
-        /** Label to be displayed in the button. */
-        label: string;
-        /** Icon to be displayed in the button. */
-        icon: 'assistant' | 'sparkle' | 'help' | 'book';
-    };
-};
-
-export type GitBookStandalone = ((...args: StandaloneCalls) => void) & {
-    q?: StandaloneCalls[];
-};
-
-let widgetIframe: HTMLIFrameElement | undefined;
-let _client: GitBookClient | undefined;
-let _frame: GitBookFrameClient | undefined;
-let frameOptions: GetFrameURLOptions | undefined;
-let frameConfiguration: GitBookEmbeddableConfiguration & StandaloneConfiguration = {
-    button: {
-        label: 'Ask',
-        icon: 'assistant',
-    },
-    actions: [],
-    greeting: { title: '', subtitle: '' },
-    suggestions: [],
-    tools: [],
-    tabs: ['assistant', 'search', 'docs'],
-    trademark: true,
-};
-
-const widgetButton = document.createElement('button');
-widgetButton.id = 'gitbook-widget-button';
-widgetButton.addEventListener('click', () => {
-    GitBook('toggle');
-});
-widgetButton.innerHTML = `
-    <span id="gitbook-widget-button-icon" data-icon="${frameConfiguration.button.icon}"></span>
-    <span id="gitbook-widget-button-label">${frameConfiguration.button.label}</span>
-`;
-
-const widgetWindow = document.createElement('div');
-widgetWindow.id = 'gitbook-widget-window';
-widgetWindow.classList.add('hidden');
-
-document.body.appendChild(widgetButton);
-document.body.appendChild(widgetWindow);
-
-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.allow = 'clipboard-write';
-        if (frameOptions?.colorScheme) {
-            widgetIframe.style.colorScheme = frameOptions.colorScheme;
-        }
-        widgetIframe.src = client.getFrameURL({
-            ...frameOptions,
-        });
-        widgetWindow.appendChild(widgetIframe);
-
-        _frame = client.createFrame(widgetIframe);
-        _frame.on('close', () => {
-            widgetWindow.classList.add('hidden');
-            widgetButton.classList.remove('open');
-        });
-    }
-    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 'configure': {
-            const settings = args[1];
-
-            // If trademark is disabled, change the (branded) icon to the sparkle icon
-            if (
-                settings.trademark === false &&
-                !settings.button?.icon &&
-                frameConfiguration.button.icon === 'assistant'
-            ) {
-                settings.button = {
-                    label: frameConfiguration.button.label,
-                    icon: 'sparkle',
-                };
-            }
-
-            frameConfiguration = {
-                ...frameConfiguration,
-                ...settings,
-            };
-            // Update the button label and icon
-            if (settings.button?.label) {
-                const label = widgetButton.querySelector('#gitbook-widget-button-label');
-                if (label) {
-                    label.textContent = settings.button.label;
-                }
-            }
-            if (settings.button?.icon) {
-                const icon = widgetButton.querySelector('#gitbook-widget-button-icon');
-                if (icon) {
-                    icon.setAttribute('data-icon', settings.button.icon);
-                }
-            }
-
-            getIframe().frame.configure({
-                ...frameConfiguration,
-            });
-            break;
-        }
-        case 'clearChat':
-            getIframe().frame.clearChat();
-            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,194 +0,0 @@
-:root {
-    --gitbook-widget-top: 1rem;
-    --gitbook-widget-bottom: 1rem;
-    --gitbook-widget-right: 1rem;
-    --gitbook-widget-left: 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);
-}
-
-@media (prefers-color-scheme: dark) {
-    :root {
-        --gitbook-widget-text-color: #FFFFFF;
-        --gitbook-widget-border-color: #202020;
-        --gitbook-widget-background-translucent: rgba(15, 15, 15, 0.9);
-        --gitbook-widget-background-translucent-hover: rgba(20, 20, 20, 0.9);
-        --gitbook-widget-background-solid: #f0f0f0;
-    }
-}
-
-* {
-    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-icon[data-icon="sparkle"] {
-    mask-image: url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/sparkle.svg?v=2&token=a463935e93");
-}
-
-#gitbook-widget-button-icon[data-icon="help"] {
-    mask-image: url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/circle-question.svg?v=2&token=a463935e93");
-}
-
-#gitbook-widget-button-icon[data-icon="book"] {
-    mask-image: url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/book-open.svg?v=2&token=a463935e93");
-}
-
-#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: calc(min(var(--gitbook-widget-window-width), calc(100vw - var(--gitbook-widget-right) - var(--gitbook-widget-left))));
-    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-translucent);
-    backdrop-filter: blur(48px);
-    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/embed/tsdown.config.ts

@@ -1,13 +0,0 @@
-import { defineConfig } from 'tsdown';
-
-export default defineConfig([
-    {
-        entry: 'src/index.ts',
-        outDir: 'dist',
-    },
-    {
-        entry: 'src/react/index.ts',
-        outDir: 'dist/react',
-        unbundle: true,
-    },
-]);

packages/emoji-codepoints/CHANGELOG.md

@@ -1,25 +1,13 @@
 # @gitbook/emoji-codepoints
 
-## 0.2.2
-
-### Patch Changes
-
-- 6142d6b: Mark as sideEffects, fix all package bundles
-
-## 0.2.1
-
-### Patch Changes
-
-- 295f03d: Republish packages
-
 ## 0.2.0
 
 ### Minor Changes
 
-- 57adb3e: Second release to fix publishing with changeset
+-   57adb3e: Second release to fix publishing with changeset
 
 ## 0.1.0
 
 ### Minor Changes
 
-- 5f8a8fe: Initial release
+-   5f8a8fe: Initial release

packages/emoji-codepoints/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@gitbook/emoji-codepoints",
     "description": "Optimized mapping of codepoints to the fully qualified emoji codepoints",
-    "version": "0.2.2",
+    "version": "0.2.0",
     "private": true,
     "exports": "./dist/index.ts",
-    "sideEffects": false,
+    "dependencies": {},
     "devDependencies": {
-        "emoji-assets": "^9.0.0"
+        "emoji-assets": "^8.0.0"
     },
     "scripts": {
         "generate": "bun ./build.ts",