Make Emoji component synchronous (#3417)

Co-authored-by: Nicolas Dorseuil <nicolas@gitbook.io>

.changeset/afraid-gifts-sparkle.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix UX issue about highlighting the search term in search result sections

.changeset/big-gorillas-perform.md

@@ -0,0 +1,9 @@
+---
+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

.changeset/breezy-falcons-drop.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Respect fullWidth and defaultWidth for images

.changeset/brown-ducks-think.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Hide scrollbar on sections

.changeset/clever-jokes-yell.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Add docs.testgitbook.com to ADAPTIVE_CONTENT_HOSTS list

.changeset/cold-buckets-divide.md

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

.changeset/cool-jars-matter.md

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

.changeset/cool-seas-approve.md

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

.changeset/curly-rules-learn.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Add support for inline icons.

.changeset/dry-pandas-rhyme.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix revision id for computed content

.changeset/fair-crews-wink.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Add circular corners and depth styling

.changeset/famous-melons-compete.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix crash when integration script fails to render block.

.changeset/fast-trees-battle.md

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

.changeset/few-cars-joke.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Display MCP tool calls in AI chat.

.changeset/fifty-ducks-press.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Improve support for OAuth2 security type

.changeset/flat-wolves-poke.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Adds Columns layout block to GBO

.changeset/forty-readers-mix.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Support dark-mode specific page cover image

.changeset/fresh-shrimps-flow.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Update Models page styling

.changeset/fuzzy-baboons-buy.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Show scrollbars

.changeset/fuzzy-tables-jump.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Optimize performances by using a smarter per-request cache arround data cached functions

.changeset/gorgeous-cycles-cheat.md

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

.changeset/gorgeous-cycles-grow.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Add support for icons in buttons.

.changeset/green-clouds-cough.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Fix rendering of ogimage with SVG logos.

.changeset/hip-bobcats-cover.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Best effort at preserving current variant when navigating between sections by matching the pathname against site spaces in the new section.

.changeset/khaki-bees-count.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix crash when integration is triggering invalid requests.

.changeset/lazy-colts-hammer.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Optimize the fetch of revision files by using only the getRevision cache.

.changeset/lazy-pants-matter.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+encode customization header

.changeset/long-cameras-protect.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Rework full-width layout, add support for full-width page option

.changeset/metal-trainers-nail.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix CodeBlock layout

.changeset/nasty-donkeys-sell.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Scroll to active TOC when clicking a link

.changeset/nasty-moles-visit.md

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

.changeset/neat-walls-drum.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Add support for text alignment for headings and paragraphs.

.changeset/nervous-students-judge.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix concurrent execution in Vercel causing pages to not be attached to the proper tags.

.changeset/orange-ears-drop.md

@@ -0,0 +1,5 @@
+---
+"@gitbook/react-contentkit": patch
+---
+
+Add basic error handling when transitioning between states.

.changeset/orange-hounds-sparkle.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Generate a llms-full.txt version of the docs site

.changeset/pink-windows-wonder.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Don't crash ogimage generation on RTL text, as a workaround until we can support it.

.changeset/plenty-laws-buy.md

@@ -0,0 +1,5 @@
+---
+gitbook: minor
+---
+
+Add support for site customization option to change how external links open.

.changeset/poor-dodos-lick.md

@@ -0,0 +1,5 @@
+---
+"@gitbook/fonts": minor
+---
+
+Initial version of the package

.changeset/pretty-balloons-fold.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix rendering of ogimage when logo or icon are AVIF images.

.changeset/purple-cougars-breathe.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Add margin to adjacent buttons

.changeset/rare-pens-whisper.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix ogimage generation failing with some JPEG images.

.changeset/real-trains-perform.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix page group not expanded by default

.changeset/real-walls-glow.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Don't cache unexpected API errors for more than a few minutes.

.changeset/rich-buses-hunt.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix an issue where PDF export URLs were not keeping their query params.

.changeset/rotten-crews-tie.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Fix markdown page generation for groups

.changeset/rotten-donuts-bow.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+add a global error boundary

.changeset/rotten-pianos-cheat.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Fix links to other spaces within a section.

.changeset/rotten-seals-rush.md

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

.changeset/rude-games-beg.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Add support for cover repositioning

.changeset/selfish-bananas-sneeze.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/react-openapi': patch
+'gitbook': patch
+---
+
+Handle nullish OpenAPI mediaTypeObject

.changeset/sharp-hats-applaud.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix missing title on button to close the announcement banner.

.changeset/sharp-jeans-burn.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Make icons for page groups more contrasting

.changeset/sixty-cows-pay.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Add AI chat

.changeset/slimy-cows-press.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Ignore case while highlighting search results.

.changeset/slimy-hornets-share.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Consistently show variant selector in section bar if site has sections

.changeset/slow-boxes-approve.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Include page group children under the .md route

.changeset/slow-lizards-obey.md

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

.changeset/slow-masks-agree.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Clicking an active TOC item toggles its descendants

.changeset/small-dots-report.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix viewing a page from a revision

.changeset/soft-walls-change.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix InlineLinkTooltip having a negative impact on performance, especially on larger pages.

.changeset/spotty-apples-crash.md

@@ -0,0 +1,6 @@
+---
+'@gitbook/openapi-parser': patch
+'@gitbook/react-openapi': patch
+---
+
+Optional label in OpenAPI x-codeSamples

.changeset/strong-poets-move.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix bold header links hover color

.changeset/stupid-plums-perform.md

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

.changeset/tame-mangos-battle.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix border being added to cards

.changeset/tender-poets-hang.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Add metadata for adding site to Apple devices home

.changeset/thick-chefs-repeat.md

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

.changeset/thick-cups-shout.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix crash during rendering of ogimage for VA sites with default icon.

.changeset/thin-buckets-grow.md

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

.changeset/thin-spiders-relate.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Allow to zoom images on mobile if relevant

.changeset/tidy-dots-suffer.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+apply customization for dynamic context

.changeset/tiny-zoos-scream.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Reverse order of feedback smileys

.changeset/violet-schools-care.md

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

.changeset/warm-roses-sleep.md

@@ -0,0 +1,5 @@
+---
+gitbook: patch
+---
+
+Fix ogimage using incorrect Google Font depending on language.

.changeset/wise-gifts-smash.md

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

.github/CODEOWNERS

@@ -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

.github/CONTRIBUTING.md

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

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

@@ -0,0 +1,83 @@
+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.10.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.10.0'
+            environment: ${{ inputs.environment }}
+            command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
+
+      # 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.10.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.10.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/composite/deploy-cloudflare/action.yaml

@@ -28,7 +28,7 @@ inputs:
 outputs:
     deployment-url: 
       description: "Deployment URL"
-      value: ${{ steps.deploy.outputs.deployment-url }}
+      value: ${{ steps.upload_middleware.outputs.deployment-url }}
 runs:
     using: 'composite'
     steps:
@@ -59,12 +59,12 @@ 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
-        - id: deploy
-          name: Deploy to Cloudflare
+
+        - name: Upload the DO worker
           uses: cloudflare/wrangler-action@v3.14.0
           with:
               apiToken: ${{ inputs.apiToken }}
@@ -72,10 +72,67 @@ runs:
               workingDirectory: ./
               wranglerVersion: '4.10.0'
               environment: ${{ inputs.environment }}
-              command: ${{ inputs.deploy == 'true' && 'deploy' || format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook-v2/wrangler.jsonc
+              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.10.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.10.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 }}
+
+
         - name: Outputs
           shell: bash
           env:
-            DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
+            DEPLOYMENT_URL: ${{ steps.upload_middleware.outputs.deployment-url }}
           run: |
-              echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+              echo "URL: ${{ steps.upload_middleware.outputs.deployment-url }}"
+              echo "Output server: ${{ steps.upload_server.outputs.command-output }}"

.github/workflows/deploy-preview.yaml

@@ -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,30 +93,11 @@ jobs:
 
                       ### Test content
 
-                      | 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) |
+                      | 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) |
                   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
