Compare commits

..

32 Commits

Author SHA1 Message Date
Samy Pessé 65c1bdc455 Version Packages (#2945)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-03-07 19:37:41 +01:00
Samy Pessé 0711a171d4 Fix deployment of 2c to production 2025-03-07 18:26:51 +01:00
Samy Pessé c58c551f9e Simplify envs management for deployments (#2943) 2025-03-07 18:17:44 +01:00
Greg Bergé f574858b9b Fix OpenAPI example (#2944) 2025-03-07 17:54:35 +01:00
Samy Pessé 3e1592e16b Fix configuration for v2 staging (#2940) 2025-03-07 14:46:45 +01:00
Samy Pessé 90604c4c3b Version Packages (#2917)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-03-07 14:03:59 +01:00
Claire Chabas 9ffc3b606d Fix content overflowing out of their container in lists (#2939) 2025-03-07 11:19:02 +01:00
Samy Pessé e00c87d3e6 Output a x-gitbook-route-type header to distinguish static/dynamic (#2938) 2025-03-07 10:29:50 +01:00
Nolann B. bb3ca9c165 Implement OpenAPI models blocks (#2908) 2025-03-07 09:44:14 +01:00
Samy Pessé 8ee9757132 v2: cleanup deployment to Cloudflare (#2937) 2025-03-07 09:15:43 +01:00
Samy Pessé 946a463979 v2: Fix deployment to Cloudflare and improve CI (#2935) 2025-03-07 00:01:07 +01:00
Samy Pessé 7aad9f7ff8 v2: render code block with syntax highlighting on the server (#2932) 2025-03-06 15:07:06 +01:00
Greg Bergé 3fe8f7c219 Fix circular refs OpenAPI (#2934) 2025-03-06 10:32:49 +00:00
Greg Bergé 0278a14e8e Upgrade Scalar client & fix opening endpoint (#2933) 2025-03-06 11:28:51 +01:00
Samy Pessé e5366d3a49 v2: fix error handling in middleware and data fetcher (#2925) 2025-03-06 10:53:17 +01:00
Samy Pessé 38e84ffe1a Persist visitor auth token in cookie for as long as the token is valid (#2931) 2025-03-06 09:45:25 +01:00
Greg Bergé 052e07a936 Support references pointing to invalid files (#2930) 2025-03-05 21:37:46 +01:00
Samy Pessé 7e67ebc11d Fix condition for public content cache (#2929) 2025-03-05 21:22:22 +01:00
Samy Pessé c9dea94717 V2: Add back redirect for trailing slash (#2928) 2025-03-05 21:06:33 +01:00
Samy Pessé 1344754ca9 v2: enable skipTrailingSlashRedirect in the middleware 2025-03-05 19:27:48 +01:00
Samy Pessé 0f4759fb89 Fix condition for VERCEL_URL 2025-03-05 16:30:59 +01:00
Samy Pessé 6d77b647a4 Skip requests to assets/main/vercel hosts in middleware (#2927) 2025-03-05 16:22:20 +01:00
Zeno Kapitein 5907bd9af4 Adjust hint spacing (#2873) 2025-03-05 15:59:58 +01:00
Samy Pessé b66d04c9c5 v2: fix resolution of revalidation requests (#2926) 2025-03-05 14:48:07 +01:00
Nolann B. 3173d8ec2d Remove top level circular refs in alternatives (#2924) 2025-03-05 14:08:34 +01:00
Samy Pessé 31e381035e Dynamic routing for v2: customization preview and visitor auth (#2922) 2025-03-05 11:25:44 +01:00
Greg Bergé 259074b81f Fix OpenAPI spec recursion (#2920) 2025-03-05 09:25:23 +01:00
Samy Pessé 9a2f5b9295 Fix host used for image resizing in v2 (#2923) 2025-03-04 23:42:15 +01:00
Greg Bergé 58cd70b0c1 Put back logs (#2919) 2025-03-04 20:33:29 +00:00
Samy Pessé 821899a767 Fix image resizing in v2 when url is being passed as x-gitbook-url (#2921) 2025-03-04 18:57:49 +01:00
Samy Pessé bfcc119ff3 Remove support for x-gitbook-host in v2 (#2918) 2025-03-04 18:36:43 +01:00
Samy Pessé 76c797498e Implement route to invalidate data cache (#2916) 2025-03-04 13:52:02 +01:00
98 changed files with 2570 additions and 1614 deletions
@@ -0,0 +1,70 @@
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
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_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_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
- name: Build worker
run: bun run turbo build:v2: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: '3.112.0'
environment: ${{ inputs.environment }}
command: ${{ fromJSON(inputs.deploy) == true && 'deploy' || 'versions upload' }} --config ./packages/gitbook-v2/wrangler.toml
- name: Outputs
shell: bash
env:
DEPLOYMENT_URL: ${{ steps.deploy.outputs.deployment-url }}
run: |
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+33 -16
View File
@@ -1,15 +1,21 @@
name: 'Deploy vercel' name: 'Deploy vercel'
description: 'Deploy GitBook to Vercel' description: 'Deploy GitBook to Vercel'
inputs: inputs:
vercel-org: vercelOrg:
description: 'Vercel organization' description: 'Vercel organization'
required: true required: true
vercel-project: vercelProject:
description: 'Vercel project' description: 'Vercel project'
required: true required: true
vercel-token: vercelToken:
description: 'Vercel token' description: 'Vercel token'
required: true required: true
opItem:
description: '1Password item to load secrets from'
required: true
opServiceAccount:
description: '1Password service account token'
required: true
environment: environment:
description: 'Environment to deploy to' description: 'Environment to deploy to'
required: true required: true
@@ -27,31 +33,42 @@ runs:
shell: bash shell: bash
env: env:
PUPPETEER_SKIP_DOWNLOAD: 1 PUPPETEER_SKIP_DOWNLOAD: 1
- name: Sets env vars for environment
shell: bash
run: |
echo "VERCEL_ENVIRONMENT=${{ inputs.environment }}" >> $GITHUB_ENV
- name: Pull Vercel Environment Information - name: Pull Vercel Environment Information
run: bun run vercel pull --yes --environment=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }} run: bun run vercel pull --yes --environment=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
shell: bash shell: bash
env: env:
VERCEL_ORG_ID: ${{ inputs.vercel-org }} VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
VERCEL_PROJECT_ID: ${{ inputs.vercel-project }} 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_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_ASSETS_PREFIX: ${{ inputs.opItem }}/GITBOOK_ASSETS_PREFIX
- name: Build Project Artifacts - name: Build Project Artifacts
run: bun run vercel build --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }} run: bun run vercel build --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }}
shell: bash shell: bash
env: env:
VERCEL_ORG_ID: ${{ inputs.vercel-org }} VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
VERCEL_PROJECT_ID: ${{ inputs.vercel-project }} VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
- name: Deploy Project Artifacts to Vercel - name: Deploy Project Artifacts to Vercel
id: deploy id: deploy
shell: bash shell: bash
run: | run: |
DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=$VERCEL_ENVIRONMENT --token=${{ inputs.vercel-token }}) DEPLOYMENT_URL=$(bun run vercel deploy --prebuilt --target=${{ inputs.environment }} --token=${{ inputs.vercelToken }})
echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT" echo "deployment-url=$DEPLOYMENT_URL" >> "$GITHUB_OUTPUT"
env: env:
VERCEL_ORG_ID: ${{ inputs.vercel-org }} VERCEL_ORG_ID: ${{ inputs.vercelOrg }}
VERCEL_PROJECT_ID: ${{ inputs.vercel-project }} VERCEL_PROJECT_ID: ${{ inputs.vercelProject }}
- name: Outputs - name: Outputs
shell: bash shell: bash
run: | run: |
-310
View File
@@ -7,316 +7,6 @@ on:
env: env:
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }} NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
jobs: jobs:
deploy:
name: Deploy to Cloudflare Pages
runs-on: ubuntu-latest
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
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 turbo gitbook#build:cloudflare
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
SENTRY_ORG: ${{ vars.SENTRY_ORG }}
SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
SENTRY_DSN: ${{ vars.SENTRY_DSN }}
SENTRY_RELEASE: ${{ github.sha }}
- 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.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 }}
deploy-v2-vercel:
name: Deploy v2 to Vercel
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
issues: write
pull-requests: write
checks: write
statuses: write
outputs:
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Deploy ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
id: deploy
uses: ./.github/composite/deploy-vercel
with:
environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}
vercel-org: ${{ secrets.VERCEL_ORG_ID }}
vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
vercel-token: ${{ secrets.VERCEL_TOKEN }}
deploy-v2-vercel-staging:
name: Deploy v2 to Vercel (staging)
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
issues: write
pull-requests: write
checks: write
statuses: write
if: startsWith(github.ref, 'refs/heads/main')
outputs:
deployment-url: ${{ steps.deploy.outputs.deployment-url }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Deploy staging
id: deploy
uses: ./.github/composite/deploy-vercel
with:
environment: staging
vercel-org: ${{ secrets.VERCEL_ORG_ID }}
vercel-project: ${{ secrets.VERCEL_PROJECT_ID }}
vercel-token: ${{ secrets.VERCEL_TOKEN }}
deploy-v2-cloudflare:
name: Deploy v2 to Cloudflare Worker
runs-on: ubuntu-latest
permissions:
contents: read
deployments: write
issues: write
pull-requests: write
checks: write
statuses: write
outputs:
deployment-url: ${{ steps.deploy.outputs.deployment-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
run: |
echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
echo "GITBOOK_URL=https://open-2c.gitbook.com" >> $GITHUB_ENV
echo "GITBOOK_ASSETS_PREFIX=https://static-2c.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 worker
run: bun run turbo build:v2:cloudflare
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
SENTRY_ORG: ${{ vars.SENTRY_ORG }}
SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
SENTRY_DSN: ${{ vars.SENTRY_DSN }}
SENTRY_RELEASE: ${{ github.sha }}
- 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.82.0'
command: versions upload --config ./packages/gitbook-v2/wrangler.toml
- name: Outputs
run: |
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
comment-deployments:
runs-on: ubuntu-latest
name: Comment Deployments
if: always() && !startsWith(github.ref, 'refs/heads/main')
needs:
- deploy
- 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 (production)
| Version | URL | Status |
| --- | --- | --- |
| Latest commit | [${{ needs.deploy.outputs.deployment-url }}](${{ needs.deploy.outputs.deployment-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
| PR | [${{ needs.deploy.outputs.deployment-alias-url }}](${{ needs.deploy.outputs.deployment-alias-url }}) | ${{ needs.deploy.result == 'success' && '✅' || '❌' }} |
### Version 2 (experimental)
| 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 | v2 |
| --- | --- | --- |
| GitBook | [${{ needs.deploy.outputs.deployment-url }}/docs.gitbook.com](${{ needs.deploy.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) |
| E2E | [${{ needs.deploy.outputs.deployment-url }}/gitbook.gitbook.io/test-gitbook-open](${{ needs.deploy.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) |
edit-mode: replace
visual-testing:
runs-on: ubuntu-latest
name: Visual Testing
needs: deploy
timeout-minutes: 6
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.outputs.deployment-url }}
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
visual-testing-v2:
runs-on: ubuntu-latest
name: Visual Testing v2
needs: deploy-v2-vercel
timeout-minutes: 6
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 }}/url/
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
ARGOS_BUILD_NAME: 'v2'
visual-testing-customers:
runs-on: ubuntu-latest
name: Visual Testing Customers
needs: deploy
timeout-minutes: 6
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.outputs.deployment-url }}
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
ARGOS_BUILD_NAME: 'customers'
visual-testing-customers-v2:
runs-on: ubuntu-latest
name: Visual Testing Customers v2
needs: deploy-v2-vercel
timeout-minutes: 6
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 }}/url/
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
ARGOS_BUILD_NAME: 'customers-v2'
pagespeed-testing:
runs-on: ubuntu-latest
name: PageSpeed Testing
needs: deploy
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 $DEPLOYMENT_URL
env:
DEPLOYMENT_URL: ${{needs.deploy.outputs.deployment-url}}
PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
format: format:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: Format name: Format
+253
View File
@@ -0,0 +1,253 @@
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 "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
echo "GITBOOK_ASSETS_PREFIX=https://static.gitbook.com" >> $GITHUB_ENV
- name: Sets env vars for preview
if: github.ref != 'refs/heads/main'
run: |
echo "SENTRY_ENVIRONMENT=preview" >> $GITHUB_ENV
- name: Build Next.js with next-on-pages
run: bun run turbo gitbook#build:cloudflare
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: ${{ secrets.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY }}
SENTRY_ORG: ${{ vars.SENTRY_ORG }}
SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}
SENTRY_DSN: ${{ vars.SENTRY_DSN }}
SENTRY_RELEASE: ${{ github.sha }}
- 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:
- 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 }}
- name: Outputs
run: |
echo "URL: ${{ steps.deploy.outputs.deployment-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 (production)
| 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 (experimental)
| 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 | v2 |
| --- | --- | --- |
| 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) |
| 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) |
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 }}/url/
ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
ARGOS_BUILD_NAME: 'v2-vercel'
visual-testing-customers-v1:
runs-on: ubuntu-latest
name: Visual Testing Customers v1
needs: deploy-v1-cloudflare
timeout-minutes: 6
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: 6
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 }}/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 $DEPLOYMENT_URL
env:
DEPLOYMENT_URL: ${{needs.deploy-v1-cloudflare.outputs.deployment-url}}
PAGESPEED_API_KEY: ${{ secrets.PAGESPEED_API_KEY }}
+53
View File
@@ -0,0 +1,53 @@
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 staging
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 }}
- name: Outputs
run: |
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+53
View File
@@ -0,0 +1,53 @@
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 staging
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 }}
- name: Outputs
run: |
echo "URL: ${{ steps.deploy.outputs.deployment-url }}"
+2 -1
View File
@@ -11,6 +11,7 @@
"prettier.enable": false, "prettier.enable": false,
"editor.defaultFormatter": "biomejs.biome", "editor.defaultFormatter": "biomejs.biome",
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.organizeImports": "explicit" "source.organizeImports.biome": "explicit",
"source.fixAll.biome": "explicit"
} }
} }
+6 -1
View File
@@ -67,7 +67,12 @@
"useThrowOnlyError": "error" "useThrowOnlyError": "error"
}, },
"suspicious": { "suspicious": {
"noConsole": "warn", "noConsole": {
"level": "warn",
"options": {
"allow": ["assert", "error", "warn"]
}
},
"noExplicitAny": "warn", "noExplicitAny": "warn",
"noImplicitAnyLet": "warn", "noImplicitAnyLet": "warn",
"noConfusingVoidType": "warn", "noConfusingVoidType": "warn",
+70 -88
View File
@@ -19,12 +19,12 @@
}, },
"devDependencies": { "devDependencies": {
"typescript": "^5.5.3", "typescript": "^5.5.3",
"wrangler": "^3.109.2", "wrangler": "^3.112.0",
}, },
}, },
"packages/cache-tags": { "packages/cache-tags": {
"name": "@gitbook/cache-tags", "name": "@gitbook/cache-tags",
"version": "0.0.0", "version": "0.1.0",
"dependencies": { "dependencies": {
"@gitbook/api": "0.96.1", "@gitbook/api": "0.96.1",
"assert-never": "^1.2.1", "assert-never": "^1.2.1",
@@ -49,7 +49,7 @@
}, },
"packages/gitbook": { "packages/gitbook": {
"name": "gitbook", "name": "gitbook",
"version": "0.6.4", "version": "0.6.5",
"dependencies": { "dependencies": {
"@gitbook/api": "0.96.1", "@gitbook/api": "0.96.1",
"@gitbook/cache-do": "workspace:*", "@gitbook/cache-do": "workspace:*",
@@ -77,6 +77,7 @@
"framer-motion": "^10.16.14", "framer-motion": "^10.16.14",
"js-cookie": "^3.0.5", "js-cookie": "^3.0.5",
"jsontoxml": "^1.0.1", "jsontoxml": "^1.0.1",
"jwt-decode": "^4.0.0",
"katex": "^0.16.9", "katex": "^0.16.9",
"mathjax": "^3.2.2", "mathjax": "^3.2.2",
"mdast-util-to-markdown": "^2.1.2", "mdast-util-to-markdown": "^2.1.2",
@@ -131,18 +132,19 @@
}, },
"packages/gitbook-v2": { "packages/gitbook-v2": {
"name": "gitbook-v2", "name": "gitbook-v2",
"version": "0.1.1", "version": "0.1.2",
"dependencies": { "dependencies": {
"@gitbook/api": "0.96.1", "@gitbook/api": "0.96.1",
"@gitbook/cache-tags": "workspace:*", "@gitbook/cache-tags": "workspace:*",
"@sindresorhus/fnv1a": "^3.1.0", "@sindresorhus/fnv1a": "^3.1.0",
"next": "^15.2.0", "next": "^15.2.1",
"react": "^19.0.0", "react": "^19.0.0",
"react-dom": "^19.0.0", "react-dom": "^19.0.0",
"server-only": "^0.0.1", "server-only": "^0.0.1",
"warn-once": "^0.1.1",
}, },
"devDependencies": { "devDependencies": {
"@opennextjs/cloudflare": "^0.5.3", "@opennextjs/cloudflare": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@40fec7d",
"gitbook": "*", "gitbook": "*",
"postcss": "^8", "postcss": "^8",
"tailwindcss": "^3.4.0", "tailwindcss": "^3.4.0",
@@ -170,10 +172,10 @@
}, },
"packages/openapi-parser": { "packages/openapi-parser": {
"name": "@gitbook/openapi-parser", "name": "@gitbook/openapi-parser",
"version": "2.0.1", "version": "2.0.2",
"dependencies": { "dependencies": {
"@scalar/openapi-parser": "^0.10.4", "@scalar/openapi-parser": "^0.10.9",
"@scalar/openapi-types": "^0.1.6", "@scalar/openapi-types": "^0.1.9",
}, },
"devDependencies": { "devDependencies": {
"@tsconfig/node20": "^20.1.4", "@tsconfig/node20": "^20.1.4",
@@ -192,7 +194,7 @@
}, },
"packages/react-contentkit": { "packages/react-contentkit": {
"name": "@gitbook/react-contentkit", "name": "@gitbook/react-contentkit",
"version": "0.6.0", "version": "0.6.1",
"dependencies": { "dependencies": {
"@gitbook/api": "0.96.1", "@gitbook/api": "0.96.1",
"@gitbook/icons": "workspace:*", "@gitbook/icons": "workspace:*",
@@ -225,11 +227,11 @@
}, },
"packages/react-openapi": { "packages/react-openapi": {
"name": "@gitbook/react-openapi", "name": "@gitbook/react-openapi",
"version": "1.0.4", "version": "1.0.5",
"dependencies": { "dependencies": {
"@gitbook/openapi-parser": "workspace:*", "@gitbook/openapi-parser": "workspace:*",
"@scalar/api-client-react": "1.0.87", "@scalar/api-client-react": "^1.1.36",
"@scalar/oas-utils": "^0.2.101", "@scalar/oas-utils": "^0.2.110",
"clsx": "^2.1.1", "clsx": "^2.1.1",
"flatted": "^3.2.9", "flatted": "^3.2.9",
"json-xml-parse": "^1.3.0", "json-xml-parse": "^1.3.0",
@@ -553,8 +555,6 @@
"@esbuild-plugins/node-modules-polyfill": ["@esbuild-plugins/node-modules-polyfill@0.2.2", "", { "dependencies": { "escape-string-regexp": "^4.0.0", "rollup-plugin-node-polyfills": "^0.2.1" }, "peerDependencies": { "esbuild": "*" } }, "sha512-LXV7QsWJxRuMYvKbiznh+U1ilIop3g2TeKRzUxOG5X3YITc8JyyTa90BmLwqqv0YnX4v32CSlG+vsziZp9dMvA=="], "@esbuild-plugins/node-modules-polyfill": ["@esbuild-plugins/node-modules-polyfill@0.2.2", "", { "dependencies": { "escape-string-regexp": "^4.0.0", "rollup-plugin-node-polyfills": "^0.2.1" }, "peerDependencies": { "esbuild": "*" } }, "sha512-LXV7QsWJxRuMYvKbiznh+U1ilIop3g2TeKRzUxOG5X3YITc8JyyTa90BmLwqqv0YnX4v32CSlG+vsziZp9dMvA=="],
"@esbuild-plugins/node-resolve": ["@esbuild-plugins/node-resolve@0.2.2", "", { "dependencies": { "@types/resolve": "^1.17.1", "debug": "^4.3.1", "escape-string-regexp": "^4.0.0", "resolve": "^1.19.0" }, "peerDependencies": { "esbuild": "*" } }, "sha512-+t5FdX3ATQlb53UFDBRb4nqjYBz492bIrnVWvpQHpzZlu9BQL5HasMZhqc409ygUwOWCXZhrWr6NyZ6T6Y+cxw=="],
"@esbuild/android-arm": ["@esbuild/android-arm@0.17.19", "", { "os": "android", "cpu": "arm" }, "sha512-rIKddzqhmav7MSmoFCmDIb6e2W57geRsM94gV2l38fzhXMwq7hZoClug9USI2pFRGL06f4IOPHHpFNOkWieR8A=="], "@esbuild/android-arm": ["@esbuild/android-arm@0.17.19", "", { "os": "android", "cpu": "arm" }, "sha512-rIKddzqhmav7MSmoFCmDIb6e2W57geRsM94gV2l38fzhXMwq7hZoClug9USI2pFRGL06f4IOPHHpFNOkWieR8A=="],
"@esbuild/android-arm64": ["@esbuild/android-arm64@0.17.19", "", { "os": "android", "cpu": "arm64" }, "sha512-KBMWvEZooR7+kzY0BtbTQn0OAYY7CsiydT63pVEaPtVYF0hXbUaOyZog37DKxK7NF3XacBJOpYT4adIJh+avxA=="], "@esbuild/android-arm64": ["@esbuild/android-arm64@0.17.19", "", { "os": "android", "cpu": "arm64" }, "sha512-KBMWvEZooR7+kzY0BtbTQn0OAYY7CsiydT63pVEaPtVYF0hXbUaOyZog37DKxK7NF3XacBJOpYT4adIJh+avxA=="],
@@ -791,9 +791,9 @@
"@nodelib/fs.walk": ["@nodelib/fs.walk@1.2.8", "", { "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg=="], "@nodelib/fs.walk": ["@nodelib/fs.walk@1.2.8", "", { "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg=="],
"@opennextjs/aws": ["@opennextjs/aws@https://pkg.pr.new/@opennextjs/aws@733", { "dependencies": { "@aws-sdk/client-cloudfront": "3.398.0", "@aws-sdk/client-dynamodb": "^3.398.0", "@aws-sdk/client-lambda": "^3.398.0", "@aws-sdk/client-s3": "^3.398.0", "@aws-sdk/client-sqs": "^3.398.0", "@esbuild-plugins/node-resolve": "0.2.2", "@node-minify/core": "^8.0.6", "@node-minify/terser": "^8.0.6", "@tsconfig/node18": "^1.0.1", "aws4fetch": "^1.0.18", "chalk": "^5.3.0", "esbuild": "0.19.2", "express": "5.0.1", "path-to-regexp": "^6.3.0", "promise.series": "^0.2.0", "urlpattern-polyfill": "^10.0.0" }, "bin": { "open-next": "./dist/index.js" } }], "@opennextjs/aws": ["@opennextjs/aws@https://pkg.pr.new/@opennextjs/aws@756", { "dependencies": { "@aws-sdk/client-cloudfront": "3.398.0", "@aws-sdk/client-dynamodb": "^3.398.0", "@aws-sdk/client-lambda": "^3.398.0", "@aws-sdk/client-s3": "^3.398.0", "@aws-sdk/client-sqs": "^3.398.0", "@node-minify/core": "^8.0.6", "@node-minify/terser": "^8.0.6", "@tsconfig/node18": "^1.0.1", "aws4fetch": "^1.0.18", "chalk": "^5.3.0", "esbuild": "0.19.2", "express": "5.0.1", "path-to-regexp": "^6.3.0", "urlpattern-polyfill": "^10.0.0" }, "bin": { "open-next": "./dist/index.js" } }],
"@opennextjs/cloudflare": ["@opennextjs/cloudflare@0.5.3", "", { "dependencies": { "@ast-grep/napi": "^0.34.1", "@dotenvx/dotenvx": "1.31.0", "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@733", "enquirer": "^2.4.1", "glob": "^11.0.0", "yaml": "^2.7.0" }, "peerDependencies": { "wrangler": "^3.107.3" }, "bin": { "opennextjs-cloudflare": "dist/cli/index.js" } }, "sha512-0A8oXlRBnPHc0fhAfoFSOq2ZAuPC/n/Vj87lytcU4Cese2VsRqf89CxBMCSqAH9g+OB+kUZ2jOGGntGpVOvM0g=="], "@opennextjs/cloudflare": ["@opennextjs/cloudflare@https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@40fec7d", { "dependencies": { "@ast-grep/napi": "^0.34.1", "@dotenvx/dotenvx": "1.31.0", "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@756", "enquirer": "^2.4.1", "glob": "^11.0.0", "yaml": "^2.7.0" }, "peerDependencies": { "wrangler": "^3.111.0" }, "bin": { "opennextjs-cloudflare": "dist/cli/index.js" } }],
"@opentelemetry/api": ["@opentelemetry/api@1.9.0", "", {}, "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg=="], "@opentelemetry/api": ["@opentelemetry/api@1.9.0", "", {}, "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg=="],
@@ -1139,37 +1139,43 @@
"@rollup/pluginutils": ["@rollup/pluginutils@5.1.2", "", { "dependencies": { "@types/estree": "^1.0.0", "estree-walker": "^2.0.2", "picomatch": "^2.3.1" }, "peerDependencies": { "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" }, "optionalPeers": ["rollup"] }, "sha512-/FIdS3PyZ39bjZlwqFnWqCOVnW7o963LtKMwQOD0NhQqw22gSr2YY1afu3FxRip4ZCZNsD5jq6Aaz6QV3D/Njw=="], "@rollup/pluginutils": ["@rollup/pluginutils@5.1.2", "", { "dependencies": { "@types/estree": "^1.0.0", "estree-walker": "^2.0.2", "picomatch": "^2.3.1" }, "peerDependencies": { "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" }, "optionalPeers": ["rollup"] }, "sha512-/FIdS3PyZ39bjZlwqFnWqCOVnW7o963LtKMwQOD0NhQqw22gSr2YY1afu3FxRip4ZCZNsD5jq6Aaz6QV3D/Njw=="],
"@scalar/api-client": ["@scalar/api-client@2.1.49", "", { "dependencies": { "@headlessui/tailwindcss": "^0.2.0", "@headlessui/vue": "^1.7.20", "@scalar/components": "0.12.69", "@scalar/draggable": "0.1.7", "@scalar/icons": "0.1.1", "@scalar/import": "0.1.1", "@scalar/oas-utils": "0.2.75", "@scalar/object-utils": "1.1.12", "@scalar/openapi-parser": "0.8.9", "@scalar/openapi-types": "0.1.5", "@scalar/themes": "0.9.48", "@scalar/types": "0.0.19", "@scalar/use-codemirror": "0.11.36", "@scalar/use-toasts": "0.7.7", "@scalar/use-tooltip": "1.0.4", "@vueuse/core": "^10.10.0", "@vueuse/integrations": "^11.2.0", "cva": "1.0.0-beta.1", "focus-trap": "^7", "fuse.js": "^7.0.0", "js-cookie": "^3.0.5", "microdiff": "^1.4.0", "nanoid": "^5.0.7", "pretty-bytes": "^6.1.1", "pretty-ms": "^8.0.0", "shell-quote": "^1.8.1", "vue": "^3.5.12", "vue-router": "^4.3.0", "whatwg-mimetype": "^4.0.0", "yaml": "^2.4.5", "zod": "^3.23.8" } }, "sha512-AjsMpOgTiAPuOCXoPbcY8oAMLOq7/+7yQW3wJLBdXvg3cAru2AsRllQv3dIC9dbTGcGXSbSqxgR/r2Qe18aDEA=="], "@scalar/api-client": ["@scalar/api-client@2.2.56", "", { "dependencies": { "@headlessui/tailwindcss": "^0.2.0", "@headlessui/vue": "^1.7.20", "@scalar/components": "0.13.28", "@scalar/draggable": "0.1.11", "@scalar/icons": "0.1.3", "@scalar/import": "0.2.30", "@scalar/oas-utils": "0.2.110", "@scalar/object-utils": "1.1.13", "@scalar/openapi-parser": "0.10.9", "@scalar/openapi-types": "0.1.9", "@scalar/postman-to-openapi": "0.1.33", "@scalar/snippetz": "0.2.15", "@scalar/themes": "0.9.71", "@scalar/types": "0.0.36", "@scalar/use-codemirror": "0.11.73", "@scalar/use-hooks": "0.1.25", "@scalar/use-toasts": "0.7.9", "@scalar/use-tooltip": "1.0.6", "@vueuse/core": "^10.10.0", "@vueuse/integrations": "^11.2.0", "focus-trap": "^7", "fuse.js": "^7.0.0", "microdiff": "^1.4.0", "nanoid": "^5.0.9", "pretty-bytes": "^6.1.1", "pretty-ms": "^8.0.0", "shell-quote": "^1.8.1", "vue": "^3.5.12", "vue-router": "^4.3.0", "whatwg-mimetype": "^4.0.0", "yaml": "^2.4.5", "zod": "^3.23.8" } }, "sha512-ilY0geYUg90xVameaQ3IJm1/gO9MOmvcQEm98/IfizoYJ5P9aFnXphwEvR+K0xeSD6QYXdaz4ir5UB31Jkuueg=="],
"@scalar/api-client-react": ["@scalar/api-client-react@1.0.87", "", { "dependencies": { "@scalar/api-client": "2.1.49", "rollup-preserve-directives": "^1.1.1", "vue": "^3.5.12" }, "peerDependencies": { "react": "^18.0.0" } }, "sha512-wt1gCBMu8Ti30aDyGdni9fG2EnOU0eEhRcM18DVc53+NtABuvV3uKrmkaEd+Nizr7HUH43UAW8qgECCqrbH4+g=="], "@scalar/api-client-react": ["@scalar/api-client-react@1.1.36", "", { "dependencies": { "@scalar/api-client": "2.2.56", "vue": "^3.5.12" }, "peerDependencies": { "react": "^18.0.0 || ^19.0.0" } }, "sha512-PRogjHFP0bGe6Q1AOxHOctdMpehWLdL8Wo7GtGsFVKXPqcO/tgAZN8x61Qls3SYT5SDqENk8cwAmSaivLzfD2Q=="],
"@scalar/code-highlight": ["@scalar/code-highlight@0.0.15", "", { "dependencies": { "hast-util-to-text": "^4.0.2", "highlight.js": "^11.9.0", "highlightjs-curl": "^1.3.0", "highlightjs-vue": "^1.0.0", "lowlight": "^3.1.0", "rehype-external-links": "^3.0.0", "rehype-format": "^5.0.0", "rehype-parse": "^9.0.0", "rehype-raw": "^7.0.0", "rehype-sanitize": "^6.0.0", "rehype-stringify": "^10.0.0", "remark-gfm": "^4.0.0", "remark-parse": "^11.0.0", "remark-rehype": "^11.1.0", "remark-stringify": "^11.0.0", "unified": "^11.0.4", "unist-util-visit": "^5.0.0" } }, "sha512-JVqTGvR+Itqfvm99tv+FobHPNj3beFL7u1R8GCtUlHMRFFErzKz2Ut7ok+7Er5uVjDZUsNBWi1wS954MAhFrmw=="], "@scalar/code-highlight": ["@scalar/code-highlight@0.0.23", "", { "dependencies": { "hast-util-to-text": "^4.0.2", "highlight.js": "^11.9.0", "highlightjs-curl": "^1.3.0", "highlightjs-vue": "^1.0.0", "lowlight": "^3.1.0", "rehype-external-links": "^3.0.0", "rehype-format": "^5.0.0", "rehype-parse": "^9.0.0", "rehype-raw": "^7.0.0", "rehype-sanitize": "^6.0.0", "rehype-stringify": "^10.0.0", "remark-gfm": "^4.0.0", "remark-parse": "^11.0.0", "remark-rehype": "^11.1.0", "remark-stringify": "^11.0.0", "unified": "^11.0.4", "unist-util-visit": "^5.0.0" } }, "sha512-hDHoUgjq/8ntXzmD1hbO3nvem1ny+qcWRH7L2nOflwkXhXaDM1aOPNp9zyeCxLoWwC9db4wLFP3QW+eYS0OTiQ=="],
"@scalar/components": ["@scalar/components@0.12.69", "", { "dependencies": { "@floating-ui/utils": "^0.2.2", "@floating-ui/vue": "^1.0.2", "@headlessui/vue": "^1.7.20", "@scalar/code-highlight": "0.0.15", "@scalar/themes": "0.9.48", "@scalar/use-toasts": "0.7.7", "@vueuse/core": "^10.10.0", "cva": "1.0.0-beta.1", "nanoid": "^5.0.7", "radix-vue": "^1.9.3", "tailwind-merge": "^2.3.0", "vue": "^3.5.12" } }, "sha512-M2+k4Mhr20514Ma8nXEHtFU/rRU0q+SUvgB5chQHAHubYRuwX+TgCC1It5ZsFsvzruEVPE4jUKf/xYCa0BdcXQ=="], "@scalar/components": ["@scalar/components@0.13.28", "", { "dependencies": { "@floating-ui/utils": "^0.2.2", "@floating-ui/vue": "^1.0.2", "@headlessui/vue": "^1.7.20", "@scalar/code-highlight": "0.0.23", "@scalar/themes": "0.9.71", "@scalar/use-hooks": "0.1.25", "@scalar/use-toasts": "0.7.9", "@vueuse/core": "^10.10.0", "cva": "1.0.0-beta.2", "nanoid": "^5.0.9", "pretty-bytes": "^6.1.1", "radix-vue": "^1.9.3", "tailwind-merge": "^2.5.5", "vue": "^3.5.12" } }, "sha512-trG/VuXSw/Y/q3vuE2xRrFXBQ1eJcCQPQUNsfyKXoMUzwJnuWn/LNqdYvq8rnQUwVrGWOReKjYqJ14XUUALr8Q=="],
"@scalar/draggable": ["@scalar/draggable@0.1.7", "", { "dependencies": { "vue": "^3.5.12" } }, "sha512-PnMmUvlxgs5MeMVvmWBrfScvi2zrR0G+wBghVzFazLYQnvM3tczs2CZd8xOzBzScvH13W7BhdvQRM276zszODQ=="], "@scalar/draggable": ["@scalar/draggable@0.1.11", "", { "dependencies": { "vue": "^3.5.12" } }, "sha512-EQW9N1+mDORhsbjdtCI3XDvmUKsuKw1uf6r3kT1Mm2zQKT+rWwA0ChsAkEN6OG62C0YumMuXpH71h1seAWptxw=="],
"@scalar/icons": ["@scalar/icons@0.1.1", "", { "dependencies": { "vue": "^3.5.12" } }, "sha512-qaz56TaUadWHXhdC5s8BNzjNwGgNxj/PQ+Cq+W6FadyMK6Dgdkk3dN1kKvX+cMx02T6I0GGSFFOjXzB01HNuNg=="], "@scalar/icons": ["@scalar/icons@0.1.3", "", { "dependencies": { "vue": "^3.5.12" } }, "sha512-Bl46u7WsJ7NYjW1Fva7SMvw9c/92pGBP8B68tvDc+QevQ04DVNxw6+ny1NU/PnLtpuu1rUpPdtSCAkV1OdQGZQ=="],
"@scalar/import": ["@scalar/import@0.1.1", "", { "dependencies": { "@scalar/openapi-parser": "0.8.9", "yaml": "^2.4.5" } }, "sha512-f0/TrTcSXr473NG6xvzcl8AxwWdzd1MnZXfhsxzG3n+HkeMW3o6doOVquD3FtE8Nm4VDSX5t2C2syUW+2ghHbw=="], "@scalar/import": ["@scalar/import@0.2.30", "", { "dependencies": { "@scalar/oas-utils": "0.2.110", "@scalar/openapi-parser": "0.10.9", "yaml": "^2.4.5" } }, "sha512-K2Gnbpo4aHHcadY+4i3gzmG3XGs6AbhvbP6wOPm8ubb+ZeFkRs79AUJcNTXQ6IWq0TuGNsFUmMxmc1Bvxns4uQ=="],
"@scalar/oas-utils": ["@scalar/oas-utils@0.2.101", "", { "dependencies": { "@hyperjump/json-schema": "^1.9.6", "@scalar/object-utils": "1.1.12", "@scalar/openapi-types": "0.1.6", "@scalar/themes": "0.9.63", "@scalar/types": "0.0.29", "flatted": "^3.3.1", "microdiff": "^1.4.0", "nanoid": "^5.0.7", "yaml": "^2.4.5", "zod": "^3.23.8" } }, "sha512-+fJBte0X6+Boy8Spt3oUGGGO7gCLEL+pVDZe2b3aSR78kyEPMjLVFqLjRsZw+akH5DASdnt7er/l24c4YuYxbQ=="], "@scalar/oas-utils": ["@scalar/oas-utils@0.2.110", "", { "dependencies": { "@hyperjump/json-schema": "^1.9.6", "@scalar/object-utils": "1.1.13", "@scalar/openapi-types": "0.1.9", "@scalar/themes": "0.9.71", "@scalar/types": "0.0.36", "flatted": "^3.3.1", "microdiff": "^1.4.0", "nanoid": "^5.0.9", "yaml": "^2.4.5", "zod": "^3.23.8" } }, "sha512-fjysWW4VIjR0+rlTOoii2g9+oVbgSVx4TaKGDOAN6S9YxQLz3dgu6RwfpLA9tomdiTZ5EuNMyu4o+X316jaPlw=="],
"@scalar/object-utils": ["@scalar/object-utils@1.1.12", "", { "dependencies": { "flatted": "^3.3.1", "just-clone": "^6.2.0", "ts-deepmerge": "^7.0.1" } }, "sha512-RMC4kKkFVpFKHL8QbJJpRGY4cAtc/6w4Gaf5zaZj6qtc0OZZRJyF+G9JfcqmYd98FW4DfmzN4Pr0nhYQJraZ0A=="], "@scalar/object-utils": ["@scalar/object-utils@1.1.13", "", { "dependencies": { "flatted": "^3.3.1", "just-clone": "^6.2.0", "ts-deepmerge": "^7.0.1" } }, "sha512-311eTykIXgOtjCs4VTELj9UMT97jHTWc5qkGNoIzZ5nxjCcvOVe7kDQobIkE8dGT+ybOgHz5qly02Eu7nVHeZQ=="],
"@scalar/openapi-parser": ["@scalar/openapi-parser@0.10.4", "", { "dependencies": { "ajv": "^8.17.1", "ajv-draft-04": "^1.0.0", "ajv-formats": "^3.0.1", "jsonpointer": "^5.0.1", "leven": "^4.0.0", "yaml": "^2.4.5" } }, "sha512-t0+PQcLWCRYtvkfhZf74uRsN/5FmwjxWjMEuj32aM1iseUmEHMirYFyyZMIkQpfO0DblEgHQZcmzj+v8O4aOjw=="], "@scalar/openapi-parser": ["@scalar/openapi-parser@0.10.9", "", { "dependencies": { "ajv": "^8.17.1", "ajv-draft-04": "^1.0.0", "ajv-formats": "^3.0.1", "jsonpointer": "^5.0.1", "leven": "^4.0.0", "yaml": "^2.4.5" } }, "sha512-wsKZtL4B3Fmbv24B1zzeWdsEr6F60fLmToOFLA1b9QGQ6TAtIvLgKQWQ65eh5Vfx93nQb/iekamfErqHRHtEhA=="],
"@scalar/openapi-types": ["@scalar/openapi-types@0.1.6", "", {}, "sha512-V+KnESyVJqorJzEN0QFlu3tAImCHjnvPov6QcQvjfY7s0+CjrI3rRO3oVIRlXURTQrQGrnhxvK0SkXGAZ+dxvw=="], "@scalar/openapi-types": ["@scalar/openapi-types@0.1.9", "", {}, "sha512-HQQudOSQBU7ewzfnBW9LhDmBE2XOJgSfwrh5PlUB7zJup/kaRkBGNgV2wMjNz9Af/uztiU/xNrO179FysmUT+g=="],
"@scalar/themes": ["@scalar/themes@0.9.63", "", { "dependencies": { "@scalar/types": "0.0.29" } }, "sha512-3msYnwGvtmt6e/EmrJEh5gJqry3MJAQRc+K+8q9snr46zM5A5VJoByVmEqhJCccAGmBdTAcjc6ZUijmg+Es0yQ=="], "@scalar/postman-to-openapi": ["@scalar/postman-to-openapi@0.1.33", "", { "dependencies": { "@scalar/oas-utils": "0.2.110", "@scalar/openapi-types": "0.1.9" } }, "sha512-nHZpR5WG+I8BPQMgHyeiS6q/SVt/5FnnAwU9RDxRwlBb9RQqNepAs0sNKc6RRMLgpHYPalRqNwneW5Vu8hlOaA=="],
"@scalar/types": ["@scalar/types@0.0.29", "", { "dependencies": { "@scalar/openapi-types": "0.1.6", "@unhead/schema": "^1.11.11" } }, "sha512-Z5tnRVtKHV/Gx4hCPeyFsxM1Gx92KUqpZ/HhM4KexPh5StKJo6MSLSTeFXqdVM8dbsnfw+xFBoLF9yE0eEHK3Q=="], "@scalar/snippetz": ["@scalar/snippetz@0.2.15", "", { "dependencies": { "stringify-object": "^5.0.0" } }, "sha512-2Tq+Ot09dz7ioKNUXW5z6eBqZdMLaYUw5eDONpdvmBP4yZ8hrFKpq0YV54lnMQALQebSi/DPLsnsWgo+DTkfbw=="],
"@scalar/use-codemirror": ["@scalar/use-codemirror@0.11.36", "", { "dependencies": { "@codemirror/autocomplete": "^6.12.0", "@codemirror/commands": "^6.3.3", "@codemirror/lang-css": "^6.2.1", "@codemirror/lang-html": "^6.4.8", "@codemirror/lang-json": "^6.0.0", "@codemirror/lang-xml": "^6.0.0", "@codemirror/lang-yaml": "^6.0.0", "@codemirror/language": "^6.10.1", "@codemirror/lint": "^6.8.1", "@codemirror/state": "^6.4.0", "@codemirror/view": "^6.23.1", "@lezer/common": "^1.2.1", "@lezer/highlight": "^1.2.0", "@lezer/lr": "^1.4.0", "@replit/codemirror-css-color-picker": "^6.1.0", "@scalar/components": "0.12.69", "@uiw/codemirror-themes": "^4.21.21", "codemirror": "^6.0.0", "vue": "^3.5.12" }, "optionalDependencies": { "y-codemirror.next": "^0.3.2", "yjs": "^13.6.0" } }, "sha512-P0VxeW2vkknQMLx+V5Hb4NDFStcz2XZW07JSD+KaLcv1tqKYDyxPlIc0lMDCFwMV2YLIpG0EwsYRK0w9Zo5cVQ=="], "@scalar/themes": ["@scalar/themes@0.9.71", "", { "dependencies": { "@scalar/types": "0.0.36" } }, "sha512-sgXCEV1ZS9X5Wxs3ZjCFqUAQ11dW3fupf5tVt0A3sBQI3LbKp52aCa8Z6UqVOoohwD5zVGSFcoWD5iAZEgldWg=="],
"@scalar/use-toasts": ["@scalar/use-toasts@0.7.7", "", { "dependencies": { "nanoid": "^5.0.7", "vue": "^3.5.12", "vue-sonner": "^1.0.3" } }, "sha512-eIJugwMswR9kP75uYR4SxK1vRBfL8Zqb/XmzNMqM3o7d1jnyOd4fA5Efs95QzCvpwlB3VaYkNq1HThi9hzLTow=="], "@scalar/types": ["@scalar/types@0.0.36", "", { "dependencies": { "@scalar/openapi-types": "0.1.9", "@unhead/schema": "^1.11.11" } }, "sha512-Mfv9IptUoGqDJC40xg9nfI9/3brov59tKw2lq8tPpbmXItyG9EplckHPRUf2bYKGOOQPfySUATpEgHqOBiJt7g=="],
"@scalar/use-tooltip": ["@scalar/use-tooltip@1.0.4", "", { "dependencies": { "tippy.js": "^6.3.7", "vue": "^3.5.12" } }, "sha512-QGlg24TJoZEiYJNCdgbclCQDb0mKdKbxZgILNfoADhbX+qHgIhyOHfgLct+OHxXJdE1vix7pvjnAUBR63a2CLw=="], "@scalar/use-codemirror": ["@scalar/use-codemirror@0.11.73", "", { "dependencies": { "@codemirror/autocomplete": "^6.18.3", "@codemirror/commands": "^6.7.1", "@codemirror/lang-css": "^6.3.1", "@codemirror/lang-html": "^6.4.8", "@codemirror/lang-json": "^6.0.0", "@codemirror/lang-xml": "^6.0.0", "@codemirror/lang-yaml": "^6.1.2", "@codemirror/language": "^6.10.7", "@codemirror/lint": "^6.8.4", "@codemirror/state": "^6.5.0", "@codemirror/view": "^6.35.3", "@lezer/common": "^1.2.3", "@lezer/highlight": "^1.2.1", "@lezer/lr": "^1.4.2", "@replit/codemirror-css-color-picker": "^6.3.0", "@scalar/components": "0.13.28", "codemirror": "^6.0.0", "style-mod": "^4.1.2", "vue": "^3.5.12" } }, "sha512-WPB01ZD8cWpJhNU6irPRIUc8Xn2qkFQpgiP3xxjYIcALEJ+EFzamftAsXe+7/AI8jF3z4mPuCimntpvs0jsRvA=="],
"@scalar/use-hooks": ["@scalar/use-hooks@0.1.25", "", { "dependencies": { "@scalar/themes": "0.9.71", "@scalar/use-toasts": "0.7.9", "@vueuse/core": "^10.10.0", "vue": "^3.5.12", "zod": "^3.23.8" } }, "sha512-6AmILMqbgWHM+3OWDWawG4mO8/xD1/tbZpWDNm4L8Zm5GZASUjipA1AmYFtRI5Gf3l4S+6Q4wL58Li2D6e/3iA=="],
"@scalar/use-toasts": ["@scalar/use-toasts@0.7.9", "", { "dependencies": { "nanoid": "^5.0.9", "vue": "^3.5.12", "vue-sonner": "^1.0.3" } }, "sha512-EcUDJY8VozLS9sfoQKvvipStQJ9RuH/nKOzf0BBr+mZDmumi1WFZ1iIJnHVXIN3iSLcSAr5ej6rOqa6jIv4bCQ=="],
"@scalar/use-tooltip": ["@scalar/use-tooltip@1.0.6", "", { "dependencies": { "tippy.js": "^6.3.7", "vue": "^3.5.12" } }, "sha512-f0gadIaUnILfi9qYAk7g+fNTsvLGXnam8oOUTxovavC1ocYuGTEykdz3g2MTqnAqRS8OkAB64h9mHf0FBfg6mg=="],
"@sentry-internal/browser-utils": ["@sentry-internal/browser-utils@8.35.0", "", { "dependencies": { "@sentry/core": "8.35.0", "@sentry/types": "8.35.0", "@sentry/utils": "8.35.0" } }, "sha512-uj9nwERm7HIS13f/Q52hF/NUS5Al8Ma6jkgpfYGeppYvU0uSjPkwMogtqoJQNbOoZg973tV8qUScbcWY616wNA=="], "@sentry-internal/browser-utils": ["@sentry-internal/browser-utils@8.35.0", "", { "dependencies": { "@sentry/core": "8.35.0", "@sentry/types": "8.35.0", "@sentry/utils": "8.35.0" } }, "sha512-uj9nwERm7HIS13f/Q52hF/NUS5Al8Ma6jkgpfYGeppYvU0uSjPkwMogtqoJQNbOoZg973tV8qUScbcWY616wNA=="],
@@ -1423,8 +1429,6 @@
"@types/react-dom": ["@types/react-dom@18.3.1", "", { "dependencies": { "@types/react": "*" } }, "sha512-qW1Mfv8taImTthu4KoXgDfLuk4bydU6Q/TkADnDWWHwi4NX4BR+LWfTp2sVmTqRrsHvyDDTelgelxJ+SsejKKQ=="], "@types/react-dom": ["@types/react-dom@18.3.1", "", { "dependencies": { "@types/react": "*" } }, "sha512-qW1Mfv8taImTthu4KoXgDfLuk4bydU6Q/TkADnDWWHwi4NX4BR+LWfTp2sVmTqRrsHvyDDTelgelxJ+SsejKKQ=="],
"@types/resolve": ["@types/resolve@1.20.6", "", {}, "sha512-A4STmOXPhMUtHH+S6ymgE2GiBSMqf4oTvcQZMcHzokuTLVYzXTB8ttjcgxOVaAp2lGwEdzZ0J+cRbbeevQj1UQ=="],
"@types/rison": ["@types/rison@0.0.9", "", {}, "sha512-R7cgrWQCEK6pmLsERE1UyXqckSNhZMHOWek4cyoqyMUZtI5FjX4zdiaDrsv7Z93OyN9531+H2NpSLR6YZZ29LA=="], "@types/rison": ["@types/rison@0.0.9", "", {}, "sha512-R7cgrWQCEK6pmLsERE1UyXqckSNhZMHOWek4cyoqyMUZtI5FjX4zdiaDrsv7Z93OyN9531+H2NpSLR6YZZ29LA=="],
"@types/shimmer": ["@types/shimmer@1.2.0", "", {}, "sha512-UE7oxhQLLd9gub6JKIAhDq06T0F6FnztwMNRvYgjeQSBeMc1ZG/tA47EwfduvkuQS8apbkM/lpLpWsaCeYsXVg=="], "@types/shimmer": ["@types/shimmer@1.2.0", "", {}, "sha512-UE7oxhQLLd9gub6JKIAhDq06T0F6FnztwMNRvYgjeQSBeMc1ZG/tA47EwfduvkuQS8apbkM/lpLpWsaCeYsXVg=="],
@@ -1439,8 +1443,6 @@
"@types/ws": ["@types/ws@8.5.12", "", { "dependencies": { "@types/node": "*" } }, "sha512-3tPRkv1EtkDpzlgyKyI8pGsGZAGPEaXeu0DOj5DI25Ja91bdAYddYHbADRYVrZMRbfW+1l5YwXVDKohDJNQxkQ=="], "@types/ws": ["@types/ws@8.5.12", "", { "dependencies": { "@types/node": "*" } }, "sha512-3tPRkv1EtkDpzlgyKyI8pGsGZAGPEaXeu0DOj5DI25Ja91bdAYddYHbADRYVrZMRbfW+1l5YwXVDKohDJNQxkQ=="],
"@uiw/codemirror-themes": ["@uiw/codemirror-themes@4.23.7", "", { "dependencies": { "@codemirror/language": "^6.0.0", "@codemirror/state": "^6.0.0", "@codemirror/view": "^6.0.0" } }, "sha512-UNf1XOx1hG9OmJnrtT86PxKcdcwhaNhbrcD+nsk8WxRJ3n5c8nH6euDvgVPdVLPwbizsaQcZTILACgA/FjRpVg=="],
"@ungap/structured-clone": ["@ungap/structured-clone@1.2.0", "", {}, "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ=="], "@ungap/structured-clone": ["@ungap/structured-clone@1.2.0", "", {}, "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ=="],
"@unhead/schema": ["@unhead/schema@1.11.14", "", { "dependencies": { "hookable": "^5.5.3", "zhead": "^2.2.4" } }, "sha512-V9W9u5tF1/+TiLqxu+Qvh1ShoMDkPEwHoEo4DKdDG6ko7YlbzFfDxV6el9JwCren45U/4Vy/4Xi7j8OH02wsiA=="], "@unhead/schema": ["@unhead/schema@1.11.14", "", { "dependencies": { "hookable": "^5.5.3", "zhead": "^2.2.4" } }, "sha512-V9W9u5tF1/+TiLqxu+Qvh1ShoMDkPEwHoEo4DKdDG6ko7YlbzFfDxV6el9JwCren45U/4Vy/4Xi7j8OH02wsiA=="],
@@ -1753,7 +1755,7 @@
"csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="], "csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="],
"cva": ["cva@1.0.0-beta.1", "", { "dependencies": { "clsx": "2.0.0" }, "peerDependencies": { "typescript": ">= 4.5.5 < 6" }, "optionalPeers": ["typescript"] }, "sha512-gznFqTgERU9q4wg7jfgqtt34+RUt9S5t0xDAAEuDwQEAXEgjdDkKXpLLNjwSxsB4Ln/sqWJEH7yhE8Ny0mxd0w=="], "cva": ["cva@1.0.0-beta.2", "", { "dependencies": { "clsx": "^2.1.1" }, "peerDependencies": { "typescript": ">= 4.5.5 < 6" }, "optionalPeers": ["typescript"] }, "sha512-dqcOFe247I5pKxfuzqfq3seLL5iMYsTgo40Uw7+pKZAntPgFtR7Tmy59P5IVIq/XgB0NQWoIvYDt9TwHkuK8Cg=="],
"d": ["d@1.0.2", "", { "dependencies": { "es5-ext": "^0.10.64", "type": "^2.7.2" } }, "sha512-MOqHvMWF9/9MX6nza0KgvFH4HpMU0EF5uUDXqX/BtxtU8NfB0QzRtJ8Oe/6SuS4kbhyzVJwjd97EA4PKrzJ8bw=="], "d": ["d@1.0.2", "", { "dependencies": { "es5-ext": "^0.10.64", "type": "^2.7.2" } }, "sha512-MOqHvMWF9/9MX6nza0KgvFH4HpMU0EF5uUDXqX/BtxtU8NfB0QzRtJ8Oe/6SuS4kbhyzVJwjd97EA4PKrzJ8bw=="],
@@ -2019,6 +2021,8 @@
"get-nonce": ["get-nonce@1.0.1", "", {}, "sha512-FJhYRoDaiatfEkUK8HKlicmu/3SGFD51q3itKDGoSTysQJBnfOcxU5GxnhE1E6soB76MbT0MBtnKJuXyAx+96Q=="], "get-nonce": ["get-nonce@1.0.1", "", {}, "sha512-FJhYRoDaiatfEkUK8HKlicmu/3SGFD51q3itKDGoSTysQJBnfOcxU5GxnhE1E6soB76MbT0MBtnKJuXyAx+96Q=="],
"get-own-enumerable-keys": ["get-own-enumerable-keys@1.0.0", "", {}, "sha512-PKsK2FSrQCyxcGHsGrLDcK0lx+0Ke+6e8KFFozA9/fIQLhQzPaRvJFdcz7+Axg3jUH/Mq+NI4xa5u/UT2tQskA=="],
"get-source": ["get-source@2.0.12", "", { "dependencies": { "data-uri-to-buffer": "^2.0.0", "source-map": "^0.6.1" } }, "sha512-X5+4+iD+HoSeEED+uwrQ07BOQr0kEDFMVqqpBuI+RaZBpBpHCuXxo70bjar6f0b0u/DQJsJ7ssurpP0V60Az+w=="], "get-source": ["get-source@2.0.12", "", { "dependencies": { "data-uri-to-buffer": "^2.0.0", "source-map": "^0.6.1" } }, "sha512-X5+4+iD+HoSeEED+uwrQ07BOQr0kEDFMVqqpBuI+RaZBpBpHCuXxo70bjar6f0b0u/DQJsJ7ssurpP0V60Az+w=="],
"get-stream": ["get-stream@5.2.0", "", { "dependencies": { "pump": "^3.0.0" } }, "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA=="], "get-stream": ["get-stream@5.2.0", "", { "dependencies": { "pump": "^3.0.0" } }, "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA=="],
@@ -2189,6 +2193,8 @@
"is-reference": ["is-reference@1.2.1", "", { "dependencies": { "@types/estree": "*" } }, "sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ=="], "is-reference": ["is-reference@1.2.1", "", { "dependencies": { "@types/estree": "*" } }, "sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ=="],
"is-regexp": ["is-regexp@3.1.0", "", {}, "sha512-rbku49cWloU5bSMI+zaRaXdQHXnthP6DZ/vLnfdSKyL4zUzuWnomtOEiZZOd+ioQ+avFo/qau3KPTc7Fjy1uPA=="],
"is-stream": ["is-stream@2.0.1", "", {}, "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg=="], "is-stream": ["is-stream@2.0.1", "", {}, "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg=="],
"is-subdir": ["is-subdir@1.2.0", "", { "dependencies": { "better-path-resolve": "1.0.0" } }, "sha512-2AT6j+gXe/1ueqbW6fLZJiIw3F8iXGJtt0yDrZaBhAZEG1raiTxKWU+IPqMCzQAXOUCKdA4UDMgacKH25XG2Cw=="], "is-subdir": ["is-subdir@1.2.0", "", { "dependencies": { "better-path-resolve": "1.0.0" } }, "sha512-2AT6j+gXe/1ueqbW6fLZJiIw3F8iXGJtt0yDrZaBhAZEG1raiTxKWU+IPqMCzQAXOUCKdA4UDMgacKH25XG2Cw=="],
@@ -2203,8 +2209,6 @@
"isexe": ["isexe@2.0.0", "", {}, "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="], "isexe": ["isexe@2.0.0", "", {}, "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="],
"isomorphic.js": ["isomorphic.js@0.2.5", "", {}, "sha512-PIeMbHqMt4DnUP3MA/Flc0HElYjMXArsw1qwJZcm9sqR8mq3l8NYizFMty0pWwE/tzIGH3EKK5+jes5mAr85yw=="],
"jackspeak": ["jackspeak@4.0.2", "", { "dependencies": { "@isaacs/cliui": "^8.0.2" } }, "sha512-bZsjR/iRjl1Nk1UkjGpAzLNfQtzuijhn2g+pbZb98HQ1Gk8vM9hfbxeMBP+M2/UUdwj0RqGG3mlvk2MsAqwvEw=="], "jackspeak": ["jackspeak@4.0.2", "", { "dependencies": { "@isaacs/cliui": "^8.0.2" } }, "sha512-bZsjR/iRjl1Nk1UkjGpAzLNfQtzuijhn2g+pbZb98HQ1Gk8vM9hfbxeMBP+M2/UUdwj0RqGG3mlvk2MsAqwvEw=="],
"jest-worker": ["jest-worker@27.5.1", "", { "dependencies": { "@types/node": "*", "merge-stream": "^2.0.0", "supports-color": "^8.0.0" } }, "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg=="], "jest-worker": ["jest-worker@27.5.1", "", { "dependencies": { "@types/node": "*", "merge-stream": "^2.0.0", "supports-color": "^8.0.0" } }, "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg=="],
@@ -2255,6 +2259,8 @@
"jws": ["jws@3.2.2", "", { "dependencies": { "jwa": "^1.4.1", "safe-buffer": "^5.0.1" } }, "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA=="], "jws": ["jws@3.2.2", "", { "dependencies": { "jwa": "^1.4.1", "safe-buffer": "^5.0.1" } }, "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA=="],
"jwt-decode": ["jwt-decode@4.0.0", "", {}, "sha512-+KJGIyHgkGuIq3IEBNftfhW/LfWhXUIY6OmyVWjliu5KH1y0fw7VQ8YndE2O4qZdMSd9SqbnC8GOcZEy0Om7sA=="],
"katex": ["katex@0.16.11", "", { "dependencies": { "commander": "^8.3.0" }, "bin": { "katex": "cli.js" } }, "sha512-RQrI8rlHY92OLf3rho/Ts8i/XvjgguEjOkO1BEXcU3N8BqPpSzBNwV/G0Ukr+P/l3ivvJUE/Fa/CwbS6HesGNQ=="], "katex": ["katex@0.16.11", "", { "dependencies": { "commander": "^8.3.0" }, "bin": { "katex": "cli.js" } }, "sha512-RQrI8rlHY92OLf3rho/Ts8i/XvjgguEjOkO1BEXcU3N8BqPpSzBNwV/G0Ukr+P/l3ivvJUE/Fa/CwbS6HesGNQ=="],
"keyv": ["keyv@3.1.0", "", { "dependencies": { "json-buffer": "3.0.0" } }, "sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA=="], "keyv": ["keyv@3.1.0", "", { "dependencies": { "json-buffer": "3.0.0" } }, "sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA=="],
@@ -2265,8 +2271,6 @@
"leven": ["leven@4.0.0", "", {}, "sha512-puehA3YKku3osqPlNuzGDUHq8WpwXupUg1V6NXdV38G+gr+gkBwFC8g1b/+YcIvp8gnqVIus+eJCH/eGsRmJNw=="], "leven": ["leven@4.0.0", "", {}, "sha512-puehA3YKku3osqPlNuzGDUHq8WpwXupUg1V6NXdV38G+gr+gkBwFC8g1b/+YcIvp8gnqVIus+eJCH/eGsRmJNw=="],
"lib0": ["lib0@0.2.98", "", { "dependencies": { "isomorphic.js": "^0.2.4" }, "bin": { "0gentesthtml": "bin/gentesthtml.js", "0serve": "bin/0serve.js", "0ecdsa-generate-keypair": "bin/0ecdsa-generate-keypair.js" } }, "sha512-XteTiNO0qEXqqweWx+b21p/fBnNHUA1NwAtJNJek1oPrewEZs2uiT4gWivHKr9GqCjDPAhchz0UQO8NwU3bBNA=="],
"lilconfig": ["lilconfig@2.1.0", "", {}, "sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ=="], "lilconfig": ["lilconfig@2.1.0", "", {}, "sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ=="],
"lines-and-columns": ["lines-and-columns@1.2.4", "", {}, "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="], "lines-and-columns": ["lines-and-columns@1.2.4", "", {}, "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="],
@@ -2437,7 +2441,7 @@
"min-indent": ["min-indent@1.0.1", "", {}, "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg=="], "min-indent": ["min-indent@1.0.1", "", {}, "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg=="],
"miniflare": ["miniflare@3.20250214.0", "", { "dependencies": { "@cspotcode/source-map-support": "0.8.1", "acorn": "8.14.0", "acorn-walk": "8.3.2", "exit-hook": "2.2.1", "glob-to-regexp": "0.4.1", "stoppable": "1.1.0", "undici": "^5.28.5", "workerd": "1.20250214.0", "ws": "8.18.0", "youch": "3.2.3", "zod": "3.22.3" }, "bin": { "miniflare": "bootstrap.js" } }, "sha512-XKwn+X/V2CEpbRhoeaIcJHpV/Duz5Md5rxVT8I6S1oqd3aLZkn8cUX1tuxHpUvfQSPuXwWH+2ESLNnTf9PKEWg=="], "miniflare": ["miniflare@3.20250214.2", "", { "dependencies": { "@cspotcode/source-map-support": "0.8.1", "acorn": "8.14.0", "acorn-walk": "8.3.2", "exit-hook": "2.2.1", "glob-to-regexp": "0.4.1", "stoppable": "1.1.0", "undici": "^5.28.5", "workerd": "1.20250214.0", "ws": "8.18.0", "youch": "3.2.3", "zod": "3.22.3" }, "bin": { "miniflare": "bootstrap.js" } }, "sha512-t+lT4p2lbOcKv4PS3sx1F/wcDAlbEYZCO2VooLp4H7JErWWYIi9yjD3UillC3CGOpiBahVg5nrPCoFltZf6UlA=="],
"minimatch": ["minimatch@10.0.1", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ=="], "minimatch": ["minimatch@10.0.1", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ=="],
@@ -2467,7 +2471,7 @@
"mz": ["mz@2.7.0", "", { "dependencies": { "any-promise": "^1.0.0", "object-assign": "^4.0.1", "thenify-all": "^1.0.0" } }, "sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q=="], "mz": ["mz@2.7.0", "", { "dependencies": { "any-promise": "^1.0.0", "object-assign": "^4.0.1", "thenify-all": "^1.0.0" } }, "sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q=="],
"nanoid": ["nanoid@5.0.7", "", { "bin": { "nanoid": "bin/nanoid.js" } }, "sha512-oLxFY2gd2IqnjcYyOXD8XGCftpGtZP2AbHbOkthDkvRywH5ayNtPVy9YlOPcHckXzbLTCHpkb7FB+yuxKV13pQ=="], "nanoid": ["nanoid@5.1.2", "", { "bin": { "nanoid": "bin/nanoid.js" } }, "sha512-b+CiXQCNMUGe0Ri64S9SXFcP9hogjAJ2Rd6GdVxhPLRm7mhGaM7VgOvCAJ1ZshfHbqVDI3uqTI5C8/GaKuLI7g=="],
"negotiator": ["negotiator@1.0.0", "", {}, "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg=="], "negotiator": ["negotiator@1.0.0", "", {}, "sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg=="],
@@ -2643,8 +2647,6 @@
"progress": ["progress@2.0.3", "", {}, "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA=="], "progress": ["progress@2.0.3", "", {}, "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA=="],
"promise.series": ["promise.series@0.2.0", "", {}, "sha512-VWQJyU2bcDTgZw8kpfBpB/ejZASlCrzwz5f2hjb/zlujOEB4oeiAhHygAWq8ubsX2GVkD4kCU5V2dwOTaCY5EQ=="],
"promisepipe": ["promisepipe@3.0.0", "", {}, "sha512-V6TbZDJ/ZswevgkDNpGt/YqNCiZP9ASfgU+p83uJE6NrGtvSGoOcHLiDCqkMs2+yg7F5qHdLV8d0aS8O26G/KA=="], "promisepipe": ["promisepipe@3.0.0", "", {}, "sha512-V6TbZDJ/ZswevgkDNpGt/YqNCiZP9ASfgU+p83uJE6NrGtvSGoOcHLiDCqkMs2+yg7F5qHdLV8d0aS8O26G/KA=="],
"property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="], "property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="],
@@ -2767,8 +2769,6 @@
"rollup-pluginutils": ["rollup-pluginutils@2.8.2", "", { "dependencies": { "estree-walker": "^0.6.1" } }, "sha512-EEp9NhnUkwY8aif6bxgovPHMoMoNr2FulJziTndpt5H9RdwC47GSGuII9XxpSdzVGM0GWrNPHV6ie1LTNJPaLQ=="], "rollup-pluginutils": ["rollup-pluginutils@2.8.2", "", { "dependencies": { "estree-walker": "^0.6.1" } }, "sha512-EEp9NhnUkwY8aif6bxgovPHMoMoNr2FulJziTndpt5H9RdwC47GSGuII9XxpSdzVGM0GWrNPHV6ie1LTNJPaLQ=="],
"rollup-preserve-directives": ["rollup-preserve-directives@1.1.3", "", { "dependencies": { "magic-string": "^0.30.5" }, "peerDependencies": { "rollup": "^2.0.0 || ^3.0.0 || ^4.0.0" } }, "sha512-oXqxd6ZzkoQej8Qt0k+S/yvO2+S4CEVEVv2g85oL15o0cjAKTKEuo2MzyA8FcsBBXbtytBzBMFAbhvQg4YyPUQ=="],
"router": ["router@2.0.0", "", { "dependencies": { "array-flatten": "3.0.0", "is-promise": "4.0.0", "methods": "~1.1.2", "parseurl": "~1.3.3", "path-to-regexp": "^8.0.0", "setprototypeof": "1.2.0", "utils-merge": "1.0.1" } }, "sha512-dIM5zVoG8xhC6rnSN8uoAgFARwTE7BQs8YwHEvK0VCmfxQXMaOuA1uiR1IPwsW7JyK5iTt7Od/TC9StasS2NPQ=="], "router": ["router@2.0.0", "", { "dependencies": { "array-flatten": "3.0.0", "is-promise": "4.0.0", "methods": "~1.1.2", "parseurl": "~1.3.3", "path-to-regexp": "^8.0.0", "setprototypeof": "1.2.0", "utils-merge": "1.0.1" } }, "sha512-dIM5zVoG8xhC6rnSN8uoAgFARwTE7BQs8YwHEvK0VCmfxQXMaOuA1uiR1IPwsW7JyK5iTt7Od/TC9StasS2NPQ=="],
"run-parallel": ["run-parallel@1.2.0", "", { "dependencies": { "queue-microtask": "^1.2.2" } }, "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA=="], "run-parallel": ["run-parallel@1.2.0", "", { "dependencies": { "queue-microtask": "^1.2.2" } }, "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA=="],
@@ -2867,6 +2867,8 @@
"stringify-entities": ["stringify-entities@4.0.4", "", { "dependencies": { "character-entities-html4": "^2.0.0", "character-entities-legacy": "^3.0.0" } }, "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg=="], "stringify-entities": ["stringify-entities@4.0.4", "", { "dependencies": { "character-entities-html4": "^2.0.0", "character-entities-legacy": "^3.0.0" } }, "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg=="],
"stringify-object": ["stringify-object@5.0.0", "", { "dependencies": { "get-own-enumerable-keys": "^1.0.0", "is-obj": "^3.0.0", "is-regexp": "^3.1.0" } }, "sha512-zaJYxz2FtcMb4f+g60KsRNFOpVMUyuJgA51Zi5Z1DOTC3S59+OQiVOzE9GZt0x72uBGWKsQIuBKeF9iusmKFsg=="],
"strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="], "strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="],
"strip-ansi-cjs": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="], "strip-ansi-cjs": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="],
@@ -3069,6 +3071,8 @@
"w3c-keyname": ["w3c-keyname@2.2.8", "", {}, "sha512-dpojBhNsCNN7T82Tm7k26A6G9ML3NkhDsnw9n/eoxSRlVBB4CEtIQ/KTCLI2Fwf3ataSXRhYFkQi3SlnFwPvPQ=="], "w3c-keyname": ["w3c-keyname@2.2.8", "", {}, "sha512-dpojBhNsCNN7T82Tm7k26A6G9ML3NkhDsnw9n/eoxSRlVBB4CEtIQ/KTCLI2Fwf3ataSXRhYFkQi3SlnFwPvPQ=="],
"warn-once": ["warn-once@0.1.1", "", {}, "sha512-VkQZJbO8zVImzYFteBXvBOZEl1qL175WH8VmZcxF2fZAoudNhNDvHi+doCaAEdU2l2vtcIwa2zn0QK5+I1HQ3Q=="],
"watchpack": ["watchpack@2.4.2", "", { "dependencies": { "glob-to-regexp": "^0.4.1", "graceful-fs": "^4.1.2" } }, "sha512-TnbFSbcOCcDgjZ4piURLCbJ3nJhznVh9kw6F6iokjiFPl8ONxe9A6nMDVXDiNbrSfLILs6vB07F7wLBrwPYzJw=="], "watchpack": ["watchpack@2.4.2", "", { "dependencies": { "glob-to-regexp": "^0.4.1", "graceful-fs": "^4.1.2" } }, "sha512-TnbFSbcOCcDgjZ4piURLCbJ3nJhznVh9kw6F6iokjiFPl8ONxe9A6nMDVXDiNbrSfLILs6vB07F7wLBrwPYzJw=="],
"web-namespaces": ["web-namespaces@2.0.1", "", {}, "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ=="], "web-namespaces": ["web-namespaces@2.0.1", "", {}, "sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ=="],
@@ -3093,7 +3097,7 @@
"workerd": ["workerd@1.20250214.0", "", { "optionalDependencies": { "@cloudflare/workerd-darwin-64": "1.20250214.0", "@cloudflare/workerd-darwin-arm64": "1.20250214.0", "@cloudflare/workerd-linux-64": "1.20250214.0", "@cloudflare/workerd-linux-arm64": "1.20250214.0", "@cloudflare/workerd-windows-64": "1.20250214.0" }, "bin": { "workerd": "bin/workerd" } }, "sha512-QWcqXZLiMpV12wiaVnb3nLmfs/g4ZsFQq2mX85z546r3AX4CTIkXl0VP50W3CwqLADej3PGYiRDOTelDOwVG1g=="], "workerd": ["workerd@1.20250214.0", "", { "optionalDependencies": { "@cloudflare/workerd-darwin-64": "1.20250214.0", "@cloudflare/workerd-darwin-arm64": "1.20250214.0", "@cloudflare/workerd-linux-64": "1.20250214.0", "@cloudflare/workerd-linux-arm64": "1.20250214.0", "@cloudflare/workerd-windows-64": "1.20250214.0" }, "bin": { "workerd": "bin/workerd" } }, "sha512-QWcqXZLiMpV12wiaVnb3nLmfs/g4ZsFQq2mX85z546r3AX4CTIkXl0VP50W3CwqLADej3PGYiRDOTelDOwVG1g=="],
"wrangler": ["wrangler@3.109.3", "", { "dependencies": { "@cloudflare/kv-asset-handler": "0.3.4", "@esbuild-plugins/node-globals-polyfill": "0.2.3", "@esbuild-plugins/node-modules-polyfill": "0.2.2", "blake3-wasm": "2.1.5", "esbuild": "0.17.19", "miniflare": "3.20250214.0", "path-to-regexp": "6.3.0", "unenv": "2.0.0-rc.1", "workerd": "1.20250214.0" }, "optionalDependencies": { "fsevents": "~2.3.2", "sharp": "^0.33.5" }, "peerDependencies": { "@cloudflare/workers-types": "^4.20250214.0" }, "optionalPeers": ["@cloudflare/workers-types"], "bin": { "wrangler": "bin/wrangler.js", "wrangler2": "bin/wrangler.js" } }, "sha512-T+SfFYEbkWDzf8WRR1JzaVKPH7wAzyciRIua8qszT+UqPqFNb6M5beCHHK/de7Zk5z6W5lvLly9SHToC11maDQ=="], "wrangler": ["wrangler@3.112.0", "", { "dependencies": { "@cloudflare/kv-asset-handler": "0.3.4", "@esbuild-plugins/node-globals-polyfill": "0.2.3", "@esbuild-plugins/node-modules-polyfill": "0.2.2", "blake3-wasm": "2.1.5", "esbuild": "0.17.19", "miniflare": "3.20250214.2", "path-to-regexp": "6.3.0", "unenv": "2.0.0-rc.1", "workerd": "1.20250214.0" }, "optionalDependencies": { "fsevents": "~2.3.2", "sharp": "^0.33.5" }, "peerDependencies": { "@cloudflare/workers-types": "^4.20250214.0" }, "optionalPeers": ["@cloudflare/workers-types"], "bin": { "wrangler": "bin/wrangler.js", "wrangler2": "bin/wrangler.js" } }, "sha512-PNQWGze3ODlWwG33LPr8kNhbht3eB3L9fogv+fapk2fjaqj0kNweRapkwmvtz46ojcqWzsxmTe4nOC0hIVUfPA=="],
"wrap-ansi": ["wrap-ansi@8.1.0", "", { "dependencies": { "ansi-styles": "^6.1.0", "string-width": "^5.0.1", "strip-ansi": "^7.0.1" } }, "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ=="], "wrap-ansi": ["wrap-ansi@8.1.0", "", { "dependencies": { "ansi-styles": "^6.1.0", "string-width": "^5.0.1", "strip-ansi": "^7.0.1" } }, "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ=="],
@@ -3113,11 +3117,9 @@
"xtend": ["xtend@4.0.2", "", {}, "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ=="], "xtend": ["xtend@4.0.2", "", {}, "sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ=="],
"y-codemirror.next": ["y-codemirror.next@0.3.5", "", { "dependencies": { "lib0": "^0.2.42" }, "peerDependencies": { "@codemirror/state": "^6.0.0", "@codemirror/view": "^6.0.0", "yjs": "^13.5.6" } }, "sha512-VluNu3e5HfEXybnypnsGwKAj+fKLd4iAnR7JuX1Sfyydmn1jCBS5wwEL/uS04Ch2ib0DnMAOF6ZRR/8kK3wyGw=="],
"yallist": ["yallist@3.1.1", "", {}, "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g=="], "yallist": ["yallist@3.1.1", "", {}, "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g=="],
"yaml": ["yaml@2.6.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-a6ae//JvKDEra2kdi1qzCyrJW/WZCgFi8ydDV+eXExl95t+5R+ijnqHJbz9tmMh8FUjx3iv2fCQ4dclAQlO2UQ=="], "yaml": ["yaml@2.7.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA=="],
"yargs-parser": ["yargs-parser@18.1.3", "", { "dependencies": { "camelcase": "^5.0.0", "decamelize": "^1.2.0" } }, "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ=="], "yargs-parser": ["yargs-parser@18.1.3", "", { "dependencies": { "camelcase": "^5.0.0", "decamelize": "^1.2.0" } }, "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ=="],
@@ -3127,8 +3129,6 @@
"yauzl-promise": ["yauzl-promise@2.1.3", "", { "dependencies": { "yauzl": "^2.9.1", "yauzl-clone": "^1.0.4" } }, "sha512-A1pf6fzh6eYkK0L4Qp7g9jzJSDrM6nN0bOn5T0IbY4Yo3w+YkWlHFkJP7mzknMXjqusHFHlKsK2N+4OLsK2MRA=="], "yauzl-promise": ["yauzl-promise@2.1.3", "", { "dependencies": { "yauzl": "^2.9.1", "yauzl-clone": "^1.0.4" } }, "sha512-A1pf6fzh6eYkK0L4Qp7g9jzJSDrM6nN0bOn5T0IbY4Yo3w+YkWlHFkJP7mzknMXjqusHFHlKsK2N+4OLsK2MRA=="],
"yjs": ["yjs@13.6.20", "", { "dependencies": { "lib0": "^0.2.98" } }, "sha512-Z2YZI+SYqK7XdWlloI3lhMiKnCdFCVC4PchpdO+mCYwtiTwncjUbnRK9R1JmkNfdmHyDXuWN3ibJAt0wsqTbLQ=="],
"yn": ["yn@3.1.1", "", {}, "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q=="], "yn": ["yn@3.1.1", "", {}, "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q=="],
"yocto-queue": ["yocto-queue@0.1.0", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="], "yocto-queue": ["yocto-queue@0.1.0", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="],
@@ -3883,8 +3883,6 @@
"@opennextjs/aws/esbuild": ["esbuild@0.19.2", "", { "optionalDependencies": { "@esbuild/android-arm": "0.19.2", "@esbuild/android-arm64": "0.19.2", "@esbuild/android-x64": "0.19.2", "@esbuild/darwin-arm64": "0.19.2", "@esbuild/darwin-x64": "0.19.2", "@esbuild/freebsd-arm64": "0.19.2", "@esbuild/freebsd-x64": "0.19.2", "@esbuild/linux-arm": "0.19.2", "@esbuild/linux-arm64": "0.19.2", "@esbuild/linux-ia32": "0.19.2", "@esbuild/linux-loong64": "0.19.2", "@esbuild/linux-mips64el": "0.19.2", "@esbuild/linux-ppc64": "0.19.2", "@esbuild/linux-riscv64": "0.19.2", "@esbuild/linux-s390x": "0.19.2", "@esbuild/linux-x64": "0.19.2", "@esbuild/netbsd-x64": "0.19.2", "@esbuild/openbsd-x64": "0.19.2", "@esbuild/sunos-x64": "0.19.2", "@esbuild/win32-arm64": "0.19.2", "@esbuild/win32-ia32": "0.19.2", "@esbuild/win32-x64": "0.19.2" }, "bin": { "esbuild": "bin/esbuild" } }, "sha512-G6hPax8UbFakEj3hWO0Vs52LQ8k3lnBhxZWomUJDxfz3rZTLqF5k/FCzuNdLx2RbpBiQQF9H9onlDDH1lZsnjg=="], "@opennextjs/aws/esbuild": ["esbuild@0.19.2", "", { "optionalDependencies": { "@esbuild/android-arm": "0.19.2", "@esbuild/android-arm64": "0.19.2", "@esbuild/android-x64": "0.19.2", "@esbuild/darwin-arm64": "0.19.2", "@esbuild/darwin-x64": "0.19.2", "@esbuild/freebsd-arm64": "0.19.2", "@esbuild/freebsd-x64": "0.19.2", "@esbuild/linux-arm": "0.19.2", "@esbuild/linux-arm64": "0.19.2", "@esbuild/linux-ia32": "0.19.2", "@esbuild/linux-loong64": "0.19.2", "@esbuild/linux-mips64el": "0.19.2", "@esbuild/linux-ppc64": "0.19.2", "@esbuild/linux-riscv64": "0.19.2", "@esbuild/linux-s390x": "0.19.2", "@esbuild/linux-x64": "0.19.2", "@esbuild/netbsd-x64": "0.19.2", "@esbuild/openbsd-x64": "0.19.2", "@esbuild/sunos-x64": "0.19.2", "@esbuild/win32-arm64": "0.19.2", "@esbuild/win32-ia32": "0.19.2", "@esbuild/win32-x64": "0.19.2" }, "bin": { "esbuild": "bin/esbuild" } }, "sha512-G6hPax8UbFakEj3hWO0Vs52LQ8k3lnBhxZWomUJDxfz3rZTLqF5k/FCzuNdLx2RbpBiQQF9H9onlDDH1lZsnjg=="],
"@opennextjs/cloudflare/yaml": ["yaml@2.7.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA=="],
"@opentelemetry/core/@opentelemetry/semantic-conventions": ["@opentelemetry/semantic-conventions@1.27.0", "", {}, "sha512-sAay1RrB+ONOem0OZanAR1ZI/k7yDpnOQSQmTMuGImUQb2y8EbSaCJ94FQluM74xoU03vlb2d2U90hZluL6nQg=="], "@opentelemetry/core/@opentelemetry/semantic-conventions": ["@opentelemetry/semantic-conventions@1.27.0", "", {}, "sha512-sAay1RrB+ONOem0OZanAR1ZI/k7yDpnOQSQmTMuGImUQb2y8EbSaCJ94FQluM74xoU03vlb2d2U90hZluL6nQg=="],
"@opentelemetry/instrumentation-amqplib/@opentelemetry/core": ["@opentelemetry/core@1.30.0", "", { "dependencies": { "@opentelemetry/semantic-conventions": "1.28.0" }, "peerDependencies": { "@opentelemetry/api": ">=1.0.0 <1.10.0" } }, "sha512-Q/3u/K73KUjTCnFUP97ZY+pBjQ1kPEgjOfXj/bJl8zW7GbXdkw6cwuyZk6ZTXkVgCBsYRYUzx4fvYK1jxdb9MA=="], "@opentelemetry/instrumentation-amqplib/@opentelemetry/core": ["@opentelemetry/core@1.30.0", "", { "dependencies": { "@opentelemetry/semantic-conventions": "1.28.0" }, "peerDependencies": { "@opentelemetry/api": ">=1.0.0 <1.10.0" } }, "sha512-Q/3u/K73KUjTCnFUP97ZY+pBjQ1kPEgjOfXj/bJl8zW7GbXdkw6cwuyZk6ZTXkVgCBsYRYUzx4fvYK1jxdb9MA=="],
@@ -3949,24 +3947,8 @@
"@rollup/plugin-commonjs/glob": ["glob@10.4.5", "", { "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^3.1.2", "minimatch": "^9.0.4", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^1.11.1" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg=="], "@rollup/plugin-commonjs/glob": ["glob@10.4.5", "", { "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^3.1.2", "minimatch": "^9.0.4", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^1.11.1" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg=="],
"@scalar/api-client/@scalar/oas-utils": ["@scalar/oas-utils@0.2.75", "", { "dependencies": { "@hyperjump/json-schema": "^1.9.6", "@scalar/object-utils": "1.1.12", "@scalar/openapi-types": "0.1.5", "@scalar/themes": "0.9.48", "@scalar/types": "0.0.19", "flatted": "^3.3.1", "microdiff": "^1.4.0", "nanoid": "^5.0.7", "yaml": "^2.4.5", "zod": "^3.23.8" } }, "sha512-deBH359aA9hO+QzdcdJkd0KpZFlSf9xYf+58nl+sVOQL+uEay/LAn1kO+iiE0JAkL78wlW+nqje9sVBKEAdVdw=="],
"@scalar/api-client/@scalar/openapi-parser": ["@scalar/openapi-parser@0.8.9", "", { "dependencies": { "ajv": "^8.17.1", "ajv-draft-04": "^1.0.0", "ajv-formats": "^3.0.1", "jsonpointer": "^5.0.1", "leven": "^4.0.0", "yaml": "^2.4.5" } }, "sha512-vTXrkl/hX3CG2dMe8mYutjsjfFLZOXGFJGqz6k8lUk8avFP/5eGEsd/eZe1UIcwtDwcjgJIyQ4p3pIC7jBvfuw=="],
"@scalar/api-client/@scalar/openapi-types": ["@scalar/openapi-types@0.1.5", "", {}, "sha512-6geH9ehvQ/sG/xUyy3e0lyOw3BaY5s6nn22wHjEJhcobdmWyFER0O6m7AU0ZN4QTjle/gYvFJOjj552l/rsNSw=="],
"@scalar/api-client/@scalar/themes": ["@scalar/themes@0.9.48", "", { "dependencies": { "@scalar/types": "0.0.19" } }, "sha512-lsehl9KnlKgWG8BOIIaX3iIuNMLjRFZ0ctb1KsQBhOSsoTrq3c9EUJdYJiiTWzm52zdhF+RkIx7uHaX/pvgctw=="],
"@scalar/api-client/@scalar/types": ["@scalar/types@0.0.19", "", { "dependencies": { "@scalar/openapi-types": "0.1.5", "@unhead/schema": "^1.9.5" } }, "sha512-wOxtXd35BS0DaVhBopQUB8c8hfLQ+/PKEr99GbOZW+4DWCrEB8JfWJgvpJyxHU6by7LHNVY4fvpFQR7Ezh1IIw=="],
"@scalar/api-client/pretty-ms": ["pretty-ms@8.0.0", "", { "dependencies": { "parse-ms": "^3.0.0" } }, "sha512-ASJqOugUF1bbzI35STMBUpZqdfYKlJugy6JBziGi2EE+AL5JPJGSzvpeVXojxrr0ViUYoToUjb5kjSEGf7Y83Q=="], "@scalar/api-client/pretty-ms": ["pretty-ms@8.0.0", "", { "dependencies": { "parse-ms": "^3.0.0" } }, "sha512-ASJqOugUF1bbzI35STMBUpZqdfYKlJugy6JBziGi2EE+AL5JPJGSzvpeVXojxrr0ViUYoToUjb5kjSEGf7Y83Q=="],
"@scalar/components/@scalar/themes": ["@scalar/themes@0.9.48", "", { "dependencies": { "@scalar/types": "0.0.19" } }, "sha512-lsehl9KnlKgWG8BOIIaX3iIuNMLjRFZ0ctb1KsQBhOSsoTrq3c9EUJdYJiiTWzm52zdhF+RkIx7uHaX/pvgctw=="],
"@scalar/import/@scalar/openapi-parser": ["@scalar/openapi-parser@0.8.9", "", { "dependencies": { "ajv": "^8.17.1", "ajv-draft-04": "^1.0.0", "ajv-formats": "^3.0.1", "jsonpointer": "^5.0.1", "leven": "^4.0.0", "yaml": "^2.4.5" } }, "sha512-vTXrkl/hX3CG2dMe8mYutjsjfFLZOXGFJGqz6k8lUk8avFP/5eGEsd/eZe1UIcwtDwcjgJIyQ4p3pIC7jBvfuw=="],
"@scalar/oas-utils/yaml": ["yaml@2.7.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA=="],
"@sentry/bundler-plugin-core/find-up": ["find-up@5.0.0", "", { "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" } }, "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng=="], "@sentry/bundler-plugin-core/find-up": ["find-up@5.0.0", "", { "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" } }, "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng=="],
"@sentry/bundler-plugin-core/glob": ["glob@9.3.5", "", { "dependencies": { "fs.realpath": "^1.0.0", "minimatch": "^8.0.2", "minipass": "^4.2.4", "path-scurry": "^1.6.1" } }, "sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q=="], "@sentry/bundler-plugin-core/glob": ["glob@9.3.5", "", { "dependencies": { "fs.realpath": "^1.0.0", "minimatch": "^8.0.2", "minipass": "^4.2.4", "path-scurry": "^1.6.1" } }, "sha512-e1LleDykUz2Iu+MTYdkSsuWX8lvAjAcs0Xef0lNIu0S2wOAzuTxCJtcd9S3cijlwYF18EsU3rzb8jPVobxDh9Q=="],
@@ -4241,8 +4223,6 @@
"convict/yargs-parser": ["yargs-parser@20.2.9", "", {}, "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w=="], "convict/yargs-parser": ["yargs-parser@20.2.9", "", {}, "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w=="],
"cva/clsx": ["clsx@2.0.0", "", {}, "sha512-rQ1+kcj+ttHG0MKVGBUXwayCCF1oh39BF5COIpRzuCEv8Mwjv0XucrI2ExNTOn9IlLifGClWQcU9BrZORvtw6Q=="],
"decamelize-keys/map-obj": ["map-obj@1.0.1", "", {}, "sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg=="], "decamelize-keys/map-obj": ["map-obj@1.0.1", "", {}, "sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg=="],
"edge-runtime/async-listen": ["async-listen@3.0.1", "", {}, "sha512-cWMaNwUJnf37C/S5TfCkk/15MwbPRwVYALA2jtjkbHjCmAPiDXyNJy2q3p1KAZzDLHAWyarUWSujUoHR4pEgrA=="], "edge-runtime/async-listen": ["async-listen@3.0.1", "", {}, "sha512-cWMaNwUJnf37C/S5TfCkk/15MwbPRwVYALA2jtjkbHjCmAPiDXyNJy2q3p1KAZzDLHAWyarUWSujUoHR4pEgrA=="],
@@ -4283,7 +4263,7 @@
"gaxios/node-fetch": ["node-fetch@2.7.0", "", { "dependencies": { "whatwg-url": "^5.0.0" }, "peerDependencies": { "encoding": "^0.1.0" }, "optionalPeers": ["encoding"] }, "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A=="], "gaxios/node-fetch": ["node-fetch@2.7.0", "", { "dependencies": { "whatwg-url": "^5.0.0" }, "peerDependencies": { "encoding": "^0.1.0" }, "optionalPeers": ["encoding"] }, "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A=="],
"gitbook-v2/next": ["next@15.2.0", "", { "dependencies": { "@next/env": "15.2.0", "@swc/counter": "0.1.3", "@swc/helpers": "0.5.15", "busboy": "1.6.0", "caniuse-lite": "^1.0.30001579", "postcss": "8.4.31", "styled-jsx": "5.1.6" }, "optionalDependencies": { "@next/swc-darwin-arm64": "15.2.0", "@next/swc-darwin-x64": "15.2.0", "@next/swc-linux-arm64-gnu": "15.2.0", "@next/swc-linux-arm64-musl": "15.2.0", "@next/swc-linux-x64-gnu": "15.2.0", "@next/swc-linux-x64-musl": "15.2.0", "@next/swc-win32-arm64-msvc": "15.2.0", "@next/swc-win32-x64-msvc": "15.2.0", "sharp": "^0.33.5" }, "peerDependencies": { "@opentelemetry/api": "^1.1.0", "@playwright/test": "^1.41.2", "babel-plugin-react-compiler": "*", "react": "^18.2.0 || 19.0.0-rc-de68d2f4-20241204 || ^19.0.0", "react-dom": "^18.2.0 || 19.0.0-rc-de68d2f4-20241204 || ^19.0.0", "sass": "^1.3.0" }, "optionalPeers": ["@opentelemetry/api", "@playwright/test", "babel-plugin-react-compiler", "sass"], "bin": { "next": "dist/bin/next" } }, "sha512-VaiM7sZYX8KIAHBrRGSFytKknkrexNfGb8GlG6e93JqueCspuGte8i4ybn8z4ww1x3f2uzY4YpTaBEW4/hvsoQ=="], "gitbook-v2/next": ["next@15.2.1", "", { "dependencies": { "@next/env": "15.2.1", "@swc/counter": "0.1.3", "@swc/helpers": "0.5.15", "busboy": "1.6.0", "caniuse-lite": "^1.0.30001579", "postcss": "8.4.31", "styled-jsx": "5.1.6" }, "optionalDependencies": { "@next/swc-darwin-arm64": "15.2.1", "@next/swc-darwin-x64": "15.2.1", "@next/swc-linux-arm64-gnu": "15.2.1", "@next/swc-linux-arm64-musl": "15.2.1", "@next/swc-linux-x64-gnu": "15.2.1", "@next/swc-linux-x64-musl": "15.2.1", "@next/swc-win32-arm64-msvc": "15.2.1", "@next/swc-win32-x64-msvc": "15.2.1", "sharp": "^0.33.5" }, "peerDependencies": { "@opentelemetry/api": "^1.1.0", "@playwright/test": "^1.41.2", "babel-plugin-react-compiler": "*", "react": "^18.2.0 || 19.0.0-rc-de68d2f4-20241204 || ^19.0.0", "react-dom": "^18.2.0 || 19.0.0-rc-de68d2f4-20241204 || ^19.0.0", "sass": "^1.3.0" }, "optionalPeers": ["@opentelemetry/api", "@playwright/test", "babel-plugin-react-compiler", "sass"], "bin": { "next": "dist/bin/next" } }, "sha512-zxbsdQv3OqWXybK5tMkPCBKyhIz63RstJ+NvlfkaLMc/m5MwXgz2e92k+hSKcyBpyADhMk2C31RIiaDjUZae7g=="],
"google-auth-library/jws": ["jws@4.0.0", "", { "dependencies": { "jwa": "^2.0.0", "safe-buffer": "^5.0.1" } }, "sha512-KDncfTmOZoOMTFG4mBlG0qUIOlc03fmzH+ru6RgYVZhPkyiy/92Owlt/8UEN+a4TXR1FQetfIpJE8ApdvdVxTg=="], "google-auth-library/jws": ["jws@4.0.0", "", { "dependencies": { "jwa": "^2.0.0", "safe-buffer": "^5.0.1" } }, "sha512-KDncfTmOZoOMTFG4mBlG0qUIOlc03fmzH+ru6RgYVZhPkyiy/92Owlt/8UEN+a4TXR1FQetfIpJE8ApdvdVxTg=="],
@@ -4369,6 +4349,8 @@
"postcss-load-config/lilconfig": ["lilconfig@3.1.2", "", {}, "sha512-eop+wDAvpItUys0FWkHIKeC9ybYrTGbU41U5K7+bttZZeohvnY7M9dZ5kB21GNWiFT2q1OoPTvncPCgSOVO5ow=="], "postcss-load-config/lilconfig": ["lilconfig@3.1.2", "", {}, "sha512-eop+wDAvpItUys0FWkHIKeC9ybYrTGbU41U5K7+bttZZeohvnY7M9dZ5kB21GNWiFT2q1OoPTvncPCgSOVO5ow=="],
"postcss-load-config/yaml": ["yaml@2.6.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-a6ae//JvKDEra2kdi1qzCyrJW/WZCgFi8ydDV+eXExl95t+5R+ijnqHJbz9tmMh8FUjx3iv2fCQ4dclAQlO2UQ=="],
"psi/chalk": ["chalk@3.0.0", "", { "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" } }, "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg=="], "psi/chalk": ["chalk@3.0.0", "", { "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" } }, "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg=="],
"pump/end-of-stream": ["end-of-stream@1.4.4", "", { "dependencies": { "once": "^1.4.0" } }, "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q=="], "pump/end-of-stream": ["end-of-stream@1.4.4", "", { "dependencies": { "once": "^1.4.0" } }, "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q=="],
@@ -4377,6 +4359,8 @@
"radix-vue/@internationalized/number": ["@internationalized/number@3.5.4", "", { "dependencies": { "@swc/helpers": "^0.5.0" } }, "sha512-h9huwWjNqYyE2FXZZewWqmCdkw1HeFds5q4Siuoms3hUQC5iPJK3aBmkFZoDSLN4UD0Bl8G22L/NdHpeOr+/7A=="], "radix-vue/@internationalized/number": ["@internationalized/number@3.5.4", "", { "dependencies": { "@swc/helpers": "^0.5.0" } }, "sha512-h9huwWjNqYyE2FXZZewWqmCdkw1HeFds5q4Siuoms3hUQC5iPJK3aBmkFZoDSLN4UD0Bl8G22L/NdHpeOr+/7A=="],
"radix-vue/nanoid": ["nanoid@5.0.7", "", { "bin": { "nanoid": "bin/nanoid.js" } }, "sha512-oLxFY2gd2IqnjcYyOXD8XGCftpGtZP2AbHbOkthDkvRywH5ayNtPVy9YlOPcHckXzbLTCHpkb7FB+yuxKV13pQ=="],
"raw-body/http-errors": ["http-errors@1.7.3", "", { "dependencies": { "depd": "~1.1.2", "inherits": "2.0.4", "setprototypeof": "1.1.1", "statuses": ">= 1.5.0 < 2", "toidentifier": "1.0.0" } }, "sha512-ZTTX0MWrsQ2ZAhA1cejAwDLycFsd7I7nVtnkT3Ol0aqodaKW+0CTZDQ1uBv5whptCnc8e8HeRRJxRs0kmm/Qfw=="], "raw-body/http-errors": ["http-errors@1.7.3", "", { "dependencies": { "depd": "~1.1.2", "inherits": "2.0.4", "setprototypeof": "1.1.1", "statuses": ">= 1.5.0 < 2", "toidentifier": "1.0.0" } }, "sha512-ZTTX0MWrsQ2ZAhA1cejAwDLycFsd7I7nVtnkT3Ol0aqodaKW+0CTZDQ1uBv5whptCnc8e8HeRRJxRs0kmm/Qfw=="],
"rc/ini": ["ini@1.3.8", "", {}, "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="], "rc/ini": ["ini@1.3.8", "", {}, "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew=="],
@@ -4421,6 +4405,8 @@
"stacktrace-parser/type-fest": ["type-fest@0.7.1", "", {}, "sha512-Ne2YiiGN8bmrmJJEuTWTLJR32nh/JdL1+PSicowtNb0WFpn59GK8/lfD61bVtzguz7b3PBt74nxpv/Pw5po5Rg=="], "stacktrace-parser/type-fest": ["type-fest@0.7.1", "", {}, "sha512-Ne2YiiGN8bmrmJJEuTWTLJR32nh/JdL1+PSicowtNb0WFpn59GK8/lfD61bVtzguz7b3PBt74nxpv/Pw5po5Rg=="],
"stringify-object/is-obj": ["is-obj@3.0.0", "", {}, "sha512-IlsXEHOjtKhpN8r/tRFj2nDyTmHvcfNeu/nrRIcXE17ROeatXchkojffa1SpdqW4cr/Fj6QkEf/Gn4zf6KKvEQ=="],
"sucrase/commander": ["commander@4.1.1", "", {}, "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA=="], "sucrase/commander": ["commander@4.1.1", "", {}, "sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA=="],
"sucrase/glob": ["glob@10.4.5", "", { "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^3.1.2", "minimatch": "^9.0.4", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^1.11.1" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg=="], "sucrase/glob": ["glob@10.4.5", "", { "dependencies": { "foreground-child": "^3.1.0", "jackspeak": "^3.1.2", "minimatch": "^9.0.4", "minipass": "^7.1.2", "package-json-from-dist": "^1.0.0", "path-scurry": "^1.11.1" }, "bin": { "glob": "dist/esm/bin.mjs" } }, "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg=="],
@@ -5017,8 +5003,6 @@
"@scalar/api-client/pretty-ms/parse-ms": ["parse-ms@3.0.0", "", {}, "sha512-Tpb8Z7r7XbbtBTrM9UhpkzzaMrqA2VXMT3YChzYltwV3P3pM6t8wl7TvpMnSTosz1aQAdVib7kdoys7vYOPerw=="], "@scalar/api-client/pretty-ms/parse-ms": ["parse-ms@3.0.0", "", {}, "sha512-Tpb8Z7r7XbbtBTrM9UhpkzzaMrqA2VXMT3YChzYltwV3P3pM6t8wl7TvpMnSTosz1aQAdVib7kdoys7vYOPerw=="],
"@scalar/components/@scalar/themes/@scalar/types": ["@scalar/types@0.0.19", "", { "dependencies": { "@scalar/openapi-types": "0.1.5", "@unhead/schema": "^1.9.5" } }, "sha512-wOxtXd35BS0DaVhBopQUB8c8hfLQ+/PKEr99GbOZW+4DWCrEB8JfWJgvpJyxHU6by7LHNVY4fvpFQR7Ezh1IIw=="],
"@sentry/bundler-plugin-core/find-up/locate-path": ["locate-path@6.0.0", "", { "dependencies": { "p-locate": "^5.0.0" } }, "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw=="], "@sentry/bundler-plugin-core/find-up/locate-path": ["locate-path@6.0.0", "", { "dependencies": { "p-locate": "^5.0.0" } }, "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw=="],
"@sentry/bundler-plugin-core/glob/minimatch": ["minimatch@8.0.4", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA=="], "@sentry/bundler-plugin-core/glob/minimatch": ["minimatch@8.0.4", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-W0Wvr9HyFXZRGIDgCicunpQ299OKXs9RgZfaukz4qAW/pJhcpUfupc9c+OObPOFueNy8VSrZgEmDtk6Kh4WzDA=="],
@@ -5183,23 +5167,23 @@
"gaxios/https-proxy-agent/debug": ["debug@4.3.7", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ=="], "gaxios/https-proxy-agent/debug": ["debug@4.3.7", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ=="],
"gitbook-v2/next/@next/env": ["@next/env@15.2.0", "", {}, "sha512-eMgJu1RBXxxqqnuRJQh5RozhskoNUDHBFybvi+Z+yK9qzKeG7dadhv/Vp1YooSZmCnegf7JxWuapV77necLZNA=="], "gitbook-v2/next/@next/env": ["@next/env@15.2.1", "", {}, "sha512-JmY0qvnPuS2NCWOz2bbby3Pe0VzdAQ7XpEB6uLIHmtXNfAsAO0KLQLkuAoc42Bxbo3/jMC3dcn9cdf+piCcG2Q=="],
"gitbook-v2/next/@next/swc-darwin-arm64": ["@next/swc-darwin-arm64@15.2.0", "", { "os": "darwin", "cpu": "arm64" }, "sha512-rlp22GZwNJjFCyL7h5wz9vtpBVuCt3ZYjFWpEPBGzG712/uL1bbSkS675rVAUCRZ4hjoTJ26Q7IKhr5DfJrHDA=="], "gitbook-v2/next/@next/swc-darwin-arm64": ["@next/swc-darwin-arm64@15.2.1", "", { "os": "darwin", "cpu": "arm64" }, "sha512-aWXT+5KEREoy3K5AKtiKwioeblmOvFFjd+F3dVleLvvLiQ/mD//jOOuUcx5hzcO9ISSw4lrqtUPntTpK32uXXQ=="],
"gitbook-v2/next/@next/swc-darwin-x64": ["@next/swc-darwin-x64@15.2.0", "", { "os": "darwin", "cpu": "x64" }, "sha512-DiU85EqSHogCz80+sgsx90/ecygfCSGl5P3b4XDRVZpgujBm5lp4ts7YaHru7eVTyZMjHInzKr+w0/7+qDrvMA=="], "gitbook-v2/next/@next/swc-darwin-x64": ["@next/swc-darwin-x64@15.2.1", "", { "os": "darwin", "cpu": "x64" }, "sha512-E/w8ervu4fcG5SkLhvn1NE/2POuDCDEy5gFbfhmnYXkyONZR68qbUlJlZwuN82o7BrBVAw+tkR8nTIjGiMW1jQ=="],
"gitbook-v2/next/@next/swc-linux-arm64-gnu": ["@next/swc-linux-arm64-gnu@15.2.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-VnpoMaGukiNWVxeqKHwi8MN47yKGyki5q+7ql/7p/3ifuU2341i/gDwGK1rivk0pVYbdv5D8z63uu9yMw0QhpQ=="], "gitbook-v2/next/@next/swc-linux-arm64-gnu": ["@next/swc-linux-arm64-gnu@15.2.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-gXDX5lIboebbjhiMT6kFgu4svQyjoSed6dHyjx5uZsjlvTwOAnZpn13w9XDaIMFFHw7K8CpBK7HfDKw0VZvUXQ=="],
"gitbook-v2/next/@next/swc-linux-arm64-musl": ["@next/swc-linux-arm64-musl@15.2.0", "", { "os": "linux", "cpu": "arm64" }, "sha512-ka97/ssYE5nPH4Qs+8bd8RlYeNeUVBhcnsNUmFM6VWEob4jfN9FTr0NBhXVi1XEJpj3cMfgSRW+LdE3SUZbPrw=="], "gitbook-v2/next/@next/swc-linux-arm64-musl": ["@next/swc-linux-arm64-musl@15.2.1", "", { "os": "linux", "cpu": "arm64" }, "sha512-3v0pF/adKZkBWfUffmB/ROa+QcNTrnmYG4/SS+r52HPwAK479XcWoES2I+7F7lcbqc7mTeVXrIvb4h6rR/iDKg=="],
"gitbook-v2/next/@next/swc-linux-x64-gnu": ["@next/swc-linux-x64-gnu@15.2.0", "", { "os": "linux", "cpu": "x64" }, "sha512-zY1JduE4B3q0k2ZCE+DAF/1efjTXUsKP+VXRtrt/rJCTgDlUyyryx7aOgYXNc1d8gobys/Lof9P9ze8IyRDn7Q=="], "gitbook-v2/next/@next/swc-linux-x64-gnu": ["@next/swc-linux-x64-gnu@15.2.1", "", { "os": "linux", "cpu": "x64" }, "sha512-RbsVq2iB6KFJRZ2cHrU67jLVLKeuOIhnQB05ygu5fCNgg8oTewxweJE8XlLV+Ii6Y6u4EHwETdUiRNXIAfpBww=="],
"gitbook-v2/next/@next/swc-linux-x64-musl": ["@next/swc-linux-x64-musl@15.2.0", "", { "os": "linux", "cpu": "x64" }, "sha512-QqvLZpurBD46RhaVaVBepkVQzh8xtlUN00RlG4Iq1sBheNugamUNPuZEH1r9X1YGQo1KqAe1iiShF0acva3jHQ=="], "gitbook-v2/next/@next/swc-linux-x64-musl": ["@next/swc-linux-x64-musl@15.2.1", "", { "os": "linux", "cpu": "x64" }, "sha512-QHsMLAyAIu6/fWjHmkN/F78EFPKmhQlyX5C8pRIS2RwVA7z+t9cTb0IaYWC3EHLOTjsU7MNQW+n2xGXr11QPpg=="],
"gitbook-v2/next/@next/swc-win32-arm64-msvc": ["@next/swc-win32-arm64-msvc@15.2.0", "", { "os": "win32", "cpu": "arm64" }, "sha512-ODZ0r9WMyylTHAN6pLtvUtQlGXBL9voljv6ujSlcsjOxhtXPI1Ag6AhZK0SE8hEpR1374WZZ5w33ChpJd5fsjw=="], "gitbook-v2/next/@next/swc-win32-arm64-msvc": ["@next/swc-win32-arm64-msvc@15.2.1", "", { "os": "win32", "cpu": "arm64" }, "sha512-Gk42XZXo1cE89i3hPLa/9KZ8OuupTjkDmhLaMKFohjf9brOeZVEa3BQy1J9s9TWUqPhgAEbwv6B2+ciGfe54Vw=="],
"gitbook-v2/next/@next/swc-win32-x64-msvc": ["@next/swc-win32-x64-msvc@15.2.0", "", { "os": "win32", "cpu": "x64" }, "sha512-8+4Z3Z7xa13NdUuUAcpVNA6o76lNPniBd9Xbo02bwXQXnZgFvEopwY2at5+z7yHl47X9qbZpvwatZ2BRo3EdZw=="], "gitbook-v2/next/@next/swc-win32-x64-msvc": ["@next/swc-win32-x64-msvc@15.2.1", "", { "os": "win32", "cpu": "x64" }, "sha512-YjqXCl8QGhVlMR8uBftWk0iTmvtntr41PhG1kvzGp0sUP/5ehTM+cwx25hKE54J0CRnHYjSGjSH3gkHEaHIN9g=="],
"gitbook-v2/next/postcss": ["postcss@8.4.31", "", { "dependencies": { "nanoid": "^3.3.6", "picocolors": "^1.0.0", "source-map-js": "^1.0.2" } }, "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ=="], "gitbook-v2/next/postcss": ["postcss@8.4.31", "", { "dependencies": { "nanoid": "^3.3.6", "picocolors": "^1.0.0", "source-map-js": "^1.0.2" } }, "sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ=="],
@@ -5413,8 +5397,6 @@
"@rollup/plugin-commonjs/glob/path-scurry/lru-cache": ["lru-cache@10.4.3", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="], "@rollup/plugin-commonjs/glob/path-scurry/lru-cache": ["lru-cache@10.4.3", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="],
"@scalar/components/@scalar/themes/@scalar/types/@scalar/openapi-types": ["@scalar/openapi-types@0.1.5", "", {}, "sha512-6geH9ehvQ/sG/xUyy3e0lyOw3BaY5s6nn22wHjEJhcobdmWyFER0O6m7AU0ZN4QTjle/gYvFJOjj552l/rsNSw=="],
"@sentry/bundler-plugin-core/find-up/locate-path/p-locate": ["p-locate@5.0.0", "", { "dependencies": { "p-limit": "^3.0.2" } }, "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw=="], "@sentry/bundler-plugin-core/find-up/locate-path/p-locate": ["p-locate@5.0.0", "", { "dependencies": { "p-limit": "^3.0.2" } }, "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw=="],
"@sentry/bundler-plugin-core/glob/path-scurry/lru-cache": ["lru-cache@10.4.3", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="], "@sentry/bundler-plugin-core/glob/path-scurry/lru-cache": ["lru-cache@10.4.3", "", {}, "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ=="],
+1 -1
View File
@@ -21,7 +21,7 @@
}, },
"devDependencies": { "devDependencies": {
"typescript": "^5.5.3", "typescript": "^5.5.3",
"wrangler": "^3.109.2" "wrangler": "^3.112.0"
}, },
"scripts": { "scripts": {
"generate": "wrangler types --experimental-include-runtime", "generate": "wrangler types --experimental-include-runtime",
+6
View File
@@ -1,5 +1,11 @@
# gitbook-v2 # gitbook-v2
## 0.2.0
### Minor Changes
- 76c7974: Add route to revalidate cached data
## 0.1.2 ## 0.1.2
### Patch Changes ### Patch Changes
+13 -2
View File
@@ -10,10 +10,21 @@ const nextConfig = {
env: { env: {
BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7), BUILD_VERSION: (process.env.GITHUB_SHA ?? '').slice(0, 7),
GITBOOK_URL: process.env.GITBOOK_URL,
GITBOOK_ASSETS_PREFIX: process.env.GITBOOK_ASSETS_PREFIX, // 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_URL: process.env.GITBOOK_ICONS_URL,
GITBOOK_ICONS_TOKEN: process.env.GITBOOK_ICONS_TOKEN, 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,
// Next.js envs
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY, NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY,
// Used to detect if the app is running in V2 mode // Used to detect if the app is running in V2 mode
+9 -29
View File
@@ -1,30 +1,10 @@
// default open-next.config.ts file created by @opennextjs/cloudflare import { defineCloudflareConfig } from '@opennextjs/cloudflare';
import d1TagCache from '@opennextjs/cloudflare/d1-tag-cache';
import kvIncrementalCache from '@opennextjs/cloudflare/kv-cache';
import memoryQueue from '@opennextjs/cloudflare/memory-queue';
import cache from '@opennextjs/cloudflare/kvCache'; export default defineCloudflareConfig({
incrementalCache: kvIncrementalCache,
const config = { queue: memoryQueue,
default: { tagCache: d1TagCache,
override: { });
wrapper: 'cloudflare-node',
converter: 'edge',
incrementalCache: async () => cache,
tagCache: 'dummy',
queue: 'dummy',
},
},
middleware: {
external: true,
override: {
wrapper: 'cloudflare-edge',
converter: 'edge',
proxyExternalRequest: 'fetch',
},
},
dangerous: {
enableCacheInterception: false,
},
};
export default config;
+5 -4
View File
@@ -1,19 +1,20 @@
{ {
"name": "gitbook-v2", "name": "gitbook-v2",
"version": "0.1.2", "version": "0.2.0",
"private": true, "private": true,
"dependencies": { "dependencies": {
"next": "^15.2.0", "next": "^15.2.1",
"react": "^19.0.0", "react": "^19.0.0",
"react-dom": "^19.0.0", "react-dom": "^19.0.0",
"@gitbook/api": "0.96.1", "@gitbook/api": "0.96.1",
"@gitbook/cache-tags": "workspace:*", "@gitbook/cache-tags": "workspace:*",
"@sindresorhus/fnv1a": "^3.1.0", "@sindresorhus/fnv1a": "^3.1.0",
"server-only": "^0.0.1" "server-only": "^0.0.1",
"warn-once": "^0.1.1"
}, },
"devDependencies": { "devDependencies": {
"gitbook": "*", "gitbook": "*",
"@opennextjs/cloudflare": "^0.5.3", "@opennextjs/cloudflare": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@40fec7d",
"tailwindcss": "^3.4.0", "tailwindcss": "^3.4.0",
"postcss": "^8" "postcss": "^8"
}, },
@@ -3,8 +3,6 @@ import type { NextRequest } from 'next/server';
import { serveIcon } from '@/routes/icon'; import { serveIcon } from '@/routes/icon';
import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils'; import { type RouteLayoutParams, getDynamicSiteContext } from '@v2/app/utils';
export const dynamic = 'force-static';
export async function GET( export async function GET(
request: NextRequest, request: NextRequest,
{ params }: { params: Promise<RouteLayoutParams> } { params }: { params: Promise<RouteLayoutParams> }
+36
View File
@@ -0,0 +1,36 @@
import { type NextRequest, NextResponse } from 'next/server';
import {
GITBOOK_API_TOKEN,
GITBOOK_API_URL,
GITBOOK_APP_URL,
GITBOOK_ASSETS_URL,
GITBOOK_DISABLE_TRACKING,
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_ASSETS_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,
});
}
@@ -0,0 +1,35 @@
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,
});
});
}
+22 -13
View File
@@ -13,7 +13,7 @@ import type {
SiteStructure, SiteStructure,
Space, Space,
} from '@gitbook/api'; } from '@gitbook/api';
import { type GitBookDataFetcher, createDataFetcher } from '@v2/lib/data'; import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
import { redirect } from 'next/navigation'; import { redirect } from 'next/navigation';
import { assert } from 'ts-essentials'; import { assert } from 'ts-essentials';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from './env'; import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from './env';
@@ -116,7 +116,7 @@ export function getBaseContext(input: {
apiToken: input.apiToken ?? GITBOOK_API_TOKEN, apiToken: input.apiToken ?? GITBOOK_API_TOKEN,
apiEndpoint: GITBOOK_API_URL, apiEndpoint: GITBOOK_API_URL,
}); });
const gitbookURL = new URL(GITBOOK_URL); const gitbookURL = GITBOOK_URL ? new URL(GITBOOK_URL) : undefined;
const linker = const linker =
urlMode === 'url-host' urlMode === 'url-host'
@@ -125,8 +125,8 @@ export function getBaseContext(input: {
pathname: url.pathname, pathname: url.pathname,
}) })
: createLinker({ : createLinker({
protocol: gitbookURL.protocol, protocol: gitbookURL?.protocol,
host: gitbookURL.host, host: gitbookURL?.host,
pathname: `/url/${url.host}${url.pathname}`, pathname: `/url/${url.host}${url.pathname}`,
}); });
@@ -139,8 +139,7 @@ export function getBaseContext(input: {
} }
const imageResizer = createImageResizer({ const imageResizer = createImageResizer({
host: urlMode === 'url-host' ? url.host : gitbookURL.host, host: url.host,
// To ensure image resizing work for proxied sites, // To ensure image resizing work for proxied sites,
// we serve images from the root of the site. // we serve images from the root of the site.
linker: linker, linker: linker,
@@ -165,11 +164,13 @@ export async function fetchSiteContextByURL(
} }
): Promise<GitBookSiteContext> { ): Promise<GitBookSiteContext> {
const { dataFetcher } = baseContext; const { dataFetcher } = baseContext;
const data = await dataFetcher.getPublishedContentByUrl({ const data = await throwIfDataError(
dataFetcher.getPublishedContentByUrl({
url: input.url, url: input.url,
visitorAuthToken: input.visitorAuthToken, visitorAuthToken: input.visitorAuthToken,
redirectOnError: input.redirectOnError, redirectOnError: input.redirectOnError,
}); })
);
return fetchSiteContextByURLLookup(baseContext, data); return fetchSiteContextByURLLookup(baseContext, data);
} }
@@ -226,11 +227,13 @@ export async function fetchSiteContextByIds(
const [{ site: orgSite, structure: siteStructure, customizations, scripts }, spaceContext] = const [{ site: orgSite, structure: siteStructure, customizations, scripts }, spaceContext] =
await Promise.all([ await Promise.all([
throwIfDataError(
dataFetcher.getPublishedContentSite({ dataFetcher.getPublishedContentSite({
organizationId: ids.organization, organizationId: ids.organization,
siteId: ids.site, siteId: ids.site,
siteShareKey: ids.shareKey, siteShareKey: ids.shareKey,
}), })
),
fetchSpaceContextByIds(baseContext, ids), fetchSpaceContextByIds(baseContext, ids),
]); ]);
@@ -303,27 +306,33 @@ export async function fetchSpaceContextByIds(
const { dataFetcher } = baseContext; const { dataFetcher } = baseContext;
const [space, changeRequest] = await Promise.all([ const [space, changeRequest] = await Promise.all([
throwIfDataError(
dataFetcher.getSpace({ dataFetcher.getSpace({
spaceId: ids.space, spaceId: ids.space,
shareKey: ids.shareKey, shareKey: ids.shareKey,
}), })
),
ids.changeRequest ids.changeRequest
? dataFetcher.getChangeRequest({ ? throwIfDataError(
dataFetcher.getChangeRequest({
spaceId: ids.space, spaceId: ids.space,
changeRequestId: ids.changeRequest, changeRequestId: ids.changeRequest,
}) })
)
: null, : null,
]); ]);
const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision; const revisionId = changeRequest?.revision ?? ids.revision ?? space.revision;
const pages = await dataFetcher.getRevisionPages({ const pages = await throwIfDataError(
dataFetcher.getRevisionPages({
spaceId: ids.space, spaceId: ids.space,
revisionId, revisionId,
// We only care about the Git metadata when the Git sync is enabled, // We only care about the Git metadata when the Git sync is enabled,
// otherwise we can optimize performance by not fetching it // otherwise we can optimize performance by not fetching it
metadata: !!space.gitSync, metadata: !!space.gitSync,
}); })
);
return { return {
...baseContext, ...baseContext,
+33 -66
View File
@@ -2,6 +2,7 @@ import { type ComputedContentSource, GitBookAPI } from '@gitbook/api';
import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags'; import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env'; import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache'; import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
import { wrapDataFetcherError } from './errors';
import type { GitBookDataFetcher } from './types'; import type { GitBookDataFetcher } from './types';
interface DataFetcherInput { interface DataFetcherInput {
@@ -156,16 +157,10 @@ async function getUserById(input: DataFetcherInput, userId: string) {
cacheLife('days'); cacheLife('days');
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).users.getUserById(userId); const res = await getAPI(input).users.getUserById(userId);
return res.data; return res.data;
} catch (error) { });
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getSpace( async function getSpace(
@@ -185,10 +180,12 @@ async function getSpace(
}) })
); );
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getSpaceById(params.spaceId, { const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
shareKey: params.shareKey, shareKey: params.shareKey,
}); });
return res.data; return res.data;
});
} }
async function getChangeRequest( async function getChangeRequest(
@@ -202,7 +199,7 @@ async function getChangeRequest(
cacheLife('minutes'); cacheLife('minutes');
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getChangeRequestById( const res = await getAPI(input).spaces.getChangeRequestById(
params.spaceId, params.spaceId,
params.changeRequestId params.changeRequestId
@@ -215,13 +212,7 @@ async function getChangeRequest(
}) })
); );
return res.data; return res.data;
} catch (error) { });
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getRevision( async function getRevision(
@@ -236,10 +227,12 @@ async function getRevision(
cacheLife('max'); cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, { const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
metadata: params.metadata, metadata: params.metadata,
}); });
return res.data; return res.data;
});
} }
async function getRevisionPages( async function getRevisionPages(
@@ -254,6 +247,7 @@ async function getRevisionPages(
cacheLife('max'); cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.listPagesInRevisionById( const res = await getAPI(input).spaces.listPagesInRevisionById(
params.spaceId, params.spaceId,
params.revisionId, params.revisionId,
@@ -262,6 +256,7 @@ async function getRevisionPages(
} }
); );
return res.data.pages; return res.data.pages;
});
} }
async function getRevisionFile( async function getRevisionFile(
@@ -276,20 +271,14 @@ async function getRevisionFile(
cacheLife('max'); cacheLife('max');
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getFileInRevisionById( const res = await getAPI(input).spaces.getFileInRevisionById(
params.spaceId, params.spaceId,
params.revisionId, params.revisionId,
params.fileId params.fileId
); );
return res.data; return res.data;
} catch (error) { });
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getRevisionPageByPath( async function getRevisionPageByPath(
@@ -305,7 +294,7 @@ async function getRevisionPageByPath(
cacheLife('max'); cacheLife('max');
const encodedPath = encodeURIComponent(params.path); const encodedPath = encodeURIComponent(params.path);
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getPageInRevisionByPath( const res = await getAPI(input).spaces.getPageInRevisionByPath(
params.spaceId, params.spaceId,
params.revisionId, params.revisionId,
@@ -313,13 +302,7 @@ async function getRevisionPageByPath(
); );
return res.data; return res.data;
} catch (error) { });
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getDocument( async function getDocument(
@@ -333,8 +316,10 @@ async function getDocument(
cacheLife('max'); cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId); const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
return res.data; return res.data;
});
} }
async function getComputedDocument( async function getComputedDocument(
@@ -359,10 +344,12 @@ async function getComputedDocument(
) )
); );
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, { const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
source: params.source, source: params.source,
}); });
return res.data; return res.data;
});
} }
async function getReusableContent( async function getReusableContent(
@@ -377,20 +364,14 @@ async function getReusableContent(
cacheLife('max'); cacheLife('max');
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getReusableContentInRevisionById( const res = await getAPI(input).spaces.getReusableContentInRevisionById(
params.spaceId, params.spaceId,
params.revisionId, params.revisionId,
params.reusableContentId params.reusableContentId
); );
return res.data; return res.data;
} catch (error) { });
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getLatestOpenAPISpecVersionContent( async function getLatestOpenAPISpecVersionContent(
@@ -411,19 +392,13 @@ async function getLatestOpenAPISpecVersionContent(
); );
cacheLife('days'); cacheLife('days');
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.getLatestOpenApiSpecVersionContent( const res = await getAPI(input).orgs.getLatestOpenApiSpecVersionContent(
params.organizationId, params.organizationId,
params.slug params.slug
); );
return res.data; return res.data;
} catch (error) { });
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getPublishedContentByUrl( async function getPublishedContentByUrl(
@@ -447,6 +422,7 @@ async function getPublishedContentByUrl(
); );
cacheLife('days'); cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).urls.getPublishedContentByUrl({ const res = await getAPI(input).urls.getPublishedContentByUrl({
url, url,
visitorAuthToken: visitorAuthToken ?? undefined, visitorAuthToken: visitorAuthToken ?? undefined,
@@ -463,6 +439,7 @@ async function getPublishedContentByUrl(
} }
return res.data; return res.data;
});
} }
async function getPublishedContentSite( async function getPublishedContentSite(
@@ -483,6 +460,7 @@ async function getPublishedContentSite(
); );
cacheLife('days'); cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.getPublishedContentSite( const res = await getAPI(input).orgs.getPublishedContentSite(
params.organizationId, params.organizationId,
params.siteId, params.siteId,
@@ -491,6 +469,7 @@ async function getPublishedContentSite(
} }
); );
return res.data; return res.data;
});
} }
async function getSiteRedirectBySource( async function getSiteRedirectBySource(
@@ -512,7 +491,7 @@ async function getSiteRedirectBySource(
); );
cacheLife('days'); cacheLife('days');
try { return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.getSiteRedirectBySource( const res = await getAPI(input).orgs.getSiteRedirectBySource(
params.organizationId, params.organizationId,
params.siteId, params.siteId,
@@ -523,19 +502,7 @@ async function getSiteRedirectBySource(
); );
return res.data; return res.data;
} catch (error) { });
// 422 is returned when the source is invalid
// we don't want to throw but just return null
if (checkHasErrorCode(error, 422)) {
return null;
}
if (checkHasErrorCode(error, 404)) {
return null;
}
throw error;
}
} }
async function getEmbedByUrl( async function getEmbedByUrl(
@@ -549,9 +516,11 @@ async function getEmbedByUrl(
cacheLife('weeks'); cacheLife('weeks');
return wrapDataFetcherError(async () => {
const api = getAPI(input); const api = getAPI(input);
const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url }); const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
return res.data; return res.data;
});
} }
async function searchSiteContent( async function searchSiteContent(
@@ -564,11 +533,13 @@ async function searchSiteContent(
cacheLife('days'); cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.searchSiteContent(organizationId, siteId, { const res = await getAPI(input).orgs.searchSiteContent(organizationId, siteId, {
query, query,
...scope, ...scope,
}); });
return res.data.items; return res.data.items;
});
} }
function getAPI(input: DataFetcherInput) { function getAPI(input: DataFetcherInput) {
@@ -581,7 +552,3 @@ function getAPI(input: DataFetcherInput) {
return api; return api;
} }
function checkHasErrorCode(error: unknown, code: number) {
return error instanceof Error && 'code' in error && error.code === code;
}
+112
View File
@@ -0,0 +1,112 @@
import { GitBookAPIError } from '@gitbook/api';
import type { DataFetcherErrorData, DataFetcherResponse } from './types';
export class DataFetcherError extends Error {
constructor(
message: string,
public readonly code: number
) {
super(message);
}
}
/**
* Throw an error if the response contains an error.
*/
export function throwIfDataError<T>(response: DataFetcherResponse<T>): T;
export function throwIfDataError<T>(response: Promise<DataFetcherResponse<T>>): Promise<T>;
export function throwIfDataError<T>(
response: DataFetcherResponse<T> | Promise<DataFetcherResponse<T>>
): T | Promise<T> {
if (response instanceof Promise) {
return response.then((result) => throwIfDataError(result));
}
if (response.error) {
throw new DataFetcherError(response.error.message, response.error.code);
}
return response.data;
}
/**
* Get the data from the response or null if there is an "Not found" error.
*/
export function getDataOrNull<T>(
response: DataFetcherResponse<T>,
ignoreErrors?: number[]
): T | null;
export function getDataOrNull<T>(
response: Promise<DataFetcherResponse<T>>,
ignoreErrors?: number[]
): Promise<T | null>;
export function getDataOrNull<T>(
response: DataFetcherResponse<T> | Promise<DataFetcherResponse<T>>,
ignoreErrors: number[] = [404]
): T | null | Promise<T | null> {
if (response instanceof Promise) {
return response.then((result) => getDataOrNull(result, ignoreErrors));
}
if (response.error) {
if (ignoreErrors.includes(response.error.code)) return null;
throw new DataFetcherError(response.error.message, response.error.code);
}
return response.data;
}
/**
* Ignore error for an API or data call.
*/
export async function ignoreDataThrownError<T>(promise: Promise<T>): Promise<T | null> {
try {
return await promise;
} catch (error) {
getExposableError(error as Error);
return null;
}
}
/**
* Ignore all errors for an API or data call.
*/
export async function ignoreAllThrownError<T>(promise: Promise<T>): Promise<T | null> {
try {
return await promise;
} catch (error) {
console.warn('Ignoring error', error);
return null;
}
}
/**
* Wrap an async execution to handle errors and return a DataFetcherResponse.
*/
export async function wrapDataFetcherError<T>(
fn: () => Promise<T>
): Promise<DataFetcherResponse<T>> {
try {
return { data: await fn() };
} catch (error) {
return {
error: getExposableError(error as Error),
};
}
}
function getExposableError(error: Error): DataFetcherErrorData {
if (error instanceof GitBookAPIError) {
return {
code: error.code,
message: error.errorMessage,
};
}
if (error instanceof DataFetcherError) {
return {
code: error.code,
message: error.message,
};
}
throw error;
}
+3 -1
View File
@@ -1,4 +1,6 @@
export * from './api'; export * from './api';
export * from './types'; export * from './types';
export * from './utils'; export * from './pages';
export * from './urls'; export * from './urls';
export * from './errors';
export * from './lookup';
+118
View File
@@ -0,0 +1,118 @@
import { race, tryCatch } from '@/lib/async';
import { joinPath } from '@/lib/paths';
import { GitBookAPI, type GitBookAPIError, type PublishedSiteContentLookup } from '@gitbook/api';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
import { getURLLookupAlternatives, stripURLSearch } from './urls';
/**
* Lookup a content by its URL using the GitBook API.
* To optimize caching, we try multiple lookup alternatives and return the first one that matches.
*/
export async function getPublishedContentByURL(input: {
url: string;
visitorAuthToken: string | null;
redirectOnError: boolean;
}): Promise<
| { data: PublishedSiteContentLookup; error?: undefined }
| { data?: undefined; error: Error | GitBookAPIError }
> {
const lookupURL = new URL(input.url);
const url = stripURLSearch(lookupURL);
const lookup = getURLLookupAlternatives(url);
const result = await race(lookup.urls, async (alternative, { signal }) => {
const api = new GitBookAPI({
authToken: GITBOOK_API_TOKEN ?? undefined,
endpoint: GITBOOK_API_URL,
userAgent: GITBOOK_USER_AGENT,
});
const callResult = await tryCatch(
api.urls.getPublishedContentByUrl(
{
url: alternative.url,
visitorAuthToken: input.visitorAuthToken ?? undefined,
redirectOnError: input.redirectOnError,
cache: true,
},
{
signal,
headers: {
'x-gitbook-force-cache': 'true',
},
}
)
);
if (callResult.error) {
if (alternative.primary) {
// We only return an error for the primary alternative (full URL),
// as other parts could result in errors due to the URL being incomplete (share links, etc).
return { error: callResult.error };
}
return null;
}
const {
data: { data },
} = callResult;
if ('redirect' in data) {
if (alternative.primary) {
// Append the path to the redirect URL
// because we might have matched a shorter path and the redirect is relative to it
if (alternative.extraPath) {
if (data.target === 'content') {
const redirect = new URL(data.redirect);
redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
data.redirect = redirect.toString();
} else {
const redirect = new URL(data.redirect);
if (redirect.searchParams.has('location')) {
redirect.searchParams.set(
'location',
joinPath(
redirect.searchParams.get('location') ?? '',
alternative.extraPath
)
);
data.redirect = redirect.toString();
}
}
}
return { data };
}
return null;
}
/**
* We use the following criteria to determine if the lookup result is the right one:
* - the primary alternative was resolved (because that's the longest or most inclusive path)
* - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
*
* In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
*/
if (alternative.primary || ('site' in data && data.complete)) {
const siteResult: PublishedSiteContentLookup = {
...data,
changeRequest: data.changeRequest ?? lookup.changeRequest,
revision: data.revision ?? lookup.revision,
basePath: joinPath(data.basePath, lookup.basePath ?? ''),
pathname: joinPath(data.pathname, alternative.extraPath),
};
return { data: siteResult };
}
return null;
});
if (!result) {
return {
error: new Error('No content found'),
};
}
return result;
}
+29
View File
@@ -0,0 +1,29 @@
import type { JSONDocument, RevisionPageDocument, Space } from '@gitbook/api';
import { getDataOrNull } from './errors';
import type { GitBookDataFetcher } from './types';
/**
* Get the document for a page.
*/
export async function getPageDocument(
dataFetcher: GitBookDataFetcher,
space: Space,
page: RevisionPageDocument
): Promise<JSONDocument | null> {
if (page.documentId) {
return getDataOrNull(
dataFetcher.getDocument({ spaceId: space.id, documentId: page.documentId })
);
}
if (page.computed) {
return getDataOrNull(
dataFetcher.getComputedDocument({
organizationId: space.organization,
spaceId: space.id,
source: page.computed,
})
);
}
return null;
}
+37 -16
View File
@@ -1,5 +1,20 @@
import type * as api from '@gitbook/api'; import type * as api from '@gitbook/api';
export type DataFetcherErrorData = {
code: number;
message: string;
};
export type DataFetcherResponse<T> =
| {
data: T;
error?: undefined;
}
| {
error: DataFetcherErrorData;
data?: undefined;
};
/** /**
* Generic fetcher for GitBook data. * Generic fetcher for GitBook data.
* It is used between v1 and v2. * It is used between v1 and v2.
@@ -25,7 +40,7 @@ export interface GitBookDataFetcher {
/** /**
* Get a user by its ID. * Get a user by its ID.
*/ */
getUserById(userId: string): Promise<api.User | null>; getUserById(userId: string): Promise<DataFetcherResponse<api.User>>;
/** /**
* Get a published content by its URL. * Get a published content by its URL.
@@ -34,7 +49,7 @@ export interface GitBookDataFetcher {
url: string; url: string;
visitorAuthToken: string | null; visitorAuthToken: string | null;
redirectOnError: boolean; redirectOnError: boolean;
}): Promise<api.PublishedSiteContentLookup>; }): Promise<DataFetcherResponse<api.PublishedSiteContentLookup>>;
/** /**
* Get a published content site by its organization ID and site ID. * Get a published content site by its organization ID and site ID.
@@ -43,12 +58,14 @@ export interface GitBookDataFetcher {
organizationId: string; organizationId: string;
siteId: string; siteId: string;
siteShareKey: string | undefined; siteShareKey: string | undefined;
}): Promise<api.PublishedContentSite>; }): Promise<DataFetcherResponse<api.PublishedContentSite>>;
/** /**
* Get a space by its ID. * Get a space by its ID.
*/ */
getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<api.Space>; getSpace(params: { spaceId: string; shareKey: string | undefined }): Promise<
DataFetcherResponse<api.Space>
>;
/** /**
* Get a change request by its space ID and change request ID. * Get a change request by its space ID and change request ID.
@@ -56,7 +73,7 @@ export interface GitBookDataFetcher {
getChangeRequest(params: { getChangeRequest(params: {
spaceId: string; spaceId: string;
changeRequestId: string; changeRequestId: string;
}): Promise<api.ChangeRequest | null>; }): Promise<DataFetcherResponse<api.ChangeRequest>>;
/** /**
* Get the revision by its space ID and revision ID. * Get the revision by its space ID and revision ID.
@@ -65,7 +82,7 @@ export interface GitBookDataFetcher {
spaceId: string; spaceId: string;
revisionId: string; revisionId: string;
metadata: boolean; metadata: boolean;
}): Promise<api.Revision>; }): Promise<DataFetcherResponse<api.Revision>>;
/** /**
* Get the revision pages by its space ID and revision ID. * Get the revision pages by its space ID and revision ID.
@@ -74,7 +91,7 @@ export interface GitBookDataFetcher {
spaceId: string; spaceId: string;
revisionId: string; revisionId: string;
metadata: boolean; metadata: boolean;
}): Promise<api.RevisionPage[]>; }): Promise<DataFetcherResponse<api.RevisionPage[]>>;
/** /**
* Get a revision file by its space ID, revision ID and file ID. * Get a revision file by its space ID, revision ID and file ID.
@@ -83,7 +100,7 @@ export interface GitBookDataFetcher {
spaceId: string; spaceId: string;
revisionId: string; revisionId: string;
fileId: string; fileId: string;
}): Promise<api.RevisionFile | null>; }): Promise<DataFetcherResponse<api.RevisionFile>>;
/** /**
* Get a revision page by its path. * Get a revision page by its path.
@@ -92,12 +109,14 @@ export interface GitBookDataFetcher {
spaceId: string; spaceId: string;
revisionId: string; revisionId: string;
path: string; path: string;
}): Promise<api.RevisionPageDocument | api.RevisionPageGroup | null>; }): Promise<DataFetcherResponse<api.RevisionPageDocument | api.RevisionPageGroup>>;
/** /**
* Get a document by its space ID and document ID. * Get a document by its space ID and document ID.
*/ */
getDocument(params: { spaceId: string; documentId: string }): Promise<api.JSONDocument>; getDocument(params: { spaceId: string; documentId: string }): Promise<
DataFetcherResponse<api.JSONDocument>
>;
/** /**
* Get a computed document by its space ID and computed source. * Get a computed document by its space ID and computed source.
@@ -106,7 +125,7 @@ export interface GitBookDataFetcher {
organizationId: string; organizationId: string;
spaceId: string; spaceId: string;
source: api.ComputedContentSource; source: api.ComputedContentSource;
}): Promise<api.JSONDocument>; }): Promise<DataFetcherResponse<api.JSONDocument>>;
/** /**
* Get a reusable content by its space ID, revision ID and reusable content ID. * Get a reusable content by its space ID, revision ID and reusable content ID.
@@ -115,7 +134,7 @@ export interface GitBookDataFetcher {
spaceId: string; spaceId: string;
revisionId: string; revisionId: string;
reusableContentId: string; reusableContentId: string;
}): Promise<api.RevisionReusableContent | null>; }): Promise<DataFetcherResponse<api.RevisionReusableContent>>;
/** /**
* Get the latest OpenAPI spec version content by its organization ID and slug. * Get the latest OpenAPI spec version content by its organization ID and slug.
@@ -123,7 +142,7 @@ export interface GitBookDataFetcher {
getLatestOpenAPISpecVersionContent(params: { getLatestOpenAPISpecVersionContent(params: {
organizationId: string; organizationId: string;
slug: string; slug: string;
}): Promise<api.OpenAPISpecContent | null>; }): Promise<DataFetcherResponse<api.OpenAPISpecContent>>;
/** /**
* Get a site redirect by its source path. * Get a site redirect by its source path.
@@ -133,12 +152,14 @@ export interface GitBookDataFetcher {
siteId: string; siteId: string;
siteShareKey: string | undefined; siteShareKey: string | undefined;
source: string; source: string;
}): Promise<{ redirect: api.SiteRedirect | null; target: string } | null>; }): Promise<DataFetcherResponse<{ redirect: api.SiteRedirect | null; target: string }>>;
/** /**
* Get an embed by its URL. * Get an embed by its URL.
*/ */
getEmbedByUrl(params: { url: string; spaceId: string }): Promise<api.Embed>; getEmbedByUrl(params: { url: string; spaceId: string }): Promise<
DataFetcherResponse<api.Embed>
>;
/** /**
* Search content in a site. * Search content in a site.
@@ -153,5 +174,5 @@ export interface GitBookDataFetcher {
| { mode: 'specific'; siteSpaceIds: string[] }; | { mode: 'specific'; siteSpaceIds: string[] };
/** Cache bust to ensure the search results are fresh when the space is updated. */ /** Cache bust to ensure the search results are fresh when the space is updated. */
cacheBust?: string; cacheBust?: string;
}): Promise<api.SearchSpaceResult[]>; }): Promise<DataFetcherResponse<api.SearchSpaceResult[]>>;
} }
-118
View File
@@ -1,121 +1,3 @@
import { race, tryCatch } from '@/lib/async';
import { joinPath } from '@/lib/paths';
import { GitBookAPI, type GitBookAPIError, type PublishedSiteContentLookup } from '@gitbook/api';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
/**
* Lookup a content by its URL using the GitBook API.
* To optimize caching, we try multiple lookup alternatives and return the first one that matches.
*/
export async function getPublishedContentByURL(input: {
url: string;
visitorAuthToken: string | null;
redirectOnError: boolean;
}): Promise<
| { data: PublishedSiteContentLookup; error?: undefined }
| { data?: undefined; error: Error | GitBookAPIError }
> {
const lookupURL = new URL(input.url);
const url = stripURLSearch(lookupURL);
const lookup = getURLLookupAlternatives(url);
const result = await race(lookup.urls, async (alternative, { signal }) => {
const api = new GitBookAPI({
authToken: GITBOOK_API_TOKEN ?? undefined,
endpoint: GITBOOK_API_URL,
userAgent: GITBOOK_USER_AGENT,
});
const callResult = await tryCatch(
api.urls.getPublishedContentByUrl(
{
url: alternative.url,
visitorAuthToken: input.visitorAuthToken ?? undefined,
redirectOnError: input.redirectOnError,
cache: true,
},
{
signal,
headers: {
'x-gitbook-force-cache': 'true',
},
}
)
);
if (callResult.error) {
if (alternative.primary) {
// We only return an error for the primary alternative (full URL),
// as other parts could result in errors due to the URL being incomplete (share links, etc).
return { error: callResult.error };
}
return null;
}
const {
data: { data },
} = callResult;
if ('redirect' in data) {
if (alternative.primary) {
// Append the path to the redirect URL
// because we might have matched a shorter path and the redirect is relative to it
if (alternative.extraPath) {
if (data.target === 'content') {
const redirect = new URL(data.redirect);
redirect.pathname = joinPath(redirect.pathname, alternative.extraPath);
data.redirect = redirect.toString();
} else {
const redirect = new URL(data.redirect);
if (redirect.searchParams.has('location')) {
redirect.searchParams.set(
'location',
joinPath(
redirect.searchParams.get('location') ?? '',
alternative.extraPath
)
);
data.redirect = redirect.toString();
}
}
}
return { data };
}
return null;
}
/**
* We use the following criteria to determine if the lookup result is the right one:
* - the primary alternative was resolved (because that's the longest or most inclusive path)
* - the resolution of the site URL is complete (because we want to resolve the deepest path possible)
*
* In both cases, the idea is to use the deepest/longest/most inclusive path to resolve the content.
*/
if (alternative.primary || ('site' in data && data.complete)) {
const siteResult: PublishedSiteContentLookup = {
...data,
changeRequest: data.changeRequest ?? lookup.changeRequest,
revision: data.revision ?? lookup.revision,
basePath: joinPath(data.basePath, lookup.basePath ?? ''),
pathname: joinPath(data.pathname, alternative.extraPath),
};
return { data: siteResult };
}
return null;
});
if (!result) {
return {
error: new Error('No content found'),
};
}
return result;
}
/** /**
* For a given GitBook URL, return a list of alternative URLs that could be matched against to lookup the content. * For a given GitBook URL, return a list of alternative URLs that could be matched against to lookup the content.
* The approach is optimized to aim at reusing cached lookup results as much as possible. * The approach is optimized to aim at reusing cached lookup results as much as possible.
-24
View File
@@ -1,24 +0,0 @@
import type { RevisionPageDocument, Space } from '@gitbook/api';
import type { GitBookDataFetcher } from './types';
/**
* Get the document for a page.
*/
export async function getPageDocument(
dataFetcher: GitBookDataFetcher,
space: Space,
page: RevisionPageDocument
) {
if (page.documentId) {
return dataFetcher.getDocument({ spaceId: space.id, documentId: page.documentId });
}
if (page.computed) {
return dataFetcher.getComputedDocument({
organizationId: space.organization,
spaceId: space.id,
source: page.computed,
});
}
return null;
}
@@ -1,11 +1,19 @@
import 'server-only';
/*
* Support both Cloudflare and Vercel, environment variables can be bundled.
* To avoid leaking them on the client-side, they should be accessed from this file
* and not from the `process.env` object.
*/
/** /**
* Main host on which GitBook is running. * Main host on which GitBook is running.
*/ */
export const GITBOOK_URL = export const GITBOOK_URL =
process.env.NODE_ENV === 'development' process.env.NODE_ENV === 'development'
? 'http://localhost:3000' ? 'http://localhost:3000'
: ((process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ?? : (process.env.GITBOOK_URL ??
process.env.GITBOOK_URL ?? (process.env.VERCEL_URL ? `https://${process.env.VERCEL_URL}` : undefined) ??
''); '');
/** /**
@@ -14,28 +22,28 @@ export const GITBOOK_URL =
export const GITBOOK_ASSETS_URL = export const GITBOOK_ASSETS_URL =
process.env.NODE_ENV === 'development' process.env.NODE_ENV === 'development'
? 'http://localhost:3000' ? 'http://localhost:3000'
: (process.env.GITBOOK_ASSETS_PREFIX ?? GITBOOK_URL); : process.env.GITBOOK_ASSETS_PREFIX;
/** /**
* GitBook app URL. * GitBook app URL.
*/ */
export const GITBOOK_APP_URL = process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? 'https://app.gitbook.com'; export const GITBOOK_APP_URL = process.env.GITBOOK_APP_URL || 'https://app.gitbook.com';
/** /**
* Default GitBook API URL endpoint. * Default GitBook API URL endpoint.
*/ */
export const GITBOOK_API_URL = process.env.GITBOOK_API_URL ?? 'https://api.gitbook.com'; export const GITBOOK_API_URL = process.env.GITBOOK_API_URL || 'https://api.gitbook.com';
/** /**
* Default GitBook API token. * Default GitBook API token.
* It can be use to avoid rate-limiting. * It can be use to avoid rate-limiting.
*/ */
export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN ?? null; export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN || null;
/** /**
* User agent to use for API requests. * User agent to use for API requests.
*/ */
export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT ?? 'GitBook-Open/2.0.0'; export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT || 'GitBook-Open/2.0.0';
/** /**
* Whether to disable tracking of events into site insights. * Whether to disable tracking of events into site insights.
@@ -49,7 +57,7 @@ export const GITBOOK_DISABLE_TRACKING = Boolean(
* Hostname serving the integrations. * Hostname serving the integrations.
*/ */
export const GITBOOK_INTEGRATIONS_HOST = export const GITBOOK_INTEGRATIONS_HOST =
process.env.GITBOOK_INTEGRATIONS_HOST ?? 'integrations.gitbook.com'; process.env.GITBOOK_INTEGRATIONS_HOST || 'integrations.gitbook.com';
/** /**
* Endpoint to use for resizing images. * Endpoint to use for resizing images.
@@ -58,3 +66,19 @@ export const GITBOOK_INTEGRATIONS_HOST =
export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ?? null; export const GITBOOK_IMAGE_RESIZE_URL = process.env.GITBOOK_IMAGE_RESIZE_URL ?? null;
export const GITBOOK_IMAGE_RESIZE_SIGNING_KEY = export const GITBOOK_IMAGE_RESIZE_SIGNING_KEY =
process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY ?? null; process.env.GITBOOK_IMAGE_RESIZE_SIGNING_KEY ?? null;
/**
* Endpoint where icons are served.
*/
export const GITBOOK_ICONS_URL =
process.env.GITBOOK_ICONS_URL || `${GITBOOK_ASSETS_URL || ''}/~gitbook/static/icons`;
/**
* Token passed to the icons endpoint.
*/
export const GITBOOK_ICONS_TOKEN = process.env.GITBOOK_ICONS_TOKEN;
/**
* Secret used to validate requests from the GitBook app.
*/
export const GITBOOK_SECRET = process.env.GITBOOK_SECRET ?? null;
+2
View File
@@ -0,0 +1,2 @@
export * from './globals';
export * from './urls';
+45
View File
@@ -0,0 +1,45 @@
import { GITBOOK_ASSETS_URL, GITBOOK_URL } from './globals';
/**
* Check if the URL is a GitBook host URL.
*/
export function isGitBookHostURL(input: URL | string): boolean {
const url = typeof input === 'string' ? new URL(input) : input;
if (!GITBOOK_URL) {
return false;
}
const gitbookHost = new URL(GITBOOK_URL).host;
if (url.host === gitbookHost) {
return true;
}
// Handle the Cloudflare preview URLs that are prefixed with a random hash
// https://developers.cloudflare.com/workers/configuration/previews/
if (url.host.endsWith(`-${gitbookHost}`)) {
return true;
}
return false;
}
/**
* Check if the URL is a GitBook assets host URL.
*/
export function isGitBookAssetsHostURL(input: URL | string): boolean {
const url = typeof input === 'string' ? new URL(input) : input;
if (!GITBOOK_ASSETS_URL) {
return false;
}
const gitbookAssetsHost = new URL(GITBOOK_ASSETS_URL).host;
if (url.host === gitbookAssetsHost) {
return true;
}
return false;
}
@@ -62,28 +62,27 @@ export function createImageResizer({
url: urlInput, url: urlInput,
}); });
const url = new URL( const url = linker.toAbsoluteURL(linker.toPathInContent('/~gitbook/image'));
linker.toAbsoluteURL(linker.toPathInContent('/~gitbook/image')) const searchParams = new URLSearchParams();
); searchParams.set('url', getImageAPIUrl(urlInput));
url.searchParams.set('url', getImageAPIUrl(urlInput));
if (options.width) { if (options.width) {
url.searchParams.set('width', options.width.toString()); searchParams.set('width', options.width.toString());
} }
if (options.height) { if (options.height) {
url.searchParams.set('height', options.height.toString()); searchParams.set('height', options.height.toString());
} }
if (options.dpr) { if (options.dpr) {
url.searchParams.set('dpr', options.dpr.toString()); searchParams.set('dpr', options.dpr.toString());
} }
if (options.quality) { if (options.quality) {
url.searchParams.set('quality', options.quality.toString()); searchParams.set('quality', options.quality.toString());
} }
url.searchParams.set('sign', cachedSignature.signature); searchParams.set('sign', cachedSignature.signature);
url.searchParams.set('sv', cachedSignature.version); searchParams.set('sv', cachedSignature.version);
return url.toString(); return `${url}?${searchParams.toString()}`;
}; };
}, },
+7 -4
View File
@@ -1,5 +1,6 @@
import { getPagePath } from '@/lib/pages'; import { getPagePath } from '@/lib/pages';
import type { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api'; import type { RevisionPage, RevisionPageDocument, RevisionPageGroup } from '@gitbook/api';
import warnOnce from 'warn-once';
/** /**
* Generic interface to generate links based on a given context. * Generic interface to generate links based on a given context.
@@ -46,13 +47,11 @@ export function createLinker(
/** Where the top of the space is served on */ /** Where the top of the space is served on */
servedOn: { servedOn: {
protocol?: string; protocol?: string;
host: string; host?: string;
pathname: string; pathname: string;
} }
): GitBookSpaceLinker { ): GitBookSpaceLinker {
if (servedOn.host.includes('/')) { warnOnce(!servedOn.host, 'No host provided to createLinker. It can lead to issues with links.');
throw new Error('Host cannot include a slash');
}
const linker: GitBookSpaceLinker = { const linker: GitBookSpaceLinker = {
toPathInContent(relativePath: string): string { toPathInContent(relativePath: string): string {
@@ -60,6 +59,10 @@ export function createLinker(
}, },
toAbsoluteURL(absolutePath: string): string { toAbsoluteURL(absolutePath: string): string {
if (!servedOn.host) {
return absolutePath;
}
return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`; return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
}, },
@@ -32,11 +32,6 @@ export enum MiddlewareHeaders {
*/ */
Customization = 'x-gitbook-customization', Customization = 'x-gitbook-customization',
/**
* Token to use for the API.
*/
APIToken = 'x-gitbook-token',
/** /**
* The visitor token used to access this content * The visitor token used to access this content
*/ */
+41
View File
@@ -0,0 +1,41 @@
import crypto from 'node:crypto';
import { NextResponse } from 'next/server';
import { GITBOOK_SECRET } from './env';
/**
* Verify the signature of the request and call the function with the body.
*/
export async function withVerifySignature<T>(
request: Request,
fn: (body: T) => Promise<NextResponse>
) {
try {
const rawBody = await request.text();
const body = JSON.parse(rawBody) as T;
if (GITBOOK_SECRET) {
// Retrieve the signature header from the request
const incomingSignature = request.headers.get('x-gitbook-signature');
if (!incomingSignature) {
return NextResponse.json({ error: 'Missing signature header' }, { status: 400 });
}
const computedSignature = crypto
.createHmac('sha256', GITBOOK_SECRET)
.update(rawBody)
.digest('hex');
// Compare incoming signature to computed signature
if (incomingSignature !== computedSignature) {
return NextResponse.json({ error: 'Invalid signature' }, { status: 401 });
}
}
return await fn(body);
} catch (_error) {
return NextResponse.json(
{ error: 'Invalid request or unable to parse JSON' },
{ status: 400 }
);
}
}
+107 -44
View File
@@ -1,21 +1,29 @@
import { GitBookAPIError } from '@gitbook/api'; import { CustomizationThemeMode, GitBookAPIError } from '@gitbook/api';
import type { NextRequest } from 'next/server'; import type { NextRequest } from 'next/server';
import { NextResponse } from 'next/server'; import { NextResponse } from 'next/server';
import { getContentSecurityPolicy } from '@/lib/csp'; import { getContentSecurityPolicy } from '@/lib/csp';
import { validateSerializedCustomization } from '@/lib/customization';
import { removeLeadingSlash, removeTrailingSlash } from '@/lib/paths'; import { removeLeadingSlash, removeTrailingSlash } from '@/lib/paths';
import { getResponseCookiesForVisitorAuth, getVisitorToken } from '@/lib/visitor-token';
import { serveResizedImage } from '@/routes/image'; import { serveResizedImage } from '@/routes/image';
import { getPublishedContentByURL } from '@v2/lib/data'; import { getPublishedContentByURL } from '@v2/lib/data';
import { isGitBookAssetsHostURL, isGitBookHostURL } from '@v2/lib/env';
import { MiddlewareHeaders } from '@v2/lib/middleware'; import { MiddlewareHeaders } from '@v2/lib/middleware';
export const config = { export const config = {
matcher: ['/((?!_next/|_static/|_vercel|[\\w-]+\\.\\w+).*)'], matcher: [
'/((?!_next/static|_next/image|~gitbook/static|~gitbook/revalidate|~gitbook/monitoring|~scalar/proxy).*)',
],
}; };
type URLWithMode = { url: URL; mode: 'url' | 'url-host' }; type URLWithMode = { url: URL; mode: 'url' | 'url-host' };
export async function middleware(request: NextRequest) { export async function middleware(request: NextRequest) {
try { try {
// Route all requests to a site
const extracted = getSiteURLFromRequest(request);
if (extracted) {
/** /**
* Serve image resizing requests (all requests containing `/~gitbook/image`). * Serve image resizing requests (all requests containing `/~gitbook/image`).
* All URLs containing `/~gitbook/image` are rewritten to `/~gitbook/image` * All URLs containing `/~gitbook/image` are rewritten to `/~gitbook/image`
@@ -24,14 +32,13 @@ export async function middleware(request: NextRequest) {
* In GitBook v1: image resizing was done at the root of the hostname (docs.company.com/~gitbook/image) * In GitBook v1: image resizing was done at the root of the hostname (docs.company.com/~gitbook/image)
* In GitBook v2: image resizing is done at the content level (docs.company.com/section/variant/~gitbook/image) * In GitBook v2: image resizing is done at the content level (docs.company.com/section/variant/~gitbook/image)
*/ */
if (request.nextUrl.pathname.endsWith('/~gitbook/image')) { if (extracted.url.pathname.endsWith('/~gitbook/image')) {
return serveResizedImage(request); return await serveResizedImage(request, {
host: extracted.url.host,
});
} }
// Route all requests to a site return await serveSiteByURL(request, extracted);
const extracted = extractURL(request);
if (extracted) {
return serveSiteByURL(request, extracted);
} }
// Handle the rest with the router default logic // Handle the rest with the router default logic
@@ -45,13 +52,19 @@ export async function middleware(request: NextRequest) {
* Serve site by URL. * Serve site by URL.
*/ */
async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) { async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
const dynamicHeaders = getDynamicHeaders(request);
const { url, mode } = urlWithMode; const { url, mode } = urlWithMode;
// Visitor authentication
// @ts-ignore - request typing
const visitorToken = getVisitorToken(request, url);
const result = await getPublishedContentByURL({ const result = await getPublishedContentByURL({
url: url.toString(), url: url.toString(),
visitorAuthToken: null, visitorAuthToken: visitorToken?.token ?? null,
redirectOnError: false, // When the visitor auth token is pulled from the cookie, set redirectOnError when calling getPublishedContentByUrl to allow
// redirecting when the token is invalid as we could be dealing with stale token stored in the cookie.
// For example when the VA backend signature has changed but the token stored in the cookie is not yet expired.
redirectOnError: visitorToken?.source === 'visitor-auth-cookie',
}); });
if (result.error) { if (result.error) {
@@ -64,32 +77,48 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
return NextResponse.redirect(data.redirect); return NextResponse.redirect(data.redirect);
} }
const routeType = dynamicHeaders ? 'dynamic' : 'static'; // When visitor has authentication (adaptive content or VA), we serve dynamic routes.
let routeType = visitorToken ? 'dynamic' : 'static';
const requestHeaders = new Headers(request.headers); const requestHeaders = new Headers(request.headers);
requestHeaders.set(MiddlewareHeaders.RouteType, routeType); requestHeaders.set(MiddlewareHeaders.RouteType, routeType);
requestHeaders.set(MiddlewareHeaders.URLMode, mode); requestHeaders.set(MiddlewareHeaders.URLMode, mode);
requestHeaders.set(MiddlewareHeaders.SiteURL, `${url.origin}${data.basePath}`); requestHeaders.set(MiddlewareHeaders.SiteURL, `${url.origin}${data.basePath}`);
requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data)); requestHeaders.set(MiddlewareHeaders.SiteURLData, JSON.stringify(data));
if (dynamicHeaders) {
for (const [key, value] of Object.entries(dynamicHeaders)) { // Preview of customization/theme
requestHeaders.set(key, value); const customization = url.searchParams.get('customization');
if (customization && validateSerializedCustomization(customization)) {
routeType = 'dynamic';
requestHeaders.set(MiddlewareHeaders.Customization, customization);
} }
const theme = url.searchParams.get('theme');
if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
routeType = 'dynamic';
requestHeaders.set(MiddlewareHeaders.Theme, theme);
}
// We support forcing dynamic routes by setting a `gitbook-dynamic-route` cookie
// This is useful for testing dynamic routes.
if (request.cookies.has('gitbook-dynamic-route')) {
routeType = 'dynamic';
} }
// Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied // Pass a x-forwarded-host and origin that are equal to ensure Next doesn't block server actions when proxied
requestHeaders.set('x-forwarded-host', request.nextUrl.host); requestHeaders.set('x-forwarded-host', request.nextUrl.host);
requestHeaders.set('origin', request.nextUrl.origin); requestHeaders.set('origin', request.nextUrl.origin);
const siteURL = `${url.host}${data.basePath}`;
const route = [ const route = [
'sites', 'sites',
routeType, routeType,
mode, mode,
encodeURIComponent(url.host + data.basePath), encodeURIComponent(siteURL),
encodePathInSiteContent(data.pathname), encodePathInSiteContent(data.pathname),
].join('/'); ].join('/');
console.log(`rewriting to ${route}`); console.log(`rewriting ${request.nextUrl.toString()} to ${route}`);
const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString()); const rewrittenURL = new URL(`/${route}`, request.nextUrl.toString());
const response = NextResponse.rewrite(rewrittenURL, { const response = NextResponse.rewrite(rewrittenURL, {
@@ -100,6 +129,20 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
// Add Content Security Policy header // Add Content Security Policy header
response.headers.set('content-security-policy', getContentSecurityPolicy()); response.headers.set('content-security-policy', getContentSecurityPolicy());
// Basic security headers
response.headers.set('strict-transport-security', 'max-age=31536000');
response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
response.headers.set('x-content-type-options', 'nosniff');
// Debug header
response.headers.set('x-gitbook-route-type', routeType);
response.headers.set('x-gitbook-site-url', siteURL);
if (visitorToken) {
const cookies = getResponseCookiesForVisitorAuth(data.basePath, visitorToken);
for (const [key, value] of Object.entries(cookies)) {
response.cookies.set(key, value.value, value.options);
}
}
return response; return response;
} }
@@ -109,57 +152,66 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
*/ */
function serveErrorResponse(error: Error) { function serveErrorResponse(error: Error) {
if (error instanceof GitBookAPIError) { if (error instanceof GitBookAPIError) {
return NextResponse.json( return new Response(error.errorMessage, {
{ error: error.message }, status: error.code,
{ status: 500, headers: { 'content-type': 'application/json' } } headers: { 'content-type': 'text/plain' },
); });
} }
throw error; throw error;
} }
/** /**
* The URL of the GitBook content can be passed in 3 different ways: * The URL of the GitBook content can be passed in 3 different ways (in order of priority):
* - The request URL is in the `X-GitBook-URL` header. * - The request has a `X-GitBook-URL` header:
* - Hostname is in the `X-GitBook-Host` header and the pathname is the path in the request URL. * URL is taken from the header.
* - The request URL is matching `/url/:url` * - The request has a `X-Forwarded-Host` header:
* Host is taken from the header, pathname is taken from the request URL.
* - The request URL is matching `/url/:url`:
* URL is taken from the pathname.
*/ */
function extractURL(request: NextRequest): URLWithMode | null { function getSiteURLFromRequest(request: NextRequest): URLWithMode | null {
const xGitbookUrl = request.headers.get('x-gitbook-url'); const xGitbookUrl = request.headers.get('x-gitbook-url');
if (xGitbookUrl) { if (xGitbookUrl) {
return { return {
url: new URL(xGitbookUrl), url: appendQueryParams(new URL(xGitbookUrl), request.nextUrl.searchParams),
mode: 'url-host', mode: 'url-host',
}; };
} }
const xGitbookHost = request.headers.get('x-gitbook-host'); const isMainHost = isGitBookHostURL(request.url);
if (xGitbookHost) { const isAssetsHost = isGitBookAssetsHostURL(request.url);
return {
url: new URL(`https://${xGitbookHost}${request.nextUrl.pathname}`),
mode: 'url-host',
};
}
// /url/:url requests on the main host
const prefix = '/url/'; const prefix = '/url/';
if (request.nextUrl.pathname.startsWith(prefix)) { if (isMainHost && request.nextUrl.pathname.startsWith(prefix)) {
return { return {
url: new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`), url: appendQueryParams(
new URL(`https://${request.nextUrl.pathname.slice(prefix.length)}`),
request.nextUrl.searchParams
),
mode: 'url', mode: 'url',
}; };
} }
// Skip other requests to main hosts
if (isMainHost || isAssetsHost) {
return null; return null;
} }
/** const xForwardedHost = request.headers.get('x-forwarded-host');
* Evaluate if a request is dynamic or static. // The x-forwarded-host is set by Vercel for all requests
*/ // so we ignore it if the hostname is the same as the instance one.
function getDynamicHeaders(_request: NextRequest): null | Record<string, string> { if (xForwardedHost) {
// TODO: return {
// - check token in query string url: appendQueryParams(
// - check token in cookies new URL(`https://${xForwardedHost}${request.nextUrl.pathname}`),
// - check special headers or query string request.nextUrl.searchParams
),
mode: 'url-host',
};
}
return null; return null;
} }
@@ -185,3 +237,14 @@ function encodePathInSiteContent(rawPathname: string) {
return encodeURIComponent(pathname || '/'); return encodeURIComponent(pathname || '/');
} }
} }
/**
* Append all the query params from a URL to another URL.
*/
function appendQueryParams(url: URL, from: URLSearchParams) {
for (const [key, value] of from.entries()) {
url.searchParams.set(key, value);
}
return url;
}
+11
View File
@@ -0,0 +1,11 @@
{
"extends": ["//"],
"tasks": {
"generate": {
"outputs": ["public"]
},
"typecheck": {
"dependsOn": ["^typecheck"]
}
}
}
+34 -1
View File
@@ -1,5 +1,38 @@
main = ".open-next/worker.js" main = ".open-next/worker.js"
name = "gitbook-v2" name = "gitbook-open-v2"
compatibility_date = "2024-09-23" compatibility_date = "2024-09-23"
compatibility_flags = ["nodejs_compat"] compatibility_flags = ["nodejs_compat"]
assets = { directory = ".open-next/assets", binding = "ASSETS" } assets = { directory = ".open-next/assets", binding = "ASSETS" }
observability = { enabled = true }
[env.preview]
kv_namespaces = [
{ binding = "NEXT_CACHE_WORKERS_KV", id = "b7dd9cf58bf2458f84812a2d83b3760c" } # gitbook-open-v2-cache-preview
]
d1_databases = [
{ binding = "NEXT_CACHE_D1", database_id = "f59ddb40-ad72-4312-9395-0ac6a129af8e", database_name = "gitbook-open-v2-tags-preview" }
]
[env.staging]
routes = [
{ pattern = "open-2c.gitbook-staging.com/*", zone_name = "gitbook-staging.com" },
{ pattern = "static-2c.gitbook-staging.com/*", zone_name = "gitbook-staging.com" }
]
kv_namespaces = [
{ binding = "NEXT_CACHE_WORKERS_KV", id = "a446e25f12b741afb185f1e5b4474f0a" } # gitbook-open-v2-cache-staging
]
d1_databases = [
{ binding = "NEXT_CACHE_D1", database_id = "9df62e39-1f35-4066-83aa-e9b8ed3ac8d5", database_name = "gitbook-open-v2-tags-staging" }
]
[env.production]
routes = [
{ pattern = "open-2c.gitbook.com/*", zone_name = "gitbook.com" },
{ pattern = "static-2c.gitbook.com/*", zone_name = "gitbook.com" }
]
kv_namespaces = [
{ binding = "NEXT_CACHE_WORKERS_KV", id = "72379746280d4e79acf24440eea950dc" } # gitbook-open-v2-cache-production
]
d1_databases = [
{ binding = "NEXT_CACHE_D1", database_id = "a6f16fce-5f45-43a9-89a4-7b83ddf25b77", database_name = "gitbook-open-v2-tags-production" }
]
+24
View File
@@ -1,5 +1,29 @@
# gitbook # gitbook
## 0.7.1
### Patch Changes
- Updated dependencies [f574858]
- @gitbook/react-openapi@1.1.1
## 0.7.0
### Minor Changes
- bb3ca9c: Implement OpenAPI models blocks
### Patch Changes
- 5907bd9: Adjust hint block spacing
- 9ffc3b6: Fix content overflowing out of its container in tabs
- Updated dependencies [0278a14]
- Updated dependencies [bb3ca9c]
- Updated dependencies [3173d8e]
- Updated dependencies [052e07a]
- @gitbook/openapi-parser@2.1.0
- @gitbook/react-openapi@1.1.0
## 0.6.5 ## 0.6.5
### Patch Changes ### Patch Changes
+3 -2
View File
@@ -1,6 +1,6 @@
{ {
"name": "gitbook", "name": "gitbook",
"version": "0.6.5", "version": "0.7.1",
"private": true, "private": true,
"scripts": { "scripts": {
"dev": "env-cmd --silent -f ../../.env.local next dev", "dev": "env-cmd --silent -f ../../.env.local next dev",
@@ -64,7 +64,8 @@
"tailwind-shades": "^1.1.2", "tailwind-shades": "^1.1.2",
"url-join": "^5.0.0", "url-join": "^5.0.0",
"usehooks-ts": "^3.1.0", "usehooks-ts": "^3.1.0",
"ai": "^4.1.46" "ai": "^4.1.46",
"jwt-decode": "^4.0.0"
}, },
"devDependencies": { "devDependencies": {
"@argos-ci/playwright": "^3.10.0", "@argos-ci/playwright": "^3.10.0",
@@ -4,6 +4,7 @@ import { headers } from 'next/headers';
import React from 'react'; import React from 'react';
import { tcls } from '@/lib/tailwind'; import { tcls } from '@/lib/tailwind';
import { throwIfDataError } from '@v2/lib/data';
import { DateRelative } from '../primitives'; import { DateRelative } from '../primitives';
import { RefreshChangeRequestButton } from './RefreshChangeRequestButton'; import { RefreshChangeRequestButton } from './RefreshChangeRequestButton';
@@ -107,11 +108,13 @@ async function RevisionToolbar(props: { context: GitBookSiteContext }) {
const { context } = props; const { context } = props;
const { space, revisionId } = context; const { space, revisionId } = context;
const revision = await context.dataFetcher.getRevision({ const revision = await throwIfDataError(
context.dataFetcher.getRevision({
spaceId: space.id, spaceId: space.id,
revisionId, revisionId,
metadata: true, metadata: true,
}); })
);
return ( return (
<ToolbarLayout> <ToolbarLayout>
@@ -52,9 +52,7 @@ export function UnwrappedBlocks<TBlock extends DocumentBlock>(props: UnwrappedBl
let isOffscreen = false; let isOffscreen = false;
return ( return nodes.map((node) => {
<>
{nodes.map((node) => {
isOffscreen = isOffscreen =
isOffscreen || isOffscreen ||
isBlockOffscreen({ isBlockOffscreen({
@@ -78,7 +76,5 @@ export function UnwrappedBlocks<TBlock extends DocumentBlock>(props: UnwrappedBl
{...contextProps} {...contextProps}
/> />
); );
})} });
</>
);
} }
@@ -1,17 +1,19 @@
import type { DocumentBlockCode } from '@gitbook/api'; import type { DocumentBlockCode } from '@gitbook/api';
import { getNodeFragmentByType } from '@/lib/document'; import { getNodeFragmentByType } from '@/lib/document';
import { isV2 } from '@/lib/v2';
import type { BlockProps } from '../Block'; import type { BlockProps } from '../Block';
import { Blocks } from '../Blocks'; import { Blocks } from '../Blocks';
import { ClientCodeBlock } from './ClientCodeBlock'; import { ClientCodeBlock } from './ClientCodeBlock';
import { type RenderedInline, getInlines } from './highlight'; import { CodeBlockRenderer } from './CodeBlockRenderer';
import { type RenderedInline, getInlines, highlight } from './highlight';
/** /**
* Render a code block, can be client-side or server-side. * Render a code block, can be client-side or server-side.
*/ */
export function CodeBlock(props: BlockProps<DocumentBlockCode>) { export async function CodeBlock(props: BlockProps<DocumentBlockCode>) {
const { block, document, style, context } = props; const { block, document, style, isEstimatedOffscreen, context } = props;
const inlines = getInlines(block); const inlines = getInlines(block);
const richInlines: RenderedInline[] = inlines.map((inline, index) => { const richInlines: RenderedInline[] = inlines.map((inline, index) => {
const body = (() => { const body = (() => {
@@ -34,5 +36,11 @@ export function CodeBlock(props: BlockProps<DocumentBlockCode>) {
return { inline, body }; return { inline, body };
}); });
if (isV2() && !isEstimatedOffscreen) {
// In v2, we render the code block server-side
const lines = await highlight(block, richInlines);
return <CodeBlockRenderer block={block} style={style} lines={lines} />;
}
return <ClientCodeBlock block={block} style={style} inlines={richInlines} />; return <ClientCodeBlock block={block} style={style} inlines={richInlines} />;
} }
@@ -5,6 +5,7 @@ import ReactDOM from 'react-dom';
import { Card } from '@/components/primitives'; import { Card } from '@/components/primitives';
import { tcls } from '@/lib/tailwind'; import { tcls } from '@/lib/tailwind';
import { getDataOrNull } from '@v2/lib/data';
import type { BlockProps } from './Block'; import type { BlockProps } from './Block';
import { Caption } from './Caption'; import { Caption } from './Caption';
import { IntegrationBlock } from './Integration'; import { IntegrationBlock } from './Integration';
@@ -18,10 +19,16 @@ export async function Embed(props: BlockProps<gitbookAPI.DocumentBlockEmbed>) {
ReactDOM.preload('https://cdn.iframe.ly/embed.js', { as: 'script' }); ReactDOM.preload('https://cdn.iframe.ly/embed.js', { as: 'script' });
const embed = await context.contentContext.dataFetcher.getEmbedByUrl({ const embed = await getDataOrNull(
context.contentContext.dataFetcher.getEmbedByUrl({
url: block.data.url, url: block.data.url,
spaceId: context.contentContext.space?.id, spaceId: context.contentContext.space?.id,
}); })
);
if (!embed) {
return null;
}
return ( return (
<Caption {...props} withBorder> <Caption {...props} withBorder>
@@ -37,22 +37,21 @@ export function Hint(props: BlockProps<DocumentBlockHint>) {
> >
<div <div
className={tcls( className={tcls(
'py-3', 'py-4',
'pl-3', 'pl-4',
'-mt-px', // Bump icon up 1px for optical alignment with heading
hasHeading ? hintStyle.header : null, hasHeading ? hintStyle.header : null,
hintStyle.iconColor hintStyle.iconColor
)} )}
> >
<Icon <Icon
icon={hintStyle.icon} icon={hintStyle.icon}
className={tcls('size-[1.2em]', 'mt-0.5', firstLine.lineHeight)} className={tcls('size-[1.2em]', 'mt-px', firstLine.lineHeight)}
/> />
</div> </div>
{hasHeading ? ( {hasHeading ? (
<Block <Block
style={tcls( style={tcls(
'flip-heading-hash p-3 text-[1em] *:mt-0', 'flip-heading-hash p-4 pl-3 text-[1em] *:mt-0',
hasHeading ? hintStyle.header : null hasHeading ? hintStyle.header : null
)} )}
ancestorBlocks={[...ancestorBlocks, block]} ancestorBlocks={[...ancestorBlocks, block]}
@@ -70,11 +69,12 @@ export function Hint(props: BlockProps<DocumentBlockHint>) {
'flip-heading-hash' 'flip-heading-hash'
)} )}
style={[ style={[
'p-3', 'p-4',
'pl-3',
'empty:p-0', 'empty:p-0',
'-row-end-1', '-row-end-1',
'-col-end-1', '-col-end-1',
'space-y-4', 'space-y-3',
'[&_.hint]:border', '[&_.hint]:border',
'[&_pre]:border', '[&_pre]:border',
'[&_pre]:border-neutral', '[&_pre]:border-neutral',
@@ -24,9 +24,7 @@ export function Inlines<T extends DocumentInline | DocumentText>(
) { ) {
const { nodes, document, ancestorInlines, ...contextProps } = props; const { nodes, document, ancestorInlines, ...contextProps } = props;
return ( return nodes.map((node) => {
<>
{nodes.map((node) => {
if (node.object === 'text') { if (node.object === 'text') {
return <Text key={node.key} text={node} />; return <Text key={node.key} text={node} />;
} }
@@ -40,7 +38,5 @@ export function Inlines<T extends DocumentInline | DocumentText>(
{...contextProps} {...contextProps}
/> />
); );
})} });
</>
);
} }
@@ -6,7 +6,7 @@ import {
type ContentKitServerContext, type ContentKitServerContext,
} from '@gitbook/react-contentkit'; } from '@gitbook/react-contentkit';
import { ignoreAPIError, renderIntegrationUi } from '@/lib/api'; import { renderIntegrationUi } from '@/lib/api';
import { parseMarkdown } from '@/lib/markdown'; import { parseMarkdown } from '@/lib/markdown';
import { tcls } from '@/lib/tailwind'; import { tcls } from '@/lib/tailwind';
import { GITBOOK_INTEGRATIONS_HOST } from '@v2/lib/env'; import { GITBOOK_INTEGRATIONS_HOST } from '@v2/lib/env';
@@ -14,6 +14,7 @@ import { GITBOOK_INTEGRATIONS_HOST } from '@v2/lib/env';
import type { BlockProps } from '../Block'; import type { BlockProps } from '../Block';
import { PlainCodeBlock } from '../CodeBlock'; import { PlainCodeBlock } from '../CodeBlock';
import './contentkit.css'; import './contentkit.css';
import { ignoreAllThrownError } from '@v2/lib/data';
const outputContext: ContentKitServerContext = { const outputContext: ContentKitServerContext = {
icons: { icons: {
@@ -63,9 +64,8 @@ export async function IntegrationBlock(props: BlockProps<DocumentBlockIntegratio
context: contentKitContext, context: contentKitContext,
}; };
const initialOutput = await ignoreAPIError( const initialOutput = await ignoreAllThrownError(
renderIntegrationUi(block.data.integration, initialInput), renderIntegrationUi(block.data.integration, initialInput)
true
); );
if (!initialOutput || initialOutput.type === 'complete') { if (!initialOutput || initialOutput.type === 'complete') {
return null; return null;
@@ -21,7 +21,7 @@ export function List(
tag={getListTag(block.type)} tag={getListTag(block.type)}
nodes={block.nodes} nodes={block.nodes}
ancestorBlocks={[...ancestorBlocks, block]} ancestorBlocks={[...ancestorBlocks, block]}
style={['space-y-2', style]} style={['min-w-0 space-y-2', style]}
/> />
); );
} }
@@ -41,7 +41,7 @@ export function ListItem(props: BlockProps<DocumentBlockListItem>) {
// Override the "mx-auto" class from UnwrappedBlocks // Override the "mx-auto" class from UnwrappedBlocks
'mx-0' 'mx-0'
)} )}
style="flex flex-1 flex-col space-y-2" style="flex min-w-0 flex-1 flex-col space-y-2"
/> />
); );
@@ -2,7 +2,7 @@ import type { JSONDocument } from '@gitbook/api';
import { Icon } from '@gitbook/icons'; import { Icon } from '@gitbook/icons';
import { OpenAPIOperation } from '@gitbook/react-openapi'; import { OpenAPIOperation } from '@gitbook/react-openapi';
import { type AnyOpenAPIOperationBlock, resolveOpenAPIBlock } from '@/lib/openapi/fetch'; import { resolveOpenAPIOperationBlock } from '@/lib/openapi/resolveOpenAPIOperationBlock';
import { tcls } from '@/lib/tailwind'; import { tcls } from '@/lib/tailwind';
import type { BlockProps } from '../Block'; import type { BlockProps } from '../Block';
@@ -12,11 +12,12 @@ import { Heading } from '../Heading';
import './scalar.css'; import './scalar.css';
import './style.css'; import './style.css';
import type { AnyOpenAPIBlock } from '@/lib/openapi/types';
/** /**
* Render an openapi block or an openapi-operation block. * Render an openapi block or an openapi-operation block.
*/ */
export async function OpenAPI(props: BlockProps<AnyOpenAPIOperationBlock>) { export async function OpenAPI(props: BlockProps<AnyOpenAPIBlock>) {
const { style } = props; const { style } = props;
return ( return (
<div className={tcls('flex w-full', style, 'max-w-full')}> <div className={tcls('flex w-full', style, 'max-w-full')}>
@@ -25,14 +26,14 @@ export async function OpenAPI(props: BlockProps<AnyOpenAPIOperationBlock>) {
); );
} }
async function OpenAPIBody(props: BlockProps<AnyOpenAPIOperationBlock>) { async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
const { block, context } = props; const { block, context } = props;
if (!context.contentContext) { if (!context.contentContext) {
return null; return null;
} }
const { data, specUrl, error } = await resolveOpenAPIBlock({ const { data, specUrl, error } = await resolveOpenAPIOperationBlock({
block, block,
context: context.contentContext, context: context.contentContext,
}); });
@@ -3,6 +3,10 @@
@apply flex-1 flex flex-col gap-4 mb-14; @apply flex-1 flex flex-col gap-4 mb-14;
} }
.openapi-models {
@apply flex flex-col mb-14 flex-1;
}
.openapi-columns { .openapi-columns {
@apply grid grid-cols-1 lg:grid-cols-2 gap-6 print-mode:grid-cols-1 justify-stretch; @apply grid grid-cols-1 lg:grid-cols-2 gap-6 print-mode:grid-cols-1 justify-stretch;
} }
@@ -134,7 +138,7 @@
@apply flex flex-col; @apply flex flex-col;
} }
.openapi-schema-body { .openapi-schema {
@apply py-2.5 flex flex-col gap-2; @apply py-2.5 flex flex-col gap-2;
} }
@@ -142,18 +146,15 @@
@apply divide-y divide-tint-subtle; @apply divide-y divide-tint-subtle;
} }
.openapi-disclosure-group-panel .openapi-disclosure-group-panel > .openapi-schema-properties > *:first-child > .openapi-schema {
> .openapi-schema-properties
> *:first-child
> .openapi-schema-body {
@apply pt-0; @apply pt-0;
} }
.openapi-responsebody > .openapi-schema-properties > *:last-child > .openapi-schema-body { .openapi-responsebody > .openapi-schema-properties > .openapi-schema:last-child {
@apply pb-0; @apply pb-0;
} }
.openapi-responsebody > .openapi-schema-properties > *:only-child > .openapi-schema-body { .openapi-responsebody > .openapi-schema-properties > .openapi-schema:only-child {
@apply py-0; @apply py-0;
} }
@@ -602,7 +603,7 @@
@apply border-b border-x border-tint-subtle rounded-b-lg; @apply border-b border-x border-tint-subtle rounded-b-lg;
} }
.openapi-disclosure-panel .openapi-schema-body { .openapi-disclosure-panel .openapi-schema {
@apply p-2.5; @apply p-2.5;
} }
@@ -615,6 +616,14 @@
@apply pt-0 mt-0; @apply pt-0 mt-0;
} }
.openapi-section-body.openapi-schema.openapi-schema-root-body { .openapi-section-body.openapi-schema.openapi-schema-root {
@apply space-y-2.5; @apply space-y-2.5;
} }
.openapi-section-models {
@apply border border-tint-subtle rounded-lg;
}
.openapi-section-models > .openapi-section-body > .openapi-schema-properties > .openapi-schema {
@apply p-2.5;
}
@@ -2,6 +2,7 @@ import type { DocumentBlockReusableContent } from '@gitbook/api';
import { resolveContentRef } from '@/lib/references'; import { resolveContentRef } from '@/lib/references';
import { getDataOrNull } from '@v2/lib/data';
import type { BlockProps } from './Block'; import type { BlockProps } from './Block';
import { UnwrappedBlocks } from './Blocks'; import { UnwrappedBlocks } from './Blocks';
@@ -17,10 +18,12 @@ export async function ReusableContent(props: BlockProps<DocumentBlockReusableCon
return null; return null;
} }
const document = await context.contentContext.dataFetcher.getDocument({ const document = await getDataOrNull(
context.contentContext.dataFetcher.getDocument({
spaceId: context.contentContext.space.id, spaceId: context.contentContext.space.id,
documentId: resolved.reusableContent.document, documentId: resolved.reusableContent.document,
}); })
);
if (!document) { if (!document) {
return null; return null;
@@ -63,6 +63,7 @@ const InsightsContext = React.createContext<TrackEventCallback>(() => {});
interface InsightsProviderProps extends InsightsEventContext { interface InsightsProviderProps extends InsightsEventContext {
enabled: boolean; enabled: boolean;
appURL: string;
apiHost: string; apiHost: string;
visitorAuthToken: string | null; visitorAuthToken: string | null;
children: React.ReactNode; children: React.ReactNode;
@@ -72,7 +73,7 @@ interface InsightsProviderProps extends InsightsEventContext {
* Wrap the content of the app with the InsightsProvider to track events. * Wrap the content of the app with the InsightsProvider to track events.
*/ */
export function InsightsProvider(props: InsightsProviderProps) { export function InsightsProvider(props: InsightsProviderProps) {
const { enabled, apiHost, visitorAuthToken, children, ...context } = props; const { enabled, appURL, apiHost, visitorAuthToken, children, ...context } = props;
const visitorIdRef = React.useRef<string | null>(null); const visitorIdRef = React.useRef<string | null>(null);
const eventsRef = React.useRef<{ const eventsRef = React.useRef<{
@@ -140,7 +141,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
}); });
const flushBatchedEvents = useDebounceCallback(async () => { const flushBatchedEvents = useDebounceCallback(async () => {
const visitorId = visitorIdRef.current ?? (await getVisitorId()); const visitorId = visitorIdRef.current ?? (await getVisitorId(appURL));
visitorIdRef.current = visitorId; visitorIdRef.current = visitorId;
flushEventsSync(); flushEventsSync();
@@ -184,7 +185,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
* Get the visitor ID and store it in a ref. * Get the visitor ID and store it in a ref.
*/ */
React.useEffect(() => { React.useEffect(() => {
getVisitorId().then((visitorId) => { getVisitorId(appURL).then((visitorId) => {
visitorIdRef.current = visitorId; visitorIdRef.current = visitorId;
// When the page is unloaded, flush all events, but only if the visitor ID is set // When the page is unloaded, flush all events, but only if the visitor ID is set
window.addEventListener('beforeunload', flushEventsSync); window.addEventListener('beforeunload', flushEventsSync);
@@ -192,7 +193,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
return () => { return () => {
window.removeEventListener('beforeunload', flushEventsSync); window.removeEventListener('beforeunload', flushEventsSync);
}; };
}, [flushEventsSync]); }, [flushEventsSync, appURL]);
return ( return (
<InsightsContext.Provider value={trackEvent}> <InsightsContext.Provider value={trackEvent}>
@@ -13,10 +13,10 @@ let pendingVisitorId: Promise<string> | null = null;
/** /**
* Return the current visitor identifier. * Return the current visitor identifier.
*/ */
export async function getVisitorId(): Promise<string> { export async function getVisitorId(appURL: string): Promise<string> {
if (!visitorId) { if (!visitorId) {
if (!pendingVisitorId) { if (!pendingVisitorId) {
pendingVisitorId = fetchVisitorID().finally(() => { pendingVisitorId = fetchVisitorID(appURL).finally(() => {
pendingVisitorId = null; pendingVisitorId = null;
}); });
} }
@@ -30,7 +30,7 @@ export async function getVisitorId(): Promise<string> {
/** /**
* Propose a visitor identifier to the GitBook.com server and get the devideId back. * Propose a visitor identifier to the GitBook.com server and get the devideId back.
*/ */
async function fetchVisitorID(): Promise<string> { async function fetchVisitorID(appURL: string): Promise<string> {
const withoutCookies = isCookiesTrackingDisabled(); const withoutCookies = isCookiesTrackingDisabled();
if (withoutCookies) { if (withoutCookies) {
@@ -46,7 +46,7 @@ async function fetchVisitorID(): Promise<string> {
// No tracking deviceId set, we'll need to consolidate with the server. // No tracking deviceId set, we'll need to consolidate with the server.
const proposed = generateRandomId(); const proposed = generateRandomId();
const url = new URL(process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? 'https://app.gitbook.com'); const url = new URL(appURL);
url.pathname = '/__session'; url.pathname = '/__session';
url.searchParams.set('proposed', proposed); url.searchParams.set('proposed', proposed);
@@ -31,6 +31,7 @@ import { ClientContexts } from './ClientContexts';
import '@gitbook/icons/style.css'; import '@gitbook/icons/style.css';
import './globals.css'; import './globals.css';
import { GITBOOK_ICONS_TOKEN, GITBOOK_ICONS_URL } from '@v2/lib/env';
/** /**
* Layout shared between the content and the PDF renderer. * Layout shared between the content and the PDF renderer.
@@ -127,8 +128,8 @@ export async function CustomizationRootLayout(props: {
)} )}
> >
<IconsProvider <IconsProvider
assetsURL={process.env.GITBOOK_ICONS_URL ?? getAssetURL('icons')} assetsURL={GITBOOK_ICONS_URL}
assetsURLToken={process.env.GITBOOK_ICONS_TOKEN} assetsURLToken={GITBOOK_ICONS_TOKEN}
assetsByStyles={{ assetsByStyles={{
'custom-icons': { 'custom-icons': {
assetsURL: getAssetURL('icons'), assetsURL: getAssetURL('icons'),
@@ -20,6 +20,7 @@ import { filterOutNullable } from '@/lib/typescript';
import { getV1BaseContext } from '@/lib/v1'; import { getV1BaseContext } from '@/lib/v1';
import { isV2 } from '@/lib/v2'; import { isV2 } from '@/lib/v2';
import { throwIfDataError } from '@v2/lib/data';
import { getSiteURLDataFromMiddleware } from '@v2/lib/middleware'; import { getSiteURLDataFromMiddleware } from '@v2/lib/middleware';
import { DocumentView } from '../DocumentView'; import { DocumentView } from '../DocumentView';
@@ -133,11 +134,13 @@ export async function streamAskQuestion({
if (!spacePromises.has(source.space)) { if (!spacePromises.has(source.space)) {
spacePromises.set( spacePromises.set(
source.space, source.space,
throwIfDataError(
context.dataFetcher.getRevisionPages({ context.dataFetcher.getRevisionPages({
spaceId: source.space, spaceId: source.space,
revisionId: source.revision, revisionId: source.revision,
metadata: false, metadata: false,
}) })
)
); );
} }
@@ -229,17 +232,21 @@ async function searchSiteContent(
} }
const [searchResults, { structure }] = await Promise.all([ const [searchResults, { structure }] = await Promise.all([
throwIfDataError(
dataFetcher.searchSiteContent({ dataFetcher.searchSiteContent({
organizationId: siteURLData.organization, organizationId: siteURLData.organization,
siteId: siteURLData.site, siteId: siteURLData.site,
query, query,
scope, scope,
}), })
),
throwIfDataError(
dataFetcher.getPublishedContentSite({ dataFetcher.getPublishedContentSite({
organizationId: siteURLData.organization, organizationId: siteURLData.organization,
siteId: siteURLData.site, siteId: siteURLData.site,
siteShareKey: siteURLData.shareKey, siteShareKey: siteURLData.shareKey,
}), })
),
]); ]);
return ( return (
@@ -2,6 +2,7 @@ import type { GitBookSiteContext } from '@v2/lib/context';
import { redirect } from 'next/navigation'; import { redirect } from 'next/navigation';
import { resolvePageId, resolvePagePath } from '@/lib/pages'; import { resolvePageId, resolvePagePath } from '@/lib/pages';
import { getDataOrNull } from '@v2/lib/data';
export interface PagePathParams { export interface PagePathParams {
pathname?: string | string[]; pathname?: string | string[];
@@ -54,22 +55,26 @@ async function resolvePage(context: GitBookSiteContext, params: PagePathParams |
// If page can't be found, we try with the API, in case we have a redirect at space level. // If page can't be found, we try with the API, in case we have a redirect at space level.
// We use the raw pathname to handle special/malformed redirects setup by users in the GitSync. // We use the raw pathname to handle special/malformed redirects setup by users in the GitSync.
// The page rendering will take care of redirecting to a normalized pathname. // The page rendering will take care of redirecting to a normalized pathname.
const resolved = await context.dataFetcher.getRevisionPageByPath({ const resolved = await getDataOrNull(
context.dataFetcher.getRevisionPageByPath({
spaceId: space.id, spaceId: space.id,
revisionId, revisionId,
path: rawPathname, path: rawPathname,
}); })
);
if (resolved) { if (resolved) {
return resolvePageId(pages, resolved.id); return resolvePageId(pages, resolved.id);
} }
// If a page still can't be found, we try with the API, in case we have a redirect at site level. // If a page still can't be found, we try with the API, in case we have a redirect at site level.
const resolvedSiteRedirect = await context.dataFetcher.getSiteRedirectBySource({ const resolvedSiteRedirect = await getDataOrNull(
context.dataFetcher.getSiteRedirectBySource({
organizationId, organizationId,
siteId: site.id, siteId: site.id,
source: rawPathname.startsWith('/') ? rawPathname : `/${rawPathname}`, source: rawPathname.startsWith('/') ? rawPathname : `/${rawPathname}`,
siteShareKey: shareKey, siteShareKey: shareKey,
}); })
);
if (resolvedSiteRedirect) { if (resolvedSiteRedirect) {
return redirect(resolvedSiteRedirect.target); return redirect(resolvedSiteRedirect.target);
} }
@@ -11,6 +11,7 @@ import { getSpaceLanguage } from '@/intl/server';
import { t } from '@/intl/translate'; import { t } from '@/intl/translate';
import { tcls } from '@/lib/tailwind'; import { tcls } from '@/lib/tailwind';
import { GITBOOK_APP_URL } from '@v2/lib/env';
import { SpacesDropdown } from '../Header/SpacesDropdown'; import { SpacesDropdown } from '../Header/SpacesDropdown';
import { InsightsProvider } from '../Insights'; import { InsightsProvider } from '../Insights';
import { SiteSectionList, encodeClientSiteSections } from '../SiteSections'; import { SiteSectionList, encodeClientSiteSections } from '../SiteSections';
@@ -47,6 +48,7 @@ export function SpaceLayout(props: {
return ( return (
<InsightsProvider <InsightsProvider
enabled={withTracking} enabled={withTracking}
appURL={GITBOOK_APP_URL}
apiHost={context.dataFetcher.apiEndpoint} apiHost={context.dataFetcher.apiEndpoint}
visitorAuthToken={visitorAuthToken} visitorAuthToken={visitorAuthToken}
organizationId={context.organizationId} organizationId={context.organizationId}
-61
View File
@@ -14,7 +14,6 @@ import {
type RevisionFile, type RevisionFile,
type RevisionReusableContent, type RevisionReusableContent,
} from '@gitbook/api'; } from '@gitbook/api';
import type { GitBookDataFetcher } from '@v2/lib/data/types';
import { headers } from 'next/headers'; import { headers } from 'next/headers';
import { batch } from './async'; import { batch } from './async';
@@ -865,50 +864,6 @@ export const getPublishedContentSite = cache({
}, },
}); });
/**
* Fetch all the content data about a space at once.
* This function executes the requests in parallel and should be used as early as possible
* instead of calling the individual functions.
*
* @deprecated - use 'fetchSpaceContextByIds' from v2
*/
export async function getSpaceContentData(
dataFetcher: GitBookDataFetcher,
pointer: SpaceContentPointer,
shareKey: string | undefined
) {
const [space, changeRequest] = await Promise.all([
dataFetcher.getSpace({
spaceId: pointer.spaceId,
shareKey,
}),
pointer.changeRequestId
? dataFetcher.getChangeRequest({
spaceId: pointer.spaceId,
changeRequestId: pointer.changeRequestId,
})
: null,
]);
const contentTarget: ContentTarget = {
spaceId: pointer.spaceId,
revisionId: changeRequest?.revision ?? pointer.revisionId ?? space.revision,
};
const pages = await dataFetcher.getRevisionPages({
spaceId: pointer.spaceId,
revisionId: contentTarget.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,
});
return {
space,
pages,
contentTarget,
};
}
/** /**
* Search content in a Site or specific SiteSpaces. * Search content in a Site or specific SiteSpaces.
*/ */
@@ -1009,22 +964,6 @@ export function userAgent(): string {
return result; return result;
} }
/**
* Ignore error for an API call.
*/
export async function ignoreAPIError<T>(promise: Promise<T>, ignoreAll = false): Promise<T | null> {
try {
return await promise;
} catch (error) {
const code = (error as GitBookAPIError).code;
if (ignoreAll || (code >= 400 && code < 500)) {
return null;
}
throw error;
}
}
/** /**
* Iterate over a paginated API endpoint and return all the items. * Iterate over a paginated API endpoint and return all the items.
*/ */
+1 -1
View File
@@ -4,5 +4,5 @@ import { GITBOOK_ASSETS_URL } from '@v2/lib/env';
* Create a public URL for an asset. * Create a public URL for an asset.
*/ */
export function getAssetURL(path: string): string { export function getAssetURL(path: string): string {
return `${GITBOOK_ASSETS_URL}/~gitbook/static/${path}`; return `${GITBOOK_ASSETS_URL || ''}/~gitbook/static/${path}`;
} }
+11 -3
View File
@@ -129,7 +129,7 @@ export function cache<Args extends any[], Result>(
async (key: string, signal: AbortSignal | undefined, span: TraceSpan, ...args: Args) => { async (key: string, signal: AbortSignal | undefined, span: TraceSpan, ...args: Args) => {
const timeStart = now(); const timeStart = now();
let readCacheDuration = 0; let readCacheDuration = 0;
let _fetchDuration = 0; let fetchDuration = 0;
let result: readonly [CacheEntry, string] | null = null; let result: readonly [CacheEntry, string] | null = null;
const tag = cacheDef.tag?.(...args); const tag = cacheDef.tag?.(...args);
@@ -179,7 +179,7 @@ export function cache<Args extends any[], Result>(
const upstream = await revalidate(key, fallbackOps.signal, ...args); const upstream = await revalidate(key, fallbackOps.signal, ...args);
readCacheDuration = timeFetch - timeStart; readCacheDuration = timeFetch - timeStart;
_fetchDuration = now() - timeFetch; fetchDuration = now() - timeFetch;
return [upstream, 'fetch'] as const; return [upstream, 'fetch'] as const;
}, },
@@ -219,10 +219,18 @@ export function cache<Args extends any[], Result>(
); );
} }
const _totalDuration = now() - timeStart; const totalDuration = now() - timeStart;
// Log // Log
if (process.env.SILENT !== 'true') { if (process.env.SILENT !== 'true') {
// biome-ignore lint/suspicious/noConsole: we want to log here
console.log(
`cache: ${key} ${cacheStatus}${
cacheStatus === 'hit' ? ` on ${backendName}` : ''
} in total ${totalDuration.toFixed(0)}ms, fetch in ${fetchDuration.toFixed(
0
)}ms, read in ${readCacheDuration.toFixed(0)}ms`
);
} }
if (savedEntry.meta.revalidatesAt && savedEntry.meta.revalidatesAt < Date.now()) { if (savedEntry.meta.revalidatesAt && savedEntry.meta.revalidatesAt < Date.now()) {
@@ -2,7 +2,7 @@ import type { JSONDocument } from '@gitbook/api';
import type { GitBookAnyContext } from '@v2/lib/context'; import type { GitBookAnyContext } from '@v2/lib/context';
import { getNodeText } from './document'; import { getNodeText } from './document';
import { resolveOpenAPIBlock } from './openapi/fetch'; import { resolveOpenAPIOperationBlock } from './openapi/resolveOpenAPIOperationBlock';
export interface DocumentSection { export interface DocumentSection {
id: string; id: string;
@@ -38,7 +38,7 @@ export async function getDocumentSections(
} }
if ((block.type === 'swagger' || block.type === 'openapi-operation') && block.meta?.id) { if ((block.type === 'swagger' || block.type === 'openapi-operation') && block.meta?.id) {
const { data: operation } = await resolveOpenAPIBlock({ const { data: operation } = await resolveOpenAPIOperationBlock({
block, block,
context, context,
}); });
+2 -1
View File
@@ -8,6 +8,7 @@ import {
} from '@gitbook/api'; } from '@gitbook/api';
import { headers } from 'next/headers'; import { headers } from 'next/headers';
import { GITBOOK_APP_URL } from '@v2/lib/env';
import { getPagePath } from './pages'; import { getPagePath } from './pages';
import { assertIsNotV2 } from './v2'; import { assertIsNotV2 } from './v2';
@@ -100,7 +101,7 @@ export async function getAbsoluteHref(href: string, withHost = false): Promise<s
* Create an absolute href in the GitBook application. * Create an absolute href in the GitBook application.
*/ */
export function getGitbookAppHref(pathname: string): string { export function getGitbookAppHref(pathname: string): string {
const appUrl = new URL(process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? 'https://app.gitbook.com'); const appUrl = new URL(GITBOOK_APP_URL);
appUrl.pathname = pathname; appUrl.pathname = pathname;
return appUrl.toString(); return appUrl.toString();
+11 -53
View File
@@ -1,61 +1,28 @@
import type { DocumentBlockOpenAPI, DocumentBlockOpenAPIOperation } from '@gitbook/api'; import { parseOpenAPI } from '@gitbook/openapi-parser';
import { OpenAPIParseError, parseOpenAPI } from '@gitbook/openapi-parser';
import { type OpenAPIOperationData, resolveOpenAPIOperation } from '@gitbook/react-openapi';
import type { GitBookAnyContext } from '@v2/lib/context';
import { type CacheFunctionOptions, cache, noCacheFetchOptions } from '@/lib/cache'; import { type CacheFunctionOptions, cache, noCacheFetchOptions } from '@/lib/cache';
import type { ResolveOpenAPIBlockArgs } from '@/lib/openapi/types';
import { assert } from 'ts-essentials'; import { assert } from 'ts-essentials';
import { resolveContentRef } from '../references'; import { resolveContentRef } from '../references';
import { isV2 } from '../v2'; import { isV2 } from '../v2';
import { enrichFilesystem } from './enrich'; import { enrichFilesystem } from './enrich';
import type { FetchOpenAPIFilesystemResult } from './types';
export type AnyOpenAPIOperationBlock = DocumentBlockOpenAPI | DocumentBlockOpenAPIOperation;
const weakmap = new WeakMap<AnyOpenAPIOperationBlock, Promise<ResolveOpenAPIBlockResult>>();
/** /**
* Cache the result of resolving an OpenAPI block. * Fetch OpenAPI block.
* It is important because the resolve is called in sections and in the block itself.
*/ */
export function resolveOpenAPIBlock( export async function fetchOpenAPIFilesystem(
args: ResolveOpenAPIBlockArgs args: ResolveOpenAPIBlockArgs
): Promise<ResolveOpenAPIBlockResult> { ): Promise<FetchOpenAPIFilesystemResult> {
if (weakmap.has(args.block)) {
return weakmap.get(args.block)!;
}
const result = baseResolveOpenAPIBlock(args);
weakmap.set(args.block, result);
return result;
}
type ResolveOpenAPIBlockArgs = {
block: AnyOpenAPIOperationBlock;
context: GitBookAnyContext;
};
export type ResolveOpenAPIBlockResult =
| { error?: undefined; data: OpenAPIOperationData | null; specUrl: string | null }
| { error: OpenAPIParseError; data?: undefined; specUrl?: undefined };
/**
* Resolve OpenAPI block.
*/
async function baseResolveOpenAPIBlock(
args: ResolveOpenAPIBlockArgs
): Promise<ResolveOpenAPIBlockResult> {
const { context, block } = args; const { context, block } = args;
if (!block.data.path || !block.data.method) {
return { data: null, specUrl: null };
}
const ref = block.data.ref; const ref = block.data.ref;
const resolved = ref ? await resolveContentRef(ref, context) : null; const resolved = ref ? await resolveContentRef(ref, context) : null;
if (!resolved) { if (!resolved) {
return { data: null, specUrl: null }; return { filesystem: null, specUrl: null };
} }
try {
const filesystem = await (() => { const filesystem = await (() => {
if (ref.kind === 'openapi') { if (ref.kind === 'openapi') {
assert(resolved.openAPIFilesystem); assert(resolved.openAPIFilesystem);
@@ -64,19 +31,10 @@ async function baseResolveOpenAPIBlock(
return fetchFilesystem(resolved.href); return fetchFilesystem(resolved.href);
})(); })();
const data = await resolveOpenAPIOperation(filesystem, { return {
path: block.data.path, filesystem,
method: block.data.method, specUrl: resolved.href,
}); };
return { data, specUrl: resolved.href };
} catch (error) {
if (error instanceof OpenAPIParseError) {
return { error };
}
throw error;
}
} }
function fetchFilesystem(url: string) { function fetchFilesystem(url: string) {
@@ -0,0 +1,55 @@
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
import type { ResolveOpenAPIBlockResult } from '@/lib/openapi/types';
import { OpenAPIParseError } from '@gitbook/openapi-parser';
import { type OpenAPIModelsData, resolveOpenAPIModels } from '@gitbook/react-openapi';
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs } from './types';
type ResolveOpenAPIModelsBlockResult = ResolveOpenAPIBlockResult<OpenAPIModelsData>;
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPIModelsBlockResult>>();
/**
* Cache the result of resolving an OpenAPI block.
* It is important because the resolve is called in sections and in the block itself.
*/
export function resolveOpenAPIModelsBlock(
args: ResolveOpenAPIBlockArgs
): Promise<ResolveOpenAPIModelsBlockResult> {
if (weakmap.has(args.block)) {
return weakmap.get(args.block)!;
}
const result = baseResolveOpenAPIModelsBlock(args);
weakmap.set(args.block, result);
return result;
}
/**
* Resolve OpenAPI models block.
*/
async function baseResolveOpenAPIModelsBlock(
args: ResolveOpenAPIBlockArgs
): Promise<ResolveOpenAPIModelsBlockResult> {
const { context, block } = args;
if (!block.data.path || !block.data.method) {
return { data: null, specUrl: null };
}
try {
const { filesystem, specUrl } = await fetchOpenAPIFilesystem({ block, context });
if (!filesystem || !specUrl) {
return { data: null, specUrl: null };
}
const data = await resolveOpenAPIModels(filesystem);
return { data, specUrl };
} catch (error) {
if (error instanceof OpenAPIParseError) {
return { error };
}
throw error;
}
}
@@ -0,0 +1,57 @@
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
import { OpenAPIParseError } from '@gitbook/openapi-parser';
import { type OpenAPIOperationData, resolveOpenAPIOperation } from '@gitbook/react-openapi';
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs, ResolveOpenAPIBlockResult } from './types';
type ResolveOpenAPIOperationBlockResult = ResolveOpenAPIBlockResult<OpenAPIOperationData>;
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPIOperationBlockResult>>();
/**
* Cache the result of resolving an OpenAPI block.
* It is important because the resolve is called in sections and in the block itself.
*/
export function resolveOpenAPIOperationBlock(
args: ResolveOpenAPIBlockArgs
): Promise<ResolveOpenAPIOperationBlockResult> {
if (weakmap.has(args.block)) {
return weakmap.get(args.block)!;
}
const result = baseResolveOpenAPIOperationBlock(args);
weakmap.set(args.block, result);
return result;
}
/**
* Resolve OpenAPI operation block.
*/
async function baseResolveOpenAPIOperationBlock(
args: ResolveOpenAPIBlockArgs
): Promise<ResolveOpenAPIOperationBlockResult> {
const { context, block } = args;
if (!block.data.path || !block.data.method) {
return { data: null, specUrl: null };
}
try {
const { filesystem, specUrl } = await fetchOpenAPIFilesystem({ block, context });
if (!filesystem) {
return { data: null, specUrl: null };
}
const data = await resolveOpenAPIOperation(filesystem, {
path: block.data.path,
method: block.data.method,
});
return { data, specUrl };
} catch (error) {
if (error instanceof OpenAPIParseError) {
return { error };
}
throw error;
}
}
+50
View File
@@ -0,0 +1,50 @@
import type { DocumentBlockOpenAPI, DocumentBlockOpenAPIOperation } from '@gitbook/api';
import type { Filesystem, OpenAPIParseError, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
import type { GitBookAnyContext } from '@v2/lib/context';
//!!TODO: Add DocumentBlockOpenAPIModels when available in @gitbook/api
export type AnyOpenAPIBlock = DocumentBlockOpenAPI | DocumentBlockOpenAPIOperation;
/**
* Arguments for resolving OpenAPI block.
*/
export type ResolveOpenAPIBlockArgs = {
block: AnyOpenAPIBlock;
context: GitBookAnyContext;
};
/**
* Fetch OpenAPI filesystem result.
*/
export type FetchOpenAPIFilesystemResult =
| {
error?: undefined;
filesystem: Filesystem<OpenAPIV3xDocument> | null;
specUrl: string | null;
}
| FetchOpenAPIFilesystemError;
/**
* Fetch OpenAPI filesystem error.
*/
type FetchOpenAPIFilesystemError = {
error: OpenAPIParseError;
filesystem?: undefined;
specUrl?: undefined;
};
/**
* Resolved OpenAPI block result.
*/
export type ResolveOpenAPIBlockResult<T> =
| { error?: undefined; data: T | null; specUrl: string | null }
| ResolveOpenAPIBlockError;
/**
* Resolved OpenAPI block error.
*/
type ResolveOpenAPIBlockError = {
error: OpenAPIParseError;
data?: undefined;
specUrl?: undefined;
};
+21 -14
View File
@@ -7,14 +7,13 @@ import type {
} from '@gitbook/api'; } from '@gitbook/api';
import type { Filesystem } from '@gitbook/openapi-parser'; import type { Filesystem } from '@gitbook/openapi-parser';
import { type GitBookAnyContext, fetchSpaceContextByIds } from '@v2/lib/context'; import { type GitBookAnyContext, fetchSpaceContextByIds } from '@v2/lib/context';
import { getPageDocument } from '@v2/lib/data'; import { getDataOrNull, getPageDocument, ignoreDataThrownError } from '@v2/lib/data';
import { createLinker } from '@v2/lib/links'; import { createLinker } from '@v2/lib/links';
import assertNever from 'assert-never'; import assertNever from 'assert-never';
import type React from 'react'; import type React from 'react';
import { PageIcon } from '@/components/PageIcon'; import { PageIcon } from '@/components/PageIcon';
import { ignoreAPIError } from './api';
import { getBlockById, getBlockTitle } from './document'; import { getBlockById, getBlockTitle } from './document';
import { getGitbookAppHref } from './links'; import { getGitbookAppHref } from './links';
import { resolvePageId } from './pages'; import { resolvePageId } from './pages';
@@ -84,11 +83,13 @@ export async function resolveContentRef(
} }
case 'file': { case 'file': {
const file = await dataFetcher.getRevisionFile({ const file = await getDataOrNull(
dataFetcher.getRevisionFile({
spaceId: space.id, spaceId: space.id,
revisionId, revisionId,
fileId: contentRef.file, fileId: contentRef.file,
}); })
);
if (file) { if (file) {
return { return {
href: file.downloadURL, href: file.downloadURL,
@@ -189,7 +190,7 @@ export async function resolveContentRef(
} }
case 'user': { case 'user': {
const user = await dataFetcher.getUserById(contentRef.user); const user = await getDataOrNull(dataFetcher.getUserById(contentRef.user));
if (user) { if (user) {
return { return {
href: `mailto:${user.email}`, href: `mailto:${user.email}`,
@@ -209,11 +210,13 @@ export async function resolveContentRef(
} }
case 'reusable-content': { case 'reusable-content': {
const reusableContent = await dataFetcher.getReusableContent({ const reusableContent = await getDataOrNull(
dataFetcher.getReusableContent({
spaceId: space.id, spaceId: space.id,
revisionId, revisionId,
reusableContentId: contentRef.reusableContent, reusableContentId: contentRef.reusableContent,
}); })
);
if (!reusableContent) { if (!reusableContent) {
return null; return null;
} }
@@ -226,10 +229,12 @@ export async function resolveContentRef(
} }
case 'openapi': { case 'openapi': {
const openAPISpecVersionContent = await dataFetcher.getLatestOpenAPISpecVersionContent({ const openAPISpecVersionContent = await getDataOrNull(
dataFetcher.getLatestOpenAPISpecVersionContent({
organizationId: context.organizationId, organizationId: context.organizationId,
slug: contentRef.spec, slug: contentRef.spec,
}); })
);
if (!openAPISpecVersionContent) { if (!openAPISpecVersionContent) {
return null; return null;
@@ -258,19 +263,21 @@ async function getBestTargetSpace(
const { dataFetcher } = context; const { dataFetcher } = context;
const [fetchedSpace, publishedContentSite] = await Promise.all([ const [fetchedSpace, publishedContentSite] = await Promise.all([
ignoreAPIError( getDataOrNull(
dataFetcher.getSpace({ dataFetcher.getSpace({
spaceId, spaceId,
shareKey: context?.shareKey, shareKey: context?.shareKey,
}) }),
[404, 403]
), ),
'site' in context 'site' in context
? ignoreAPIError( ? getDataOrNull(
dataFetcher.getPublishedContentSite({ dataFetcher.getPublishedContentSite({
organizationId: context.organizationId, organizationId: context.organizationId,
siteId: context.site.id, siteId: context.site.id,
siteShareKey: context.shareKey, siteShareKey: context.shareKey,
}) }),
[404, 403]
) )
: null, : null,
]); ]);
@@ -294,7 +301,7 @@ async function resolveContentRefInSpace(
contentRef: ContentRef contentRef: ContentRef
) { ) {
const [spaceContext, bestTargetSpace] = await Promise.all([ const [spaceContext, bestTargetSpace] = await Promise.all([
ignoreAPIError( ignoreDataThrownError(
fetchSpaceContextByIds(context, { fetchSpaceContextByIds(context, {
space: spaceId, space: spaceId,
shareKey: context?.shareKey, shareKey: context?.shareKey,
+4 -2
View File
@@ -36,7 +36,7 @@ export async function trace<T>(
}, },
}; };
const _start = now(); const start = now();
try { try {
return await fn(span); return await fn(span);
} catch (error) { } catch (error) {
@@ -44,7 +44,9 @@ export async function trace<T>(
throw error; throw error;
} finally { } finally {
if (process.env.SILENT !== 'true') { if (process.env.SILENT !== 'true') {
const _end = now(); const end = now();
// biome-ignore lint/suspicious/noConsole: we want to log performance data
console.log(`trace ${completeName} ${end - start}ms`, attributes);
} }
} }
} }
+109 -10
View File
@@ -8,6 +8,7 @@ import type { GitBookDataFetcher } from '@v2/lib/data/types';
import { createImageResizer } from '@v2/lib/images'; import { createImageResizer } from '@v2/lib/images';
import { createLinker } from '@v2/lib/links'; import { createLinker } from '@v2/lib/links';
import { DataFetcherError, wrapDataFetcherError } from '@v2/lib/data';
import { import {
type SiteContentPointer, type SiteContentPointer,
type SpaceContentPointer, type SpaceContentPointer,
@@ -89,78 +90,176 @@ async function getDataFetcherV1(): Promise<GitBookDataFetcher> {
}, },
getUserById(userId) { getUserById(userId) {
return getUserById(userId); return wrapDataFetcherError(async () => {
const user = await getUserById(userId);
if (!user) {
throw new DataFetcherError('User not found', 404);
}
return user;
});
}, },
// @ts-ignore - types are compatible enough, and this will not be called in v1 this way // @ts-ignore - types are compatible enough, and this will not be called in v1 this way
getPublishedContentByUrl(params) { getPublishedContentByUrl(params) {
return wrapDataFetcherError(async () => {
return getPublishedContentByUrl( return getPublishedContentByUrl(
params.url, params.url,
params.visitorAuthToken ?? undefined, params.visitorAuthToken ?? undefined,
params.redirectOnError ? true : undefined params.redirectOnError ? true : undefined
); );
});
}, },
getPublishedContentSite(params) { getPublishedContentSite(params) {
return wrapDataFetcherError(async () => {
return getPublishedContentSite(params); return getPublishedContentSite(params);
});
}, },
getSpace(params) { getSpace(params) {
return wrapDataFetcherError(async () => {
return getSpace(params.spaceId, params.shareKey); return getSpace(params.spaceId, params.shareKey);
});
}, },
getChangeRequest(params) { getChangeRequest(params) {
return getChangeRequest(params.spaceId, params.changeRequestId); return wrapDataFetcherError(async () => {
const changeRequest = await getChangeRequest(
params.spaceId,
params.changeRequestId
);
if (!changeRequest) {
throw new DataFetcherError('Change request not found', 404);
}
return changeRequest;
});
}, },
getRevision(params) { getRevision(params) {
return wrapDataFetcherError(async () => {
return getRevision(params.spaceId, params.revisionId, { return getRevision(params.spaceId, params.revisionId, {
metadata: params.metadata, metadata: params.metadata,
}); });
});
}, },
getRevisionFile(params) { getRevisionFile(params) {
return getRevisionFile(params.spaceId, params.revisionId, params.fileId); return wrapDataFetcherError(async () => {
const revisionFile = await getRevisionFile(
params.spaceId,
params.revisionId,
params.fileId
);
if (!revisionFile) {
throw new DataFetcherError('Revision file not found', 404);
}
return revisionFile;
});
}, },
getDocument(params) { getDocument(params) {
return getDocument(params.spaceId, params.documentId); return wrapDataFetcherError(async () => {
const document = await getDocument(params.spaceId, params.documentId);
if (!document) {
throw new DataFetcherError('Document not found', 404);
}
return document;
});
}, },
getComputedDocument(params) { getComputedDocument(params) {
return wrapDataFetcherError(() => {
return getComputedDocument(params.organizationId, params.spaceId, params.source); return getComputedDocument(params.organizationId, params.spaceId, params.source);
});
}, },
getRevisionPages(params) { getRevisionPages(params) {
return wrapDataFetcherError(async () => {
return getRevisionPages(params.spaceId, params.revisionId, { return getRevisionPages(params.spaceId, params.revisionId, {
metadata: params.metadata, metadata: params.metadata,
}); });
});
}, },
getRevisionPageByPath(params) { getRevisionPageByPath(params) {
return getRevisionPageByPath(params.spaceId, params.revisionId, params.path); return wrapDataFetcherError(async () => {
const revisionPage = await getRevisionPageByPath(
params.spaceId,
params.revisionId,
params.path
);
if (!revisionPage) {
throw new DataFetcherError('Revision page not found', 404);
}
return revisionPage;
});
}, },
getReusableContent(params) { getReusableContent(params) {
return getReusableContent(params.spaceId, params.revisionId, params.reusableContentId); return wrapDataFetcherError(async () => {
const reusableContent = await getReusableContent(
params.spaceId,
params.revisionId,
params.reusableContentId
);
if (!reusableContent) {
throw new DataFetcherError('Reusable content not found', 404);
}
return reusableContent;
});
}, },
getLatestOpenAPISpecVersionContent(params) { getLatestOpenAPISpecVersionContent(params) {
return getLatestOpenAPISpecVersionContent(params.organizationId, params.slug); return wrapDataFetcherError(async () => {
const openAPISpecVersionContent = await getLatestOpenAPISpecVersionContent(
params.organizationId,
params.slug
);
if (!openAPISpecVersionContent) {
throw new DataFetcherError('OpenAPI spec version content not found', 404);
}
return openAPISpecVersionContent;
});
}, },
getSiteRedirectBySource(params) { getSiteRedirectBySource(params) {
return getSiteRedirectBySource(params); return wrapDataFetcherError(async () => {
}, const siteRedirect = await getSiteRedirectBySource(params);
if (!siteRedirect) {
throw new DataFetcherError('Site redirect not found', 404);
}
return siteRedirect;
});
},
getEmbedByUrl(params) { getEmbedByUrl(params) {
return wrapDataFetcherError(() => {
return getEmbedByUrlInSpace(params.spaceId, params.url); return getEmbedByUrlInSpace(params.spaceId, params.url);
});
}, },
async searchSiteContent(params) { async searchSiteContent(params) {
return wrapDataFetcherError(async () => {
const { organizationId, siteId, query, cacheBust, scope } = params; const { organizationId, siteId, query, cacheBust, scope } = params;
const result = await searchSiteContent(organizationId, siteId, query, scope, cacheBust); const result = await searchSiteContent(
organizationId,
siteId,
query,
scope,
cacheBust
);
return result.items; return result.items;
});
}, },
}; };
+76
View File
@@ -1,3 +1,4 @@
import { type JwtPayload, jwtDecode } from 'jwt-decode';
import type { NextRequest } from 'next/server'; import type { NextRequest } from 'next/server';
import hash from 'object-hash'; import hash from 'object-hash';
@@ -5,6 +6,18 @@ const VISITOR_AUTH_PARAM = 'jwt_token';
const VISITOR_AUTH_COOKIE_ROOT = 'gitbook-visitor-token~'; const VISITOR_AUTH_COOKIE_ROOT = 'gitbook-visitor-token~';
export const VISITOR_TOKEN_COOKIE = 'gitbook-visitor-token'; export const VISITOR_TOKEN_COOKIE = 'gitbook-visitor-token';
export type ResponseCookie = {
value: string;
options?: Partial<{
httpOnly: boolean;
sameSite: boolean | 'lax' | 'strict' | 'none' | undefined;
secure: boolean;
maxAge: number;
}>;
};
export type ResponseCookies = Record<string, ResponseCookie>;
/** /**
* The contents of the visitor authentication cookie. * The contents of the visitor authentication cookie.
*/ */
@@ -62,6 +75,51 @@ export function getVisitorToken(
} }
} }
/**
* Return the lookup result for content served with visitor auth. It basically disables caching
* and sets a cookie with the visitor auth token.
*/
export function getResponseCookiesForVisitorAuth(
basePath: string,
visitorTokenLookup: VisitorTokenLookup
): ResponseCookies {
if (!visitorTokenLookup) {
return {};
}
let decoded: JwtPayload;
try {
decoded = jwtDecode(visitorTokenLookup.token);
} catch (error) {
console.error('Error decoding visitor token', error);
return {};
}
return {
/**
* If the visitor token has been retrieve from the URL, or if its a VA cookie and the basePath is the same, set it
* as a cookie on the response.
*
* Note that we do not re-store the gitbook-visitor-cookie in another cookie, to maintain a single source of truth.
*/
...(visitorTokenLookup?.source === 'url' ||
(visitorTokenLookup?.source === 'visitor-auth-cookie' &&
visitorTokenLookup.basePath === basePath)
? {
[getVisitorAuthCookieName(basePath)]: {
value: getVisitorAuthCookieValue(basePath, visitorTokenLookup.token),
options: {
httpOnly: true,
sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
secure: process.env.NODE_ENV === 'production',
maxAge: getVisitorAuthCookieMaxAge(decoded),
},
},
}
: {}),
};
}
/** /**
* Get the name of the visitor authentication cookie for a given base path. * Get the name of the visitor authentication cookie for a given base path.
* *
@@ -167,3 +225,21 @@ function findVisitorAuthCookieForBasePath(
undefined undefined
); );
} }
/**
* Get the max age to store a visitor auth token in a cookie.
* We want to store the token for as long as it's valid, but at least 1 minute.
* If an invalid token is passed to the API, the API will return a redirect to the auth flow.
*/
function getVisitorAuthCookieMaxAge(decoded: JwtPayload): number {
const defaultMaxAge = 7 * 24 * 60 * 60; // 7 days
const minMaxAge = 60; // 1 min
const exp = decoded.exp;
if (typeof exp === 'number') {
const now = new Date().getTime();
return Math.max(exp - now, minMaxAge);
}
return defaultMaxAge;
}
+9 -39
View File
@@ -23,9 +23,9 @@ import { getContentSecurityPolicy } from '@/lib/csp';
import { validateSerializedCustomization } from '@/lib/customization'; import { validateSerializedCustomization } from '@/lib/customization';
import { setMiddlewareHeader } from '@/lib/middleware'; import { setMiddlewareHeader } from '@/lib/middleware';
import { import {
type ResponseCookies,
type VisitorTokenLookup, type VisitorTokenLookup,
getVisitorAuthCookieName, getResponseCookiesForVisitorAuth,
getVisitorAuthCookieValue,
getVisitorToken, getVisitorToken,
normalizeVisitorAuthURL, normalizeVisitorAuthURL,
} from '@/lib/visitor-token'; } from '@/lib/visitor-token';
@@ -69,19 +69,11 @@ type URLLookupMode =
*/ */
| 'multi-id'; | 'multi-id';
export type LookupCookies = Record<
string,
{
value: string;
options?: Partial<ResponseCookie>;
}
>;
export type LookupResult = PublishedContentWithCache & { export type LookupResult = PublishedContentWithCache & {
/** API endpoint to use for the content post lookup */ /** API endpoint to use for the content post lookup */
apiEndpoint?: string; apiEndpoint?: string;
/** Cookies to store on the response */ /** Cookies to store on the response */
cookies?: LookupCookies; cookies?: ResponseCookies;
/** Visitor authentication token */ /** Visitor authentication token */
visitorToken?: string; visitorToken?: string;
/** URL of the site */ /** URL of the site */
@@ -229,12 +221,12 @@ export async function middleware(request: NextRequest) {
const customization = url.searchParams.get('customization'); const customization = url.searchParams.get('customization');
if (customization && validateSerializedCustomization(customization)) { if (customization && validateSerializedCustomization(customization)) {
headers.set('x-gitbook-customization', customization); headers.set(MiddlewareHeaders.Customization, customization);
} }
const theme = url.searchParams.get('theme'); const theme = url.searchParams.get('theme');
if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) { if (theme === CustomizationThemeMode.Dark || theme === CustomizationThemeMode.Light) {
headers.set('x-gitbook-theme', theme); headers.set(MiddlewareHeaders.Theme, theme);
} }
if (apiEndpoint) { if (apiEndpoint) {
@@ -277,8 +269,8 @@ export async function middleware(request: NextRequest) {
// When the request is authenticated, we don't want to cache the response on the server. // When the request is authenticated, we don't want to cache the response on the server.
// Allow storing so that revalidation still happens with server. // Allow storing so that revalidation still happens with server.
if (!resolved.visitorToken) { if (resolved.visitorToken) {
return 'no-cache'; return 'no-cache, no-store';
} }
if (typeof resolved.cacheMaxAge === 'number') { if (typeof resolved.cacheMaxAge === 'number') {
@@ -551,7 +543,7 @@ async function lookupSiteOrSpaceInMultiIdMode(
); );
} }
const cookies: LookupCookies = { const cookies: ResponseCookies = {
[cookieName]: { [cookieName]: {
value: encodeGitBookTokenCookie(source.id, apiToken, apiEndpoint), value: encodeGitBookTokenCookie(source.id, apiToken, apiEndpoint),
options: { options: {
@@ -798,29 +790,7 @@ function getLookupResultForVisitorAuth(
// No caching for content served with visitor auth // No caching for content served with visitor auth
cacheMaxAge: undefined, cacheMaxAge: undefined,
cacheTags: [], cacheTags: [],
cookies: { cookies: getResponseCookiesForVisitorAuth(basePath, visitorTokenLookup),
/**
* If the visitor token has been retrieve from the URL, or if its a VA cookie and the basePath is the same, set it
* as a cookie on the response.
*
* Note that we do not re-store the gitbook-visitor-cookie in another cookie, to maintain a single source of truth.
*/
...(visitorTokenLookup?.source === 'url' ||
(visitorTokenLookup?.source === 'visitor-auth-cookie' &&
visitorTokenLookup.basePath === basePath)
? {
[getVisitorAuthCookieName(basePath)]: {
value: getVisitorAuthCookieValue(basePath, visitorTokenLookup.token),
options: {
httpOnly: true,
sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
secure: process.env.NODE_ENV === 'production',
maxAge: 7 * 24 * 60 * 60,
},
},
}
: {}),
},
}; };
} }
+11 -2
View File
@@ -13,7 +13,15 @@ import { NextResponse } from 'next/server';
/** /**
* Resize an image using the Cloudflare Image API. * Resize an image using the Cloudflare Image API.
*/ */
export async function serveResizedImage(request: Request) { export async function serveResizedImage(
request: Request,
requestOptions: {
/**
* The host to use for the image.
*/
host?: string;
} = {}
) {
const requestURL = new URL(request.url); const requestURL = new URL(request.url);
const urlParam = requestURL.searchParams.get('url'); const urlParam = requestURL.searchParams.get('url');
const signature = requestURL.searchParams.get('sign'); const signature = requestURL.searchParams.get('sign');
@@ -38,7 +46,8 @@ export async function serveResizedImage(request: Request) {
// Verify the signature // Verify the signature
const host = const host =
request.headers.get('x-gitbook-host') ?? requestOptions.host ??
request.headers.get('x-gitbook-host') ?? // Only for v1, to be removed
request.headers.get('x-forwarded-host') ?? request.headers.get('x-forwarded-host') ??
request.headers.get('host') ?? request.headers.get('host') ??
requestURL.host; requestURL.host;
+5 -2
View File
@@ -8,6 +8,7 @@ import { joinPath } from '@/lib/paths';
import { getIndexablePages } from '@/lib/sitemap'; import { getIndexablePages } from '@/lib/sitemap';
import { getSiteStructureSections } from '@/lib/sites'; import { getSiteStructureSections } from '@/lib/sites';
import { type GitBookSiteContext, checkIsRootSiteContext } from '@v2/lib/context'; import { type GitBookSiteContext, checkIsRootSiteContext } from '@v2/lib/context';
import { throwIfDataError } from '@v2/lib/data';
/** /**
* Generate a llms.txt file for the site. * Generate a llms.txt file for the site.
@@ -106,11 +107,13 @@ async function getNodesFromSiteSpaces(
if (!siteSpaceUrl) { if (!siteSpaceUrl) {
return []; return [];
} }
const rootPages = await dataFetcher.getRevisionPages({ const rootPages = await throwIfDataError(
dataFetcher.getRevisionPages({
spaceId: siteSpace.space.id, spaceId: siteSpace.space.id,
revisionId: siteSpace.space.revision, revisionId: siteSpace.space.revision,
metadata: false, metadata: false,
}); })
);
const pages = getIndexablePages(rootPages); const pages = getIndexablePages(rootPages);
const listChildren = await Promise.all( const listChildren = await Promise.all(
pages.map(async ({ page }): Promise<ListItem> => { pages.map(async ({ page }): Promise<ListItem> => {
+11
View File
@@ -0,0 +1,11 @@
{
"extends": ["//"],
"tasks": {
"generate": {
"outputs": ["public/~gitbook/static/icons/**/*", "public/~gitbook/static/math/**/*"]
},
"typecheck": {
"dependsOn": ["^typecheck"]
}
}
}
+8
View File
@@ -0,0 +1,8 @@
{
"extends": ["//"],
"tasks": {
"generate": {
"outputs": ["data/*.json"]
}
}
}
+11
View File
@@ -1,5 +1,16 @@
# @gitbook/openapi-parser # @gitbook/openapi-parser
## 2.1.0
### Minor Changes
- bb3ca9c: Implement OpenAPI models blocks
### Patch Changes
- 0278a14: Upgrade Scalar dependencies
- 052e07a: Support references pointing to invalid files
## 2.0.2 ## 2.0.2
### Patch Changes ### Patch Changes
+3 -3
View File
@@ -9,11 +9,11 @@
"default": "./dist/index.js" "default": "./dist/index.js"
} }
}, },
"version": "2.0.2", "version": "2.1.0",
"sideEffects": false, "sideEffects": false,
"dependencies": { "dependencies": {
"@scalar/openapi-parser": "^0.10.4", "@scalar/openapi-parser": "^0.10.9",
"@scalar/openapi-types": "^0.1.6" "@scalar/openapi-types": "^0.1.9"
}, },
"devDependencies": { "devDependencies": {
"@tsconfig/strictest": "^2.0.5", "@tsconfig/strictest": "^2.0.5",
@@ -17,10 +17,13 @@ describe('#createFileSystem', () => {
'/root/spec.yaml': await serveFixture('/remote-ref/root/spec.yaml'), '/root/spec.yaml': await serveFixture('/remote-ref/root/spec.yaml'),
'/root/user.yaml': await serveFixture('/remote-ref/root/user.yaml'), '/root/user.yaml': await serveFixture('/remote-ref/root/user.yaml'),
'/root/pet.yaml': await serveFixture('/remote-ref/root/pet.yaml'), '/root/pet.yaml': await serveFixture('/remote-ref/root/pet.yaml'),
'/root/invalid.yaml': await serveFixture('/remote-ref/root/invalid.txt'),
'/tag.yaml': await serveFixture('/remote-ref/tag.yaml'), '/tag.yaml': await serveFixture('/remote-ref/tag.yaml'),
}, },
fetch() { fetch() {
return new Response('404!'); return new Response('<404>', {
status: 404,
});
}, },
port: 3020, port: 3020,
}); });
@@ -0,0 +1 @@
{ "invalid" <> }
@@ -676,19 +676,6 @@ components:
xml: xml:
name: address name: address
type: object type: object
Category:
x-swagger-router-model: io.swagger.petstore.model.Category
properties:
id:
type: integer
format: int64
example: 1
name:
type: string
example: Dogs
xml:
name: category
type: object
User: User:
$ref: 'user.yaml#/components/schemas/User' $ref: 'user.yaml#/components/schemas/User'
Tag: Tag:
@@ -696,17 +683,9 @@ components:
Pet: Pet:
$ref: 'http://localhost:3020/root/pet.yaml#/components/schemas/Pet' $ref: 'http://localhost:3020/root/pet.yaml#/components/schemas/Pet'
ApiResponse: ApiResponse:
properties: $ref: 'http://localhost:3020/root/not-found.yaml'
code: Category:
type: integer $ref: 'http://localhost:3020/root/invalid.txt'
format: int32
type:
type: string
message:
type: string
xml:
name: '##default'
type: object
requestBodies: requestBodies:
Pet: Pet:
content: content:
@@ -1,4 +1,4 @@
import type { LoadPlugin } from '@scalar/openapi-parser'; import { type LoadPlugin, normalize } from '@scalar/openapi-parser';
export const fetchUrlsDefaultConfiguration = { export const fetchUrlsDefaultConfiguration = {
limit: 40, limit: 40,
@@ -52,7 +52,13 @@ export const fetchURLs: (customConfiguration: {
numberOfRequests++; numberOfRequests++;
const url = getReferenceUrl({ value, rootURL: configuration.rootURL }); const url = getReferenceUrl({ value, rootURL: configuration.rootURL });
const response = await fetch(url); const response = await fetch(url);
return await response.text(); if (!response.ok) {
return undefined;
}
const text = await response.text();
// Try to normalize the text to be sure it's a valid JSON or YAML.
await normalize(text);
return text;
} catch (_error: any) { } catch (_error: any) {
return undefined; return undefined;
} }
+11 -3
View File
@@ -29,12 +29,20 @@ export async function traverse<T extends AnyObject | AnyObject[]>(
} }
const keys = Object.keys(specification); const keys = Object.keys(specification);
await Promise.all( const results = await Promise.all(
keys.map(async (key) => { keys.map(async (key, index) => {
const value = specification[key]; const value = specification[key];
result[key] = await traverse(value, transform, [...path, key], seen); const processed = await traverse(value, transform, [...path, key], seen);
return { key, value: processed, index };
}) })
); );
// Promise.all does not guarantee the order of the results
// So we need to sort them to preserve the original order
results.sort((a, b) => a.index - b.index);
for (const { key, value } of results) {
result[key] = value;
}
return transform(result, path) as Promise<T>; return transform(result, path) as Promise<T>;
} }
+21
View File
@@ -1,5 +1,26 @@
# @gitbook/react-openapi # @gitbook/react-openapi
## 1.1.1
### Patch Changes
- f574858: Fix OpenAPI example display error
## 1.1.0
### Minor Changes
- bb3ca9c: Implement OpenAPI models blocks
### Patch Changes
- 0278a14: Upgrade Scalar dependencies
- 3173d8e: Remove top level circular refs in alternatives
- Updated dependencies [0278a14]
- Updated dependencies [bb3ca9c]
- Updated dependencies [052e07a]
- @gitbook/openapi-parser@2.1.0
## 1.0.5 ## 1.0.5
### Patch Changes ### Patch Changes
+3 -3
View File
@@ -8,12 +8,12 @@
"default": "./dist/index.js" "default": "./dist/index.js"
} }
}, },
"version": "1.0.5", "version": "1.1.1",
"sideEffects": false, "sideEffects": false,
"dependencies": { "dependencies": {
"@gitbook/openapi-parser": "workspace:*", "@gitbook/openapi-parser": "workspace:*",
"@scalar/api-client-react": "1.0.87", "@scalar/api-client-react": "^1.1.36",
"@scalar/oas-utils": "^0.2.101", "@scalar/oas-utils": "^0.2.110",
"clsx": "^2.1.1", "clsx": "^2.1.1",
"flatted": "^3.2.9", "flatted": "^3.2.9",
"json-xml-parse": "^1.3.0", "json-xml-parse": "^1.3.0",
@@ -1,52 +1,44 @@
'use client'; 'use client';
import type React from 'react'; import { useState } from 'react';
import { useRef } from 'react'; import { Button, Disclosure, DisclosurePanel, Heading } from 'react-aria-components';
import { mergeProps, useButton, useDisclosure, useFocusRing } from 'react-aria';
import { useDisclosureState } from 'react-stately';
import type { OpenAPIClientContext } from './types'; import type { OpenAPIClientContext } from './types';
interface Props {
context: OpenAPIClientContext;
children: React.ReactNode;
label?: string;
}
/** /**
* Display an interactive OpenAPI disclosure. * Display an interactive OpenAPI disclosure.
* The label is optional and defaults to "child attributes".
*/ */
export function OpenAPIDisclosure({ context, children, label }: Props): React.JSX.Element { export function OpenAPIDisclosure(props: {
const state = useDisclosureState({}); context: OpenAPIClientContext;
const panelRef = useRef<HTMLDivElement | null>(null); children: React.ReactNode;
const triggerRef = useRef<HTMLButtonElement | null>(null); label: string;
const { buttonProps: triggerProps, panelProps } = useDisclosure({}, state, panelRef); }): React.JSX.Element {
const { buttonProps } = useButton(triggerProps, triggerRef); const { context, children, label } = props;
const { isFocusVisible, focusProps } = useFocusRing(); const [isExpanded, setIsExpanded] = useState(false);
return ( return (
<div className="openapi-disclosure"> <Disclosure
<button className="openapi-disclosure"
ref={triggerRef} isExpanded={isExpanded}
{...mergeProps(buttonProps, focusProps)} onExpandedChange={setIsExpanded}
>
<Heading>
<Button
slot="trigger" slot="trigger"
className="openapi-disclosure-trigger" className="openapi-disclosure-trigger"
style={{ style={({ isFocusVisible }) => ({
outline: isFocusVisible outline: isFocusVisible
? '2px solid rgb(var(--primary-color-500) / 0.4)' ? '2px solid rgb(var(--primary-color-500) / 0.4)'
: 'none', : 'none',
}} })}
> >
{context.icons.plus} {context.icons.plus}
<span> <span>
{`${state.isExpanded ? 'Hide' : 'Show'} ${label ? label : 'child attributes'}`} {isExpanded ? 'Hide' : 'Show'} {label}
</span> </span>
</button> </Button>
</Heading>
{state.isExpanded && ( <DisclosurePanel className="openapi-disclosure-panel">
<div ref={panelRef} {...panelProps} className="openapi-disclosure-panel"> {isExpanded ? children : null}
{children} </DisclosurePanel>
</div> </Disclosure>
)}
</div>
); );
} }
@@ -19,7 +19,7 @@ type TDisclosureGroup = {
label: string | React.ReactNode; label: string | React.ReactNode;
tabs?: { tabs?: {
id: string; id: string;
label: string | React.ReactNode; label?: string | React.ReactNode;
body?: React.ReactNode; body?: React.ReactNode;
}[]; }[];
}; };
@@ -121,7 +121,7 @@ function DisclosureItem(props: { group: TDisclosureGroup; icon?: React.ReactNode
</option> </option>
))} ))}
</select> </select>
) : group.tabs[0] ? ( ) : group.tabs[0]?.label ? (
<span>{group.tabs[0].label}</span> <span>{group.tabs[0].label}</span>
) : null} ) : null}
</div> </div>
+7 -1
View File
@@ -1,3 +1,4 @@
import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
import type React from 'react'; import type React from 'react';
import { ScalarApiButton } from './ScalarApiButton'; import { ScalarApiButton } from './ScalarApiButton';
import type { OpenAPIContextProps, OpenAPIOperationData } from './types'; import type { OpenAPIContextProps, OpenAPIOperationData } from './types';
@@ -12,6 +13,7 @@ export function OpenAPIPath(props: {
const { data, context } = props; const { data, context } = props;
const { method, path } = data; const { method, path } = data;
const { specUrl } = context; const { specUrl } = context;
const hideTryItPanel = data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'];
return ( return (
<div className="openapi-path"> <div className="openapi-path">
@@ -19,13 +21,17 @@ export function OpenAPIPath(props: {
<div className="openapi-path-title" data-deprecated={data.operation.deprecated}> <div className="openapi-path-title" data-deprecated={data.operation.deprecated}>
<p>{formatPath(path)}</p> <p>{formatPath(path)}</p>
</div> </div>
{data['x-hideTryItPanel'] || data.operation['x-hideTryItPanel'] ? null : ( {!hideTryItPanel && validateHttpMethod(method) && (
<ScalarApiButton method={method} path={path} specUrl={specUrl} /> <ScalarApiButton method={method} path={path} specUrl={specUrl} />
)} )}
</div> </div>
); );
} }
function validateHttpMethod(method: string): method is OpenAPIV3_1.HttpMethods {
return ['get', 'post', 'put', 'delete', 'patch', 'head', 'options', 'trace'].includes(method);
}
// Format the path to highlight placeholders // Format the path to highlight placeholders
function formatPath(path: string) { function formatPath(path: string) {
// Matches placeholders like {id}, {userId}, etc. // Matches placeholders like {id}, {userId}, etc.
@@ -23,7 +23,6 @@ describe('getSchemaAlternatives', () => {
], ],
}) })
).toEqual([ ).toEqual([
[
{ {
type: 'number', type: 'number',
}, },
@@ -33,8 +32,6 @@ describe('getSchemaAlternatives', () => {
{ {
type: 'string', type: 'string',
}, },
],
undefined,
]); ]);
}); });
@@ -58,7 +55,6 @@ describe('getSchemaAlternatives', () => {
], ],
}) })
).toEqual([ ).toEqual([
[
{ {
allOf: [ allOf: [
{ {
@@ -72,8 +68,6 @@ describe('getSchemaAlternatives', () => {
{ {
type: 'string', type: 'string',
}, },
],
undefined,
]); ]);
}); });
@@ -89,13 +83,10 @@ describe('getSchemaAlternatives', () => {
a.anyOf?.push(a); a.anyOf?.push(a);
expect(getSchemaAlternatives(a)).toEqual([ expect(getSchemaAlternatives(a)).toEqual([
[
{ {
type: 'string', type: 'string',
}, },
a, a,
],
undefined,
]); ]);
}); });
}); });
+113 -202
View File
@@ -1,18 +1,16 @@
import type { OpenAPIV3 } from '@gitbook/openapi-parser'; import type { OpenAPIV3 } from '@gitbook/openapi-parser';
import clsx from 'clsx';
import { useId } from 'react'; import { useId } from 'react';
import { InteractiveSection } from './InteractiveSection'; import clsx from 'clsx';
import { Markdown } from './Markdown'; import { Markdown } from './Markdown';
import { OpenAPIDisclosure } from './OpenAPIDisclosure'; import { OpenAPIDisclosure } from './OpenAPIDisclosure';
import { OpenAPISchemaName } from './OpenAPISchemaName'; import { OpenAPISchemaName } from './OpenAPISchemaName';
import { stringifyOpenAPI } from './stringifyOpenAPI';
import type { OpenAPIClientContext } from './types'; import type { OpenAPIClientContext } from './types';
import { checkIsReference, resolveDescription } from './utils'; import { checkIsReference, resolveDescription, resolveFirstExample } from './utils';
type CircularRefsIds = Map<OpenAPIV3.SchemaObject, string>; type CircularRefsIds = Map<OpenAPIV3.SchemaObject, string>;
export interface OpenAPISchemaPropertyEntry { interface OpenAPISchemaPropertyEntry {
propertyName?: string | undefined; propertyName?: string | undefined;
required?: boolean | undefined; required?: boolean | undefined;
schema: OpenAPIV3.SchemaObject; schema: OpenAPIV3.SchemaObject;
@@ -21,49 +19,48 @@ export interface OpenAPISchemaPropertyEntry {
/** /**
* Render a property of an OpenAPI schema. * Render a property of an OpenAPI schema.
*/ */
export function OpenAPISchemaProperty( function OpenAPISchemaProperty(props: {
props: OpenAPISchemaPropertyEntry & { property: OpenAPISchemaPropertyEntry;
/** Set of objects already observed as parents */
circularRefs?: CircularRefsIds;
context: OpenAPIClientContext; context: OpenAPIClientContext;
circularRefs?: CircularRefsIds;
className?: string; className?: string;
} }) {
) {
const { const {
schema, property,
circularRefs: parentCircularRefs = new Map<OpenAPIV3.SchemaObject, string>(), circularRefs: parentCircularRefs = new Map<OpenAPIV3.SchemaObject, string>(),
context, context,
className, className,
} = props; } = props;
const { schema } = property;
const id = useId(); const id = useId();
return (
<div id={id} className={clsx('openapi-schema', className)}>
<OpenAPISchemaPresentation property={property} />
{(() => {
const parentCircularRef = parentCircularRefs.get(schema); const parentCircularRef = parentCircularRefs.get(schema);
const circularRefs = new Map(parentCircularRefs).set(schema, id);
// Avoid recursing infinitely, and instead render a link to the parent schema // Avoid recursing infinitely, and instead render a link to the parent schema
const properties = parentCircularRef ? null : getSchemaProperties(schema); if (parentCircularRef) {
const alternatives = parentCircularRef return <OpenAPISchemaCircularRef id={parentCircularRef} schema={schema} />;
? null
: getSchemaAlternatives(schema, new Set(circularRefs.keys()));
if (alternatives?.[0]?.length) {
return (
<OpenAPISchemaAlternativesItem
{...props}
circularRefs={circularRefs}
context={context}
alternatives={alternatives}
parentCircularRef={parentCircularRef}
/>
);
} }
if ((properties && properties.length > 0) || schema.type === 'object') { const circularRefs = parentCircularRefs.set(schema, id);
const properties = getSchemaProperties(schema);
const alternatives = getSchemaAlternatives(schema, new Set(circularRefs.keys()));
return ( return (
<InteractiveSection id={id} className={clsx('openapi-schema', className)}> <>
<OpenAPISchemaPresentation {...props} /> {alternatives?.map((schema, index) => (
{properties && properties.length > 0 ? ( <OpenAPISchemaAlternative
key={index}
schema={schema}
circularRefs={circularRefs}
context={context}
/>
))}
{properties?.length ? (
<OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}> <OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
<OpenAPISchemaProperties <OpenAPISchemaProperties
properties={properties} properties={properties}
@@ -72,33 +69,10 @@ export function OpenAPISchemaProperty(
/> />
</OpenAPIDisclosure> </OpenAPIDisclosure>
) : null} ) : null}
{parentCircularRef ? (
<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema} />
) : null}
</InteractiveSection>
);
}
return (
<InteractiveSection id={id} className={clsx('openapi-schema', className)}>
<OpenAPISchemaPresentation {...props} />
{(properties && properties.length > 0) ||
(schema.enum && schema.enum.length > 0) ||
parentCircularRef ? (
<>
{properties?.length ? (
<OpenAPISchemaProperties
properties={properties}
circularRefs={circularRefs}
context={context}
/>
) : null}
{parentCircularRef ? (
<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema} />
) : null}
</> </>
) : null} );
</InteractiveSection> })()}
</div>
); );
} }
@@ -113,17 +87,13 @@ export function OpenAPISchemaProperties(props: {
}) { }) {
const { id, properties, circularRefs, context } = props; const { id, properties, circularRefs, context } = props;
if (!properties.length) {
return null;
}
return ( return (
<div id={id} className="openapi-schema-properties"> <div id={id} className="openapi-schema-properties">
{properties.map((property, index) => ( {properties.map((property, index) => (
<OpenAPISchemaProperty <OpenAPISchemaProperty
key={index} key={index}
circularRefs={circularRefs} circularRefs={circularRefs}
{...property} property={property}
context={context} context={context}
/> />
))} ))}
@@ -140,15 +110,18 @@ export function OpenAPIRootSchema(props: {
}) { }) {
const { schema, context } = props; const { schema, context } = props;
// Avoid recursing infinitely, and instead render a link to the parent schema
const properties = getSchemaProperties(schema); const properties = getSchemaProperties(schema);
if (properties && properties.length > 0) { if (properties?.length) {
return <OpenAPISchemaProperties properties={properties} context={context} />; return <OpenAPISchemaProperties properties={properties} context={context} />;
} }
return ( return (
<OpenAPISchemaProperty schema={schema} context={context} className="openapi-schema-root" /> <OpenAPISchemaProperty
className="openapi-schema-root"
property={{ schema }}
context={context}
/>
); );
} }
@@ -159,32 +132,12 @@ export function OpenAPIRootSchema(props: {
*/ */
function OpenAPISchemaAlternative(props: { function OpenAPISchemaAlternative(props: {
schema: OpenAPIV3.SchemaObject; schema: OpenAPIV3.SchemaObject;
circularRefs?: CircularRefsIds; circularRefs: CircularRefsIds;
context: OpenAPIClientContext; context: OpenAPIClientContext;
}) { }) {
const { schema, circularRefs, context } = props; const { schema, circularRefs, context } = props;
const id = useId();
const subProperties = getSchemaProperties(schema);
const description = resolveDescription(schema); const description = resolveDescription(schema);
const alternatives = getSchemaAlternatives(schema, new Set(circularRefs?.keys())); const properties = getSchemaProperties(schema);
if (alternatives?.[0]?.length && !subProperties?.length) {
return (
<>
{description ? (
<Markdown source={description} className="openapi-schema-description" />
) : null}
<OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
<OpenAPISchemaAlternativesItem
schema={schema}
circularRefs={circularRefs}
context={context}
alternatives={alternatives}
/>
</OpenAPIDisclosure>
</>
);
}
return ( return (
<> <>
@@ -192,45 +145,21 @@ function OpenAPISchemaAlternative(props: {
<Markdown source={description} className="openapi-schema-description" /> <Markdown source={description} className="openapi-schema-description" />
) : null} ) : null}
<OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}> <OpenAPIDisclosure context={context} label={getDisclosureLabel(schema)}>
{properties?.length ? (
<OpenAPISchemaProperties <OpenAPISchemaProperties
id={id} properties={properties}
properties={subProperties ?? [{ schema }]}
circularRefs={
subProperties ? new Map(circularRefs).set(schema, id) : circularRefs
}
context={context}
/>
</OpenAPIDisclosure>
</>
);
}
function OpenAPISchemaAlternativesItem(
props: OpenAPISchemaPropertyEntry & {
circularRefs?: CircularRefsIds;
context: OpenAPIClientContext;
alternatives: OpenAPISchemaAlternatives;
parentCircularRef?: string;
}
) {
const id = useId();
const { schema, circularRefs, context, alternatives, parentCircularRef } = props;
return (
<InteractiveSection id={id} className={clsx('openapi-schema')}>
<OpenAPISchemaPresentation {...props} />
{alternatives[0].map((alternative, index) => (
<OpenAPISchemaAlternative
key={`alternative-${index}`}
schema={alternative}
circularRefs={circularRefs} circularRefs={circularRefs}
context={context} context={context}
/> />
))} ) : (
{parentCircularRef ? ( <OpenAPISchemaProperty
<OpenAPISchemaCircularRef id={parentCircularRef} schema={schema} /> property={{ schema }}
) : null} circularRefs={circularRefs}
</InteractiveSection> context={context}
/>
)}
</OpenAPIDisclosure>
</>
); );
} }
@@ -251,7 +180,7 @@ function OpenAPISchemaCircularRef(props: { id: string; schema: OpenAPIV3.SchemaO
/** /**
* Render the enum value for a schema. * Render the enum value for a schema.
*/ */
export function OpenAPISchemaEnum(props: { enumValues: any[] }) { function OpenAPISchemaEnum(props: { enumValues: any[] }) {
const { enumValues } = props; const { enumValues } = props;
return ( return (
@@ -269,22 +198,16 @@ export function OpenAPISchemaEnum(props: { enumValues: any[] }) {
); );
} }
export function OpenAPISchemaPresentation(props: OpenAPISchemaPropertyEntry) { /**
const { schema, propertyName, required } = props; * Render the top row of a schema. e.g: name, type, and required status.
*/
const shouldDisplayExample = (schema: OpenAPIV3.SchemaObject): boolean => { function OpenAPISchemaPresentation(props: { property: OpenAPISchemaPropertyEntry }) {
return ( const {
(typeof schema.example === 'string' && !!schema.example) || property: { schema, propertyName, required },
typeof schema.example === 'number' || } = props;
typeof schema.example === 'boolean' ||
(Array.isArray(schema.example) && schema.example.length > 0) ||
(typeof schema.example === 'object' &&
schema.example !== null &&
Object.keys(schema.example).length > 0)
);
};
const description = resolveDescription(schema); const description = resolveDescription(schema);
const example = resolveFirstExample(schema);
return ( return (
<div className="openapi-schema-presentation"> <div className="openapi-schema-presentation">
@@ -294,7 +217,7 @@ export function OpenAPISchemaPresentation(props: OpenAPISchemaPropertyEntry) {
propertyName={propertyName} propertyName={propertyName}
required={required} required={required}
/> />
{schema['x-deprecated-sunset'] ? ( {typeof schema['x-deprecated-sunset'] === 'string' ? (
<div className="openapi-deprecated-sunset openapi-schema-description openapi-markdown"> <div className="openapi-deprecated-sunset openapi-schema-description openapi-markdown">
Sunset date:{' '} Sunset date:{' '}
<span className="openapi-deprecated-sunset-date"> <span className="openapi-deprecated-sunset-date">
@@ -305,9 +228,9 @@ export function OpenAPISchemaPresentation(props: OpenAPISchemaPropertyEntry) {
{description ? ( {description ? (
<Markdown source={description} className="openapi-schema-description" /> <Markdown source={description} className="openapi-schema-description" />
) : null} ) : null}
{shouldDisplayExample(schema) ? ( {typeof example === 'string' ? (
<div className="openapi-schema-example"> <div className="openapi-schema-example">
Example: <code>{formatExample(schema.example)}</code> Example: <code>{example}</code>
</div> </div>
) : null} ) : null}
{schema.pattern ? ( {schema.pattern ? (
@@ -327,7 +250,7 @@ export function OpenAPISchemaPresentation(props: OpenAPISchemaPropertyEntry) {
*/ */
function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISchemaPropertyEntry[] { function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISchemaPropertyEntry[] {
// check array AND schema.items as this is sometimes null despite what the type indicates // check array AND schema.items as this is sometimes null despite what the type indicates
if (schema.type === 'array' && !!schema.items) { if (schema.type === 'array' && schema.items && !checkIsReference(schema.items)) {
const items = schema.items; const items = schema.items;
const itemProperties = getSchemaProperties(items); const itemProperties = getSchemaProperties(items);
if (itemProperties) { if (itemProperties) {
@@ -335,16 +258,17 @@ function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISche
} }
// If the items are a primitive type, we don't need to display them // If the items are a primitive type, we don't need to display them
if (['string', 'number', 'boolean', 'integer'].includes(items.type) && !items.enum) { if (
(items.type === 'string' ||
items.type === 'number' ||
items.type === 'boolean' ||
items.type === 'integer') &&
!items.enum
) {
return null; return null;
} }
return [ return [{ propertyName: 'items', schema: items }];
{
propertyName: 'items',
schema: items,
},
];
} }
if (schema.type === 'object' || schema.properties) { if (schema.type === 'object' || schema.properties) {
@@ -352,6 +276,10 @@ function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISche
if (schema.properties) { if (schema.properties) {
Object.entries(schema.properties).forEach(([propertyName, propertySchema]) => { Object.entries(schema.properties).forEach(([propertyName, propertySchema]) => {
if (checkIsReference(propertySchema)) {
return;
}
result.push({ result.push({
propertyName, propertyName,
required: Array.isArray(schema.required) required: Array.isArray(schema.required)
@@ -362,12 +290,10 @@ function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISche
}); });
} }
if (schema.additionalProperties) { if (schema.additionalProperties && !checkIsReference(schema.additionalProperties)) {
const additionalProperties = schema.additionalProperties;
result.push({ result.push({
propertyName: 'Other properties', propertyName: 'Other properties',
schema: additionalProperties === true ? {} : additionalProperties, schema: schema.additionalProperties === true ? {} : schema.additionalProperties,
}); });
} }
@@ -377,10 +303,7 @@ function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISche
return null; return null;
} }
type OpenAPISchemaAlternatives = [ type AlternativeType = 'oneOf' | 'allOf' | 'anyOf';
OpenAPIV3.SchemaObject[],
OpenAPIV3.DiscriminatorObject | undefined,
];
/** /**
* Get the alternatives to display for a schema. * Get the alternatives to display for a schema.
@@ -388,56 +311,57 @@ type OpenAPISchemaAlternatives = [
export function getSchemaAlternatives( export function getSchemaAlternatives(
schema: OpenAPIV3.SchemaObject, schema: OpenAPIV3.SchemaObject,
ancestors: Set<OpenAPIV3.SchemaObject> = new Set() ancestors: Set<OpenAPIV3.SchemaObject> = new Set()
): null | OpenAPISchemaAlternatives { ): OpenAPIV3.SchemaObject[] | null {
const downAncestors = new Set(ancestors).add(schema); const alternatives:
| [AlternativeType, (OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject)[]]
| null = (() => {
if (schema.anyOf) { if (schema.anyOf) {
return [flattenAlternatives('anyOf', schema.anyOf, downAncestors), schema.discriminator]; return ['anyOf', schema.anyOf];
} }
if (schema.oneOf) { if (schema.oneOf) {
return [flattenAlternatives('oneOf', schema.oneOf, downAncestors), schema.discriminator]; return ['oneOf', schema.oneOf];
} }
if (schema.allOf) { if (schema.allOf) {
return [flattenAlternatives('allOf', schema.allOf, downAncestors), schema.discriminator]; return ['allOf', schema.allOf];
} }
return null; return null;
})();
if (!alternatives) {
return null;
}
const [type, schemas] = alternatives;
return flattenAlternatives(type, schemas, new Set(ancestors).add(schema));
} }
function flattenAlternatives( function flattenAlternatives(
alternativeType: 'oneOf' | 'allOf' | 'anyOf', alternativeType: AlternativeType,
alternatives: OpenAPIV3.SchemaObject[], schemasOrRefs: (OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject)[],
ancestors: Set<OpenAPIV3.SchemaObject> ancestors: Set<OpenAPIV3.SchemaObject>
): OpenAPIV3.SchemaObject[] { ): OpenAPIV3.SchemaObject[] {
return alternatives.reduce((acc, alternative) => { return schemasOrRefs.reduce<OpenAPIV3.SchemaObject[]>((acc, schemaOrRef) => {
if (!!alternative[alternativeType] && !ancestors.has(alternative)) { if (checkIsReference(schemaOrRef)) {
acc.push(...(getSchemaAlternatives(alternative, ancestors)?.[0] || []));
} else {
acc.push(alternative);
}
return acc; return acc;
}, [] as OpenAPIV3.SchemaObject[]);
} }
export function getSchemaTitle( if (schemaOrRef[alternativeType] && !ancestors.has(schemaOrRef)) {
schema: OpenAPIV3.SchemaObject, const schemas = getSchemaAlternatives(schemaOrRef, ancestors);
if (schemas) {
/** If the title is inferred in a oneOf with discriminator, we can use it to optimize the title */ acc.push(...schemas);
discriminator?: OpenAPIV3.DiscriminatorObject
): string {
// Try using the discriminator
if (discriminator?.propertyName && schema.properties) {
const discriminatorProperty = schema.properties[discriminator.propertyName];
if (discriminatorProperty && !checkIsReference(discriminatorProperty)) {
if (discriminatorProperty.enum) {
return discriminatorProperty.enum.map((value) => value.toString()).join(' | ');
}
} }
return acc;
} }
acc.push(schemaOrRef);
return acc;
}, []);
}
function getSchemaTitle(schema: OpenAPIV3.SchemaObject): string {
// Otherwise try to infer a nice title // Otherwise try to infer a nice title
let type = 'any'; let type = 'any';
@@ -469,7 +393,7 @@ export function getSchemaTitle(
return type; return type;
} }
function getDisclosureLabel(schema: OpenAPIV3.SchemaObject): string | undefined { function getDisclosureLabel(schema: OpenAPIV3.SchemaObject): string {
if (schema.type === 'array' && !!schema.items) { if (schema.type === 'array' && !!schema.items) {
if (schema.items.oneOf) { if (schema.items.oneOf) {
return 'available items'; return 'available items';
@@ -477,24 +401,11 @@ function getDisclosureLabel(schema: OpenAPIV3.SchemaObject): string | undefined
// Fallback to "child attributes" for enums and objects // Fallback to "child attributes" for enums and objects
if (schema.items.enum || schema.items.type === 'object') { if (schema.items.enum || schema.items.type === 'object') {
return; return 'child attributes';
} }
return schema.items.title ?? schema.title ?? getSchemaTitle(schema.items); return schema.items.title ?? schema.title ?? getSchemaTitle(schema.items);
} }
return schema.title; return schema.title || 'child attributes';
}
function formatExample(example: any): string {
if (typeof example === 'string') {
return example
.replace(/\n/g, ' ') // Replace newlines with spaces
.replace(/\s+/g, ' ') // Collapse multiple spaces/newlines into a single space
.replace(/([\{\}:,])\s+/g, '$1 ') // Ensure a space after {, }, :, and ,
.replace(/\s+([\{\}:,])/g, ' $1') // Ensure a space before {, }, :, and ,
.trim();
}
return stringifyOpenAPI(example);
} }
+26 -28
View File
@@ -1,24 +1,21 @@
'use client'; 'use client';
import { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-react'; import { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-react';
import { useEffect, useImperativeHandle, useRef, useState } from 'react'; import { useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
import { createPortal } from 'react-dom'; import { createPortal } from 'react-dom';
import { useEventCallback } from 'usehooks-ts'; import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
import { useOpenAPIOperationContext } from './OpenAPIOperationContext'; import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
/** /**
* Button which launches the Scalar API Client * Button which launches the Scalar API Client
*/ */
export function ScalarApiButton({ export function ScalarApiButton(props: {
method, method: OpenAPIV3_1.HttpMethods;
path,
specUrl,
}: {
method: string;
path: string; path: string;
specUrl: string; specUrl: string;
}) { }) {
const { method, path, specUrl } = props;
const [isOpen, setIsOpen] = useState(false); const [isOpen, setIsOpen] = useState(false);
const controllerRef = useRef<ScalarModalControllerRef>(null); const controllerRef = useRef<ScalarModalControllerRef>(null);
return ( return (
@@ -55,21 +52,18 @@ export function ScalarApiButton({
} }
function ScalarModal(props: { function ScalarModal(props: {
method: string; method: OpenAPIV3_1.HttpMethods;
path: string; path: string;
specUrl: string; specUrl: string;
controllerRef: React.Ref<ScalarModalControllerRef>; controllerRef: React.Ref<ScalarModalControllerRef>;
}) { }) {
const { method, path, specUrl, controllerRef } = props;
return ( return (
<ApiClientModalProvider <ApiClientModalProvider
configuration={{ spec: { url: props.specUrl } }} configuration={{ spec: { url: specUrl } }}
initialRequest={{ path: props.path, method: props.method }} initialRequest={{ method, path }}
> >
<ScalarModalController <ScalarModalController method={method} path={path} controllerRef={controllerRef} />
method={props.method}
path={props.path}
controllerRef={props.controllerRef}
/>
</ApiClientModalProvider> </ApiClientModalProvider>
); );
} }
@@ -79,28 +73,32 @@ type ScalarModalControllerRef = {
}; };
function ScalarModalController(props: { function ScalarModalController(props: {
method: string; method: OpenAPIV3_1.HttpMethods;
path: string; path: string;
controllerRef: React.Ref<ScalarModalControllerRef>; controllerRef: React.Ref<ScalarModalControllerRef>;
}) { }) {
const { method, path, controllerRef } = props;
const client = useApiClientModal(); const client = useApiClientModal();
const openClient = client?.open; const openScalarClient = client?.open;
const { onOpenClient: trackClientOpening } = useOpenAPIOperationContext();
const openClient = useMemo(() => {
if (openScalarClient) {
return () => {
openScalarClient({ method, path, _source: 'gitbook' });
trackClientOpening({ method, path });
};
}
return null;
}, [openScalarClient, method, path, trackClientOpening]);
useImperativeHandle( useImperativeHandle(
props.controllerRef, controllerRef,
() => ({ openClient: openClient ? () => openClient() : undefined }), () => ({ openClient: openClient ? () => openClient() : undefined }),
[openClient] [openClient]
); );
// Open the client when the component is mounted. // Open at mount
const { onOpenClient } = useOpenAPIOperationContext();
const trackOpening = useEventCallback(() => {
onOpenClient({ method: props.method, path: props.path });
});
useEffect(() => { useEffect(() => {
if (openClient) { openClient?.();
openClient();
trackOpening();
}
}, [openClient]); }, [openClient]);
return null; return null;
} }
+29
View File
@@ -0,0 +1,29 @@
import { type Filesystem, type OpenAPIV3xDocument, dereference } from '@gitbook/openapi-parser';
const dereferenceCache = new WeakMap<Filesystem, Promise<OpenAPIV3xDocument>>();
/**
* Memoized version of `dereferenceSchema`.
*/
export function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
if (dereferenceCache.has(filesystem)) {
return dereferenceCache.get(filesystem) as Promise<OpenAPIV3xDocument>;
}
const promise = baseDereferenceFilesystem(filesystem);
dereferenceCache.set(filesystem, promise);
return promise;
}
/**
* Dereference an OpenAPI schema.
*/
async function baseDereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
const result = await dereference(filesystem);
if (!result.schema) {
throw new Error('Failed to dereference OpenAPI document');
}
return result.schema as OpenAPIV3xDocument;
}
+3 -2
View File
@@ -1,4 +1,5 @@
export * from './resolveOpenAPIOperation'; export * from './models';
export * from './OpenAPIOperation'; export * from './OpenAPIOperation';
export * from './OpenAPIOperationContext'; export * from './OpenAPIOperationContext';
export type { OpenAPIOperationData } from './types'; export * from './resolveOpenAPIOperation';
export type { OpenAPIModelsData, OpenAPIOperationData } from './types';
@@ -0,0 +1,89 @@
import clsx from 'clsx';
import { OpenAPIDisclosureGroup } from '../OpenAPIDisclosureGroup';
import { OpenAPIRootSchema } from '../OpenAPISchema';
import { Section, SectionBody } from '../StaticSection';
import type { OpenAPIClientContext, OpenAPIContextProps, OpenAPIModelsData } from '../types';
/**
* Display OpenAPI Models.
*/
export function OpenAPIModels(props: {
className?: string;
data: OpenAPIModelsData;
context: OpenAPIContextProps;
}) {
const { className, data, context } = props;
const { models } = data;
const clientContext: OpenAPIClientContext = {
defaultInteractiveOpened: context.defaultInteractiveOpened,
icons: context.icons,
blockKey: context.blockKey,
};
if (!models.length) {
return null;
}
return (
<div className={clsx('openapi-models', className)}>
<OpenAPIRootModelsSchema models={models} context={clientContext} />
</div>
);
}
/**
* Root schema for OpenAPI models.
* It displays a single model or a disclosure group for multiple models.
*/
function OpenAPIRootModelsSchema(props: {
models: OpenAPIModelsData['models'];
context: OpenAPIClientContext;
}) {
const { models, context } = props;
// If there is only one model, we show it directly.
if (models.length === 1) {
const schema = models?.[0]?.schema;
if (!schema) {
return null;
}
return (
<Section>
<SectionBody>
<OpenAPIRootSchema schema={schema} context={context} />
</SectionBody>
</Section>
);
}
// If there are multiple models, we use a disclosure group to show them all.
return (
<OpenAPIDisclosureGroup
allowsMultipleExpanded
icon={context.icons.chevronRight}
groups={models.map(({ name, schema }) => ({
id: name,
label: (
<div className="openapi-response-tab-content" key={`model-${name}`}>
<span className="openapi-response-statuscode">{name}</span>
</div>
),
tabs: [
{
id: 'model',
body: (
<Section className="openapi-section-models">
<SectionBody>
<OpenAPIRootSchema schema={schema} context={context} />
</SectionBody>
</Section>
),
},
],
}))}
/>
);
}
@@ -0,0 +1,2 @@
export * from './OpenAPIModels';
export * from './resolveOpenAPIModels';
@@ -0,0 +1,35 @@
import {
type Filesystem,
type OpenAPIV3,
type OpenAPIV3_1,
type OpenAPIV3xDocument,
shouldIgnoreEntity,
} from '@gitbook/openapi-parser';
import { dereferenceFilesystem } from '../dereference';
import type { OpenAPIModel, OpenAPIModelsData } from '../types';
//!!TODO: We should return only the models that are used in the block. Still a WIP awaiting future work.
/**
* Resolve an OpenAPI models from a file and compile it to a more usable format.
* Models are extracted from the OpenAPI components.schemas
*/
export async function resolveOpenAPIModels(
filesystem: Filesystem<OpenAPIV3xDocument>
): Promise<OpenAPIModelsData | null> {
const schema = await dereferenceFilesystem(filesystem);
const models = getOpenAPIComponents(schema);
return { models };
}
/**
* Get OpenAPI components.schemas that are not ignored.
*/
function getOpenAPIComponents(schema: OpenAPIV3.Document | OpenAPIV3_1.Document): OpenAPIModel[] {
const schemas = schema.components?.schemas ?? {};
return Object.entries(schemas)
.filter(([, schema]) => !shouldIgnoreEntity(schema))
.map(([key, schema]) => ({ name: key, schema }));
}
@@ -1,16 +1,16 @@
import { fromJSON, toJSON } from 'flatted'; import { fromJSON, toJSON } from 'flatted';
import { import type {
type Filesystem, Filesystem,
type OpenAPIV3, OpenAPIV3,
type OpenAPIV3_1, OpenAPIV3_1,
type OpenAPIV3xDocument, OpenAPIV3xDocument,
dereference,
} from '@gitbook/openapi-parser'; } from '@gitbook/openapi-parser';
import { dereferenceFilesystem } from './dereference';
import type { OpenAPIOperationData } from './types'; import type { OpenAPIOperationData } from './types';
import { checkIsReference } from './utils'; import { checkIsReference } from './utils';
export { toJSON, fromJSON }; export { fromJSON, toJSON };
/** /**
* Resolve an OpenAPI operation in a file and compile it to a more usable format. * Resolve an OpenAPI operation in a file and compile it to a more usable format.
@@ -23,7 +23,7 @@ export async function resolveOpenAPIOperation(
} }
): Promise<OpenAPIOperationData | null> { ): Promise<OpenAPIOperationData | null> {
const { path, method } = operationDescriptor; const { path, method } = operationDescriptor;
const schema = await memoDereferenceFilesystem(filesystem); const schema = await dereferenceFilesystem(filesystem);
let operation = getOperationByPathAndMethod(schema, path, method); let operation = getOperationByPathAndMethod(schema, path, method);
if (!operation) { if (!operation) {
@@ -69,34 +69,6 @@ export async function resolveOpenAPIOperation(
}; };
} }
const dereferenceCache = new WeakMap<Filesystem, Promise<OpenAPIV3xDocument>>();
/**
* Memoized version of `dereferenceSchema`.
*/
function memoDereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
if (dereferenceCache.has(filesystem)) {
return dereferenceCache.get(filesystem) as Promise<OpenAPIV3xDocument>;
}
const promise = dereferenceFilesystem(filesystem);
dereferenceCache.set(filesystem, promise);
return promise;
}
/**
* Dereference an OpenAPI schema.
*/
async function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
const result = await dereference(filesystem);
if (!result.schema) {
throw new Error('Failed to dereference OpenAPI document');
}
return result.schema as OpenAPIV3xDocument;
}
/** /**
* Get a path object from its path. * Get a path object from its path.
*/ */
+10
View File
@@ -55,3 +55,13 @@ export interface OpenAPIOperationData extends OpenAPICustomSpecProperties {
/** Securities that should be used for this operation */ /** Securities that should be used for this operation */
securities: [string, OpenAPIV3.SecuritySchemeObject][]; securities: [string, OpenAPIV3.SecuritySchemeObject][];
} }
export type OpenAPIModel = {
name: string;
schema: OpenAPIV3.SchemaObject;
};
export interface OpenAPIModelsData {
/** Components schemas to be used for models */
models: OpenAPIModel[];
}
+53 -5
View File
@@ -1,4 +1,5 @@
import type { AnyObject, OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser'; import type { AnyObject, OpenAPIV3, OpenAPIV3_1 } from '@gitbook/openapi-parser';
import { stringifyOpenAPI } from './stringifyOpenAPI';
export function checkIsReference( export function checkIsReference(
input: unknown input: unknown
@@ -10,11 +11,19 @@ export function createStateKey(key: string, scope?: string) {
return scope ? `${scope}_${key}` : key; return scope ? `${scope}_${key}` : key;
} }
/**
* Check if an object has a description. Either at the root level or in items.
*/
function hasDescription(object: AnyObject) {
return 'description' in object || 'x-gitbook-description-html' in object;
}
/** /**
* Resolve the description of an object. * Resolve the description of an object.
*/ */
export function resolveDescription(object: OpenAPIV3.SchemaObject | AnyObject) { export function resolveDescription(object: OpenAPIV3.SchemaObject | AnyObject) {
if ('items' in object && object.items) { // If the object has items and has a description, we resolve the description from items
if ('items' in object && typeof object.items === 'object' && hasDescription(object.items)) {
return resolveDescription(object.items); return resolveDescription(object.items);
} }
@@ -42,17 +51,25 @@ export function extractDescriptions(object: AnyObject) {
/** /**
* Resolve the first example from an object. * Resolve the first example from an object.
*/ */
export function resolveFirstExample(object: AnyObject) { export function resolveFirstExample(object: AnyObject): string | undefined {
if ('examples' in object && typeof object.examples === 'object' && object.examples) { if ('examples' in object && typeof object.examples === 'object' && object.examples) {
const keys = Object.keys(object.examples); const keys = Object.keys(object.examples);
const firstKey = keys[0]; const firstKey = keys[0];
if (firstKey && object.examples[firstKey]) { if (firstKey && object.examples[firstKey]) {
return object.examples[firstKey]; return formatExample(object.examples[firstKey]);
} }
} }
if ('example' in object && object.example !== undefined) {
return object.example; // Resolve top level example first
if (shouldDisplayExample(object)) {
return formatExample(object.example);
} }
// Resolve example from items if it exists
if (object.items && typeof object.items === 'object') {
return formatExample(object.items.example);
}
return undefined; return undefined;
} }
@@ -98,3 +115,34 @@ export function parameterToProperty(
required: parameter.required, required: parameter.required,
}; };
} }
/**
* Format the example of a schema.
*/
function formatExample(example: unknown): string {
if (typeof example === 'string') {
return example
.replace(/\n/g, ' ') // Replace newlines with spaces
.replace(/\s+/g, ' ') // Collapse multiple spaces/newlines into a single space
.replace(/([\{\}:,])\s+/g, '$1 ') // Ensure a space after {, }, :, and ,
.replace(/\s+([\{\}:,])/g, ' $1') // Ensure a space before {, }, :, and ,
.trim();
}
return stringifyOpenAPI(example);
}
/**
* Check if an example should be displayed.
*/
function shouldDisplayExample(schema: OpenAPIV3.SchemaObject): boolean {
return (
(typeof schema.example === 'string' && !!schema.example) ||
typeof schema.example === 'number' ||
typeof schema.example === 'boolean' ||
(Array.isArray(schema.example) && schema.example.length > 0) ||
(typeof schema.example === 'object' &&
schema.example !== null &&
Object.keys(schema.example).length > 0)
);
}
+10 -7
View File
@@ -1,17 +1,21 @@
{ {
"$schema": "https://turbo.build/schema.json", "$schema": "https://turbo.build/schema.json",
"ui": "stream", "ui": "stream",
"globalEnv": ["NODE_ENV", "CI", "ARGOS_*", "GITHUB_*", "GITBOOK_*", "SENTRY_*"], "globalEnv": [
"NODE_ENV",
"CI",
"ARGOS_*",
"GITHUB_*",
"GITBOOK_*",
"SENTRY_*",
"NEXT_SERVER_ACTIONS_ENCRYPTION_KEY"
],
"tasks": { "tasks": {
// Prepare the package for all other tasks // Prepare the package for all other tasks
"generate": { "generate": {
"dependsOn": ["^generate"], "dependsOn": ["^generate"],
"outputs": ["dist"] "outputs": ["dist"]
}, },
"@gitbook/icons#generate": {
"dependsOn": ["^generate"],
"outputs": ["data/*.json"]
},
// Build the package for publishing // Build the package for publishing
"build": { "build": {
"dependsOn": ["^build", "generate"], "dependsOn": ["^build", "generate"],
@@ -29,8 +33,7 @@
}, },
// Build the package for Cloudflare Pages // Build the package for Cloudflare Pages
"build:cloudflare": { "build:cloudflare": {
"dependsOn": ["^build", "generate"], "dependsOn": ["^build", "generate"]
"env": ["NEXT_SERVER_ACTIONS_ENCRYPTION_KEY"]
}, },
// Check the package for type errors // Check the package for type errors
"typecheck": { "typecheck": {