Version Packages (#3720 )

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Add npm token to publish with bun (#3721 )
2026-09-14 22:55:25 +00:00 · 2025-10-13 08:42:09 +02:00 · 2025-10-13 11:38:57 +05:30 · 2025-10-11 07:36:58 +00:00 · 2025-10-10 17:41:54 +02:00 · 2025-10-10 17:20:11 +02:00
698 changed files with 30838 additions and 15526 deletions
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix UX issue about highlighting the search term in search result sections
@@ -1,9 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix three small visual issues
 - Fix sidebar showing on `no-toc` pages in the gradient theme
 - Fix variant selector truncating incorrectly in header when sections are present
 - Fix page cover alignment on `lg` screens without TOC
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Respect fullWidth and defaultWidth for images
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 Add docs.testgitbook.com to ADAPTIVE_CONTENT_HOSTS list
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 fix nested a tag causing hydration error
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 fix href being empty in TOC
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix navigation between sections/variants when previewing a site in v2
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 Add support for inline icons.
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 Add circular corners and depth styling
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix crash when integration script fails to render block.
@@ -1,5 +0,0 @@
 ---
 '@gitbook/react-openapi': patch
 ---
 Add authorization header for OAuth2
@@ -1,6 +0,0 @@
 ---
 '@gitbook/react-openapi': patch
 'gitbook': patch
 ---
 Improve support for OAuth2 security type
@@ -1,6 +0,0 @@
 ---
 "gitbook-v2": patch
 "gitbook": patch
 ---
 Adds Columns layout block to GBO
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 Support dark-mode specific page cover image
@@ -1,5 +0,0 @@
 ---
 'gitbook': patch
 ---
 Update Models page styling
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 Optimize performances by using a smarter per-request cache arround data cached functions
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 add a force-revalidate api route to force bust the cache in case of errors
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 Fix rendering of ogimage with SVG logos.
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 Best effort at preserving current variant when navigating between sections by matching the pathname against site spaces in the new section.
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix crash when integration is triggering invalid requests.
@@ -1,6 +0,0 @@
 ---
 "gitbook-v2": patch
 "gitbook": patch
 ---
 encode customization header
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 Rework full-width layout, add support for full-width page option
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 fix ISR on preview env
@@ -1,6 +0,0 @@
 ---
 "gitbook-v2": patch
 "gitbook": patch
 ---
 Fix concurrent execution in Vercel causing pages to not be attached to the proper tags.
@@ -1,5 +0,0 @@
 ---
 "@gitbook/react-contentkit": patch
 ---
 Add basic error handling when transitioning between states.
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 Generate a llms-full.txt version of the docs site
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Don't crash ogimage generation on RTL text, as a workaround until we can support it.
@@ -1,5 +0,0 @@
 ---
 "@gitbook/fonts": minor
 ---
 Initial version of the package
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix rendering of ogimage when logo or icon are AVIF images.
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Add margin to adjacent buttons
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix ogimage generation failing with some JPEG images.
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 Don't cache unexpected API errors for more than a few minutes.
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 Fix an issue where PDF export URLs were not keeping their query params.
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 add a global error boundary
@@ -1,5 +0,0 @@
 ---
 '@gitbook/react-openapi': patch
 ---
 Indent JSON python code sample
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix missing title on button to close the announcement banner.
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Make icons for page groups more contrasting
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Ignore case while highlighting search results.
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Make TOC height dynamic based on visible header and footer elements
@@ -1,6 +0,0 @@
 ---
 "gitbook": patch
 "gitbook-v2": patch
 ---
 Fix InlineLinkTooltip having a negative impact on performance, especially on larger pages.
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix bold header links hover color
@@ -1,6 +0,0 @@
 ---
 "gitbook": patch
 "gitbook-v2": patch
 ---
 cache fonts and static image used in OGImage in memory
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix border being added to cards
@@ -1,5 +0,0 @@
 ---
 '@gitbook/react-openapi': patch
 ---
 Handle nested deprecated properties in generateSchemaExample
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix crash during rendering of ogimage for VA sites with default icon.
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 Add `urlObject.hash` to `linker.toLinkForContent` to pass through URL fragment identifiers, used in search
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 apply customization for dynamic context
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Reverse order of feedback smileys
@@ -1,5 +0,0 @@
 ---
 "gitbook": minor
 ---
 New design for tab blocks
@@ -1,5 +0,0 @@
 ---
 '@gitbook/react-openapi': patch
 ---
 Deduplicate path parameters from OpenAPI spec
@@ -1,5 +0,0 @@
 ---
 "gitbook": patch
 ---
 Fix ogimage using incorrect Google Font depending on language.
@@ -1,5 +0,0 @@
 ---
 "gitbook-v2": patch
 ---
 remove trailing slash from linker
@@ -0,0 +1,3 @@
 # 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
@@ -53,17 +53,40 @@ After forking this repository, you'll want to [create a branch](https://docs.git
 #### 3. Install dependencies and run the project locally
-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.
+##### Prerequisites:
 - Node.js (Version: >=20.6)
  - Use `nvm` for easy Node management
 - [Bun](https://bun.sh/) (Version: >=1.2.15)
  - We use a text-based lockfile which isn't supported below 1.2.15
-You can easily do this by running the command `nvm use`.
+##### Setup steps:
-To start your local version of GitBook, run the command `bun dev`.
+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
 #### 4. Preview your changes
-When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/`.
+When running the development server, published GitBook sites can be rendered through your local version at `http://localhost:3000/url`.
-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.
+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.
 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.
@@ -32,7 +32,7 @@ runs:
            workingDirectory: ./
            wranglerVersion: '4.10.0'
            environment: ${{ inputs.environment }}
-            command: deployments status --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+            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
@@ -51,7 +51,7 @@ runs:
            workingDirectory: ./
            wranglerVersion: '4.10.0'
            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+            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
@@ -63,7 +63,7 @@ runs:
            workingDirectory: ./
            wranglerVersion: '4.10.0'
            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc
+            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
@@ -73,7 +73,7 @@ runs:
            workingDirectory: ./
            wranglerVersion: '4.10.0'
            environment: ${{ inputs.environment }}
-            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+            command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
      - name: Outputs
        shell: bash
@@ -1,37 +0,0 @@
 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
@@ -59,7 +59,7 @@ runs:
            GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
            GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
        - name: Build worker
-          run: bun run turbo build:v2:cloudflare
+          run: bun run turbo build:cloudflare
          env:
            GITBOOK_RUNTIME: cloudflare
          shell: bash
@@ -72,7 +72,7 @@ runs:
              workingDirectory: ./
              wranglerVersion: '4.10.0'
              environment: ${{ inputs.environment }}
-              command: deploy --config ./packages/gitbook-v2/openNext/customWorkers/doWrangler.jsonc
+              command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
        - id: upload_server
          name: Upload server to Cloudflare
@@ -83,7 +83,7 @@ runs:
              workingDirectory: ./
              wranglerVersion: '4.10.0'
              environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/openNext/customWorkers/defaultWrangler.jsonc
+              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
@@ -95,7 +95,7 @@ runs:
        - name: Run updateWrangler scripts
          shell: bash
          run: |
-              bun run ./packages/gitbook-v2/openNext/customWorkers/script/updateWrangler.ts ${{ steps.extract_server_version_id.outputs.version_id }}
+              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
@@ -106,7 +106,7 @@ runs:
              workingDirectory: ./
              wranglerVersion: '4.10.0'
              environment: ${{ inputs.environment }}
-              command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/openNext/customWorkers/middlewareWrangler.jsonc
+              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
@@ -7,53 +7,6 @@ on:
 env:
    NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
 jobs:
    deploy-v1-cloudflare:
        name: Deploy v1 to Cloudflare Pages
        runs-on: ubuntu-latest
        environment:
          name: ${{ github.ref == 'refs/heads/main' && '1c-production' || '1c-preview' }}
          url: ${{ steps.deploy.outputs.deployment-url }}
        permissions:
            contents: read
            deployments: write
            issues: write
            pull-requests: write
            checks: write
            statuses: write
        outputs:
            deployment-url: ${{ steps.deploy.outputs.deployment-url }}
            deployment-alias-url: ${{ steps.deploy.outputs.deployment-alias-url }}
        steps:
            - name: Checkout
              uses: actions/checkout@v4
            - name: Setup Bun
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
              env:
                  PUPPETEER_SKIP_DOWNLOAD: 1
            - name: Sets env vars for production
              if: github.ref == 'refs/heads/main'
              run: |
                echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
            - name: Build Next.js with next-on-pages
              run: bun run turbo gitbook#build:cloudflare
              env:
                  NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
                  GITBOOK_RUNTIME: cloudflare
            - id: deploy
              name: Deploy to Cloudflare
              uses: cloudflare/wrangler-action@v3.14.0
              with:
                  apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
                  accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
                  workingDirectory: ./
                  wranglerVersion: '3.112.0'
                  command: pages deploy ./packages/gitbook/.vercel/output/static --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }} --branch=${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
            - name: Outputs
              run: |
                  echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
                  echo "Alias URL: ${{ steps.deploy.outputs.deployment-alias-url }}"
    deploy-v2-vercel:
        name: Deploy v2 to Vercel (preview)
        runs-on: ubuntu-latest
@@ -114,7 +67,6 @@ jobs:
        name: Comment Deployments (preview)
        if: always() && !startsWith(github.ref, 'refs/heads/main')
        needs:
            - deploy-v1-cloudflare
            - deploy-v2-vercel
            - deploy-v2-cloudflare
        steps:
@@ -134,15 +86,6 @@ 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' && '✅' || '❌' }} |
@@ -150,35 +93,16 @@ jobs:
                      ### Test content
-                      | Site | `v1` | `2v` | `2c` |
+                      | Site | `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) |
+                      | 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-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
+                      | E2E | [${{ needs.deploy-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: 10
        steps:
            - name: Checkout
              uses: actions/checkout@v4
            - name: Setup Bun
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
            - name: Setup Playwright
              uses: ./.github/actions/setup-playwright
            - name: Run Playwright tests
              run: bun e2e
              env:
                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
    visual-testing-v2-vercel:
        runs-on: ubuntu-latest
        name: Visual Testing v2
        needs: deploy-v2-vercel
-        timeout-minutes: 10
+        timeout-minutes: 15
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -186,8 +110,8 @@ jobs:
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
-            - name: Setup Playwright
+              env:
-              uses: ./.github/actions/setup-playwright
+                  PUPPETEER_SKIP_DOWNLOAD: 1
            - name: Run Playwright tests
              run: bun e2e
              env:
@@ -199,7 +123,7 @@ jobs:
        runs-on: ubuntu-latest
        name: Visual Testing v2 (Cloudflare)
        needs: deploy-v2-cloudflare
-        timeout-minutes: 10
+        timeout-minutes: 15
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -207,8 +131,8 @@ jobs:
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
-            - name: Setup Playwright
+              env:
-              uses: ./.github/actions/setup-playwright
+                  PUPPETEER_SKIP_DOWNLOAD: 1
            - name: Run Playwright tests
              run: bun e2e
              env:
@@ -216,31 +140,11 @@ jobs:
                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                  ARGOS_BUILD_NAME: 'v2-cloudflare'
    visual-testing-customers-v1:
        runs-on: ubuntu-latest
        name: Visual Testing Customers v1
        needs: deploy-v1-cloudflare
        timeout-minutes: 10
        steps:
            - name: Checkout
              uses: actions/checkout@v4
            - name: Setup Bun
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
            - name: Setup Playwright
              uses: ./.github/actions/setup-playwright
            - name: Run Playwright tests
              run: bun e2e-customers
              env:
                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                  ARGOS_BUILD_NAME: 'customers-v1'
    visual-testing-customers-v2:
        runs-on: ubuntu-latest
        name: Visual Testing Customers v2
        needs: deploy-v2-vercel
-        timeout-minutes: 10
+        timeout-minutes: 15
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -248,8 +152,8 @@ jobs:
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
-            - name: Setup Playwright
+              env:
-              uses: ./.github/actions/setup-playwright
+                  PUPPETEER_SKIP_DOWNLOAD: 1
            - name: Run Playwright tests
              run: bun e2e-customers
              env:
@@ -261,27 +165,7 @@ jobs:
        runs-on: ubuntu-latest
        name: Visual Testing Customers v2 (Cloudflare)
        needs: deploy-v2-cloudflare
-        timeout-minutes: 10
+        timeout-minutes: 15
        steps:
            - name: Checkout
              uses: actions/checkout@v4
            - name: Setup Bun
              uses: ./.github/composite/setup-bun
            - name: Install dependencies
              run: bun install --frozen-lockfile
            - name: Setup Playwright
              uses: ./.github/actions/setup-playwright
            - name: Run Playwright tests
              run: bun e2e-customers
              env:
                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                  ARGOS_BUILD_NAME: 'customers-v2'
    pagespeed-testing-v1:
        runs-on: ubuntu-latest
        name: PageSpeed Testing v1
        needs: deploy-v1-cloudflare
        steps:
            - name: Checkout
              uses: actions/checkout@v4
@@ -291,8 +175,46 @@ jobs:
              run: bun install --frozen-lockfile
              env:
                  PUPPETEER_SKIP_DOWNLOAD: 1
-            - name: Run pagespeed tests
+            - name: Run Playwright tests
-              run: bun ./packages/gitbook/tests/pagespeed-testing.ts
+              run: bun e2e-customers
              env:
-                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
-                  PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
+                  SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                  ARGOS_BUILD_NAME: 'customers-v2'
    browserless-testing-v2-vercel:
        runs-on: ubuntu-latest
        name: Browserless Testing v2 (Vercel)
        needs: deploy-v2-vercel
        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-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/
@@ -37,24 +37,7 @@ jobs:
                  # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
                  GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
                  NPM_CONFIG_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 }}
@@ -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://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> 
 </p>
 <p align="center">
@@ -35,10 +35,10 @@ To run a local version of this project, please follow these simple steps.
 ### Prerequisites
-   Node.js (Version: >=20.6)
+- Node.js (Version: >=20.6)
-  - Use nvm for easy Node management
+    - Use nvm for easy Node management
-   Bun (Version: >=1.2.1)
+- [Bun](https://bun.sh/) (Version: >=1.2.15)
-  - We use a text-based lockfile which isn't supported below 1.2.1
+  - We use a text-based lockfile which isn't supported below 1.2.15
 ### Set up
@@ -56,19 +56,13 @@ git clone https://github.com/gitbookIO/gitbook.git
 bun install
 ```
-4. Run build.
+4. Start your local development server.
 ```
-bun build:v2
+bun dev
 ```
-5. Start your local development server.
+6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.
 ```
 bun dev:v2
 ```
 6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
 examples:
@@ -77,11 +71,6 @@ 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.
@@ -18,10 +18,12 @@
            "**/.vercel/**/*",
            "**/.cache/**/*",
            "**/.wrangler/**/*",
            "packages/embed/standalone/**/*",
            "packages/openapi-parser/src/fixtures/**/*",
            "packages/emoji-codepoints/index.ts",
            "packages/icons/src/data/*.json",
-            "packages/cache-do/worker-configuration.d.ts"
+            "packages/gitbook/worker-configuration.d.ts",
            "**/*.css"
        ]
    },
    "formatter": {
@@ -127,7 +129,6 @@
        {
            "include": [
                "packages/gitbook/**/*",
                "packages/gitbook-v2/**/*",
                "packages/react-openapi/**/*",
                "packages/react-math/**/*",
                "packages/react-contentkit/**/*",
@@ -3,22 +3,21 @@
    "version": "0.1.0",
    "devDependencies": {
        "@biomejs/biome": "^1.9.4",
-        "@changesets/cli": "^2.27.12",
+        "@changesets/cli": "^2.29.7",
-        "turbo": "^2.5.0",
+        "turbo": "^2.5.8",
-        "vercel": "^39.3.0"
+        "vercel": "^39.4.2"
    },
    "packageManager": "bun@1.2.15",
    "overrides": {
        "@codemirror/state": "6.4.1",
        "react": "^19.0.0",
-        "react-dom": "^19.0.0"
+        "react-dom": "^19.0.0",
        "esbuild": "0.24.2"
    },
    "private": true,
    "scripts": {
-        "dev": "turbo run dev",
+        "dev": "turbo run dev --concurrency 20",
        "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 ./",
@@ -27,16 +26,18 @@
        "e2e": "turbo run e2e",
        "e2e-customers": "turbo run e2e-customers",
        "changeset": "changeset",
-        "changeset-version": "changeset version && bun run format",
+        "changeset-version": "changeset version && bun run format && bun update",
-        "release": "turbo run release && changeset publish",
+        "release": "turbo run release && bun run publish-all-packages",
-        "release:preview": "turbo run release:preview",
+        "publish-all-packages": "for dir in packages/*; do (cd \"$dir\" && bun publish || true); done && changeset tag",
        "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
        "clean": "turbo run clean"
    },
    "workspaces": {
        "packages": ["packages/*"],
        "catalog": {
-            "@gitbook/api": "^0.121.0"
+            "@gitbook/api": "0.143.2",
            "bidc": "^0.0.2",
            "tsdown": "^0.15.6"
        }
    },
    "patchedDependencies": {
@@ -0,0 +1 @@
 dist/
@@ -0,0 +1,21 @@
 # @gitbook/browser-types
 ## 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
@@ -0,0 +1,3 @@
 # `@gitbook/browser-types`
 Typescript types for the global variables available in a GitBook website. These types can be used by integrations embedding scripts.
@@ -0,0 +1,28 @@
 {
    "name": "@gitbook/browser-types",
    "description": "Typescript types for the global variables available in a GitBook website. These types can be used by integrations embedding scripts.",
    "type": "module",
    "exports": {
        ".": {
            "types": "./dist/index.d.ts",
            "default": "./dist/index.js"
        }
    },
    "version": "0.1.1",
    "dependencies": {
        "@gitbook/api": "catalog:",
        "@gitbook/icons": "workspace:"
    },
    "devDependencies": {
        "typescript": "^5.5.3"
    },
    "scripts": {
        "build": "tsc",
        "typecheck": "tsc --noEmit"
    },
    "files": ["dist", "README.md", "CHANGELOG.md"],
    "publishConfig": {
        "access": "public",
        "registry": "https://registry.npmjs.org/"
    }
 }
@@ -0,0 +1,84 @@
 import type { AIToolCallResult, AIToolDefinition } from '@gitbook/api';
 import type { IconName } from '@gitbook/icons';
 export type GitBookIntegrationEvent = 'load' | 'unload';
 export type GitBookIntegrationEventCallback = (...args: any[]) => void;
 export type GitBookIntegrationTool = AIToolDefinition & {
    /**
     * Confirmation action to be displayed to the user before executing the tool.
     */
    confirmation?: {
        icon?: IconName;
        label: string;
    };
    /**
     * Callback when the tool is executed.
     * The input is provided by the AI assistant following the input schema of the tool.
     */
    execute: (input: object) => Promise<Pick<AIToolCallResult, 'output' | 'summary'>>;
 };
 export type GitBookAssistant = {
    /**
     * Name of the assistant displayed in the UI.
     */
    label: string;
    /**
     * Icon of the assistant displayed in the UI.
     * Any FontAwesome icon name is supported.
     * @example 'sparkle'
     */
    icon: string;
    /**
     * Callback when the assistant is opened.
     */
    open: (query?: string) => void;
    /**
     * Whether to display the triggers for this assistant in the UI.
     * @default true
     */
    ui?: boolean;
 };
 export type GitBookGlobal = {
    /**
     * Register an event listener.
     */
    addEventListener: (
        type: GitBookIntegrationEvent,
        func: GitBookIntegrationEventCallback
    ) => void;
    /**
     * Remove an event listener.
     */
    removeEventListener: (
        type: GitBookIntegrationEvent,
        func: GitBookIntegrationEventCallback
    ) => void;
    /**
     * Register a custom tool to be exposed to the AI assistant.
     */
    registerTool: (tool: GitBookIntegrationTool) => void;
    /**
     * Register a custom assistant to be available on the site.
     */
    registerAssistant: (assistant: GitBookAssistant) => () => void;
 };
 declare global {
    interface Window {
        /**
         * Global `window.GitBook` object accessible by integrations.
         */
        GitBook?: GitBookGlobal;
    }
 }
@@ -0,0 +1,25 @@
 {
    "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"]
 }
@@ -1,3 +0,0 @@
 .wrangler
 worker-configuration.d.ts
 dist/
@@ -1,18 +0,0 @@
 # @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
@@ -1,22 +0,0 @@
 # `@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.
@@ -1,35 +0,0 @@
 {
    "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"]
 }
@@ -1,292 +0,0 @@
 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;
 }
@@ -1,97 +0,0 @@
 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}`;
 }
@@ -1 +0,0 @@
 export * from './CacheObjectStub';
@@ -1,9 +0,0 @@
 import { WorkerEntrypoint } from 'cloudflare:workers';
 export * from './CacheObject';
 export default class Worker extends WorkerEntrypoint {
    fetch() {
        return new Response('Hello, world!');
    }
 }
@@ -1,8 +0,0 @@
 {
    "extends": ["//"],
    "tasks": {
        "generate": {
            "outputs": ["worker-configuration.d.ts"]
        }
    }
 }
@@ -1,27 +0,0 @@
 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
@@ -1,5 +1,11 @@
 # @gitbook/cache-tags
 ## 0.3.2
 ### Patch Changes
 - 295f03d: Republish packages
 ## 0.3.1
 ### Patch Changes
@@ -8,7 +8,7 @@
            "default": "./dist/index.js"
        }
    },
-    "version": "0.3.1",
+    "version": "0.3.2",
    "dependencies": {
        "@gitbook/api": "catalog:",
        "assert-never": "^1.2.1"
@@ -21,5 +21,9 @@
        "typecheck": "tsc --noEmit",
        "dev": "tsc -w"
    },
-    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"],
    "publishConfig": {
        "access": "public",
        "registry": "https://registry.npmjs.org/"
    }
 }
@@ -90,7 +90,7 @@ export function getCacheTag(
        | {
              tag: 'translation';
              organization: string;
-              translationSettings: string;
+              translation: string;
          }
 ): string {
    switch (spec.tag) {
@@ -115,23 +115,12 @@ export function getCacheTag(
        case 'openapi':
            return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
        case 'translation':
-            return `organization:${spec.organization}:translation:${spec.translationSettings}`;
+            return `organization:${spec.organization}:translation:${spec.translation}`;
        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.
 */
@@ -144,6 +133,10 @@ 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 ?? {});
@@ -167,18 +160,18 @@ export function getComputedContentSourceCacheTags(
                        })
                    );
                    break;
-                case 'translation-language':
+                case 'translation':
                    tags.push(
                        getCacheTag({
                            tag: 'translation',
                            organization: inContext.organizationId,
-                            translationSettings: dependency.ref.translationSettings,
+                            translation: dependency.ref.translation,
                        })
                    );
                    break;
                default:
                    // Do not throw for unknown dependency types
-                    // as it might mean we are lacking behind the API version
+                    // as it might mean we are lagging behind the API version
                    break;
            }
        });
@@ -194,9 +187,8 @@ 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',
@@ -5,6 +5,7 @@
        "allowJs": true,
        "skipLibCheck": true,
        "strict": true,
        "noUncheckedIndexedAccess": true,
        "noEmit": false,
        "declaration": true,
        "outDir": "dist",
@@ -1,5 +1,21 @@
 # @gitbook/colors
 ## 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
@@ -8,7 +8,7 @@
            "default": "./dist/index.js"
        }
    },
-    "version": "0.3.3",
+    "version": "0.4.1",
    "devDependencies": {
        "typescript": "^5.5.3"
    },
@@ -17,5 +17,9 @@
        "typecheck": "tsc --noEmit",
        "dev": "tsc -w"
    },
-    "files": ["dist", "src", "README.md", "CHANGELOG.md"]
+    "files": ["dist", "src", "README.md", "CHANGELOG.md"],
    "publishConfig": {
        "access": "public",
        "registry": "https://registry.npmjs.org/"
    }
 }
@@ -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]; // Reference white (D65)
+const D65 = [95.047, 100.0, 108.883] as const; // Reference white (D65)
 export enum ColorCategory {
    backgrounds = 'backgrounds',
@@ -19,7 +19,7 @@ export enum ColorCategory {
 }
 type ColorSubScale = {
-    [key: string]: number;
+    [key: string]: number | string;
 };
 /**
@@ -56,6 +56,8 @@ export const scale: Record<ColorCategory, ColorSubScale> = {
        solid: 9,
        /** Hovered solid backgrounds */
        'solid-hover': 10,
        /** Original color */
        original: 'original',
    },
    [ColorCategory.text]: {
        /** Very low-contrast text
@@ -211,8 +213,8 @@ export function colorScale(
    const result = [];
    for (let index = 0; index < mapping.length; index++) {
-        const targetL =
+        const step = mapping[index]!;
-            foregroundColor.L * mapping[index] + backgroundColor.L * (1 - mapping[index]);
+        const targetL = foregroundColor.L * step + backgroundColor.L * (1 - step);
        if (
            index === 8 &&
@@ -295,7 +297,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);
@@ -392,14 +394,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,
+        L: 116 * y! - 16,
-        A: 500 * (x - y),
+        A: 500 * (x! - y!),
-        B: 200 * (y - z),
+        B: 200 * (y! - z!),
    };
 }
@@ -419,7 +421,10 @@ export function dpsContrast(a: RGBColor, b: RGBColor) {
    return contrast < 7.5 ? 0 : contrast;
 }
-export function colorContrast(background: string, foreground: string[] = [LIGHT_BASE, DARK_BASE]) {
+export function colorContrast(
    background: string,
    foreground: string[] = [LIGHT_BASE, DARK_BASE]
 ): string {
    const bg = hexToRgbArray(background);
    const best: { color?: RGBColor; contrast: number } = {
@@ -436,5 +441,5 @@ export function colorContrast(background: string, foreground: string[] = [LIGHT_
        }
    }
-    return best.color ? rgbArrayToHex(best.color) : foreground[0];
+    return best.color ? rgbArrayToHex(best.color) : foreground[0] || LIGHT_BASE;
 }
@@ -5,6 +5,7 @@
        "allowJs": true,
        "skipLibCheck": true,
        "strict": true,
        "noUncheckedIndexedAccess": true,
        "noEmit": false,
        "declaration": true,
        "outDir": "dist",
@@ -0,0 +1,2 @@
 dist/
 standalone/
@@ -0,0 +1,33 @@
 # @gitbook/embed
 ## 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
@@ -0,0 +1,49 @@
 # `@gitbook/embed`
 Embed the GitBook Docs Assistant in your product or website.
 # Usage
 ## As a script from your docs site
 All GitBook docs site includes a script to easily embed the docs assistant as a widget on your website.
 The script is served at `https://docs.company.com/~gitbook/embed/script.js`.
 You can find the embed script from your docs site settings, or you can copy the following and replace the `docs.company.com` by your docs site hostname.
 ```html
 <script src="https://docs.company.com/~gitbook/embed/script.js"></script>
 <script>
 window.GitBook('show');
 </script>
 ```
 ## As a package from NPM
 Install the package: `npm install @gitbook/embed` and import it in your web application:
 ```tsx
 import { createGitBook } from '@gitbook/embed';
 const gitbook = createGitBook({
    siteURL: 'https://docs.company.com'
 });
 const iframe = document.createElement('iframe');
 iframe.src = gitbook.getFrameURL();
 const frame = gitbook.createFrame(iframe);
 ```
 ## As React components
 After installing the NPM package, you can import prebuilt React components:
 ```tsx
 import { GitBookProvider, GitBookAssistantFrame } from '@gitbook/embed/react';
 <GitBookProvider siteURL="https://docs.company.com">
    <GitBookAssistantFrame />
 </GitBookProvider>
 ```
