mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-14 06:35:17 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 81af6bb077 |
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix an issue with the cookie banner buttons being non responsive
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/cache-do': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Disable cloudflare observability in production
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Update styling of search+ask modal
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix a regression in variant drop-down caused by missing z-index.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Add scroll margin to the top when there are sections
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Smoother tab transition for sections
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': minor
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix an issue where the active site section indicator appeared above any dropdowns.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Don't adjust fallback font for mono font.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fixed scalar api client routing
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Optimize performances by using new API endpoint for fetching site data.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Bump @scalar/api-client-react version
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Support Integers in Response example
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Restyle hint blocks
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix security issue with image resizing that could be used for phishing
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
bumped the scalar api client dependency
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Bumped scalar api client pacakge
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': minor
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix an issue where the space dropdown was shown under the site sections in Safari.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix - whitespace added to site section tabs with icons.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Add icons to sections
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
style: adds missing scalar css variables
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': minor
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix an issue where the space dropdown could appear behind the header.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': minor
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix the styling of site section tabs on smaller screens.
|
||||||
@@ -12,7 +12,7 @@ runs:
|
|||||||
|
|
||||||
# Cache browser binaries, cache key is based on Playwright version and OS
|
# Cache browser binaries, cache key is based on Playwright version and OS
|
||||||
- name: 🧰 Cache Playwright browser binaries
|
- name: 🧰 Cache Playwright browser binaries
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v3
|
||||||
id: playwright-cache
|
id: playwright-cache
|
||||||
with:
|
with:
|
||||||
path: '~/.cache/ms-playwright'
|
path: '~/.cache/ms-playwright'
|
||||||
|
|||||||
@@ -1,81 +0,0 @@
|
|||||||
name: 'Deploy cloudflare'
|
|
||||||
description: 'Deploy GitBook to Cloudflare'
|
|
||||||
inputs:
|
|
||||||
opItem:
|
|
||||||
description: '1Password item to load secrets from'
|
|
||||||
required: true
|
|
||||||
opServiceAccount:
|
|
||||||
description: '1Password service account token'
|
|
||||||
required: true
|
|
||||||
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
|
|
||||||
deploy:
|
|
||||||
description: 'Deploy as main version for all traffic instead of uploading versions'
|
|
||||||
required: true
|
|
||||||
commitTag:
|
|
||||||
description: 'Commit branch to associate with the deployment'
|
|
||||||
required: true
|
|
||||||
commitMessage:
|
|
||||||
description: 'Commit message to associate with the deployment'
|
|
||||||
required: true
|
|
||||||
outputs:
|
|
||||||
deployment-url:
|
|
||||||
description: "Deployment URL"
|
|
||||||
value: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
runs:
|
|
||||||
using: 'composite'
|
|
||||||
steps:
|
|
||||||
- name: Setup Bun
|
|
||||||
uses: ./.github/composite/setup-bun
|
|
||||||
- name: Install dependencies
|
|
||||||
run: bun install --frozen-lockfile
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
PUPPETEER_SKIP_DOWNLOAD: 1
|
|
||||||
- name: Load secret
|
|
||||||
uses: 1password/load-secrets-action@v2
|
|
||||||
env:
|
|
||||||
OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
|
|
||||||
GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
|
|
||||||
GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
|
|
||||||
GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
|
|
||||||
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ inputs.opItem }}/NEXT_SERVER_ACTIONS_ENCRYPTION_KEY
|
|
||||||
GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
|
|
||||||
GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
|
|
||||||
GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
|
|
||||||
GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
|
|
||||||
GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
|
|
||||||
GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
|
|
||||||
GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
|
|
||||||
GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
|
|
||||||
GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
|
|
||||||
GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
|
|
||||||
GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
|
|
||||||
- name: Build worker
|
|
||||||
run: bun run turbo build:v2:cloudflare
|
|
||||||
env:
|
|
||||||
GITBOOK_RUNTIME: cloudflare
|
|
||||||
shell: bash
|
|
||||||
- id: deploy
|
|
||||||
name: Deploy to Cloudflare
|
|
||||||
uses: cloudflare/wrangler-action@v3.14.0
|
|
||||||
with:
|
|
||||||
apiToken: ${{ inputs.apiToken }}
|
|
||||||
accountId: ${{ inputs.accountId }}
|
|
||||||
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
|
|
||||||
- name: Outputs
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
run: |
|
|
||||||
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
name: 'Deploy vercel'
|
|
||||||
description: 'Deploy GitBook to Vercel'
|
|
||||||
inputs:
|
|
||||||
vercelOrg:
|
|
||||||
description: 'Vercel organization'
|
|
||||||
required: true
|
|
||||||
vercelProject:
|
|
||||||
description: 'Vercel project'
|
|
||||||
required: true
|
|
||||||
vercelToken:
|
|
||||||
description: 'Vercel token'
|
|
||||||
required: true
|
|
||||||
opItem:
|
|
||||||
description: '1Password item to load secrets from'
|
|
||||||
required: true
|
|
||||||
opServiceAccount:
|
|
||||||
description: '1Password service account token'
|
|
||||||
required: true
|
|
||||||
environment:
|
|
||||||
description: 'Environment to deploy to'
|
|
||||||
required: true
|
|
||||||
outputs:
|
|
||||||
deployment-url:
|
|
||||||
description: "Deployment URL"
|
|
||||||
value: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
runs:
|
|
||||||
using: 'composite'
|
|
||||||
steps:
|
|
||||||
- name: Setup Bun
|
|
||||||
uses: ./.github/composite/setup-bun
|
|
||||||
- name: Install dependencies
|
|
||||||
run: bun install --frozen-lockfile
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
PUPPETEER_SKIP_DOWNLOAD: 1
|
|
||||||
- name: Pull Vercel Environment Information
|
|
||||||
run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
|
|
||||||
VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
|
|
||||||
- name: Load secret
|
|
||||||
uses: 1password/load-secrets-action@v2
|
|
||||||
env:
|
|
||||||
OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.opServiceAccount }}
|
|
||||||
GITBOOK_URL: ${{ inputs.opItem }}/GITBOOK_URL
|
|
||||||
GITBOOK_ICONS_URL: ${{ inputs.opItem }}/GITBOOK_ICONS_URL
|
|
||||||
GITBOOK_ICONS_TOKEN: ${{ inputs.opItem }}/GITBOOK_ICONS_TOKEN
|
|
||||||
GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
|
|
||||||
GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
|
|
||||||
GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
|
|
||||||
GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
|
|
||||||
GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
|
|
||||||
GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
|
|
||||||
GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
|
|
||||||
GITBOOK_IMAGE_RESIZE_URL: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_URL
|
|
||||||
GITBOOK_IMAGE_RESIZE_MODE: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_MODE
|
|
||||||
GITBOOK_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
|
|
||||||
GITBOOK_FONTS_URL: ${{ inputs.opItem }}/GITBOOK_FONTS_URL
|
|
||||||
- name: Build Project Artifacts
|
|
||||||
run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
|
|
||||||
shell: bash
|
|
||||||
env:
|
|
||||||
VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
|
|
||||||
VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
|
|
||||||
GITBOOK_RUNTIME: vercel
|
|
||||||
- name: Deploy Project Artifacts to Vercel
|
|
||||||
id: deploy
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }})
|
|
||||||
echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
|
|
||||||
env:
|
|
||||||
VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
|
|
||||||
VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
|
|
||||||
- name: Outputs
|
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
name: 'Setup Bun'
|
|
||||||
description: 'Install Bun and cache dependencies'
|
|
||||||
runs:
|
|
||||||
using: 'composite'
|
|
||||||
steps:
|
|
||||||
- name: Setup bun
|
|
||||||
uses: oven-sh/setup-bun@v2
|
|
||||||
with:
|
|
||||||
bun-version-file: 'package.json'
|
|
||||||
+182
-19
@@ -5,31 +5,192 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
NPMRC_FONT_AWESOME_TOKEN: ${{ secrets.NPMRC_FONT_AWESOME_TOKEN }}
|
||||||
jobs:
|
jobs:
|
||||||
format:
|
deploy:
|
||||||
|
name: Deploy to Cloudflare Pages
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Format
|
permissions:
|
||||||
timeout-minutes: 6
|
contents: read
|
||||||
|
deployments: write
|
||||||
|
issues: write
|
||||||
|
pull-requests: write
|
||||||
|
checks: write
|
||||||
|
statuses: write
|
||||||
|
outputs:
|
||||||
|
deployment_url: ${{ steps.deploy.outputs.deployment-url }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Setup Bun
|
- name: Setup bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
|
- name: Install dependencies
|
||||||
|
run: bun install --frozen-lockfile
|
||||||
|
env:
|
||||||
|
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||||
|
- name: Cache Next.js build
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
${{ github.workspace }}/.next/cache
|
||||||
|
# Generate a new cache whenever packages or source files change.
|
||||||
|
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
|
||||||
|
# If source files changed but packages didn't, rebuild from a prior cache.
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-
|
||||||
|
- name: Sets env vars for production
|
||||||
|
run: |
|
||||||
|
echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
|
||||||
|
echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
|
||||||
|
if: startsWith(github.ref, 'refs/heads/main')
|
||||||
|
- name: Sets env vars for preview
|
||||||
|
run: |
|
||||||
|
echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
|
||||||
|
if: 1 && !startsWith(github.ref, 'refs/heads/main')
|
||||||
|
- name: Build Next.js with next-on-pages
|
||||||
|
run: bun run build:cloudflare
|
||||||
|
env:
|
||||||
|
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
|
||||||
|
SENTRY_ORG: ${{ vars.SENTRY_ORG }}
|
||||||
|
SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
|
||||||
|
SENTRY_DSN: ${{ vars.SENTRY_DSN }}
|
||||||
|
- id: deploy
|
||||||
|
name: Deploy to Cloudflare
|
||||||
|
uses: cloudflare/wrangler-action@v3.11.0
|
||||||
|
with:
|
||||||
|
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||||
|
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||||
|
workingDirectory: ./
|
||||||
|
wranglerVersion: '3.82.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 }}"
|
||||||
|
- name: Archive build output
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: build-output
|
||||||
|
path: .vercel/
|
||||||
|
# Until https://github.com/cloudflare/wrangler-action/issues/301 is done
|
||||||
|
- name: Update Deployment Status to Success
|
||||||
|
env:
|
||||||
|
DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
|
||||||
|
run: |
|
||||||
|
curl -X POST \
|
||||||
|
-H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
|
||||||
|
-H "Accept: application/vnd.github.v3+json" \
|
||||||
|
-d '{"state": "success", "target_url": "${{ steps.deploy.outputs.deployment-url }}", "description": "Deployed Preview URL for commit", "context": "cloudflare/preview"}' \
|
||||||
|
https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }}
|
||||||
|
|
||||||
|
- name: Find GitHub Comment
|
||||||
|
uses: peter-evans/find-comment@v3
|
||||||
|
id: fc
|
||||||
|
if: 1 && !startsWith(github.ref, 'refs/heads/main')
|
||||||
|
with:
|
||||||
|
issue-number: ${{ github.event.pull_request.number }}
|
||||||
|
comment-author: 'github-actions[bot]'
|
||||||
|
body-includes: GitBook Preview
|
||||||
|
|
||||||
|
- name: Create or update GitHub comment
|
||||||
|
uses: peter-evans/create-or-update-comment@v4
|
||||||
|
if: 1 && !startsWith(github.ref, 'refs/heads/main')
|
||||||
|
with:
|
||||||
|
comment-id: ${{ steps.fc.outputs.comment-id }}
|
||||||
|
issue-number: ${{ github.event.pull_request.number }}
|
||||||
|
body: |
|
||||||
|
**GitBook Preview**
|
||||||
|
Latest commit: [${{ steps.deploy.outputs.deployment-url }}](${{ steps.deploy.outputs.deployment-url }})
|
||||||
|
PR: [${{ steps.deploy.outputs.deployment-alias-url }}](${{ steps.deploy.outputs.deployment-alias-url }})
|
||||||
|
edit-mode: replace
|
||||||
|
visual-testing:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: Visual Testing
|
||||||
|
needs: deploy
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Setup bun
|
||||||
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
|
- 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.outputs.deployment_url}}
|
||||||
|
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
|
||||||
|
- uses: actions/upload-artifact@v4
|
||||||
|
if: ${{ !cancelled() }}
|
||||||
|
with:
|
||||||
|
name: playwright-test-results
|
||||||
|
path: packages/gitbook/test-results/
|
||||||
|
retention-days: 3
|
||||||
|
pagespeed-testing:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: PageSpeed Testing
|
||||||
|
needs: deploy
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Setup bun
|
||||||
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
|
- name: Install dependencies
|
||||||
|
run: bun install --frozen-lockfile
|
||||||
|
env:
|
||||||
|
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||||
|
- name: Run pagespeed tests
|
||||||
|
run: bun ./packages/gitbook/tests/pagespeed-testing.ts $DEPLOYMENT_URL
|
||||||
|
env:
|
||||||
|
DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment_url}}
|
||||||
|
PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
|
||||||
|
format:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: Format
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Setup bun
|
||||||
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
PUPPETEER_SKIP_DOWNLOAD: 1
|
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||||
- run: bun format:check
|
- run: bun format:check
|
||||||
test:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Test
|
name: Lint
|
||||||
timeout-minutes: 6
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Setup Bun
|
- name: Setup bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
|
- name: Install dependencies
|
||||||
|
run: bun install --frozen-lockfile
|
||||||
|
env:
|
||||||
|
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||||
|
- run: bun lint --no-cache
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
name: Test
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Setup bun
|
||||||
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
@@ -39,28 +200,30 @@ jobs:
|
|||||||
# CI to check that the repository builds correctly on a machine without the credentials
|
# CI to check that the repository builds correctly on a machine without the credentials
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Build (Open Source)
|
name: Build (Open Source)
|
||||||
timeout-minutes: 6
|
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ''
|
NPMRC_FONT_AWESOME_TOKEN: ''
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Setup Bun
|
- name: Setup bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
PUPPETEER_SKIP_DOWNLOAD: 1
|
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||||
- run: bun run build
|
- run: bun run build
|
||||||
typecheck:
|
typecheck:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
name: Typecheck
|
name: Typecheck
|
||||||
timeout-minutes: 6
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Setup Bun
|
- name: Setup bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -1,300 +0,0 @@
|
|||||||
name: Preview
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
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
|
|
||||||
environment:
|
|
||||||
name: 2v-preview
|
|
||||||
url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
outputs:
|
|
||||||
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Deploy to Vercel
|
|
||||||
id: deploy
|
|
||||||
uses: ./.github/composite/deploy-vercel
|
|
||||||
with:
|
|
||||||
environment: preview
|
|
||||||
vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
|
|
||||||
vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
|
|
||||||
vercelToken: ${{ secrets.VERCEL_TOKEN }}
|
|
||||||
opItem: op://gitbook-open/2v-preview
|
|
||||||
opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
|
|
||||||
deploy-v2-cloudflare:
|
|
||||||
name: Deploy v2 to Cloudflare Worker (preview)
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 2c-preview
|
|
||||||
url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
outputs:
|
|
||||||
deployment-url: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Deploy to Cloudflare
|
|
||||||
id: deploy
|
|
||||||
uses: ./.github/composite/deploy-cloudflare
|
|
||||||
with:
|
|
||||||
environment: preview
|
|
||||||
deploy: ${{ github.ref == 'refs/heads/main' }}
|
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
opItem: op://gitbook-open/2c-preview
|
|
||||||
opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
|
|
||||||
commitTag: ${{ github.ref == 'refs/heads/main' && 'main' || format('pr{0}', github.event.pull_request.number) }}
|
|
||||||
commitMessage: ${{ github.sha }}
|
|
||||||
- name: Extract Worker ID
|
|
||||||
id: extract-worker-id
|
|
||||||
if: ${{ !steps.deploy.outputs.deployment-url }}
|
|
||||||
run: |
|
|
||||||
if [[ "${{ steps.deploy.outputs.command-output }}" =~ Worker\ Version\ ID:\ ([0-9a-f]{8})-([0-9a-f-]+) ]]; then
|
|
||||||
WORKER_ID_FIRST_PART="${BASH_REMATCH[1]}"
|
|
||||||
echo "worker-url=https://${WORKER_ID_FIRST_PART}-gitbook-open-v2-preview.gitbook.workers.dev/" >> $GITHUB_OUTPUT
|
|
||||||
fi
|
|
||||||
- name: Outputs
|
|
||||||
run: |
|
|
||||||
echo "URL: ${{ steps.deploy.outputs.deployment-url || steps.extract-worker-id.outputs.worker-url }}"
|
|
||||||
comment-deployments:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: Comment Deployments (preview)
|
|
||||||
if: always() && !startsWith(github.ref, 'refs/heads/main')
|
|
||||||
needs:
|
|
||||||
- deploy-v1-cloudflare
|
|
||||||
- deploy-v2-vercel
|
|
||||||
- deploy-v2-cloudflare
|
|
||||||
steps:
|
|
||||||
- name: Find GitHub Comment
|
|
||||||
uses: peter-evans/find-comment@v3
|
|
||||||
id: fc
|
|
||||||
with:
|
|
||||||
issue-number: ${{ github.event.pull_request.number }}
|
|
||||||
comment-author: 'github-actions[bot]'
|
|
||||||
body-includes: 'Summary of the deployments'
|
|
||||||
|
|
||||||
- name: Create or update GitHub comment
|
|
||||||
uses: peter-evans/create-or-update-comment@v4
|
|
||||||
with:
|
|
||||||
comment-id: ${{ steps.fc.outputs.comment-id }}
|
|
||||||
issue-number: ${{ github.event.pull_request.number }}
|
|
||||||
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' && '✅' || '❌' }} |
|
|
||||||
| Cloudflare | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}) | ${{ needs.deploy-v2-cloudflare.result == 'success' && '✅' || '❌' }} |
|
|
||||||
|
|
||||||
### Test content
|
|
||||||
|
|
||||||
| Site | `v1` | `2v` | `2c` |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| GitBook | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/docs.gitbook.com) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/docs.gitbook.com) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/docs.gitbook.com) |
|
|
||||||
| E2E | [${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) | [${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/gitbook.gitbook.io/test-gitbook-open) |
|
|
||||||
edit-mode: replace
|
|
||||||
visual-testing-v1:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: Visual Testing v1
|
|
||||||
needs: deploy-v1-cloudflare
|
|
||||||
timeout-minutes: 8
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Setup Bun
|
|
||||||
uses: ./.github/composite/setup-bun
|
|
||||||
- name: Install dependencies
|
|
||||||
run: bun install --frozen-lockfile
|
|
||||||
- name: Setup Playwright
|
|
||||||
uses: ./.github/actions/setup-playwright
|
|
||||||
- name: Run Playwright tests
|
|
||||||
run: bun e2e
|
|
||||||
env:
|
|
||||||
BASE_URL: ${{ needs.deploy-v1-cloudflare.outputs.deployment-url }}
|
|
||||||
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
|
|
||||||
visual-testing-v2-vercel:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: Visual Testing v2
|
|
||||||
needs: deploy-v2-vercel
|
|
||||||
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-v2-vercel.outputs.deployment-url }}
|
|
||||||
SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
|
|
||||||
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
|
|
||||||
ARGOS_BUILD_NAME: 'v2-vercel'
|
|
||||||
visual-testing-v2-cloudflare:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: Visual Testing v2 (Cloudflare)
|
|
||||||
needs: deploy-v2-cloudflare
|
|
||||||
timeout-minutes: 10
|
|
||||||
if: startsWith(github.head_ref || github.ref_name, 'cloudflare/') || github.ref == 'refs/heads/main'
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Setup Bun
|
|
||||||
uses: ./.github/composite/setup-bun
|
|
||||||
- name: Install dependencies
|
|
||||||
run: bun install --frozen-lockfile
|
|
||||||
- name: Setup Playwright
|
|
||||||
uses: ./.github/actions/setup-playwright
|
|
||||||
- name: Run Playwright tests
|
|
||||||
run: bun e2e
|
|
||||||
env:
|
|
||||||
BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
|
|
||||||
SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
|
|
||||||
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
|
|
||||||
ARGOS_BUILD_NAME: 'v2-cloudflare'
|
|
||||||
visual-testing-customers-v1:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: Visual Testing Customers v1
|
|
||||||
needs: deploy-v1-cloudflare
|
|
||||||
timeout-minutes: 8
|
|
||||||
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
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Setup Bun
|
|
||||||
uses: ./.github/composite/setup-bun
|
|
||||||
- name: Install dependencies
|
|
||||||
run: bun install --frozen-lockfile
|
|
||||||
- name: Setup Playwright
|
|
||||||
uses: ./.github/actions/setup-playwright
|
|
||||||
- name: Run Playwright tests
|
|
||||||
run: bun e2e-customers
|
|
||||||
env:
|
|
||||||
BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}
|
|
||||||
SITE_BASE_URL: ${{ needs.deploy-v2-vercel.outputs.deployment-url }}/url/
|
|
||||||
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
|
|
||||||
ARGOS_BUILD_NAME: 'customers-v2'
|
|
||||||
visual-testing-customers-v2-cloudflare:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: Visual Testing Customers v2 (Cloudflare)
|
|
||||||
needs: deploy-v2-cloudflare
|
|
||||||
timeout-minutes: 8
|
|
||||||
if: startsWith(github.head_ref || github.ref_name, 'cloudflare/') || github.ref == 'refs/heads/main'
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Setup Bun
|
|
||||||
uses: ./.github/composite/setup-bun
|
|
||||||
- name: Install dependencies
|
|
||||||
run: bun install --frozen-lockfile
|
|
||||||
- name: Setup Playwright
|
|
||||||
uses: ./.github/actions/setup-playwright
|
|
||||||
- name: Run Playwright tests
|
|
||||||
run: bun e2e-customers
|
|
||||||
env:
|
|
||||||
BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}
|
|
||||||
SITE_BASE_URL: ${{ needs.deploy-v2-cloudflare.outputs.deployment-url }}/url/
|
|
||||||
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
|
|
||||||
ARGOS_BUILD_NAME: 'customers-v2'
|
|
||||||
pagespeed-testing-v1:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
name: PageSpeed Testing v1
|
|
||||||
needs: deploy-v1-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 pagespeed tests
|
|
||||||
run: bun ./packages/gitbook/tests/pagespeed-testing.ts
|
|
||||||
env:
|
|
||||||
BASE_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
|
|
||||||
PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
name: Production
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
env:
|
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
|
||||||
jobs:
|
|
||||||
deploy-v2-vercel:
|
|
||||||
name: Deploy v2 to Vercel (production)
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 2v-production
|
|
||||||
url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
outputs:
|
|
||||||
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Deploy
|
|
||||||
id: deploy
|
|
||||||
uses: ./.github/composite/deploy-vercel
|
|
||||||
with:
|
|
||||||
environment: production
|
|
||||||
vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
|
|
||||||
vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
|
|
||||||
vercelToken: ${{ secrets.VERCEL_TOKEN }}
|
|
||||||
opItem: op://gitbook-open/2v-production
|
|
||||||
opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
|
|
||||||
deploy-v2-cloudflare:
|
|
||||||
name: Deploy v2 to Cloudflare Worker (production)
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 2c-production
|
|
||||||
url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
outputs:
|
|
||||||
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Deploy
|
|
||||||
id: deploy
|
|
||||||
uses: ./.github/composite/deploy-cloudflare
|
|
||||||
with:
|
|
||||||
environment: production
|
|
||||||
deploy: true
|
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
opItem: op://gitbook-open/2c-production
|
|
||||||
opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
|
|
||||||
commitTag: main
|
|
||||||
commitMessage: ${{ github.sha }}
|
|
||||||
- name: Outputs
|
|
||||||
run: |
|
|
||||||
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
|
|
||||||
@@ -1,55 +0,0 @@
|
|||||||
name: Staging
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
env:
|
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
|
||||||
jobs:
|
|
||||||
deploy-v2-vercel:
|
|
||||||
name: Deploy v2 to Vercel (staging)
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 2v-staging
|
|
||||||
url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
outputs:
|
|
||||||
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Deploy
|
|
||||||
id: deploy
|
|
||||||
uses: ./.github/composite/deploy-vercel
|
|
||||||
with:
|
|
||||||
environment: staging
|
|
||||||
vercelOrg: ${{ secrets.VERCEL_ORG_ID }}
|
|
||||||
vercelProject: ${{ secrets.VERCEL_PROJECT_ID }}
|
|
||||||
vercelToken: ${{ secrets.VERCEL_TOKEN }}
|
|
||||||
opItem: op://gitbook-open/2v-staging
|
|
||||||
opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
|
|
||||||
deploy-v2-cloudflare:
|
|
||||||
name: Deploy v2 to Cloudflare Worker (staging)
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 2c-staging
|
|
||||||
url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
outputs:
|
|
||||||
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Deploy
|
|
||||||
id: deploy
|
|
||||||
uses: ./.github/composite/deploy-cloudflare
|
|
||||||
with:
|
|
||||||
environment: staging
|
|
||||||
deploy: true
|
|
||||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
opItem: op://gitbook-open/2c-staging
|
|
||||||
opServiceAccount: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
|
|
||||||
commitTag: main
|
|
||||||
commitMessage: ${{ github.sha }}
|
|
||||||
- name: Outputs
|
|
||||||
run: |
|
|
||||||
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
|
|
||||||
@@ -5,9 +5,6 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
|
||||||
env:
|
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
|
||||||
|
|
||||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -20,8 +17,10 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
|
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Setup Bun
|
- name: Setup bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
@@ -31,7 +30,6 @@ jobs:
|
|||||||
uses: changesets/action@v1
|
uses: changesets/action@v1
|
||||||
with:
|
with:
|
||||||
publish: npm run release
|
publish: npm run release
|
||||||
version: npm run changeset-version
|
|
||||||
env:
|
env:
|
||||||
# Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
|
# Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
|
||||||
# https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
|
# https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
|
||||||
@@ -47,8 +45,10 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout Repo
|
- name: Checkout Repo
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
- name: Setup Bun
|
- name: Setup bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: oven-sh/setup-bun@v1
|
||||||
|
with:
|
||||||
|
bun-version: 1.1.18
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -22,6 +22,3 @@ yarn-error.log*
|
|||||||
|
|
||||||
# Env files
|
# Env files
|
||||||
.env.local
|
.env.local
|
||||||
|
|
||||||
# TypeScript
|
|
||||||
*.tsbuildinfo
|
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
.next
|
||||||
|
.vercel
|
||||||
|
|
||||||
|
# Generated
|
||||||
|
packages/emoji-codepoints/index.ts
|
||||||
|
packages/gitbook/public/~gitbook/static/
|
||||||
|
packages/icons/src/data/*.json
|
||||||
|
|
||||||
|
# Build files
|
||||||
|
dist/
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"printWidth": 100,
|
||||||
|
"singleQuote": true,
|
||||||
|
"tabWidth": 4
|
||||||
|
}
|
||||||
Vendored
-3
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
"recommendations": ["biomejs.biome"]
|
|
||||||
}
|
|
||||||
Vendored
+1
-10
@@ -7,14 +7,5 @@
|
|||||||
["style \\=([^;]*);", "\"([^\"]*)\""],
|
["style \\=([^;]*);", "\"([^\"]*)\""],
|
||||||
["style \\=([^;]*);", "\\`([^\\`]*)\\`"]
|
["style \\=([^;]*);", "\\`([^\\`]*)\\`"]
|
||||||
],
|
],
|
||||||
"tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"],
|
"tailwindCSS.classAttributes": ["class", "className", "style", ".*Style"]
|
||||||
"prettier.enable": false,
|
|
||||||
"editor.defaultFormatter": "biomejs.biome",
|
|
||||||
"editor.codeActionsOnSave": {
|
|
||||||
"source.organizeImports.biome": "explicit",
|
|
||||||
"source.fixAll.biome": "explicit"
|
|
||||||
},
|
|
||||||
"[typescript]": {
|
|
||||||
"editor.defaultFormatter": "biomejs.biome"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -35,10 +35,8 @@ To run a local version of this project, please follow these simple steps.
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Node.js (Version: >=20.6)
|
- Node.js (Version: >=18.x)
|
||||||
- Use nvm for easy Node management
|
- Bun
|
||||||
- Bun (Version: >=1.2.1)
|
|
||||||
- We use a text-based lockfile which isn't supported below 1.2.1
|
|
||||||
|
|
||||||
### Set up
|
### Set up
|
||||||
|
|
||||||
@@ -59,15 +57,15 @@ bun install
|
|||||||
4. Start your local development server.
|
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/`.
|
5. Open a published GitBook space in your web browser, prefixing it with `http://localhost:3000/`.
|
||||||
|
|
||||||
examples:
|
examples:
|
||||||
|
|
||||||
- http://localhost:3000/url/docs.gitbook.com
|
- http://localhost:3000/docs.gitbook.com
|
||||||
- http://localhost:3000/url/open-source.gitbook.io/midjourney
|
- http://localhost:3000/open-source.gitbook.io/midjourney
|
||||||
|
|
||||||
Any published GitBook site can be accessed through your local development instance, and any updates you make to the codebase will be reflected in your browser.
|
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.
|
||||||
|
|
||||||
@@ -80,26 +78,6 @@ Any published GitBook site can be accessed through your local development instan
|
|||||||
|
|
||||||
All pull-requests will be tested against both visual and performances testing to prevent regressions.
|
All pull-requests will be tested against both visual and performances testing to prevent regressions.
|
||||||
|
|
||||||
## Fonts and Icons
|
|
||||||
|
|
||||||
GitBook Open uses fontawesome. During development, your local environment will use the free version. However, only the pro version will be accepted by CI. If you see the following error:
|
|
||||||
|
|
||||||
```
|
|
||||||
The GitBook icon is missing. It indicates that the dependencies were installed without the correct font-awesome package. These changes have probably been persisted in the Bun lockfile. Read the README for more information.
|
|
||||||
```
|
|
||||||
|
|
||||||
It means that you've changed the GBO dependencies and bundled in the free version. Only GitBook staff can help with this - if you're not on the GitBook team, please ping us in the PR and we'll help get things moving.
|
|
||||||
|
|
||||||
If you are GitBook staff, you'll need our NPM token in your local environment.
|
|
||||||
|
|
||||||
```
|
|
||||||
.env.local
|
|
||||||
|
|
||||||
NPM_TOKEN_READONLY=xxx
|
|
||||||
```
|
|
||||||
|
|
||||||
and then reinstall dependencies.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
GitBook's rendering engine is fully open source and built on top of [Next.js](https://nextjs.org/). Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to learn more about the workflow on adding your first Pull Request.
|
GitBook's rendering engine is fully open source and built on top of [Next.js](https://nextjs.org/). Head to our [contributing guide](https://github.com/GitbookIO/gitbook/blob/main/.github/CONTRIBUTING.md) to learn more about the workflow on adding your first Pull Request.
|
||||||
|
|||||||
-176
@@ -1,176 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
|
|
||||||
"vcs": {
|
|
||||||
"enabled": false,
|
|
||||||
"clientKind": "git",
|
|
||||||
"useIgnoreFile": false
|
|
||||||
},
|
|
||||||
"files": {
|
|
||||||
"ignoreUnknown": false,
|
|
||||||
"ignore": [
|
|
||||||
"**/node_modules/**/*",
|
|
||||||
"**/dist/**/*",
|
|
||||||
"**/build/**/*",
|
|
||||||
"**/public/**/*",
|
|
||||||
"**/.next/**/*",
|
|
||||||
"**/.open-next/**/*",
|
|
||||||
"**/.turbo/**/*",
|
|
||||||
"**/.vercel/**/*",
|
|
||||||
"**/.cache/**/*",
|
|
||||||
"**/.wrangler/**/*",
|
|
||||||
"packages/openapi-parser/src/fixtures/**/*",
|
|
||||||
"packages/emoji-codepoints/index.ts",
|
|
||||||
"packages/icons/src/data/*.json",
|
|
||||||
"packages/cache-do/worker-configuration.d.ts"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"formatter": {
|
|
||||||
"enabled": true,
|
|
||||||
"useEditorconfig": true,
|
|
||||||
"formatWithErrors": false,
|
|
||||||
"indentStyle": "space",
|
|
||||||
"indentWidth": 4,
|
|
||||||
"lineEnding": "lf",
|
|
||||||
"lineWidth": 100,
|
|
||||||
"attributePosition": "auto",
|
|
||||||
"bracketSpacing": true
|
|
||||||
},
|
|
||||||
"organizeImports": {
|
|
||||||
"enabled": true
|
|
||||||
},
|
|
||||||
"linter": {
|
|
||||||
"enabled": true,
|
|
||||||
"rules": {
|
|
||||||
"recommended": true,
|
|
||||||
"performance": {
|
|
||||||
"noDelete": "warn"
|
|
||||||
},
|
|
||||||
"security": {
|
|
||||||
"noDangerouslySetInnerHtml": "off"
|
|
||||||
},
|
|
||||||
"complexity": {
|
|
||||||
"noForEach": "off",
|
|
||||||
"noUselessFragments": "warn",
|
|
||||||
"noBannedTypes": "warn"
|
|
||||||
},
|
|
||||||
"correctness": {
|
|
||||||
"noUndeclaredVariables": "error",
|
|
||||||
"noUnusedVariables": "error",
|
|
||||||
"useArrayLiterals": "error",
|
|
||||||
"useHookAtTopLevel": "error",
|
|
||||||
"noUnusedImports": "error",
|
|
||||||
"noVoidElementsWithChildren": "warn",
|
|
||||||
"useJsxKeyInIterable": "warn",
|
|
||||||
"useExhaustiveDependencies": "warn",
|
|
||||||
"noUnknownFunction": "warn"
|
|
||||||
},
|
|
||||||
"style": {
|
|
||||||
"noNonNullAssertion": "warn",
|
|
||||||
"noParameterAssign": "off",
|
|
||||||
"useThrowOnlyError": "error"
|
|
||||||
},
|
|
||||||
"suspicious": {
|
|
||||||
"noConsole": {
|
|
||||||
"level": "warn",
|
|
||||||
"options": {
|
|
||||||
"allow": ["assert", "error", "warn"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"noExplicitAny": "warn",
|
|
||||||
"noImplicitAnyLet": "warn",
|
|
||||||
"noConfusingVoidType": "warn",
|
|
||||||
"noControlCharactersInRegex": "warn",
|
|
||||||
"noPrototypeBuiltins": "warn",
|
|
||||||
"noAssignInExpressions": "warn",
|
|
||||||
"noArrayIndexKey": "warn"
|
|
||||||
},
|
|
||||||
"a11y": {
|
|
||||||
"useSemanticElements": "warn",
|
|
||||||
"useKeyWithClickEvents": "warn",
|
|
||||||
"noSvgWithoutTitle": "warn",
|
|
||||||
"useButtonType": "warn",
|
|
||||||
"useIframeTitle": "warn",
|
|
||||||
"useAltText": "warn",
|
|
||||||
"noPositiveTabindex": "warn",
|
|
||||||
"useFocusableInteractive": "warn",
|
|
||||||
"useAriaPropsForRole": "warn",
|
|
||||||
"useValidAnchor": "warn",
|
|
||||||
"noLabelWithoutControl": "warn",
|
|
||||||
"noNoninteractiveTabindex": "warn"
|
|
||||||
},
|
|
||||||
"nursery": {
|
|
||||||
"useSortedClasses": {
|
|
||||||
"level": "error",
|
|
||||||
"fix": "safe",
|
|
||||||
"options": {
|
|
||||||
"attributes": ["class", "className", "style"],
|
|
||||||
"functions": ["clsx", "tw"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"javascript": {
|
|
||||||
"formatter": {
|
|
||||||
"jsxQuoteStyle": "double",
|
|
||||||
"quoteProperties": "asNeeded",
|
|
||||||
"trailingCommas": "es5",
|
|
||||||
"semicolons": "always",
|
|
||||||
"arrowParentheses": "always",
|
|
||||||
"bracketSameLine": false,
|
|
||||||
"quoteStyle": "single",
|
|
||||||
"attributePosition": "auto",
|
|
||||||
"bracketSpacing": true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"overrides": [
|
|
||||||
{
|
|
||||||
"include": [
|
|
||||||
"packages/gitbook/**/*",
|
|
||||||
"packages/gitbook-v2/**/*",
|
|
||||||
"packages/react-openapi/**/*",
|
|
||||||
"packages/react-math/**/*",
|
|
||||||
"packages/react-contentkit/**/*",
|
|
||||||
"packages/icons/**/*"
|
|
||||||
],
|
|
||||||
"javascript": {
|
|
||||||
"globals": ["React"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"include": ["packages/gitbook/**/*"],
|
|
||||||
"javascript": {
|
|
||||||
"globals": ["React", "GitBookIntegrationEvent"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"include": ["*.css"],
|
|
||||||
"javascript": {
|
|
||||||
"globals": ["theme"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"include": ["*.test.ts", "packages/gitbook/tests/**/*"],
|
|
||||||
"javascript": {
|
|
||||||
"globals": ["Bun"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"include": [
|
|
||||||
"packages/cache-do/**/*",
|
|
||||||
"packages/gitbook/cf-env.d.ts",
|
|
||||||
"packages/gitbook/src/cloudflare-entrypoint.ts"
|
|
||||||
],
|
|
||||||
"javascript": {
|
|
||||||
"globals": [
|
|
||||||
"DurableObjectLocationHint",
|
|
||||||
"DurableObjectNamespace",
|
|
||||||
"DurableObjectStub",
|
|
||||||
"ContinentCode",
|
|
||||||
"Fetcher",
|
|
||||||
"ExportedHandler"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
+1
-1
@@ -1,2 +1,2 @@
|
|||||||
[install.scopes]
|
[install.scopes]
|
||||||
"gitbook" = { token = "$NPM_TOKEN_READONLY", url = "https://registry.npmjs.org" }
|
"awesome.me" = { token = "$NPMRC_FONT_AWESOME_TOKEN", url = "https://npm.fontawesome.com/" }
|
||||||
|
|||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# Caching
|
||||||
|
|
||||||
|
## Revalidating the cache
|
||||||
|
|
||||||
|
Invalidate cache can be done at two levels using tags:
|
||||||
|
|
||||||
|
- Data fetching cache
|
||||||
|
- Rendering cache
|
||||||
|
|
||||||
|
To invalidate and refetch the data cache, you can execute a POST request to `/~/gitbook/revalidate`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl --location --request POST 'https://gitbook/mycompany.com/~gitbook/revalidate' \
|
||||||
|
--header 'Content-Type: application/json' \
|
||||||
|
--data-raw '{"tags": ["space.id"]}'
|
||||||
|
```
|
||||||
|
|
||||||
|
To invalidate the rendering cache, the implementation mainly depends on the infrastructure serving the content, GitBook outputs a `Cache-Tag` header on every requests. The value of the header is a comma separated list of tags.
|
||||||
|
|
||||||
|
## Purging the cache
|
||||||
|
|
||||||
|
Purging the cache, without revalidating, is done by passing `"purge": true` in the request body.
|
||||||
+15
-22
@@ -2,41 +2,34 @@
|
|||||||
"name": "gitbook",
|
"name": "gitbook",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "^1.9.4",
|
"@changesets/cli": "^2.27.7",
|
||||||
"@changesets/cli": "^2.27.12",
|
"prettier": "^3.0.3",
|
||||||
"turbo": "^2.5.0",
|
"turbo": "^2.1.2"
|
||||||
"vercel": "^39.3.0"
|
|
||||||
},
|
},
|
||||||
"packageManager": "bun@1.2.8",
|
"packageManager": "bun@1.1.18",
|
||||||
"overrides": {
|
"patchedDependencies": {
|
||||||
"@codemirror/state": "6.4.1",
|
"@vercel/next@4.3.15": "patches/@vercel%2Fnext@4.3.15.patch",
|
||||||
"react": "18.3.1",
|
"@cloudflare/next-on-pages@1.13.5": "patches/@cloudflare%2Fnext-on-pages@1.13.5.patch"
|
||||||
"react-dom": "18.3.1",
|
|
||||||
"@gitbook/api": "0.111.0"
|
|
||||||
},
|
},
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "turbo run dev",
|
"dev": "turbo run dev",
|
||||||
"dev:v2": "turbo run dev:v2",
|
|
||||||
"build": "turbo run build",
|
"build": "turbo run build",
|
||||||
"build:v2": "turbo run build:v2",
|
"build:cloudflare": "turbo run build:cloudflare",
|
||||||
"clean-deps": "rm -rf node_modules && rm -rf packages/*/node_modules",
|
"lint": "turbo run lint",
|
||||||
|
"lint:fix": "turbo run lint -- --fix",
|
||||||
"typecheck": "turbo run typecheck",
|
"typecheck": "turbo run typecheck",
|
||||||
"format": "biome check --write ./",
|
"format": "prettier ./ --ignore-unknown --write",
|
||||||
"format:check": "biome check --diagnostic-level=error ./",
|
"format:check": "prettier ./ --ignore-unknown --list-different",
|
||||||
"unit": "turbo run unit",
|
"unit": "turbo run unit",
|
||||||
"e2e": "turbo run e2e",
|
"e2e": "turbo run e2e",
|
||||||
"e2e-customers": "turbo run e2e-customers",
|
|
||||||
"changeset": "changeset",
|
"changeset": "changeset",
|
||||||
"changeset-version": "changeset version && bun run format",
|
|
||||||
"release": "turbo run release && changeset publish",
|
"release": "turbo run release && changeset publish",
|
||||||
"release:preview": "turbo run release:preview",
|
"release:preview": "turbo run release:preview",
|
||||||
"download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
|
"download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
|
||||||
"clean": "turbo run clean"
|
"clean": "turbo run clean"
|
||||||
},
|
},
|
||||||
"workspaces": ["packages/*"],
|
"workspaces": [
|
||||||
"patchedDependencies": {
|
"packages/*"
|
||||||
"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"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,11 +1,5 @@
|
|||||||
# @gitbook/cache-do
|
# @gitbook/cache-do
|
||||||
|
|
||||||
## 0.1.1
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- b7a5106: Disable cloudflare observability in production
|
|
||||||
|
|
||||||
## 0.1.0
|
## 0.1.0
|
||||||
|
|
||||||
### Minor Changes
|
### Minor Changes
|
||||||
|
|||||||
@@ -14,22 +14,29 @@
|
|||||||
"default": "./dist/api.js"
|
"default": "./dist/api.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "0.1.1",
|
"version": "0.1.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@msgpack/msgpack": "^3.0.0-beta2",
|
"@msgpack/msgpack": "^3.0.0-beta2",
|
||||||
"lru_map": "^0.4.1"
|
"lru_map": "^0.4.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.5.3",
|
"typescript": "^5.5.3",
|
||||||
"wrangler": "^4.10.0"
|
"wrangler": "3.82.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"generate": "wrangler types",
|
"generate": "wrangler types --experimental-include-runtime",
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"dev": "tsc -w",
|
"dev": "tsc -w",
|
||||||
"release": "wrangler deploy",
|
"release": "wrangler deploy",
|
||||||
"release:preview": "wrangler deploy && wrangler deploy --env preview"
|
"release:preview": "wrangler deploy && wrangler deploy --env preview"
|
||||||
},
|
},
|
||||||
"files": ["dist", "src", "bin", "data", "README.md", "CHANGELOG.md"]
|
"files": [
|
||||||
|
"dist",
|
||||||
|
"src",
|
||||||
|
"bin",
|
||||||
|
"data",
|
||||||
|
"README.md",
|
||||||
|
"CHANGELOG.md"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
|
import { encode, decode } from '@msgpack/msgpack';
|
||||||
import { DurableObject } from 'cloudflare:workers';
|
import { DurableObject } from 'cloudflare:workers';
|
||||||
import { decode, encode } from '@msgpack/msgpack';
|
|
||||||
import { LRUMap } from 'lru_map';
|
import { LRUMap } from 'lru_map';
|
||||||
|
|
||||||
export interface CacheObjectDescriptor {
|
export interface CacheObjectDescriptor {
|
||||||
@@ -137,7 +137,7 @@ export class CacheObject extends DurableObject {
|
|||||||
*/
|
*/
|
||||||
public async purge() {
|
public async purge() {
|
||||||
return this.logOperation({ operation: 'purge' }, async (setLog) => {
|
return this.logOperation({ operation: 'purge' }, async (setLog) => {
|
||||||
const result = new Set<string>();
|
let result = new Set<string>();
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// List all the keys in the cache object.
|
// List all the keys in the cache object.
|
||||||
@@ -149,7 +149,11 @@ export class CacheObject extends DurableObject {
|
|||||||
entries.forEach((exp) => {
|
entries.forEach((exp) => {
|
||||||
result.add(exp.k);
|
result.add(exp.k);
|
||||||
});
|
});
|
||||||
} catch (_error) {}
|
} catch (error) {
|
||||||
|
// If an error occurs, reset the cache object.
|
||||||
|
// This is a safety mechanism to prevent the cache object from being stuck in a bad state.
|
||||||
|
console.error('Error during purge, resetting the cache object', error);
|
||||||
|
}
|
||||||
|
|
||||||
await this.reset();
|
await this.reset();
|
||||||
return Array.from(result);
|
return Array.from(result);
|
||||||
@@ -170,7 +174,7 @@ export class CacheObject extends DurableObject {
|
|||||||
const toDeleteSet = new Set<string>();
|
const toDeleteSet = new Set<string>();
|
||||||
|
|
||||||
for (const [key, exp] of entries) {
|
for (const [key, exp] of entries) {
|
||||||
const timestamp = Number.parseInt(key.split('.')[1]);
|
const timestamp = parseInt(key.split('.')[1]);
|
||||||
if (timestamp < Date.now()) {
|
if (timestamp < Date.now()) {
|
||||||
toDeleteSet.add(key);
|
toDeleteSet.add(key);
|
||||||
for (let i = 0; i < exp.c; i++) {
|
for (let i = 0; i < exp.c; i++) {
|
||||||
@@ -190,7 +194,10 @@ export class CacheObject extends DurableObject {
|
|||||||
if (toDelete.length) {
|
if (toDelete.length) {
|
||||||
await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
|
await this.ctx.storage.setAlarm(Date.now() + 12 * 60 * 60 * 1000);
|
||||||
}
|
}
|
||||||
} catch (_error) {
|
} catch (error) {
|
||||||
|
// If an error occurs, reset the cache object.
|
||||||
|
// This is a safety mechanism to prevent the cache object from being stuck in a bad state.
|
||||||
|
console.error('Error during alarm, reset the cache object', error);
|
||||||
await this.reset();
|
await this.reset();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -211,10 +218,10 @@ export class CacheObject extends DurableObject {
|
|||||||
*/
|
*/
|
||||||
async logOperation<T>(
|
async logOperation<T>(
|
||||||
log: Record<string, unknown>,
|
log: Record<string, unknown>,
|
||||||
fn: (update: (log: Record<string, unknown>) => void) => Promise<T>
|
fn: (update: (log: Record<string, unknown>) => void) => Promise<T>,
|
||||||
): Promise<T> {
|
): Promise<T> {
|
||||||
const objectId = this.ctx.id.name ?? this.ctx.id.toString();
|
const objectId = this.ctx.id.name ?? this.ctx.id.toString();
|
||||||
const update: Record<string, unknown> = {};
|
let update: Record<string, unknown> = {};
|
||||||
const start = performance.now();
|
const start = performance.now();
|
||||||
try {
|
try {
|
||||||
return await fn((arg) => {
|
return await fn((arg) => {
|
||||||
@@ -258,7 +265,7 @@ function encodeChunks<T>(key: string, value: T): Record<string, Uint8Array> {
|
|||||||
function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
|
function decodeChunks<T>(entries: Map<string, Uint8Array>): { value: T; size: number } | undefined {
|
||||||
const chunks = Array.from(entries.entries())
|
const chunks = Array.from(entries.entries())
|
||||||
.map(([key, value]) => {
|
.map(([key, value]) => {
|
||||||
const index = Number.parseInt(key.split('.').pop()!);
|
const index = parseInt(key.split('.').pop()!);
|
||||||
return [index, value] as const;
|
return [index, value] as const;
|
||||||
})
|
})
|
||||||
.sort(([a], [b]) => a - b)
|
.sort(([a], [b]) => a - b)
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import type { CacheObject } from './CacheObject';
|
import type { CacheObject, CacheObjectDescriptor } from './CacheObject';
|
||||||
|
|
||||||
export type CacheLocationId = ContinentCode;
|
export type CacheLocationId = ContinentCode;
|
||||||
const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
|
const allLocations: CacheLocationId[] = ['AF', 'AS', 'NA', 'SA', 'AN', 'EU', 'OC'];
|
||||||
@@ -30,7 +30,7 @@ export class CacheObjectStub {
|
|||||||
/** ID of the location to target */
|
/** ID of the location to target */
|
||||||
private locationId: CacheLocationId,
|
private locationId: CacheLocationId,
|
||||||
/** Name of the tag */
|
/** Name of the tag */
|
||||||
private tag: string
|
private tag: string,
|
||||||
) {
|
) {
|
||||||
const groupId = getCacheObjectIdName(this.locationId, this.tag);
|
const groupId = getCacheObjectIdName(this.locationId, this.tag);
|
||||||
this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
|
this.stub = this.doNamespace.get(this.doNamespace.idFromName(groupId), {
|
||||||
@@ -85,7 +85,7 @@ export class CacheObjectStub {
|
|||||||
});
|
});
|
||||||
const locationkeys = await cacheGroup.purge();
|
const locationkeys = await cacheGroup.purge();
|
||||||
locationkeys.forEach((key) => keys.add(key));
|
locationkeys.forEach((key) => keys.add(key));
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
return keys;
|
return keys;
|
||||||
|
|||||||
@@ -14,7 +14,7 @@
|
|||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
"isolatedModules": true,
|
"isolatedModules": true,
|
||||||
"incremental": true,
|
"incremental": true,
|
||||||
"types": ["./worker-configuration.d.ts"]
|
"types": ["./.wrangler/types/runtime.d.ts"]
|
||||||
},
|
},
|
||||||
"include": ["src/**/*.ts"],
|
"include": ["src/**/*.ts"],
|
||||||
"exclude": ["node_modules"]
|
"exclude": ["node_modules"]
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": ["//"],
|
|
||||||
"tasks": {
|
|
||||||
"generate": {
|
|
||||||
"outputs": ["worker-configuration.d.ts"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
dist/
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# @gitbook/cache-tags
|
|
||||||
|
|
||||||
## 0.3.1
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- 77397ca: Fix version of @gitbook/api referenced in package.json
|
|
||||||
|
|
||||||
## 0.3.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- 116575c: Improve typing of getComputedContentSourceCacheTags to match latest API specification
|
|
||||||
|
|
||||||
## 0.2.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
|
|
||||||
|
|
||||||
## 0.1.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- 05ffd0e: Initial version of the package
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# `@gitbook/cache-tags`
|
|
||||||
|
|
||||||
Utility to generate cache tags for GitBook Open.
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@gitbook/cache-tags",
|
|
||||||
"type": "module",
|
|
||||||
"exports": {
|
|
||||||
".": {
|
|
||||||
"types": "./dist/index.d.ts",
|
|
||||||
"development": "./src/index.ts",
|
|
||||||
"default": "./dist/index.js"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"version": "0.3.1",
|
|
||||||
"dependencies": {
|
|
||||||
"@gitbook/api": "^0.111.0",
|
|
||||||
"assert-never": "^1.2.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"typescript": "^5.5.3"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"build": "tsc",
|
|
||||||
"typecheck": "tsc --noEmit",
|
|
||||||
"dev": "tsc -w"
|
|
||||||
},
|
|
||||||
"files": ["dist", "src", "README.md", "CHANGELOG.md"]
|
|
||||||
}
|
|
||||||
@@ -1,209 +0,0 @@
|
|||||||
import type { ComputedContentSource } from '@gitbook/api';
|
|
||||||
import assertNever from 'assert-never';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a stringified cache tag for a given object.
|
|
||||||
*/
|
|
||||||
export function getCacheTag(
|
|
||||||
spec: /**
|
|
||||||
* All data related to a user
|
|
||||||
* @deprecated - in v2, no tag as this is an immutable data
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'user';
|
|
||||||
user: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to a space
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'space';
|
|
||||||
space: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to an integration.
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'integration';
|
|
||||||
integration: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to a change request
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'change-request';
|
|
||||||
space: string;
|
|
||||||
changeRequest: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Immutable data related to a revision
|
|
||||||
* @deprecated - in v2, no tag as this is an immutable data
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'revision';
|
|
||||||
space: string;
|
|
||||||
revision: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Immutable data related to a document
|
|
||||||
* @deprecated - in v2, no tag as this is an immutable data
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'document';
|
|
||||||
space: string;
|
|
||||||
document: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Immutable data related to a computed document
|
|
||||||
* @deprecated - in v2, no tag as this is an immutable data
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'computed-document';
|
|
||||||
space: string;
|
|
||||||
sourceType: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to the URL of a content
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'url';
|
|
||||||
hostname: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to a site
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'site';
|
|
||||||
site: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to an OpenAPI spec
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'openapi';
|
|
||||||
organization: string;
|
|
||||||
openAPISpec: string;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* All data related to a translation
|
|
||||||
*/
|
|
||||||
| {
|
|
||||||
tag: 'translation';
|
|
||||||
organization: string;
|
|
||||||
translationSettings: string;
|
|
||||||
}
|
|
||||||
): string {
|
|
||||||
switch (spec.tag) {
|
|
||||||
case 'user':
|
|
||||||
return `user:${spec.user}`;
|
|
||||||
case 'url':
|
|
||||||
return `url:${spec.hostname}`;
|
|
||||||
case 'space':
|
|
||||||
return `space:${spec.space}`;
|
|
||||||
case 'change-request':
|
|
||||||
return `space:${spec.space}:change-request:${spec.changeRequest}`;
|
|
||||||
case 'revision':
|
|
||||||
return `space:${spec.space}:revision:${spec.revision}`;
|
|
||||||
case 'document':
|
|
||||||
return `space:${spec.space}:document:${spec.document}`;
|
|
||||||
case 'computed-document':
|
|
||||||
return `space:${spec.space}:computed-document:${spec.sourceType}`;
|
|
||||||
case 'site':
|
|
||||||
return `site:${spec.site}`;
|
|
||||||
case 'integration':
|
|
||||||
return `integration:${spec.integration}`;
|
|
||||||
case 'openapi':
|
|
||||||
return `organization:${spec.organization}:openapi:${spec.openAPISpec}`;
|
|
||||||
case 'translation':
|
|
||||||
return `organization:${spec.organization}:translation:${spec.translationSettings}`;
|
|
||||||
default:
|
|
||||||
assertNever(spec);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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.
|
|
||||||
*/
|
|
||||||
export function getComputedContentSourceCacheTags(
|
|
||||||
inContext: {
|
|
||||||
spaceId: string;
|
|
||||||
organizationId: string;
|
|
||||||
},
|
|
||||||
source: ComputedContentSource
|
|
||||||
) {
|
|
||||||
const tags: string[] = [];
|
|
||||||
|
|
||||||
// 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 ?? {});
|
|
||||||
if (dependencies.length > 0) {
|
|
||||||
dependencies.forEach((dependency) => {
|
|
||||||
switch (dependency.ref.kind) {
|
|
||||||
case 'space':
|
|
||||||
tags.push(
|
|
||||||
getCacheTag({
|
|
||||||
tag: 'space',
|
|
||||||
space: dependency.ref.space,
|
|
||||||
})
|
|
||||||
);
|
|
||||||
break;
|
|
||||||
case 'openapi':
|
|
||||||
tags.push(
|
|
||||||
getCacheTag({
|
|
||||||
tag: 'openapi',
|
|
||||||
organization: inContext.organizationId,
|
|
||||||
openAPISpec: dependency.ref.spec,
|
|
||||||
})
|
|
||||||
);
|
|
||||||
break;
|
|
||||||
case 'translation-language':
|
|
||||||
tags.push(
|
|
||||||
getCacheTag({
|
|
||||||
tag: 'translation',
|
|
||||||
organization: inContext.organizationId,
|
|
||||||
translationSettings: dependency.ref.translationSettings,
|
|
||||||
})
|
|
||||||
);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
// Do not throw for unknown dependency types
|
|
||||||
// as it might mean we are lacking behind the API version
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
// Push a dummy tag, as the v1 is only using the first tag
|
|
||||||
tags.push(
|
|
||||||
getCacheTag({
|
|
||||||
tag: 'computed-document',
|
|
||||||
space: inContext.spaceId,
|
|
||||||
sourceType: source.type,
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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];
|
|
||||||
tags.push(
|
|
||||||
getCacheTag({
|
|
||||||
tag: 'integration',
|
|
||||||
integration,
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return tags;
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "esnext",
|
|
||||||
"lib": ["dom", "dom.iterable", "esnext"],
|
|
||||||
"allowJs": true,
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"strict": true,
|
|
||||||
"noEmit": false,
|
|
||||||
"declaration": true,
|
|
||||||
"outDir": "dist",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"module": "esnext",
|
|
||||||
"moduleResolution": "bundler",
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"isolatedModules": true,
|
|
||||||
"jsx": "react-jsx",
|
|
||||||
"incremental": true,
|
|
||||||
"types": [
|
|
||||||
"bun-types" // add Bun global
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"include": ["src/**/*.ts", "src/**/*.tsx"],
|
|
||||||
"exclude": ["node_modules"]
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
dist/
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# @gitbook/colors
|
|
||||||
|
|
||||||
## 0.3.2
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- cdffd7c: Desaturate text colors by decreasing chroma for the last steps of the color scale
|
|
||||||
|
|
||||||
## 0.3.1
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- fb90eb0: Reduce chroma of first color scale step
|
|
||||||
|
|
||||||
## 0.3.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- 4f0a772: Override tint lightness if supplied color is out of bounds
|
|
||||||
|
|
||||||
## 0.2.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- 445baaa: Initial release
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# `@gitbook/colors`
|
|
||||||
|
|
||||||
A set of default colors and transformation functions used throughout the GitBook Open and app.
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@gitbook/colors",
|
|
||||||
"type": "module",
|
|
||||||
"exports": {
|
|
||||||
".": {
|
|
||||||
"types": "./dist/index.d.ts",
|
|
||||||
"development": "./src/index.ts",
|
|
||||||
"default": "./dist/index.js"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"version": "0.3.2",
|
|
||||||
"devDependencies": {
|
|
||||||
"typescript": "^5.5.3"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"build": "tsc",
|
|
||||||
"typecheck": "tsc --noEmit",
|
|
||||||
"dev": "tsc -w"
|
|
||||||
},
|
|
||||||
"files": ["dist", "src", "README.md", "CHANGELOG.md"]
|
|
||||||
}
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
/**
|
|
||||||
* Default primary color throughout the GitBook ecosystem.
|
|
||||||
*/
|
|
||||||
export const DEFAULT_PRIMARY_COLOR = '#346DDB';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The darkest color that exists in GitBook, used as the relative minimum of every generated color scale.
|
|
||||||
*/
|
|
||||||
export const DARK_BASE = '#1D1D1D';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The lightest color that exists in GitBook, used as the relative maximum of every generated color scale.
|
|
||||||
*/
|
|
||||||
export const LIGHT_BASE = '#FFFFFF';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used as the basis of all UI elements that are not colored by the primary color. Neutral gray by default, overridden by site customization.
|
|
||||||
*/
|
|
||||||
export const DEFAULT_TINT_COLOR = '#787878';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used for informational messages and neutral alerts.
|
|
||||||
*/
|
|
||||||
export const DEFAULT_HINT_INFO_COLOR = '#787878';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used for showing important information or non-critical warnings.
|
|
||||||
*/
|
|
||||||
export const DEFAULT_HINT_WARNING_COLOR = '#FE9A00';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used for destructive actions or raising attention to critical information.
|
|
||||||
*/
|
|
||||||
export const DEFAULT_HINT_DANGER_COLOR = '#FB2C36';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used for showing positive actions or achievements.
|
|
||||||
*/
|
|
||||||
export const DEFAULT_HINT_SUCCESS_COLOR = '#00C950';
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
export * from './colors';
|
|
||||||
export * from './transformations';
|
|
||||||
@@ -1,422 +0,0 @@
|
|||||||
import { DARK_BASE, DEFAULT_TINT_COLOR, LIGHT_BASE } from './colors';
|
|
||||||
|
|
||||||
type ColorShades = {
|
|
||||||
[key: string]: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
export enum ColorCategory {
|
|
||||||
backgrounds = 'backgrounds',
|
|
||||||
components = 'components',
|
|
||||||
borders = 'borders',
|
|
||||||
accents = 'accents',
|
|
||||||
text = 'text',
|
|
||||||
}
|
|
||||||
|
|
||||||
type ColorSubScale = {
|
|
||||||
[key: string]: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Main color scale object.
|
|
||||||
*
|
|
||||||
* Each `ColorCategory` can be in/excluded in Tailwind's utility classes generation.
|
|
||||||
* Each subitem maps a semantic name within that category to a step in the scale.
|
|
||||||
*/
|
|
||||||
export const scale: Record<ColorCategory, ColorSubScale> = {
|
|
||||||
[ColorCategory.backgrounds]: {
|
|
||||||
/** Base background */
|
|
||||||
base: 1,
|
|
||||||
/** Accent background */
|
|
||||||
subtle: 2,
|
|
||||||
},
|
|
||||||
[ColorCategory.components]: {
|
|
||||||
/** Component background */
|
|
||||||
DEFAULT: 3,
|
|
||||||
/** Component hover background */
|
|
||||||
hover: 4,
|
|
||||||
/** Component active background */
|
|
||||||
active: 5,
|
|
||||||
},
|
|
||||||
[ColorCategory.borders]: {
|
|
||||||
/** Subtle borders, separators */
|
|
||||||
subtle: 6,
|
|
||||||
/** Element border, focus rings */
|
|
||||||
DEFAULT: 7,
|
|
||||||
/** Element hover border */
|
|
||||||
hover: 8,
|
|
||||||
},
|
|
||||||
[ColorCategory.accents]: {
|
|
||||||
/** Solid backgrounds */
|
|
||||||
solid: 9,
|
|
||||||
/** Hovered solid backgrounds */
|
|
||||||
'solid-hover': 10,
|
|
||||||
},
|
|
||||||
[ColorCategory.text]: {
|
|
||||||
/** Very low-contrast text
|
|
||||||
* Caution: this contrast does not meet accessiblity guidelines.
|
|
||||||
* Always check if you need to include a mitigating contrast-more style for users who need it. */
|
|
||||||
subtle: 9,
|
|
||||||
/** Low-contrast text */
|
|
||||||
DEFAULT: 11,
|
|
||||||
/** High-contrast text */
|
|
||||||
strong: 12,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The mix of foreground and background for every step in a colour scale.
|
|
||||||
* 0: 100% of the background color's luminosity, white in light mode
|
|
||||||
* 1: 100% of the foreground color's luminosity, black in light mode
|
|
||||||
*/
|
|
||||||
export const colorMixMapping = {
|
|
||||||
// bgs |components |borders |solid |text
|
|
||||||
light: [0, 0.02, 0.03, 0.05, 0.07, 0.1, 0.15, 0.2, 0.5, 0.55, 0.6, 1],
|
|
||||||
dark: [0, 0.03, 0.08, 0.1, 0.13, 0.15, 0.2, 0.25, 0.5, 0.55, 0.75, 1],
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert a hex color to an RGB color.
|
|
||||||
*/
|
|
||||||
export function hexToRgb(hex: string): string {
|
|
||||||
const [r, g, b] = hexToRgbArray(hex);
|
|
||||||
// Return the RGB values separated by spaces
|
|
||||||
return `${r} ${g} ${b}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert a hex color to a RGBA color.
|
|
||||||
*/
|
|
||||||
export function hexToRgba(hex: string, alpha: number): string {
|
|
||||||
const [r, g, b] = hexToRgbArray(hex);
|
|
||||||
// Return the RGBA values separated by spaces
|
|
||||||
return `rgba(${r}, ${g}, ${b}, ${alpha})`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate Tailwind-compatible shades from a single color
|
|
||||||
* @param {string} hex The hex code to generate shades from
|
|
||||||
* @param {boolean} halfShades Generate additional shades, e.g. at 150
|
|
||||||
* @returns {{[key: number]: string}}
|
|
||||||
*/
|
|
||||||
export function shadesOfColor(hex: string, halfShades = false) {
|
|
||||||
const baseColor = hex;
|
|
||||||
|
|
||||||
const shades = [
|
|
||||||
50,
|
|
||||||
100,
|
|
||||||
200,
|
|
||||||
300,
|
|
||||||
400,
|
|
||||||
500,
|
|
||||||
600,
|
|
||||||
700,
|
|
||||||
800,
|
|
||||||
900,
|
|
||||||
...(halfShades ? [150, 250, 350, 450, 550, 650, 750, 850] : []),
|
|
||||||
].sort();
|
|
||||||
|
|
||||||
const result: ColorShades = {};
|
|
||||||
|
|
||||||
for (const shade of shades) {
|
|
||||||
const key = shade.toString();
|
|
||||||
|
|
||||||
if (shade === 500) {
|
|
||||||
result[key] = hex;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let shadeIndex = shade;
|
|
||||||
const isDarkShade = shadeIndex > 500;
|
|
||||||
if (isDarkShade) {
|
|
||||||
shadeIndex -= 500;
|
|
||||||
}
|
|
||||||
|
|
||||||
const percentage = shadeIndex / 500;
|
|
||||||
const startColor = isDarkShade ? DARK_BASE : baseColor;
|
|
||||||
const endColor = isDarkShade ? baseColor : LIGHT_BASE;
|
|
||||||
|
|
||||||
result[key] = getColor(percentage, hexToRgbArray(startColor), hexToRgbArray(endColor));
|
|
||||||
}
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type ColorScaleOptions = {
|
|
||||||
/** If set to `true`, inverts the scale (so 1 is black instead of white) and uses `colorMixMapping.dark` with different mix ratios per step. */
|
|
||||||
darkMode?: boolean;
|
|
||||||
|
|
||||||
/** Define a custom background color to use. If left undefined, the global `light`/`dark` values (in `colors.ts`) will be used. */
|
|
||||||
background?: string;
|
|
||||||
|
|
||||||
/** Define a custom foreground color to use. If left undefined, the global `light`/`dark` values (in `colors.ts`) will be used. */
|
|
||||||
foreground?: string;
|
|
||||||
|
|
||||||
mix?: {
|
|
||||||
/** If set to a hex code, this color will be additionally mixed into the generated scale according to `mix.ratio`. */
|
|
||||||
color: string;
|
|
||||||
|
|
||||||
/** Define a custom mix ratio to mix the `mix` color with. If left undefined, the default ratio will be used. */
|
|
||||||
ratio: number;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate a [Radix-like](https://www.radix-ui.com/colors/docs/palette-composition/understanding-the-scale) colour scale based of a hex colour.
|
|
||||||
* @param {string} hex The hex code to generate shades from
|
|
||||||
* @param {object} options
|
|
||||||
*/
|
|
||||||
export function colorScale(
|
|
||||||
hex: string,
|
|
||||||
{
|
|
||||||
darkMode = false,
|
|
||||||
background = darkMode ? DARK_BASE : LIGHT_BASE,
|
|
||||||
foreground = darkMode ? LIGHT_BASE : DARK_BASE,
|
|
||||||
mix,
|
|
||||||
}: ColorScaleOptions = {}
|
|
||||||
) {
|
|
||||||
const baseColor = rgbToOklch(hexToRgbArray(hex));
|
|
||||||
const mixColor = mix?.color ? rgbToOklch(hexToRgbArray(mix.color)) : null;
|
|
||||||
const foregroundColor = rgbToOklch(hexToRgbArray(foreground));
|
|
||||||
const backgroundColor = rgbToOklch(hexToRgbArray(background));
|
|
||||||
let mapping = darkMode ? colorMixMapping.dark : colorMixMapping.light;
|
|
||||||
|
|
||||||
if (mixColor && mix?.ratio && mix.ratio > 0) {
|
|
||||||
// If defined, we mix in a (tiny) bit of the mix color with the base color.
|
|
||||||
baseColor.L = mixColor.L * mix.ratio + baseColor.L * (1 - mix.ratio);
|
|
||||||
baseColor.C = mixColor.C * mix.ratio + baseColor.C * (1 - mix.ratio);
|
|
||||||
baseColor.H = mix.color === DEFAULT_TINT_COLOR ? baseColor.H : mixColor.H;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (
|
|
||||||
(darkMode && baseColor.L < backgroundColor.L) ||
|
|
||||||
(!darkMode && baseColor.L > backgroundColor.L)
|
|
||||||
) {
|
|
||||||
// If the supplied color is outside of our lightness bounds, use the supplied color's lightness.
|
|
||||||
// This is mostly used to allow darker-than-dark backgrounds for brands that specifically want that look.
|
|
||||||
const difference = (backgroundColor.L - baseColor.L) / backgroundColor.L;
|
|
||||||
backgroundColor.L = baseColor.L;
|
|
||||||
// At the edges of the scale, the subtle lightness changes stop being perceptible. We need to amp up our mapping to still stand out.
|
|
||||||
const amplifier = 1;
|
|
||||||
mapping = mapping.map((step, index) =>
|
|
||||||
index < 9 ? step + step * amplifier * difference : step
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = [];
|
|
||||||
|
|
||||||
for (let index = 0; index < mapping.length; index++) {
|
|
||||||
const targetL =
|
|
||||||
foregroundColor.L * mapping[index] + backgroundColor.L * (1 - mapping[index]);
|
|
||||||
|
|
||||||
if (index === 8 && !mix && Math.abs(baseColor.L - targetL) < 0.2) {
|
|
||||||
// Original colour is close enough to target, so let's use the original colour as step 9.
|
|
||||||
result.push(hex);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const chromaRatio = index === 8 || index === 9 ? 1 : index * 0.05;
|
|
||||||
|
|
||||||
const shade = {
|
|
||||||
L: targetL, // Blend lightness
|
|
||||||
C: baseColor.C * chromaRatio,
|
|
||||||
H: baseColor.H, // Maintain the hue from the base color
|
|
||||||
};
|
|
||||||
|
|
||||||
const newHex = rgbArrayToHex(oklchToRgb(shade));
|
|
||||||
|
|
||||||
result.push(newHex);
|
|
||||||
}
|
|
||||||
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert a hex color to an RGB color set.
|
|
||||||
*/
|
|
||||||
export function hexToRgbArray(hex: string): RGBColor {
|
|
||||||
const originalHex = hex;
|
|
||||||
|
|
||||||
let value = hex.replace('#', '');
|
|
||||||
if (hex.length === 3) value = value + value;
|
|
||||||
|
|
||||||
const r = value.substring(0, 2);
|
|
||||||
const g = value.substring(2, 4);
|
|
||||||
const b = value.substring(4, 6);
|
|
||||||
|
|
||||||
const rgb = [r, g, b].map((channel) => {
|
|
||||||
try {
|
|
||||||
const channelInt = Number.parseInt(channel, 16);
|
|
||||||
if (channelInt < 0 || channelInt > 255) throw new Error();
|
|
||||||
return channelInt;
|
|
||||||
} catch {
|
|
||||||
throw new Error(`Invalid hex color provided: ${originalHex}`);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return rgb as RGBColor;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert a RGB color set to a hex color.
|
|
||||||
*/
|
|
||||||
export function rgbArrayToHex(rgb: RGBColor): string {
|
|
||||||
return `#${rgb
|
|
||||||
.map((channel) => {
|
|
||||||
const component = channel.toString(16);
|
|
||||||
if (component.length === 1) return `0${component}`;
|
|
||||||
return component;
|
|
||||||
})
|
|
||||||
.join('')}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function getColor(percentage: number, start: RGBColor, end: RGBColor) {
|
|
||||||
const rgb = end.map((channel, index) => {
|
|
||||||
return Math.round(channel + percentage * (start[index] - channel));
|
|
||||||
});
|
|
||||||
|
|
||||||
return rgbArrayToHex(rgb as RGBColor);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Utility constants and helper functions
|
|
||||||
export function rgbToLinear(rgb: RGBColor): [number, number, number] {
|
|
||||||
return rgb.map((v) => {
|
|
||||||
const scaled = v / 255;
|
|
||||||
return scaled <= 0.04045 ? scaled / 12.92 : ((scaled + 0.055) / 1.055) ** 2.4;
|
|
||||||
}) as [number, number, number];
|
|
||||||
}
|
|
||||||
|
|
||||||
export function linearToRgb(linear: [number, number, number]): RGBColor {
|
|
||||||
return linear.map((v) => {
|
|
||||||
const scaled = v <= 0.0031308 ? 12.92 * v : 1.055 * v ** (1 / 2.4) - 0.055;
|
|
||||||
return Math.round(Math.max(0, Math.min(1, scaled)) * 255);
|
|
||||||
}) as RGBColor;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function rgbToOklab(rgb: RGBColor): OKLABColor {
|
|
||||||
const [r, g, b] = rgbToLinear(rgb);
|
|
||||||
|
|
||||||
const l = 0.4122214708 * r + 0.5363325363 * g + 0.0514459929 * b;
|
|
||||||
const m = 0.2119034982 * r + 0.6806995451 * g + 0.1073969566 * b;
|
|
||||||
const s = 0.0883024619 * r + 0.2817188376 * g + 0.6299787005 * b;
|
|
||||||
|
|
||||||
const lRoot = Math.cbrt(l);
|
|
||||||
const mRoot = Math.cbrt(m);
|
|
||||||
const sRoot = Math.cbrt(s);
|
|
||||||
|
|
||||||
return {
|
|
||||||
L: 0.2104542553 * lRoot + 0.793617785 * mRoot - 0.0040720468 * sRoot,
|
|
||||||
A: 1.9779984951 * lRoot - 2.428592205 * mRoot + 0.4505937099 * sRoot,
|
|
||||||
B: 0.0259040371 * lRoot + 0.7827717662 * mRoot - 0.808675766 * sRoot,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function oklabToRgb(oklab: OKLABColor): RGBColor {
|
|
||||||
const { L, A, B } = oklab;
|
|
||||||
|
|
||||||
const lRoot = L + 0.3963377774 * A + 0.2158037573 * B;
|
|
||||||
const mRoot = L - 0.1055613458 * A - 0.0638541728 * B;
|
|
||||||
const sRoot = L - 0.0894841775 * A - 1.291485548 * B;
|
|
||||||
|
|
||||||
const l = lRoot ** 3;
|
|
||||||
const m = mRoot ** 3;
|
|
||||||
const s = sRoot ** 3;
|
|
||||||
|
|
||||||
const r = 4.0767416621 * l - 3.3077115913 * m + 0.2309699292 * s;
|
|
||||||
const g = -1.2684380046 * l + 2.6097574011 * m - 0.3413193965 * s;
|
|
||||||
const b = -0.0041960863 * l - 0.7034186147 * m + 1.707614701 * s;
|
|
||||||
|
|
||||||
return linearToRgb([r, g, b]);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function oklabToOklch(oklab: OKLABColor): OKLCHColor {
|
|
||||||
const { L, A, B } = oklab;
|
|
||||||
const C = Math.sqrt(A ** 2 + B ** 2);
|
|
||||||
const H = (Math.atan2(B, A) * 180) / Math.PI;
|
|
||||||
return { L, C, H: H < 0 ? H + 360 : H };
|
|
||||||
}
|
|
||||||
|
|
||||||
export function oklchToOklab(oklch: OKLCHColor): OKLABColor {
|
|
||||||
const { L, C, H } = oklch;
|
|
||||||
const rad = (H * Math.PI) / 180;
|
|
||||||
return {
|
|
||||||
L,
|
|
||||||
A: C * Math.cos(rad),
|
|
||||||
B: C * Math.sin(rad),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function rgbToOklch(rgb: RGBColor): OKLCHColor {
|
|
||||||
return oklabToOklch(rgbToOklab(rgb));
|
|
||||||
}
|
|
||||||
|
|
||||||
export function oklchToRgb(oklch: OKLCHColor): RGBColor {
|
|
||||||
return oklabToRgb(oklchToOklab(oklch));
|
|
||||||
}
|
|
||||||
|
|
||||||
export function rgbToXyz(rgb: RGBColor): [number, number, number] {
|
|
||||||
const [r, g, b] = rgbToLinear(rgb);
|
|
||||||
return [
|
|
||||||
(r * 0.4124564 + g * 0.3575761 + b * 0.1804375) * 100,
|
|
||||||
(r * 0.2126729 + g * 0.7151522 + b * 0.072175) * 100,
|
|
||||||
(r * 0.0193339 + g * 0.119192 + b * 0.9503041) * 100,
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
export function xyzToLab65(xyz: [number, number, number]): {
|
|
||||||
L: number;
|
|
||||||
A: number;
|
|
||||||
B: number;
|
|
||||||
} {
|
|
||||||
const [x, y, z] = xyz.map((v, i) => {
|
|
||||||
const scaled = v / D65[i];
|
|
||||||
return scaled > 0.008856 ? Math.cbrt(scaled) : 7.787 * scaled + 16 / 116;
|
|
||||||
});
|
|
||||||
|
|
||||||
return {
|
|
||||||
L: 116 * y - 16,
|
|
||||||
A: 500 * (x - y),
|
|
||||||
B: 200 * (y - z),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function rgbTolab65(rgb: RGBColor): { L: number; A: number; B: number } {
|
|
||||||
return xyzToLab65(rgbToXyz(rgb));
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
Delta Phi Star perceptual lightness contrast by Andrew Somers:
|
|
||||||
https://github.com/Myndex/deltaphistar
|
|
||||||
*/
|
|
||||||
export const PHI = 0.5 + Math.sqrt(1.25);
|
|
||||||
|
|
||||||
export function dpsContrast(a: RGBColor, b: RGBColor) {
|
|
||||||
const dps = Math.abs(rgbTolab65(a).L ** PHI - rgbTolab65(b).L ** PHI);
|
|
||||||
const contrast = dps ** (1 / PHI) * Math.SQRT2 - 40;
|
|
||||||
return contrast < 7.5 ? 0 : contrast;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function colorContrast(background: string, foreground: string[] = [LIGHT_BASE, DARK_BASE]) {
|
|
||||||
const bg = hexToRgbArray(background);
|
|
||||||
|
|
||||||
const best: { color?: RGBColor; contrast: number } = {
|
|
||||||
color: undefined,
|
|
||||||
contrast: 0,
|
|
||||||
};
|
|
||||||
for (const color of foreground) {
|
|
||||||
const c = hexToRgbArray(color);
|
|
||||||
|
|
||||||
const contrast = dpsContrast(c, bg);
|
|
||||||
if (contrast > best.contrast) {
|
|
||||||
best.color = c;
|
|
||||||
best.contrast = contrast;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return best.color ? rgbArrayToHex(best.color) : foreground[0];
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "esnext",
|
|
||||||
"lib": ["dom", "dom.iterable", "esnext"],
|
|
||||||
"allowJs": true,
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"strict": true,
|
|
||||||
"noEmit": false,
|
|
||||||
"declaration": true,
|
|
||||||
"outDir": "dist",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"module": "esnext",
|
|
||||||
"moduleResolution": "bundler",
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"isolatedModules": true,
|
|
||||||
"jsx": "react-jsx",
|
|
||||||
"incremental": true,
|
|
||||||
"types": [
|
|
||||||
"bun-types" // add Bun global
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"include": ["src/**/*.ts", "src/**/*.tsx"],
|
|
||||||
"exclude": ["node_modules"]
|
|
||||||
}
|
|
||||||
@@ -17,11 +17,12 @@ Object.entries(emojis).forEach(([key, value]) => {
|
|||||||
if (emoji && key !== emoji) {
|
if (emoji && key !== emoji) {
|
||||||
output[key] = emoji;
|
output[key] = emoji;
|
||||||
} else if (!emoji) {
|
} else if (!emoji) {
|
||||||
|
console.log('No emoji for', key);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
fs.mkdirSync(path.resolve(__dirname, 'dist'), { recursive: true });
|
fs.mkdirSync(path.resolve(__dirname, 'dist'), { recursive: true });
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
path.resolve(__dirname, 'dist/index.ts'),
|
path.resolve(__dirname, 'dist/index.ts'),
|
||||||
`export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`
|
`export const emojiCodepoints: Record<string, string> = ${JSON.stringify(output, null, 4)};`,
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
# next.js
|
|
||||||
/.next/
|
|
||||||
|
|
||||||
# vercel
|
|
||||||
.vercel
|
|
||||||
|
|
||||||
# cloudflare
|
|
||||||
.open-next
|
|
||||||
|
|
||||||
# Symbolic links
|
|
||||||
public
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
# gitbook-v2
|
|
||||||
|
|
||||||
## 0.2.5
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- Updated dependencies [77397ca]
|
|
||||||
- @gitbook/cache-tags@0.3.1
|
|
||||||
|
|
||||||
## 0.2.4
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- 4234289: Fix incoming URL for requests that were proxied
|
|
||||||
- Updated dependencies [116575c]
|
|
||||||
- @gitbook/cache-tags@0.3.0
|
|
||||||
|
|
||||||
## 0.2.3
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- 5b2bf82: Use stable site URL data for route rewrite in the middleware
|
|
||||||
|
|
||||||
## 0.2.2
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- 54ee014: Add initial support for loading custom fonts
|
|
||||||
- bba2e52: Fix site redirects when it includes a section/variant path
|
|
||||||
|
|
||||||
## 0.2.1
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- Updated dependencies [f32bf1f]
|
|
||||||
- @gitbook/cache-tags@0.2.0
|
|
||||||
|
|
||||||
## 0.2.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- 76c7974: Add route to revalidate cached data
|
|
||||||
|
|
||||||
## 0.1.2
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- 05ffd0e: Improving data cache management for computed content
|
|
||||||
- Updated dependencies [05ffd0e]
|
|
||||||
- @gitbook/cache-tags@0.1.0
|
|
||||||
|
|
||||||
## 0.1.1
|
|
||||||
|
|
||||||
### Patch Changes
|
|
||||||
|
|
||||||
- 3e11678: fix: lost section groups
|
|
||||||
|
|
||||||
## 0.1.0
|
|
||||||
|
|
||||||
### Minor Changes
|
|
||||||
|
|
||||||
- cfccc44: Setup structure and deployment for new version
|
|
||||||
Vendored
-5
@@ -1,5 +0,0 @@
|
|||||||
/// <reference types="next" />
|
|
||||||
/// <reference types="next/image-types/global" />
|
|
||||||
|
|
||||||
// NOTE: This file should not be edited
|
|
||||||
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
|
|
||||||
@@ -1,76 +0,0 @@
|
|||||||
// @ts-check
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @type {import('next').NextConfig}
|
|
||||||
*/
|
|
||||||
const nextConfig = {
|
|
||||||
experimental: {
|
|
||||||
// This is needed to throw "forbidden" when the api token expired during revalidation
|
|
||||||
authInterrupts: true,
|
|
||||||
useCache: true,
|
|
||||||
|
|
||||||
// Content is fully static, we can cache it in the session memory cache for a long time
|
|
||||||
staleTimes: {
|
|
||||||
dynamic: 3600, // 1 hour
|
|
||||||
static: 3600, // 1 hour
|
|
||||||
},
|
|
||||||
},
|
|
||||||
|
|
||||||
env: {
|
|
||||||
BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
|
|
||||||
|
|
||||||
// GitBook envs
|
|
||||||
GITBOOK_API_URL: process.env.GITBOOK_API_URL,
|
|
||||||
GITBOOK_APP_URL: process.env.GITBOOK_APP_URL,
|
|
||||||
GITBOOK_INTEGRATIONS_HOST: process.env.GITBOOK_INTEGRATIONS_HOST,
|
|
||||||
GITBOOK_IMAGE_RESIZE_URL: process.env.GITBOOK_IMAGE_RESIZE_URL,
|
|
||||||
GITBOOK_ICONS_URL: process.env.GITBOOK_ICONS_URL,
|
|
||||||
GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN,
|
|
||||||
GITBOOK_URL: process.env.GITBOOK_URL,
|
|
||||||
GITBOOK_API_TOKEN: process.env.GITBOOK_API_TOKEN,
|
|
||||||
GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX,
|
|
||||||
GITBOOK_SECRET: process.env.GITBOOK_SECRET,
|
|
||||||
GITBOOK_IMAGE_RESIZE_SIGNING_KEY: process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
|
|
||||||
GITBOOK_IMAGE_RESIZE_MODE: process.env.GITBOOK_IMAGE_RESIZE_MODE,
|
|
||||||
GITBOOK_FONTS_URL: process.env.GITBOOK_FONTS_URL,
|
|
||||||
GITBOOK_RUNTIME: process.env.GITBOOK_RUNTIME,
|
|
||||||
|
|
||||||
// Next.js envs
|
|
||||||
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
|
|
||||||
|
|
||||||
// Used to detect if the app is running in V2 mode
|
|
||||||
GITBOOK_V2: 'true',
|
|
||||||
},
|
|
||||||
|
|
||||||
assetPrefix: process.env.GITBOOK_ASSETS_PREFIX,
|
|
||||||
poweredByHeader: false,
|
|
||||||
|
|
||||||
images: {
|
|
||||||
remotePatterns: [
|
|
||||||
{
|
|
||||||
protocol: 'https',
|
|
||||||
hostname: '*.gitbook.io',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
|
|
||||||
async headers() {
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
source: '/~gitbook/static/:path*',
|
|
||||||
headers: [
|
|
||||||
{
|
|
||||||
key: 'Cache-Control',
|
|
||||||
value: 'public, max-age=31536000, immutable',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
key: 'Access-Control-Allow-Origin',
|
|
||||||
value: '*',
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
];
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
export default nextConfig;
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
import { defineCloudflareConfig } from '@opennextjs/cloudflare';
|
|
||||||
import r2IncrementalCache from '@opennextjs/cloudflare/overrides/incremental-cache/r2-incremental-cache';
|
|
||||||
import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
|
|
||||||
import doQueue from '@opennextjs/cloudflare/overrides/queue/do-queue';
|
|
||||||
import doShardedTagCache from '@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache';
|
|
||||||
|
|
||||||
export default defineCloudflareConfig({
|
|
||||||
incrementalCache: withRegionalCache(r2IncrementalCache, { mode: 'long-lived' }),
|
|
||||||
tagCache: doShardedTagCache({
|
|
||||||
baseShardSize: 12,
|
|
||||||
regionalCache: true,
|
|
||||||
shardReplication: {
|
|
||||||
numberOfSoftReplicas: 2,
|
|
||||||
numberOfHardReplicas: 1,
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
queue: doQueue,
|
|
||||||
});
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "gitbook-v2",
|
|
||||||
"version": "0.2.5",
|
|
||||||
"private": true,
|
|
||||||
"dependencies": {
|
|
||||||
"next": "canary",
|
|
||||||
"react": "^19.0.0",
|
|
||||||
"react-dom": "^19.0.0",
|
|
||||||
"@gitbook/api": "*",
|
|
||||||
"@gitbook/cache-tags": "workspace:*",
|
|
||||||
"@sindresorhus/fnv1a": "^3.1.0",
|
|
||||||
"server-only": "^0.0.1",
|
|
||||||
"warn-once": "^0.1.1",
|
|
||||||
"rison": "^0.1.1",
|
|
||||||
"jwt-decode": "^4.0.0",
|
|
||||||
"assert-never": "^1.2.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"gitbook": "*",
|
|
||||||
"@opennextjs/cloudflare": "^1.0.0-beta.3",
|
|
||||||
"@types/rison": "^0.0.9",
|
|
||||||
"tailwindcss": "^3.4.0",
|
|
||||||
"postcss": "^8"
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"generate": "rm -rf ./public && cp -r ../gitbook/public ./public",
|
|
||||||
"dev:v2": "env-cmd --silent -f ../../.env.local next --turbopack",
|
|
||||||
"build": "next build",
|
|
||||||
"build:v2": "next build",
|
|
||||||
"start": "next start",
|
|
||||||
"build:v2:cloudflare": "opennextjs-cloudflare build",
|
|
||||||
"dev:v2:cloudflare": "wrangler dev --port 8771",
|
|
||||||
"unit": "bun test",
|
|
||||||
"typecheck": "tsc --noEmit"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
plugins: {
|
|
||||||
tailwindcss: {},
|
|
||||||
autoprefixer: {},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
import { SitePageSkeleton } from '@/components/SitePage';
|
|
||||||
|
|
||||||
export default function Loading() {
|
|
||||||
return <SitePageSkeleton />;
|
|
||||||
}
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
import { SitePageNotFound } from '@/components/SitePage';
|
|
||||||
|
|
||||||
export default async function NotFound() {
|
|
||||||
return <SitePageNotFound />;
|
|
||||||
}
|
|
||||||
-36
@@ -1,36 +0,0 @@
|
|||||||
import {
|
|
||||||
SitePage,
|
|
||||||
generateSitePageMetadata,
|
|
||||||
generateSitePageViewport,
|
|
||||||
} from '@/components/SitePage';
|
|
||||||
import { type RouteParams, getDynamicSiteContext, getPagePathFromParams } from '@v2/app/utils';
|
|
||||||
import type { Metadata, Viewport } from 'next';
|
|
||||||
|
|
||||||
type PageProps = {
|
|
||||||
params: Promise<RouteParams>;
|
|
||||||
searchParams: Promise<{ fallback?: string }>;
|
|
||||||
};
|
|
||||||
|
|
||||||
export default async function Page(props: PageProps) {
|
|
||||||
const params = await props.params;
|
|
||||||
const { context } = await getDynamicSiteContext(params);
|
|
||||||
const pathname = getPagePathFromParams(params);
|
|
||||||
|
|
||||||
return <SitePage context={context} pageParams={{ pathname }} />;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateViewport(props: PageProps): Promise<Viewport> {
|
|
||||||
const { context } = await getDynamicSiteContext(await props.params);
|
|
||||||
return generateSitePageViewport(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateMetadata(props: PageProps): Promise<Metadata> {
|
|
||||||
const params = await props.params;
|
|
||||||
const { context } = await getDynamicSiteContext(params);
|
|
||||||
const pathname = getPagePathFromParams(params);
|
|
||||||
|
|
||||||
return generateSitePageMetadata({
|
|
||||||
context,
|
|
||||||
pageParams: { pathname },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
-44
@@ -1,44 +0,0 @@
|
|||||||
import { CustomizationRootLayout } from '@/components/RootLayout';
|
|
||||||
import {
|
|
||||||
SiteLayout,
|
|
||||||
generateSiteLayoutMetadata,
|
|
||||||
generateSiteLayoutViewport,
|
|
||||||
} from '@/components/SiteLayout';
|
|
||||||
import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
|
|
||||||
import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
|
|
||||||
import { getThemeFromMiddleware } from '@v2/lib/middleware';
|
|
||||||
|
|
||||||
interface SiteDynamicLayoutProps {
|
|
||||||
params: Promise<RouteLayoutParams>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default async function SiteDynamicLayout({
|
|
||||||
params,
|
|
||||||
children,
|
|
||||||
}: React.PropsWithChildren<SiteDynamicLayoutProps>) {
|
|
||||||
const { context, visitorAuthClaims } = await getDynamicSiteContext(await params);
|
|
||||||
const forcedTheme = await getThemeFromMiddleware();
|
|
||||||
|
|
||||||
return (
|
|
||||||
<CustomizationRootLayout forcedTheme={forcedTheme} customization={context.customization}>
|
|
||||||
<SiteLayout
|
|
||||||
context={context}
|
|
||||||
forcedTheme={forcedTheme}
|
|
||||||
withTracking={!GITBOOK_DISABLE_TRACKING}
|
|
||||||
visitorAuthClaims={visitorAuthClaims}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</SiteLayout>
|
|
||||||
</CustomizationRootLayout>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateViewport({ params }: SiteDynamicLayoutProps) {
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
return generateSiteLayoutViewport(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateMetadata({ params }: SiteDynamicLayoutProps) {
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
return generateSiteLayoutMetadata(context);
|
|
||||||
}
|
|
||||||
-12
@@ -1,12 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import { serveIcon } from '@/routes/icon';
|
|
||||||
import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
return serveIcon(context, request);
|
|
||||||
}
|
|
||||||
-13
@@ -1,13 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import type { PageIdParams } from '@/components/SitePage';
|
|
||||||
import { serveOGImage } from '@/routes/ogimage';
|
|
||||||
import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
_request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams & PageIdParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
return serveOGImage(context, await params);
|
|
||||||
}
|
|
||||||
-12
@@ -1,12 +0,0 @@
|
|||||||
import { PDFRootLayout } from '@/components/PDF';
|
|
||||||
import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export default async function RootLayout(props: {
|
|
||||||
params: Promise<RouteLayoutParams>;
|
|
||||||
children: React.ReactNode;
|
|
||||||
}) {
|
|
||||||
const { params, children } = props;
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
|
|
||||||
return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
|
|
||||||
}
|
|
||||||
-20
@@ -1,20 +0,0 @@
|
|||||||
import { PDFPage, generatePDFMetadata } from '@/components/PDF';
|
|
||||||
import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export async function generateMetadata({
|
|
||||||
params,
|
|
||||||
}: {
|
|
||||||
params: Promise<RouteLayoutParams>;
|
|
||||||
}) {
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
return generatePDFMetadata(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
export default async function Page(props: {
|
|
||||||
params: Promise<RouteLayoutParams>;
|
|
||||||
searchParams: Promise<{ [key: string]: string }>;
|
|
||||||
}) {
|
|
||||||
const { params, searchParams } = props;
|
|
||||||
const { context } = await getDynamicSiteContext(await params);
|
|
||||||
return <PDFPage context={context} searchParams={await searchParams} />;
|
|
||||||
}
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
import { SitePageNotFound } from '@/components/SitePage';
|
|
||||||
|
|
||||||
export default async function NotFound() {
|
|
||||||
return <SitePageNotFound />;
|
|
||||||
}
|
|
||||||
-38
@@ -1,38 +0,0 @@
|
|||||||
import {
|
|
||||||
SitePage,
|
|
||||||
generateSitePageMetadata,
|
|
||||||
generateSitePageViewport,
|
|
||||||
} from '@/components/SitePage';
|
|
||||||
import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
import type { Metadata, Viewport } from 'next';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
type PageProps = {
|
|
||||||
params: Promise<RouteParams>;
|
|
||||||
};
|
|
||||||
|
|
||||||
export default async function Page(props: PageProps) {
|
|
||||||
const params = await props.params;
|
|
||||||
const { context } = await getStaticSiteContext(params);
|
|
||||||
const pathname = getPagePathFromParams(params);
|
|
||||||
|
|
||||||
return <SitePage context={context} pageParams={{ pathname }} />;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateViewport(props: PageProps): Promise<Viewport> {
|
|
||||||
const { context } = await getStaticSiteContext(await props.params);
|
|
||||||
return generateSitePageViewport(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateMetadata(props: PageProps): Promise<Metadata> {
|
|
||||||
const params = await props.params;
|
|
||||||
const { context } = await getStaticSiteContext(params);
|
|
||||||
const pathname = getPagePathFromParams(params);
|
|
||||||
|
|
||||||
return generateSitePageMetadata({
|
|
||||||
context,
|
|
||||||
pageParams: { pathname },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
import { CustomizationRootLayout } from '@/components/RootLayout';
|
|
||||||
import {
|
|
||||||
SiteLayout,
|
|
||||||
generateSiteLayoutMetadata,
|
|
||||||
generateSiteLayoutViewport,
|
|
||||||
} from '@/components/SiteLayout';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
import { GITBOOK_DISABLE_TRACKING } from '@v2/lib/env';
|
|
||||||
|
|
||||||
interface SiteStaticLayoutProps {
|
|
||||||
params: Promise<RouteLayoutParams>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default async function SiteStaticLayout({
|
|
||||||
params,
|
|
||||||
children,
|
|
||||||
}: React.PropsWithChildren<SiteStaticLayoutProps>) {
|
|
||||||
const { context, visitorAuthClaims } = await getStaticSiteContext(await params);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<CustomizationRootLayout customization={context.customization}>
|
|
||||||
<SiteLayout
|
|
||||||
context={context}
|
|
||||||
withTracking={!GITBOOK_DISABLE_TRACKING}
|
|
||||||
visitorAuthClaims={visitorAuthClaims}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</SiteLayout>
|
|
||||||
</CustomizationRootLayout>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateViewport({ params }: SiteStaticLayoutProps) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return generateSiteLayoutViewport(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateMetadata({ params }: SiteStaticLayoutProps) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return generateSiteLayoutMetadata(context);
|
|
||||||
}
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import { serveLLMsTxt } from '@/routes/llms';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
_request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return serveLLMsTxt(context, { withMarkdownPages: true });
|
|
||||||
}
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import { serveRobotsTxt } from '@/routes/robots';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
_request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return serveRobotsTxt(context);
|
|
||||||
}
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import { servePagesSitemap } from '@/routes/sitemap';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
_request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return servePagesSitemap(context);
|
|
||||||
}
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import { serveRootSitemap } from '@/routes/sitemap';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
_request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return serveRootSitemap(context);
|
|
||||||
}
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import { serveIcon } from '@/routes/icon';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return serveIcon(context, request);
|
|
||||||
}
|
|
||||||
-11
@@ -1,11 +0,0 @@
|
|||||||
import { servePageMarkdown } from '@/routes/markdownPage';
|
|
||||||
import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(_request: NextRequest, { params }: { params: Promise<RouteParams> }) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
const pathname = getPagePathFromParams(await params);
|
|
||||||
return servePageMarkdown(context, pathname);
|
|
||||||
}
|
|
||||||
-15
@@ -1,15 +0,0 @@
|
|||||||
import type { NextRequest } from 'next/server';
|
|
||||||
|
|
||||||
import type { PageIdParams } from '@/components/SitePage';
|
|
||||||
import { serveOGImage } from '@/routes/ogimage';
|
|
||||||
import { type RouteLayoutParams, getStaticSiteContext } from '@v2/app/utils';
|
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
|
||||||
|
|
||||||
export async function GET(
|
|
||||||
_request: NextRequest,
|
|
||||||
{ params }: { params: Promise<RouteLayoutParams & PageIdParams> }
|
|
||||||
) {
|
|
||||||
const { context } = await getStaticSiteContext(await params);
|
|
||||||
return serveOGImage(context, await params);
|
|
||||||
}
|
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
import { getVisitorAuthClaims, getVisitorAuthClaimsFromToken } from '@/lib/adaptive';
|
|
||||||
import type { SiteAPIToken } from '@gitbook/api';
|
|
||||||
import { type SiteURLData, fetchSiteContextByURLLookup, getBaseContext } from '@v2/lib/context';
|
|
||||||
import { jwtDecode } from 'jwt-decode';
|
|
||||||
import { forbidden } from 'next/navigation';
|
|
||||||
import rison from 'rison';
|
|
||||||
|
|
||||||
export type RouteParamMode = 'url-host' | 'url';
|
|
||||||
|
|
||||||
export type RouteLayoutParams = {
|
|
||||||
mode: string;
|
|
||||||
|
|
||||||
/** URL encoded site URL */
|
|
||||||
siteURL: string;
|
|
||||||
|
|
||||||
/** URL and Rison encoded site data from getPublishedContentByUrl */
|
|
||||||
siteData: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type RouteParams = RouteLayoutParams & {
|
|
||||||
pagePath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the static context when rendering statically a site.
|
|
||||||
*/
|
|
||||||
export async function getStaticSiteContext(params: RouteLayoutParams) {
|
|
||||||
const siteURL = getSiteURLFromParams(params);
|
|
||||||
const siteURLData = getSiteURLDataFromParams(params);
|
|
||||||
|
|
||||||
// For static routes, we check the expiration of the JWT token
|
|
||||||
// as the route might be revalidated after expiration
|
|
||||||
const decoded = jwtDecode<SiteAPIToken & { exp: number }>(siteURLData.apiToken);
|
|
||||||
if (decoded.exp && decoded.exp < Date.now() / 1000 + 120) {
|
|
||||||
forbidden();
|
|
||||||
}
|
|
||||||
|
|
||||||
const context = await fetchSiteContextByURLLookup(
|
|
||||||
getBaseContext({
|
|
||||||
siteURL,
|
|
||||||
siteURLData,
|
|
||||||
urlMode: getModeFromParams(params.mode),
|
|
||||||
}),
|
|
||||||
siteURLData
|
|
||||||
);
|
|
||||||
|
|
||||||
return {
|
|
||||||
context,
|
|
||||||
visitorAuthClaims: getVisitorAuthClaimsFromToken(decoded),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the site context when rendering dynamically.
|
|
||||||
* The context will depend on the request.
|
|
||||||
*/
|
|
||||||
export async function getDynamicSiteContext(params: RouteLayoutParams) {
|
|
||||||
const siteURL = getSiteURLFromParams(params);
|
|
||||||
const siteURLData = getSiteURLDataFromParams(params);
|
|
||||||
|
|
||||||
const context = await fetchSiteContextByURLLookup(
|
|
||||||
getBaseContext({
|
|
||||||
siteURL,
|
|
||||||
siteURLData,
|
|
||||||
urlMode: getModeFromParams(params.mode),
|
|
||||||
}),
|
|
||||||
siteURLData
|
|
||||||
);
|
|
||||||
|
|
||||||
return {
|
|
||||||
context,
|
|
||||||
visitorAuthClaims: getVisitorAuthClaims(siteURLData),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the decoded page path from the params.
|
|
||||||
*/
|
|
||||||
export function getPagePathFromParams(params: RouteParams) {
|
|
||||||
const decoded = decodeURIComponent(params.pagePath);
|
|
||||||
return decoded;
|
|
||||||
}
|
|
||||||
|
|
||||||
function getSiteURLFromParams(params: RouteLayoutParams) {
|
|
||||||
const decoded = decodeURIComponent(params.siteURL);
|
|
||||||
const url = new URL(`https://${decoded}`);
|
|
||||||
return url;
|
|
||||||
}
|
|
||||||
|
|
||||||
function getModeFromParams(mode: string): RouteParamMode {
|
|
||||||
if (mode === 'url-host') {
|
|
||||||
return 'url-host';
|
|
||||||
}
|
|
||||||
|
|
||||||
return 'url';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the decoded site data from the params.
|
|
||||||
*/
|
|
||||||
function getSiteURLDataFromParams(params: RouteLayoutParams): SiteURLData {
|
|
||||||
const decoded = decodeURIComponent(params.siteData);
|
|
||||||
return rison.decode(decoded);
|
|
||||||
}
|
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
import { type NextRequest, NextResponse } from 'next/server';
|
|
||||||
|
|
||||||
import {
|
|
||||||
GITBOOK_API_PUBLIC_URL,
|
|
||||||
GITBOOK_API_TOKEN,
|
|
||||||
GITBOOK_API_URL,
|
|
||||||
GITBOOK_APP_URL,
|
|
||||||
GITBOOK_ASSETS_URL,
|
|
||||||
GITBOOK_DISABLE_TRACKING,
|
|
||||||
GITBOOK_FONTS_URL,
|
|
||||||
GITBOOK_ICONS_URL,
|
|
||||||
GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
|
|
||||||
GITBOOK_INTEGRATIONS_HOST,
|
|
||||||
GITBOOK_SECRET,
|
|
||||||
GITBOOK_URL,
|
|
||||||
GITBOOK_USER_AGENT,
|
|
||||||
} from '@v2/lib/env';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Output the public environment variables for this deployment
|
|
||||||
*/
|
|
||||||
export async function GET(_req: NextRequest) {
|
|
||||||
return NextResponse.json({
|
|
||||||
GITBOOK_URL,
|
|
||||||
GITBOOK_APP_URL,
|
|
||||||
GITBOOK_API_URL,
|
|
||||||
GITBOOK_API_PUBLIC_URL,
|
|
||||||
GITBOOK_ASSETS_URL,
|
|
||||||
GITBOOK_FONTS_URL,
|
|
||||||
GITBOOK_ICONS_URL,
|
|
||||||
GITBOOK_USER_AGENT,
|
|
||||||
GITBOOK_INTEGRATIONS_HOST,
|
|
||||||
GITBOOK_DISABLE_TRACKING,
|
|
||||||
|
|
||||||
// Secret envs
|
|
||||||
GITBOOK_SECRET: !!GITBOOK_SECRET,
|
|
||||||
GITBOOK_API_TOKEN: !!GITBOOK_API_TOKEN,
|
|
||||||
GITBOOK_IMAGE_RESIZE_SIGNING_KEY: !!GITBOOK_IMAGE_RESIZE_SIGNING_KEY,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
import { type NextRequest, NextResponse } from 'next/server';
|
|
||||||
|
|
||||||
import { withVerifySignature } from '@v2/lib/routes';
|
|
||||||
import { revalidateTag } from 'next/cache';
|
|
||||||
|
|
||||||
interface JsonBody {
|
|
||||||
tags: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Revalidate cached data based on tags.
|
|
||||||
* The body should be a JSON with { tags: string[] }
|
|
||||||
*/
|
|
||||||
export async function POST(req: NextRequest) {
|
|
||||||
return withVerifySignature<JsonBody>(req, async (body) => {
|
|
||||||
if (!body.tags || !Array.isArray(body.tags)) {
|
|
||||||
return NextResponse.json(
|
|
||||||
{
|
|
||||||
error: 'tags must be an array',
|
|
||||||
},
|
|
||||||
{ status: 400 }
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
body.tags.forEach((tag) => {
|
|
||||||
// biome-ignore lint/suspicious/noConsole: we want to log here
|
|
||||||
console.log(`Revalidating tag: ${tag}`);
|
|
||||||
revalidateTag(tag);
|
|
||||||
});
|
|
||||||
|
|
||||||
return NextResponse.json({
|
|
||||||
success: true,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
import {
|
|
||||||
type GitBookBaseContext,
|
|
||||||
type GitBookSpaceContext,
|
|
||||||
fetchSpaceContextByIds,
|
|
||||||
} from '@v2/lib/context';
|
|
||||||
import { createDataFetcher } from '@v2/lib/data';
|
|
||||||
import { createLinker } from '@v2/lib/links';
|
|
||||||
import { getAPITokenFromMiddleware } from '@v2/lib/middleware';
|
|
||||||
|
|
||||||
export type SpacePDFRouteParams = {
|
|
||||||
spaceId: string;
|
|
||||||
changeRequestId?: string;
|
|
||||||
revisionId?: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export async function getSpacePDFContext(
|
|
||||||
params: SpacePDFRouteParams
|
|
||||||
): Promise<GitBookSpaceContext> {
|
|
||||||
const { spaceId } = params;
|
|
||||||
|
|
||||||
const apiToken = await getAPITokenFromMiddleware();
|
|
||||||
|
|
||||||
const basePath = getPDFRoutePath(params);
|
|
||||||
const linker = createLinker({
|
|
||||||
spaceBasePath: basePath,
|
|
||||||
siteBasePath: basePath,
|
|
||||||
});
|
|
||||||
const dataFetcher = createDataFetcher({
|
|
||||||
apiToken: apiToken,
|
|
||||||
});
|
|
||||||
|
|
||||||
const baseContext: GitBookBaseContext = {
|
|
||||||
linker,
|
|
||||||
dataFetcher,
|
|
||||||
};
|
|
||||||
|
|
||||||
return await fetchSpaceContextByIds(baseContext, {
|
|
||||||
space: spaceId,
|
|
||||||
shareKey: undefined,
|
|
||||||
changeRequest: params.changeRequestId,
|
|
||||||
revision: params.revisionId,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function getPDFRoutePath(params: SpacePDFRouteParams) {
|
|
||||||
let path = `/~space/${params.spaceId}`;
|
|
||||||
|
|
||||||
if (params.changeRequestId) {
|
|
||||||
path += `/~/changes/${params.changeRequestId}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (params.revisionId) {
|
|
||||||
path += `/~/revisions/${params.revisionId}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
path += '~gitbook/pdf';
|
|
||||||
|
|
||||||
return path;
|
|
||||||
}
|
|
||||||
-2
@@ -1,2 +0,0 @@
|
|||||||
import RootLayout from '@v2/app/~space/[spaceId]/~gitbook/pdf/layout';
|
|
||||||
export default RootLayout;
|
|
||||||
-4
@@ -1,4 +0,0 @@
|
|||||||
import PDFPage, { generateMetadata } from '@v2/app/~space/[spaceId]/~gitbook/pdf/page';
|
|
||||||
|
|
||||||
export default PDFPage;
|
|
||||||
export { generateMetadata };
|
|
||||||
-2
@@ -1,2 +0,0 @@
|
|||||||
import RootLayout from '@v2/app/~space/[spaceId]/~gitbook/pdf/layout';
|
|
||||||
export default RootLayout;
|
|
||||||
-4
@@ -1,4 +0,0 @@
|
|||||||
import PDFPage, { generateMetadata } from '@v2/app/~space/[spaceId]/~gitbook/pdf/page';
|
|
||||||
|
|
||||||
export default PDFPage;
|
|
||||||
export { generateMetadata };
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
import { PDFRootLayout } from '@/components/PDF';
|
|
||||||
import { type SpacePDFRouteParams, getSpacePDFContext } from '@v2/app/~space/[spaceId]/pdf';
|
|
||||||
|
|
||||||
export default async function RootLayout(props: {
|
|
||||||
params: Promise<SpacePDFRouteParams>;
|
|
||||||
children: React.ReactNode;
|
|
||||||
}) {
|
|
||||||
const { params, children } = props;
|
|
||||||
const context = await getSpacePDFContext(await params);
|
|
||||||
|
|
||||||
return <PDFRootLayout context={context}>{children}</PDFRootLayout>;
|
|
||||||
}
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
import { PDFPage, generatePDFMetadata } from '@/components/PDF';
|
|
||||||
import { type SpacePDFRouteParams, getSpacePDFContext } from '@v2/app/~space/[spaceId]/pdf';
|
|
||||||
|
|
||||||
export async function generateMetadata({
|
|
||||||
params,
|
|
||||||
}: {
|
|
||||||
params: Promise<SpacePDFRouteParams>;
|
|
||||||
}) {
|
|
||||||
const context = await getSpacePDFContext(await params);
|
|
||||||
return generatePDFMetadata(context);
|
|
||||||
}
|
|
||||||
|
|
||||||
export default async function Page(props: {
|
|
||||||
params: Promise<SpacePDFRouteParams>;
|
|
||||||
searchParams: Promise<{ [key: string]: string }>;
|
|
||||||
}) {
|
|
||||||
const { params, searchParams } = props;
|
|
||||||
const context = await getSpacePDFContext(await params);
|
|
||||||
return <PDFPage context={context} searchParams={await searchParams} />;
|
|
||||||
}
|
|
||||||
@@ -1,390 +0,0 @@
|
|||||||
import { getSiteStructureSections } from '@/lib/sites';
|
|
||||||
import type {
|
|
||||||
ChangeRequest,
|
|
||||||
PublishedSiteContent,
|
|
||||||
RevisionPage,
|
|
||||||
RevisionPageDocument,
|
|
||||||
Site,
|
|
||||||
SiteCustomizationSettings,
|
|
||||||
SiteIntegrationScript,
|
|
||||||
SiteSection,
|
|
||||||
SiteSectionGroup,
|
|
||||||
SiteSpace,
|
|
||||||
SiteStructure,
|
|
||||||
Space,
|
|
||||||
} from '@gitbook/api';
|
|
||||||
import {
|
|
||||||
type GitBookDataFetcher,
|
|
||||||
createDataFetcher,
|
|
||||||
getDataOrNull,
|
|
||||||
throwIfDataError,
|
|
||||||
} from '@v2/lib/data';
|
|
||||||
import { notFound } from 'next/navigation';
|
|
||||||
import { assert } from 'ts-essentials';
|
|
||||||
import { GITBOOK_URL } from './env';
|
|
||||||
import { type ImageResizer, createImageResizer } from './images';
|
|
||||||
import { type GitBookLinker, createLinker } from './links';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Data about the site URL. Provided by the middleware.
|
|
||||||
* These data are stable between pages in the same site space.
|
|
||||||
*/
|
|
||||||
export type SiteURLData = Pick<
|
|
||||||
PublishedSiteContent,
|
|
||||||
| 'organization'
|
|
||||||
| 'apiToken'
|
|
||||||
| 'site'
|
|
||||||
| 'siteSpace'
|
|
||||||
| 'space'
|
|
||||||
| 'revision'
|
|
||||||
| 'changeRequest'
|
|
||||||
| 'shareKey'
|
|
||||||
| 'siteSection'
|
|
||||||
| 'siteBasePath'
|
|
||||||
| 'basePath'
|
|
||||||
> & {
|
|
||||||
/**
|
|
||||||
* Identifier used for image resizing.
|
|
||||||
*/
|
|
||||||
imagesContextId: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generic context when rendering content.
|
|
||||||
*/
|
|
||||||
export type GitBookBaseContext = {
|
|
||||||
/**
|
|
||||||
* Data fetcher to fetch data from GitBook.
|
|
||||||
*/
|
|
||||||
dataFetcher: GitBookDataFetcher;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Linker to generate links in the current space.
|
|
||||||
*/
|
|
||||||
linker: GitBookLinker;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Image resizer to resize images.
|
|
||||||
*/
|
|
||||||
imageResizer?: ImageResizer;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Any context when rendering content.
|
|
||||||
*/
|
|
||||||
export type GitBookAnyContext = GitBookSpaceContext | GitBookSiteContext | GitBookPageContext;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Context when rendering a space content.
|
|
||||||
*/
|
|
||||||
export type GitBookSpaceContext = GitBookBaseContext & {
|
|
||||||
organizationId: string;
|
|
||||||
|
|
||||||
space: Space;
|
|
||||||
changeRequest: ChangeRequest | null;
|
|
||||||
|
|
||||||
/** ID of the current revision. */
|
|
||||||
revisionId: string;
|
|
||||||
|
|
||||||
/** Pages of the space. */
|
|
||||||
pages: RevisionPage[];
|
|
||||||
|
|
||||||
/** Share key of the space. */
|
|
||||||
shareKey: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type SiteSections = {
|
|
||||||
list: (SiteSectionGroup | SiteSection)[];
|
|
||||||
current: SiteSection;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Context when rendering a site.
|
|
||||||
*/
|
|
||||||
export type GitBookSiteContext = GitBookSpaceContext & {
|
|
||||||
site: Site;
|
|
||||||
|
|
||||||
/** Current site space. */
|
|
||||||
siteSpace: SiteSpace;
|
|
||||||
|
|
||||||
/** All site spaces in the current section / or entire site */
|
|
||||||
siteSpaces: SiteSpace[];
|
|
||||||
|
|
||||||
/** Sections of the site. */
|
|
||||||
sections: null | SiteSections;
|
|
||||||
|
|
||||||
/** Customizations of the site. */
|
|
||||||
customization: SiteCustomizationSettings;
|
|
||||||
|
|
||||||
/** Structure of the site. */
|
|
||||||
structure: SiteStructure;
|
|
||||||
|
|
||||||
/** Scripts to load for the site. */
|
|
||||||
scripts: SiteIntegrationScript[];
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Context when rendering a page.
|
|
||||||
*/
|
|
||||||
export type GitBookPageContext = (GitBookSpaceContext | GitBookSiteContext) & {
|
|
||||||
page: RevisionPageDocument;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the base context for a request on a site.
|
|
||||||
*/
|
|
||||||
export function getBaseContext(input: {
|
|
||||||
siteURL: URL | string;
|
|
||||||
siteURLData: SiteURLData;
|
|
||||||
urlMode: 'url' | 'url-host';
|
|
||||||
}) {
|
|
||||||
const { urlMode, siteURLData } = input;
|
|
||||||
const siteURL = typeof input.siteURL === 'string' ? new URL(input.siteURL) : input.siteURL;
|
|
||||||
|
|
||||||
const dataFetcher = createDataFetcher({
|
|
||||||
apiToken: siteURLData.apiToken ?? null,
|
|
||||||
});
|
|
||||||
|
|
||||||
const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
|
|
||||||
const linker =
|
|
||||||
urlMode === 'url-host'
|
|
||||||
? createLinker({
|
|
||||||
host: siteURL.host,
|
|
||||||
siteBasePath: siteURLData.siteBasePath,
|
|
||||||
spaceBasePath: siteURLData.basePath,
|
|
||||||
})
|
|
||||||
: createLinker({
|
|
||||||
protocol: gitbookURL?.protocol,
|
|
||||||
host: gitbookURL?.host,
|
|
||||||
siteBasePath: `/url/${siteURL.host}${siteURLData.siteBasePath}`,
|
|
||||||
spaceBasePath: `/url/${siteURL.host}${siteURLData.basePath}`,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (urlMode === 'url') {
|
|
||||||
// Create link in the same format for links to other sites/sections.
|
|
||||||
linker.toLinkForContent = (rawURL: string) => {
|
|
||||||
const urlObject = new URL(rawURL);
|
|
||||||
return `/url/${urlObject.host}${urlObject.pathname}${urlObject.search}`;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
const imageResizer = createImageResizer({
|
|
||||||
imagesContextId: siteURLData.imagesContextId,
|
|
||||||
// To ensure image resizing work for proxied sites,
|
|
||||||
// we serve images from the root of the site.
|
|
||||||
linker: linker,
|
|
||||||
});
|
|
||||||
|
|
||||||
return {
|
|
||||||
dataFetcher,
|
|
||||||
linker,
|
|
||||||
imageResizer,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Fetch the context of a site using the resolution of a URL
|
|
||||||
*/
|
|
||||||
export async function fetchSiteContextByURLLookup(
|
|
||||||
baseContext: GitBookBaseContext,
|
|
||||||
data: SiteURLData
|
|
||||||
): Promise<GitBookSiteContext> {
|
|
||||||
return await fetchSiteContextByIds(baseContext, {
|
|
||||||
organization: data.organization,
|
|
||||||
site: data.site,
|
|
||||||
siteSection: data.siteSection,
|
|
||||||
siteSpace: data.siteSpace,
|
|
||||||
space: data.space,
|
|
||||||
shareKey: data.shareKey,
|
|
||||||
changeRequest: data.changeRequest,
|
|
||||||
revision: data.revision,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Fetch a site context by IDs.
|
|
||||||
*/
|
|
||||||
export async function fetchSiteContextByIds(
|
|
||||||
baseContext: GitBookBaseContext,
|
|
||||||
ids: {
|
|
||||||
organization: string;
|
|
||||||
site: string;
|
|
||||||
siteSection: string | undefined;
|
|
||||||
siteSpace: string | undefined;
|
|
||||||
space: string;
|
|
||||||
shareKey: string | undefined;
|
|
||||||
changeRequest: string | undefined;
|
|
||||||
revision: string | undefined;
|
|
||||||
}
|
|
||||||
): Promise<GitBookSiteContext> {
|
|
||||||
const { dataFetcher } = baseContext;
|
|
||||||
|
|
||||||
const [{ site: orgSite, structure: siteStructure, customizations, scripts }, spaceContext] =
|
|
||||||
await Promise.all([
|
|
||||||
throwIfDataError(
|
|
||||||
dataFetcher.getPublishedContentSite({
|
|
||||||
organizationId: ids.organization,
|
|
||||||
siteId: ids.site,
|
|
||||||
siteShareKey: ids.shareKey,
|
|
||||||
})
|
|
||||||
),
|
|
||||||
fetchSpaceContextByIds(baseContext, ids),
|
|
||||||
]);
|
|
||||||
|
|
||||||
// override the title with the customization title
|
|
||||||
// TODO: remove this hack once we have a proper way to handle site customizations
|
|
||||||
const site = {
|
|
||||||
...orgSite,
|
|
||||||
...(customizations.site?.title ? { title: customizations.site.title } : {}),
|
|
||||||
};
|
|
||||||
|
|
||||||
const sections = ids.siteSection
|
|
||||||
? parseSiteSectionsAndGroups(siteStructure, ids.siteSection)
|
|
||||||
: null;
|
|
||||||
|
|
||||||
const siteSpace = (
|
|
||||||
siteStructure.type === 'siteSpaces' && siteStructure.structure
|
|
||||||
? siteStructure.structure
|
|
||||||
: sections?.current.siteSpaces
|
|
||||||
)?.find((siteSpace) => siteSpace.id === ids.siteSpace);
|
|
||||||
if (!siteSpace) {
|
|
||||||
throw new Error('Site space not found');
|
|
||||||
}
|
|
||||||
|
|
||||||
const siteSpaces =
|
|
||||||
siteStructure.type === 'siteSpaces'
|
|
||||||
? siteStructure.structure
|
|
||||||
: (sections?.current.siteSpaces ?? []);
|
|
||||||
|
|
||||||
const customization = (() => {
|
|
||||||
if (ids.siteSpace) {
|
|
||||||
const siteSpaceSettings = customizations.siteSpaces[ids.siteSpace];
|
|
||||||
if (siteSpaceSettings) {
|
|
||||||
return siteSpaceSettings;
|
|
||||||
}
|
|
||||||
|
|
||||||
// We got the pointer from an API and customizations from another.
|
|
||||||
// It's possible that the two are unsynced leading to not found customizations for the space.
|
|
||||||
// It's better to fallback on customization of the site that displaying an error.
|
|
||||||
console.warn('Customization not found for site space', ids.siteSpace);
|
|
||||||
}
|
|
||||||
|
|
||||||
return customizations.site;
|
|
||||||
})();
|
|
||||||
|
|
||||||
return {
|
|
||||||
...spaceContext,
|
|
||||||
organizationId: ids.organization,
|
|
||||||
site,
|
|
||||||
siteSpaces,
|
|
||||||
siteSpace,
|
|
||||||
customization,
|
|
||||||
structure: siteStructure,
|
|
||||||
sections,
|
|
||||||
scripts,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Fetch a space context by IDs.
|
|
||||||
*/
|
|
||||||
export async function fetchSpaceContextByIds(
|
|
||||||
baseContext: GitBookBaseContext,
|
|
||||||
ids: {
|
|
||||||
space: string;
|
|
||||||
shareKey: string | undefined;
|
|
||||||
changeRequest: string | undefined;
|
|
||||||
revision: string | undefined;
|
|
||||||
}
|
|
||||||
): Promise<GitBookSpaceContext> {
|
|
||||||
const { dataFetcher } = baseContext;
|
|
||||||
|
|
||||||
const [space, changeRequest] = await Promise.all([
|
|
||||||
throwIfDataError(
|
|
||||||
dataFetcher.getSpace({
|
|
||||||
spaceId: ids.space,
|
|
||||||
shareKey: ids.shareKey,
|
|
||||||
})
|
|
||||||
),
|
|
||||||
ids.changeRequest
|
|
||||||
? getDataOrNull(
|
|
||||||
dataFetcher.getChangeRequest({
|
|
||||||
spaceId: ids.space,
|
|
||||||
changeRequestId: ids.changeRequest,
|
|
||||||
})
|
|
||||||
)
|
|
||||||
: null,
|
|
||||||
]);
|
|
||||||
|
|
||||||
if (ids.changeRequest && !changeRequest) {
|
|
||||||
// When trying to render a change request with an invalid / non-existing ID,
|
|
||||||
// we should return a 404.
|
|
||||||
notFound();
|
|
||||||
}
|
|
||||||
|
|
||||||
const revisionId = ids.revision ?? changeRequest?.revision ?? space.revision;
|
|
||||||
|
|
||||||
const pages = await getDataOrNull(
|
|
||||||
dataFetcher.getRevisionPages({
|
|
||||||
spaceId: ids.space,
|
|
||||||
revisionId,
|
|
||||||
// We only care about the Git metadata when the Git sync is enabled,
|
|
||||||
// otherwise we can optimize performance by not fetching it
|
|
||||||
metadata: !!space.gitSync,
|
|
||||||
}),
|
|
||||||
|
|
||||||
// When trying to render a revision with an invalid / non-existing ID,
|
|
||||||
// we should handle gracefully the 404 and throw notFound.
|
|
||||||
ids.revision ? [404] : undefined
|
|
||||||
);
|
|
||||||
if (!pages) {
|
|
||||||
notFound();
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
...baseContext,
|
|
||||||
organizationId: space.organization,
|
|
||||||
space,
|
|
||||||
pages,
|
|
||||||
changeRequest,
|
|
||||||
revisionId,
|
|
||||||
shareKey: ids.shareKey,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the context is the root one for a site.
|
|
||||||
* Meaning we are on the default section / space.
|
|
||||||
*/
|
|
||||||
export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {
|
|
||||||
const { structure } = context;
|
|
||||||
switch (structure.type) {
|
|
||||||
case 'sections': {
|
|
||||||
return getSiteStructureSections(structure, { ignoreGroups: true }).some(
|
|
||||||
(structure) =>
|
|
||||||
structure.default &&
|
|
||||||
structure.id === context.sections?.current.id &&
|
|
||||||
structure.siteSpaces.some(
|
|
||||||
(siteSpace) => siteSpace.default && siteSpace.id === context.siteSpace.id
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
case 'siteSpaces': {
|
|
||||||
return structure.structure.some(
|
|
||||||
(siteSpace) => siteSpace.default && siteSpace.id === context.siteSpace.id
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseSiteSectionsAndGroups(structure: SiteStructure, siteSectionId: string) {
|
|
||||||
const sectionsAndGroups = getSiteStructureSections(structure, { ignoreGroups: false });
|
|
||||||
const section = parseCurrentSection(structure, siteSectionId);
|
|
||||||
assert(section, 'A section must be defined when there are multiple sections');
|
|
||||||
return { list: sectionsAndGroups, current: section } satisfies SiteSections;
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseCurrentSection(structure: SiteStructure, siteSectionId: string) {
|
|
||||||
const sections = getSiteStructureSections(structure, { ignoreGroups: true });
|
|
||||||
return sections.find((section) => section.id === siteSectionId);
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user