@@ -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: 8
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Bun
-              uses: ./.github/composite/setup-bun
-            - name: Install dependencies
-              run: bun install --frozen-lockfile
-            - name: Setup Playwright
-              uses: ./.github/actions/setup-playwright
-            - name: Run Playwright tests
-              run: bun e2e-customers
-              env:
-                  BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
-                  ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
-                  ARGOS_BUILD_NAME: 'customers-v1'
     visual-testing-customers-v2:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v2
         needs: deploy-v2-vercel
-        timeout-minutes: 8
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -261,7 +165,7 @@ jobs:
         runs-on: ubuntu-latest
         name: Visual Testing Customers v2 (Cloudflare)
         needs: deploy-v2-cloudflare
-        timeout-minutes: 8
+        timeout-minutes: 10
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -278,10 +182,10 @@ jobs:
                   SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
                   ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
                   ARGOS_BUILD_NAME: 'customers-v2'
-    pagespeed-testing-v1:
+    pagespeed-testing-v2:
         runs-on: ubuntu-latest
         name: PageSpeed Testing v1
-        needs: deploy-v1-cloudflare
+        needs: deploy-v2-vercel
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -294,5 +198,5 @@ jobs:
             - name: Run pagespeed tests
               run: bun ./packages/gitbook/tests/pagespeed-testing.ts
               env:
-                  BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
+                  BASE_URL: ${{needs.deploy-v2-vercel.outputs.deployment-url}}
                   PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}

.github/workflows/publish.yaml

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

README.md

@@ -1,7 +1,7 @@
 <h1 align="center">GitBook</h1>
 
 <p align="center">
-  <a href="https://gitbook.com/docs/">Docs</a> - <a href="https://github.com/GitbookIO/community">Community</a> - <a href="https://developer.gitbook.com/">Developer Docs</a> - <a href="https://changelog.gitbook.com/">Changelog</a> - <a href="https://github.com/GitbookIO/gitbook/issues/new?assignees=&labels=bug&template=bug_report.md">Bug reports</a> 
+  <a href="https://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">
@@ -36,9 +36,9 @@ To run a local version of this project, please follow these simple steps.
 ### Prerequisites
 
 -   Node.js (Version: >=20.6)
-  - Use nvm for easy Node management
+    - 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
+    - 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:v2
+bun dev
 ```
 
-5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
+6. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/url`.
 
 examples:
 
@@ -71,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.
@@ -150,11 +145,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://gitbook.com/)
+[![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)
 ```
 
 ```html
-<a href="https://gitbook.com">
+<a href="https://www.gitbook.com/preview?utm_source=gitbook_readme_badge&utm_medium=organic&utm_campaign=preview_documentation&utm_content=link">
     <img
         src="https://img.shields.io/static/v1?message=Documented%20on%20GitBook&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"
     />

biome.json

@@ -21,7 +21,7 @@
             "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"
         ]
     },
     "formatter": {
@@ -127,7 +127,6 @@
         {
             "include": [
                 "packages/gitbook/**/*",
-                "packages/gitbook-v2/**/*",
                 "packages/react-openapi/**/*",
                 "packages/react-math/**/*",
                 "packages/react-contentkit/**/*",

package.json

@@ -7,19 +7,17 @@
         "turbo": "^2.5.0",
         "vercel": "^39.3.0"
     },
-    "packageManager": "bun@1.2.11",
+    "packageManager": "bun@1.2.15",
     "overrides": {
         "@codemirror/state": "6.4.1",
-        "@gitbook/api": "^0.115.0",
         "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: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 ./",
@@ -30,11 +28,15 @@
         "changeset": "changeset",
         "changeset-version": "changeset version && bun run format",
         "release": "turbo run release && changeset publish",
-        "release:preview": "turbo run release:preview",
         "download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
         "clean": "turbo run clean"
     },
-    "workspaces": ["packages/*"],
+    "workspaces": {
+        "packages": ["packages/*"],
+        "catalog": {
+            "@gitbook/api": "^0.125.0"
+        }
+    },
     "patchedDependencies": {
         "decode-named-character-reference@1.0.2": "patches/decode-named-character-reference@1.0.2.patch",
         "@vercel/next@4.4.2": "patches/@vercel%2Fnext@4.4.2.patch"

packages/cache-do/.gitignore

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

packages/cache-do/CHANGELOG.md

@@ -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

packages/cache-do/README.md

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

packages/cache-do/package.json

@@ -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"]
-}

packages/cache-do/src/CacheObject.ts

@@ -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;
-}

packages/cache-do/src/CacheObjectStub.ts

@@ -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}`;
-}

packages/cache-do/src/api.ts

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

packages/cache-do/src/index.ts

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

packages/cache-do/turbo.json

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

packages/cache-do/wrangler.toml

@@ -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

packages/cache-tags/package.json

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

packages/fonts/.gitignore

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

packages/fonts/README.md

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

packages/fonts/bin/generate.ts

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

packages/fonts/package.json

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

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

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