@@ -0,0 +1,42 @@
 {
    "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"
        }
    },
    "version": "0.1.3",
    "dependencies": {
        "@gitbook/api": "catalog:",
        "@gitbook/icons": "workspace:",
        "bidc": "catalog:"
    },
    "peerDependencies": {
        "react": "^18.0.0"
    },
    "devDependencies": {
        "tsdown": "catalog:",
        "typescript": "^5.5.3",
        "react": "^19.0.0"
    },
    "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",
        "typecheck": "tsc --noEmit",
        "dev": "bun run build -- --watch ./src"
    },
    "files": ["dist", "README.md", "CHANGELOG.md"],
    "publishConfig": {
        "access": "public",
        "registry": "https://registry.npmjs.org/"
    }
 }
@@ -0,0 +1,61 @@
 import { type GitBookFrameClient, createGitBookFrame } from './createGitBookFrame';
 export type CreateGitBookOptions = {
    /**
     * URL of the GitBook site to embed.
     */
    siteURL: string;
 };
 export type GetFrameURLOptions = {
    /**
     * Authentication to use for the frame.
     */
    visitor?: {
        /**
         * Signed JWT token for Adaptive Content or Visitor Authentication to use.
         */
        token?: string;
        /**
         * Unsigned claims to pass to the frame.
         * You can use these claims in dynamic expressions using `visitor.claims.unsigned.<claim-name>`.
         */
        unsignedClaims?: Record<string, unknown>;
    };
 };
 export type GitBookClient = {
    /**
     * Get the URL for a GitBook frame.
     */
    getFrameURL: (options: GetFrameURLOptions) => string;
    /**
     * Create a new GitBook frame.
     */
    createFrame: (iframe: HTMLIFrameElement) => GitBookFrameClient;
 };
 export function createGitBook(options: CreateGitBookOptions) {
    const client: GitBookClient = {
        getFrameURL: (frameOptions) => {
            const url = new URL(options.siteURL);
            url.pathname = `${url.pathname.endsWith('/') ? url.pathname : `${url.pathname}/`}~gitbook/embed/assistant`;
            if (frameOptions.visitor?.token) {
                url.searchParams.set('token', frameOptions.visitor.token);
            }
            if (frameOptions.visitor?.unsignedClaims) {
                Object.entries(frameOptions.visitor.unsignedClaims).forEach(([key, value]) => {
                    url.searchParams.set(`visitor.${key}`, String(value));
                });
            }
            return url.toString();
        },
        createFrame: (iframe) => createGitBookFrame(iframe),
    };
    return client;
 }
@@ -0,0 +1,98 @@
 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 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 = {
        buttons: [],
        welcomeMessage: '',
        suggestions: [],
        tools: [],
    };
    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)
                );
            };
        },
    };
 }
@@ -0,0 +1,3 @@
 export * from './createGitBook';
 export * from './createGitBookFrame';
 export * from './protocol';
@@ -0,0 +1,90 @@
 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 GitBookEmbeddableButtonDefinition = {
    /**
     * 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 embeddable GitBook.
 */
 export type GitBookEmbeddableConfiguration = {
    /**
     * Buttons to be displayed in the header of the embeddable GitBook.
     */
    buttons: GitBookEmbeddableButtonDefinition[];
    /** Message to be displayed in the welcome page. */
    welcomeMessage: string;
    /** Suggestions of questions to be displayed in the welcome page. */
    suggestions: string[];
    /** Tools to be provided to the assistant. */
    tools: GitBookToolDefinition[];
 };
 /**
 * 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';
 };
@@ -0,0 +1 @@
 export * from './client';
@@ -0,0 +1,51 @@
 import React from 'react';
 import type {
    GetFrameURLOptions,
    GitBookEmbeddableConfiguration,
    GitBookFrameClient,
 } from '../client';
 import { useGitBook } from './GitBookProvider';
 export type GitBookFrameProps = {
    className?: string;
 } & GetFrameURLOptions &
    GitBookEmbeddableConfiguration;
 /**
 * Render a frame with the GitBook Assistant in it.
 */
 export function GitBookFrame(props: GitBookFrameProps) {
    const { className, visitor, buttons, welcomeMessage, suggestions, tools } = props;
    const frameRef = React.useRef<HTMLIFrameElement>(null);
    const gitbook = useGitBook();
    const [gitbookFrame, setGitbookFrame] = React.useState<GitBookFrameClient | null>(null);
    const frameURL = React.useMemo(() => gitbook.getFrameURL({ visitor }), [gitbook, visitor]);
    React.useEffect(() => {
        if (frameRef.current) {
            setGitbookFrame(gitbook.createFrame(frameRef.current));
        }
    }, [gitbook]);
    React.useEffect(() => {
        gitbookFrame?.configure({
            buttons,
            welcomeMessage,
            suggestions,
            tools,
        });
    }, [gitbookFrame, buttons, welcomeMessage, suggestions, tools]);
    return (
        <iframe
            title="GitBook"
            ref={frameRef}
            src={frameURL}
            width="100%"
            height="100%"
            className={className}
        />
    );
 }
@@ -0,0 +1,36 @@
 '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;
 }
@@ -0,0 +1,6 @@
 'use client';
 import * as React from 'react';
 import type { GitBookClient } from '../client';
 export const GitBookContext = React.createContext<GitBookClient | null>(null);
@@ -0,0 +1,2 @@
 export * from './GitBookProvider';
 export * from './GitBookFrame';
--- a/Show More
+++ b/Show More
		`@@ -0,0 +1,3 @@`
							# `@gitbook/browser-types`

							`Typescript types for the global variables available in a GitBook website. These types can be used by integrations embedding scripts.`
		`@@ -0,0 +1,2 @@`
							`export * from './GitBookProvider';`
							`export * from './GitBookFrame';`