mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-14 06:35:17 +00:00
Compare commits
124 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1424f431a9 | |||
| c2401e9a78 | |||
| 57625cd365 | |||
| 0f330d5e00 | |||
| 91b9c7955b | |||
| fc2c708ba8 | |||
| b77623b9f3 | |||
| 1430ceebea | |||
| 3fbd6f0d50 | |||
| 8f0b97906b | |||
| d460dc4b39 | |||
| 27b9f7817b | |||
| 9e062b10d3 | |||
| 74f89316d9 | |||
| 9e1d7b296b | |||
| b49caafa9c | |||
| f372eec393 | |||
| 65ae941687 | |||
| 75b8efa155 | |||
| 34b0c67c91 | |||
| e0ace99707 | |||
| 3553db0989 | |||
| 5c14948cf3 | |||
| 8e4e2a2333 | |||
| 0f4c53cfbd | |||
| c156e946b0 | |||
| 461e15fd00 | |||
| 2989f79708 | |||
| 344842f5ce | |||
| c51076efc4 | |||
| 38e34dcce3 | |||
| 04a4175678 | |||
| 3e40b4db50 | |||
| 854e612e5d | |||
| 27a461be9d | |||
| 3d83dadb12 | |||
| 8dc5c18b9f | |||
| e4756c23a7 | |||
| 79ad7bcb59 | |||
| 5b0917a13a | |||
| 6d6f4ef6dd | |||
| fa69a64a2b | |||
| d1a85d1f91 | |||
| 05bf9d7a59 | |||
| 2e0b3370c8 | |||
| 10995e09ca | |||
| e7cc3ff61f | |||
| 59d259074b | |||
| 96c4ae4f2d | |||
| 64f3596df2 | |||
| 27d6c3af39 | |||
| 1de4eb7973 | |||
| df1966df25 | |||
| 1001aaf94e | |||
| 155e448c8f | |||
| ca2a94ee1a | |||
| a512c90bda | |||
| 9cbefa89c7 | |||
| c8bba7bfe1 | |||
| 4e04db8a1b | |||
| b45feafeff | |||
| 3876f7081e | |||
| b4a021a192 | |||
| 1d92dc1350 | |||
| e4ba35fdae | |||
| 35dcaca971 | |||
| 2aa4f2e0b8 | |||
| 6d56df7c10 | |||
| 4534ea83c3 | |||
| 9022d87ec7 | |||
| a49781e200 | |||
| 065a5e6e55 | |||
| e27986b17a | |||
| 8606f222c9 | |||
| 2c3066e3ae | |||
| 55c0b03a41 | |||
| 3e548e4186 | |||
| 3aea302648 | |||
| 1d1f0a7c6a | |||
| 590729cce5 | |||
| b554d7d13f | |||
| 9568b8a7c8 | |||
| 683bb8f634 | |||
| 7d6a31627f | |||
| c31e5648f5 | |||
| 0c01832684 | |||
| 6b1c9fef86 | |||
| cc976995cc | |||
| ebbb476589 | |||
| 89655cb428 | |||
| 3676d64bdc | |||
| f682df1e01 | |||
| 6c9893945d | |||
| a2fb627ae1 | |||
| f9f80117f0 | |||
| 63bf4dbb16 | |||
| b3fa503aff | |||
| 0ae7cfd790 | |||
| 8fdc5c89dc | |||
| 758b34d46b | |||
| 1b0613e482 | |||
| 3164f1a99d | |||
| 6b588af07d | |||
| d436b04ff4 | |||
| d159788d0b | |||
| 3355960d95 | |||
| c32d4494f2 | |||
| 1dcf4df51f | |||
| 3c0e49d56b | |||
| c35d0e8954 | |||
| c0d73d2f76 | |||
| 454175ab86 | |||
| 6feb8fcd6a | |||
| b8d3cb7ee5 | |||
| 8ce73229c3 | |||
| 8eae6e970b | |||
| a48b886dfd | |||
| 17de0838c5 | |||
| baf3496980 | |||
| ae33c09aa7 | |||
| 7ff69c3b72 | |||
| 6142d6bf80 | |||
| 75543b140f | |||
| 511f1cfbe5 |
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/openapi-parser': patch
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Add x-gitbook-prefix and x-gitbook-token-placeholder for OpenAPI security scheme
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
"@gitbook/embed": minor
|
||||||
|
"gitbook": patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Improve Docs Embed with separate Assistant and Docs tabs
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix OpenAPI basic auth placeholder
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
"gitbook": patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix links to other spaces and root page in embeddable view.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
"gitbook": patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix CORS error when using embed script.js directly
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
"gitbook": minor
|
||||||
|
---
|
||||||
|
|
||||||
|
Add a RSS feed to all pages with update blocks.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Remove hidden site spaces from navigation
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Fix hidden section not found
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
'@gitbook/react-openapi': patch
|
||||||
|
'gitbook': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Improve OpenAPI circular references
|
||||||
@@ -54,10 +54,9 @@ After forking this repository, you'll want to [create a branch](https://docs.git
|
|||||||
#### 3. Install dependencies and run the project locally
|
#### 3. Install dependencies and run the project locally
|
||||||
|
|
||||||
##### Prerequisites:
|
##### Prerequisites:
|
||||||
- Node.js (Version: >=20.6)
|
|
||||||
- Use `nvm` for easy Node management
|
- [Node.js](https://nodejs.org/en) (see "engines" in `package.json`)
|
||||||
- [Bun](https://bun.sh/) (Version: >=1.2.15)
|
- [Bun](https://bun.sh/) (see "packageManager" in `package.json`)
|
||||||
- We use a text-based lockfile which isn't supported below 1.2.15
|
|
||||||
|
|
||||||
##### Setup steps:
|
##### Setup steps:
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
command: deployments status --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
command: versions deploy ${{ steps.extract_current_version.outputs.version_id }}@100% ${{ inputs.serverVersionId }}@0% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
|
command: versions deploy ${{ inputs.middlewareVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
command: versions deploy ${{ inputs.serverVersionId }}@100% -y --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
||||||
|
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
|
command: deploy --config ./packages/gitbook/openNext/customWorkers/doWrangler.jsonc
|
||||||
|
|
||||||
@@ -81,7 +81,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/defaultWrangler.jsonc
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ runs:
|
|||||||
apiToken: ${{ inputs.apiToken }}
|
apiToken: ${{ inputs.apiToken }}
|
||||||
accountId: ${{ inputs.accountId }}
|
accountId: ${{ inputs.accountId }}
|
||||||
workingDirectory: ./
|
workingDirectory: ./
|
||||||
wranglerVersion: '4.10.0'
|
wranglerVersion: '4.43.0'
|
||||||
environment: ${{ inputs.environment }}
|
environment: ${{ inputs.environment }}
|
||||||
command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
|
command: ${{ format('versions upload --tag {0} --message "{1}"', inputs.commitTag, inputs.commitMessage) }} --config ./packages/gitbook/openNext/customWorkers/middlewareWrangler.jsonc
|
||||||
|
|
||||||
|
|||||||
@@ -4,8 +4,9 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
- changeset-release/main
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
BUN_NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
|
||||||
jobs:
|
jobs:
|
||||||
format:
|
format:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -41,7 +42,7 @@ jobs:
|
|||||||
name: Build (Open Source)
|
name: Build (Open Source)
|
||||||
timeout-minutes: 6
|
timeout-minutes: 6
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ''
|
BUN_NPM_TOKEN: ''
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
BUN_NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
|
||||||
jobs:
|
jobs:
|
||||||
deploy-v2-vercel:
|
deploy-v2-vercel:
|
||||||
name: Deploy v2 to Vercel (preview)
|
name: Deploy v2 to Vercel (preview)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
BUN_NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
|
||||||
jobs:
|
jobs:
|
||||||
deploy-v2-vercel:
|
deploy-v2-vercel:
|
||||||
name: Deploy v2 to Vercel (production)
|
name: Deploy v2 to Vercel (production)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ on:
|
|||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
BUN_NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
|
||||||
jobs:
|
jobs:
|
||||||
deploy-v2-vercel:
|
deploy-v2-vercel:
|
||||||
name: Deploy v2 to Vercel (staging)
|
name: Deploy v2 to Vercel (staging)
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ on:
|
|||||||
- main
|
- main
|
||||||
|
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN_READONLY: ${{ secrets.NPM_TOKEN_READONLY }}
|
BUN_NPM_TOKEN: ${{ secrets.NPM_TOKEN_READONLY }}
|
||||||
|
|
||||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
|
||||||
@@ -14,30 +14,38 @@ jobs:
|
|||||||
publish:
|
publish:
|
||||||
name: Publish
|
name: Publish
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
id-token: write
|
||||||
|
pull-requests: write
|
||||||
|
contents: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Repo
|
- name: Checkout Repo
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
|
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
- name: Setup Node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 22
|
||||||
|
registry-url: 'https://registry.npmjs.org'
|
||||||
|
# Ensure npm 11.5.1 or later is installed
|
||||||
|
- name: Update npm
|
||||||
|
run: npm install -g npm@latest
|
||||||
- name: Setup Bun
|
- name: Setup Bun
|
||||||
uses: ./.github/composite/setup-bun
|
uses: ./.github/composite/setup-bun
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
env:
|
env:
|
||||||
PUPPETEER_SKIP_DOWNLOAD: 1
|
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||||
- name: Create Release Pull Request or Publish to npm
|
- name: Create Release Pull Request
|
||||||
id: changesets
|
id: changesets
|
||||||
uses: changesets/action@v1
|
uses: changesets/action@v1
|
||||||
with:
|
with:
|
||||||
publish: npm run release
|
publish: bun run publish-all-packages
|
||||||
version: npm run changeset-version
|
version: bun run changeset-version
|
||||||
env:
|
env:
|
||||||
# Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
|
# Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
|
||||||
# https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
|
# https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
|
||||||
GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
NPM_CONFIG_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
||||||
CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
|
||||||
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
|
||||||
|
|
||||||
|
|||||||
@@ -25,3 +25,7 @@ yarn-error.log*
|
|||||||
|
|
||||||
# TypeScript
|
# TypeScript
|
||||||
*.tsbuildinfo
|
*.tsbuildinfo
|
||||||
|
.npmrc
|
||||||
|
|
||||||
|
# Bun pack artifacts
|
||||||
|
packages/*/*.tgz
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ To run a local version of this project, please follow these simple steps.
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Node.js (Version: >=20.6)
|
- Node.js (Version: >= 22.3)
|
||||||
- Use nvm for easy Node management
|
- Use nvm for easy Node management
|
||||||
- [Bun](https://bun.sh/) (Version: >=1.2.15)
|
- [Bun](https://bun.sh/) (Version: >=1.2.15)
|
||||||
- We use a text-based lockfile which isn't supported below 1.2.15
|
- We use a text-based lockfile which isn't supported below 1.2.15
|
||||||
@@ -90,7 +90,7 @@ If you are GitBook staff, you'll need our NPM token in your local environment.
|
|||||||
```
|
```
|
||||||
.env.local
|
.env.local
|
||||||
|
|
||||||
NPM_TOKEN_READONLY=xxx
|
BUN_NPM_TOKEN=xxx
|
||||||
```
|
```
|
||||||
|
|
||||||
and then reinstall dependencies.
|
and then reinstall dependencies.
|
||||||
|
|||||||
+1
-1
@@ -1,2 +1,2 @@
|
|||||||
[install.scopes]
|
[install.scopes]
|
||||||
"gitbook" = { token = "$NPM_TOKEN_READONLY", url = "https://registry.npmjs.org" }
|
"gitbook" = { token = "$BUN_NPM_TOKEN", url = "https://registry.npmjs.org" }
|
||||||
|
|||||||
+24
-8
@@ -1,17 +1,22 @@
|
|||||||
{
|
{
|
||||||
"name": "gitbook",
|
"name": "gitbook",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
|
"engines": {
|
||||||
|
"node": "^22.3.0"
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "^1.9.4",
|
"@biomejs/biome": "^1.9.4",
|
||||||
"@changesets/cli": "^2.29.7",
|
"@changesets/cli": "^2.29.7",
|
||||||
"turbo": "^2.5.8",
|
"turbo": "^2.6.1",
|
||||||
"vercel": "^39.4.2"
|
"vercel": "^39.4.2"
|
||||||
},
|
},
|
||||||
"packageManager": "bun@1.2.15",
|
"packageManager": "bun@1.3.2",
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"@codemirror/state": "6.4.1",
|
"@codemirror/state": "6.4.1",
|
||||||
"react": "^19.0.0",
|
"@types/react": "catalog:",
|
||||||
"react-dom": "^19.0.0",
|
"@types/react-dom": "catalog:",
|
||||||
|
"react": "catalog:",
|
||||||
|
"react-dom": "catalog:",
|
||||||
"esbuild": "0.24.2"
|
"esbuild": "0.24.2"
|
||||||
},
|
},
|
||||||
"private": true,
|
"private": true,
|
||||||
@@ -27,17 +32,28 @@
|
|||||||
"e2e-customers": "turbo run e2e-customers",
|
"e2e-customers": "turbo run e2e-customers",
|
||||||
"changeset": "changeset",
|
"changeset": "changeset",
|
||||||
"changeset-version": "changeset version && bun run format && bun update",
|
"changeset-version": "changeset version && bun run format && bun update",
|
||||||
"release": "turbo run release && bun run publish-all-packages",
|
"publish-all-packages": "turbo run publish-to-npm --continue=dependencies-successful",
|
||||||
"publish-all-packages": "for dir in packages/*; do (cd \"$dir\" && bun publish || true); done && changeset tag",
|
|
||||||
"download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
|
"download:env": "op read op://gitbook-x-dev/gitbook-open/.env.local >> .env.local",
|
||||||
"clean": "turbo run clean"
|
"clean": "turbo run clean"
|
||||||
},
|
},
|
||||||
"workspaces": {
|
"workspaces": {
|
||||||
"packages": ["packages/*"],
|
"packages": ["packages/*"],
|
||||||
"catalog": {
|
"catalog": {
|
||||||
"@gitbook/api": "0.143.2",
|
"@tsconfig/strictest": "^2.0.6",
|
||||||
|
"@tsconfig/node20": "^20.1.6",
|
||||||
|
"@gitbook/api": "0.153.0",
|
||||||
|
"@scalar/api-client-react": "^1.3.46",
|
||||||
|
"@types/react": "^19.0.0",
|
||||||
|
"@types/react-dom": "^19.0.0",
|
||||||
|
"assert-never": "^1.4.0",
|
||||||
"bidc": "^0.0.2",
|
"bidc": "^0.0.2",
|
||||||
"tsdown": "^0.15.6"
|
"bun-types": "^1.1.20",
|
||||||
|
"classnames": "^2.5.1",
|
||||||
|
"react": "^19.0.0",
|
||||||
|
"react-dom": "^19.0.0",
|
||||||
|
"tsdown": "^0.15.6",
|
||||||
|
"typescript": "^5.5.3",
|
||||||
|
"usehooks-ts": "^3.1.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"patchedDependencies": {
|
"patchedDependencies": {
|
||||||
|
|||||||
@@ -1,5 +1,21 @@
|
|||||||
# @gitbook/browser-types
|
# @gitbook/browser-types
|
||||||
|
|
||||||
|
## 0.1.3
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 10995e0: Use NPM Trusted publishing for publishing the package.
|
||||||
|
- Updated dependencies [10995e0]
|
||||||
|
- @gitbook/icons@0.3.4
|
||||||
|
|
||||||
|
## 0.1.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
- Updated dependencies [6142d6b]
|
||||||
|
- @gitbook/icons@0.3.3
|
||||||
|
|
||||||
## 0.1.1
|
## 0.1.1
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -8,21 +8,29 @@
|
|||||||
"default": "./dist/index.js"
|
"default": "./dist/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "0.1.1",
|
"sideEffects": false,
|
||||||
|
"version": "0.1.3",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gitbook/api": "catalog:",
|
"@gitbook/api": "catalog:",
|
||||||
"@gitbook/icons": "workspace:"
|
"@gitbook/icons": "workspace:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.5.3"
|
"bun-types": "catalog:",
|
||||||
|
"tsdown": "catalog:",
|
||||||
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"build": "tsdown",
|
||||||
"typecheck": "tsc --noEmit"
|
"typecheck": "tsc --noEmit",
|
||||||
|
"dev": "bun run build -- --watch ./src",
|
||||||
|
"publish-to-npm": "../../scripts/publish-if-new.sh"
|
||||||
},
|
},
|
||||||
"files": ["dist", "README.md", "CHANGELOG.md"],
|
"files": ["dist", "README.md", "CHANGELOG.md"],
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GitbookIO/gitbook"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,17 @@
|
|||||||
# @gitbook/cache-tags
|
# @gitbook/cache-tags
|
||||||
|
|
||||||
|
## 0.3.4
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 10995e0: Use NPM Trusted publishing for publishing the package.
|
||||||
|
|
||||||
|
## 0.3.3
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
|
||||||
## 0.3.2
|
## 0.3.2
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -4,26 +4,32 @@
|
|||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"development": "./src/index.ts",
|
|
||||||
"default": "./dist/index.js"
|
"default": "./dist/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "0.3.2",
|
"sideEffects": false,
|
||||||
|
"version": "0.3.4",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gitbook/api": "catalog:",
|
"@gitbook/api": "catalog:",
|
||||||
"assert-never": "^1.2.1"
|
"assert-never": "catalog:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.5.3"
|
"bun-types": "catalog:",
|
||||||
|
"tsdown": "catalog:",
|
||||||
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"build": "tsdown",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"dev": "tsc -w"
|
"dev": "bun run build -- --watch ./src",
|
||||||
|
"publish-to-npm": "../../scripts/publish-if-new.sh"
|
||||||
},
|
},
|
||||||
"files": ["dist", "src", "README.md", "CHANGELOG.md"],
|
"files": ["dist", "README.md", "CHANGELOG.md"],
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GitbookIO/gitbook"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,17 @@
|
|||||||
# @gitbook/colors
|
# @gitbook/colors
|
||||||
|
|
||||||
|
## 0.4.3
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 10995e0: Use NPM Trusted publishing for publishing the package.
|
||||||
|
|
||||||
|
## 0.4.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
|
||||||
## 0.4.1
|
## 0.4.1
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -4,22 +4,28 @@
|
|||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"development": "./src/index.ts",
|
|
||||||
"default": "./dist/index.js"
|
"default": "./dist/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "0.4.1",
|
"sideEffects": false,
|
||||||
|
"version": "0.4.3",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.5.3"
|
"bun-types": "catalog:",
|
||||||
|
"tsdown": "catalog:",
|
||||||
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"build": "tsdown",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"dev": "tsc -w"
|
"dev": "bun run build -- --watch ./src",
|
||||||
|
"publish-to-npm": "../../scripts/publish-if-new.sh"
|
||||||
},
|
},
|
||||||
"files": ["dist", "src", "README.md", "CHANGELOG.md"],
|
"files": ["dist", "README.md", "CHANGELOG.md"],
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GitbookIO/gitbook"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,21 @@
|
|||||||
# @gitbook/embed
|
# @gitbook/embed
|
||||||
|
|
||||||
|
## 0.1.5
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 10995e0: Use NPM Trusted publishing for publishing the package.
|
||||||
|
- Updated dependencies [10995e0]
|
||||||
|
- @gitbook/icons@0.3.4
|
||||||
|
|
||||||
|
## 0.1.4
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
- Updated dependencies [6142d6b]
|
||||||
|
- @gitbook/icons@0.3.3
|
||||||
|
|
||||||
## 0.1.3
|
## 0.1.3
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
+370
-8
@@ -1,24 +1,61 @@
|
|||||||
# `@gitbook/embed`
|
# GitBook Docs Embed (`@gitbook/embed`)
|
||||||
|
|
||||||
Embed the GitBook Docs Assistant in your product or website.
|
Embed your GitBook docs in your product or website.
|
||||||
|
|
||||||
|
The Docs Embed can contain two tabs:
|
||||||
|
- **Assistant**: The [GitBook Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) - an AI-powered chat interface to help users find answers
|
||||||
|
- **Docs**: A browser for navigating your documentation site
|
||||||
|
|
||||||
|
The embed is set up automatically based on your site's configuration. You can optionally customize and override the configuration with custom actions, tools, suggested questions, [Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access), and more. See the [Configuration](#configuration) section for all available options.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
## As a script from your docs site
|
## As a standalone script from your docs site
|
||||||
|
|
||||||
All GitBook docs site includes a script to easily embed the docs assistant as a widget on your website.
|
All GitBook docs sites include a script to easily add the Docs Embed as a widget on your website.
|
||||||
|
|
||||||
The script is served at `https://docs.company.com/~gitbook/embed/script.js`.
|
The script is served at `https://docs.company.com/~gitbook/embed/script.js`.
|
||||||
|
|
||||||
You can find the embed script from your docs site settings, or you can copy the following and replace the `docs.company.com` by your docs site hostname.
|
You can find the embed script from your docs site settings, or you can copy the following and replace `docs.company.com` with your docs site hostname.
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script src="https://docs.company.com/~gitbook/embed/script.js"></script>
|
<script src="https://docs.company.com/~gitbook/embed/script.js"></script>
|
||||||
<script>
|
<script>
|
||||||
|
// Initialize with Authenticated Access (optional)
|
||||||
|
window.GitBook('init',
|
||||||
|
{ siteURL: 'https://docs.company.com' },
|
||||||
|
{ visitor: { token: 'your-jwt-token' } }
|
||||||
|
);
|
||||||
window.GitBook('show');
|
window.GitBook('show');
|
||||||
</script>
|
</script>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The standalone script provides a global `GitBook` function. See the [API Reference](#api-reference) section for all available methods.
|
||||||
|
|
||||||
|
### Example: Configuring the widget
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
GitBook('configure', {
|
||||||
|
button: {
|
||||||
|
label: 'Ask',
|
||||||
|
icon: 'assistant' // 'assistant' | 'sparkle' | 'help' | 'book'
|
||||||
|
},
|
||||||
|
tabs: ['assistant', 'docs'],
|
||||||
|
actions: [
|
||||||
|
{
|
||||||
|
icon: 'circle-question',
|
||||||
|
label: 'Contact Support',
|
||||||
|
onClick: () => window.open('https://support.example.com', '_blank')
|
||||||
|
}
|
||||||
|
],
|
||||||
|
greeting: { title: 'Welcome!', subtitle: 'How can I help?' },
|
||||||
|
suggestions: ['What is GitBook?', 'How do I get started?'],
|
||||||
|
tools: [/* ... */]
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
See the [Configuration](#configuration) section for all available options.
|
||||||
|
|
||||||
## As a package from NPM
|
## As a package from NPM
|
||||||
|
|
||||||
Install the package: `npm install @gitbook/embed` and import it in your web application:
|
Install the package: `npm install @gitbook/embed` and import it in your web application:
|
||||||
@@ -30,10 +67,46 @@ const gitbook = createGitBook({
|
|||||||
siteURL: 'https://docs.company.com'
|
siteURL: 'https://docs.company.com'
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Create an iframe and get its URL
|
||||||
const iframe = document.createElement('iframe');
|
const iframe = document.createElement('iframe');
|
||||||
iframe.src = gitbook.getFrameURL();
|
iframe.src = gitbook.getFrameURL({
|
||||||
|
visitor: {
|
||||||
|
token: 'your-jwt-token', // Optional: for Adaptive Content or Authenticated Access
|
||||||
|
unsignedClaims: { // Optional: custom claims for dynamic expressions
|
||||||
|
userId: '123',
|
||||||
|
plan: 'premium'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Create a frame client to communicate with the iframe
|
||||||
const frame = gitbook.createFrame(iframe);
|
const frame = gitbook.createFrame(iframe);
|
||||||
|
|
||||||
|
// Use the frame client methods
|
||||||
|
frame.navigateToPage('/getting-started'); // Navigate to a page in the docs tab
|
||||||
|
frame.navigateToAssistant(); // Switch to the assistant tab
|
||||||
|
frame.postUserMessage('How do I get started?');
|
||||||
|
frame.clearChat();
|
||||||
|
|
||||||
|
// Configure the embed (see Configuration section for all options)
|
||||||
|
frame.configure({
|
||||||
|
tabs: ['assistant', 'docs'],
|
||||||
|
actions: [
|
||||||
|
{
|
||||||
|
icon: 'circle-question',
|
||||||
|
label: 'Contact Support',
|
||||||
|
onClick: () => window.open('https://support.example.com', '_blank')
|
||||||
|
}
|
||||||
|
],
|
||||||
|
greeting: { title: 'Welcome!', subtitle: 'How can I help?' },
|
||||||
|
suggestions: ['What is GitBook?', 'How do I get started?'],
|
||||||
|
tools: [/* ... */]
|
||||||
|
});
|
||||||
|
|
||||||
|
// Listen to events
|
||||||
|
frame.on('close', () => {
|
||||||
|
console.log('Frame closed');
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## As React components
|
## As React components
|
||||||
@@ -41,9 +114,298 @@ const frame = gitbook.createFrame(iframe);
|
|||||||
After installing the NPM package, you can import prebuilt React components:
|
After installing the NPM package, you can import prebuilt React components:
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
import { GitBookProvider, GitBookAssistantFrame } from '@gitbook/embed/react';
|
import { GitBookProvider, GitBookFrame } from '@gitbook/embed/react';
|
||||||
|
|
||||||
<GitBookProvider siteURL="https://docs.company.com">
|
<GitBookProvider siteURL="https://docs.company.com">
|
||||||
<GitBookAssistantFrame />
|
<GitBookFrame
|
||||||
|
visitor={{
|
||||||
|
token: 'your-jwt-token', // Optional: for Adaptive Content or Authenticated Access
|
||||||
|
unsignedClaims: { userId: '123' } // Optional: custom claims for dynamic expressions
|
||||||
|
}}
|
||||||
|
tabs={['assistant', 'docs']}
|
||||||
|
greeting={{ title: 'Welcome!', subtitle: 'How can I help?' }}
|
||||||
|
suggestions={['What is GitBook?', 'How do I get started?']}
|
||||||
|
actions={[
|
||||||
|
{
|
||||||
|
icon: 'circle-question',
|
||||||
|
label: 'Contact Support',
|
||||||
|
onClick: () => window.open('https://support.example.com', '_blank')
|
||||||
|
}
|
||||||
|
]}
|
||||||
|
tools={[/* ... */]}
|
||||||
|
/>
|
||||||
</GitBookProvider>
|
</GitBookProvider>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can also use the `useGitBook` hook to access the client:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { useGitBook } from '@gitbook/embed/react';
|
||||||
|
|
||||||
|
function MyComponent() {
|
||||||
|
const gitbook = useGitBook();
|
||||||
|
const frameURL = gitbook.getFrameURL({ visitor: { token: '...' } });
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
# API Reference
|
||||||
|
|
||||||
|
## Method Comparison
|
||||||
|
|
||||||
|
| Method | Standalone Script | NPM Package | React Components |
|
||||||
|
|--------|------------------|-------------|------------------|
|
||||||
|
| **Initialize** | `GitBook('init', options, frameOptions)` | `createGitBook(options)` | `<GitBookProvider siteURL="...">` |
|
||||||
|
| **Get frame URL** | ❌ (handled internally) | `client.getFrameURL(options)` | `useGitBook().getFrameURL(options)` |
|
||||||
|
| **Create frame client** | ❌ (handled internally) | `client.createFrame(iframe)` | `useGitBook().createFrame(iframe)` |
|
||||||
|
| **Show/Hide widget** | `GitBook('show')` / `GitBook('hide')` | ❌ | ❌ |
|
||||||
|
| **Open/Close window** | `GitBook('open')` / `GitBook('close')` / `GitBook('toggle')` | ❌ | ❌ |
|
||||||
|
| **Navigate to page** | `GitBook('navigateToPage', path)` | `frame.navigateToPage(path)` | Via frame client |
|
||||||
|
| **Navigate to assistant** | `GitBook('navigateToAssistant')` | `frame.navigateToAssistant()` | Via frame client |
|
||||||
|
| **Post message** | `GitBook('postUserMessage', message)` | `frame.postUserMessage(message)` | Via frame client |
|
||||||
|
| **Clear chat** | `GitBook('clearChat')` | `frame.clearChat()` | Via frame client |
|
||||||
|
| **Configure** | `GitBook('configure', settings)` | `frame.configure(settings)` | Props on `<GitBookFrame>` |
|
||||||
|
| **Event listeners** | ❌ | `frame.on(event, listener)` | Via frame client |
|
||||||
|
| **Unload** | `GitBook('unload')` | ❌ | ❌ |
|
||||||
|
|
||||||
|
## Method Signatures
|
||||||
|
|
||||||
|
### Standalone Script
|
||||||
|
|
||||||
|
- `GitBook('init', options: { siteURL: string }, frameOptions?: { visitor?: {...} })` - Initialize widget
|
||||||
|
- `GitBook('show')` - Show widget button
|
||||||
|
- `GitBook('hide')` - Hide widget button
|
||||||
|
- `GitBook('open')` - Open widget window
|
||||||
|
- `GitBook('close')` - Close widget window
|
||||||
|
- `GitBook('toggle')` - Toggle widget window
|
||||||
|
- `GitBook('navigateToPage', path: string)` - Navigate to page
|
||||||
|
- `GitBook('navigateToAssistant')` - Navigate to assistant tab
|
||||||
|
- `GitBook('postUserMessage', message: string)` - Post message to chat
|
||||||
|
- `GitBook('clearChat')` - Clear chat history
|
||||||
|
- `GitBook('configure', settings: {...})` - Configure widget
|
||||||
|
- `GitBook('unload')` - Unload widget
|
||||||
|
|
||||||
|
### NPM Package
|
||||||
|
|
||||||
|
**Client Factory:**
|
||||||
|
- `createGitBook(options: { siteURL: string })` → `GitBookClient`
|
||||||
|
- `client.getFrameURL(options?: { visitor?: {...} })` → `string`
|
||||||
|
- `client.createFrame(iframe: HTMLIFrameElement)` → `GitBookFrameClient`
|
||||||
|
|
||||||
|
**Frame Client:**
|
||||||
|
- `frame.navigateToPage(path: string)` → `void`
|
||||||
|
- `frame.navigateToAssistant()` → `void`
|
||||||
|
- `frame.postUserMessage(message: string)` → `void`
|
||||||
|
- `frame.clearChat()` → `void`
|
||||||
|
- `frame.configure(settings: Partial<GitBookEmbeddableConfiguration>)` → `void`
|
||||||
|
- `frame.on(event: string, listener: Function)` → `() => void` (unsubscribe)
|
||||||
|
|
||||||
|
### React Components
|
||||||
|
|
||||||
|
**Components:**
|
||||||
|
- `<GitBookProvider siteURL: string>` - Provider component
|
||||||
|
- `<GitBookFrame {...props}>` - Frame component (accepts all config options as props)
|
||||||
|
|
||||||
|
**Hooks:**
|
||||||
|
- `useGitBook()` → `GitBookClient` (must be used within `<GitBookProvider>`)
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
Configuration options are available across usage methods as follows:
|
||||||
|
- **Standalone script**: via `GitBook('configure', {...})`
|
||||||
|
- **NPM package**: via `frame.configure({...})`
|
||||||
|
- **React components**: via props on `<GitBookFrame>`
|
||||||
|
|
||||||
|
### `tabs`
|
||||||
|
|
||||||
|
Available in: Standalone script, NPM package, React components
|
||||||
|
|
||||||
|
Override which tabs are displayed. Defaults to your site's configuration.
|
||||||
|
|
||||||
|
- **Type**: `('assistant' | 'docs')[]`
|
||||||
|
- **Options**:
|
||||||
|
- `['assistant', 'docs']` - Show both tabs
|
||||||
|
- `['assistant']` - Show only the assistant tab
|
||||||
|
- `['docs']` - Show only the docs tab
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
tabs: ['assistant', 'docs']
|
||||||
|
```
|
||||||
|
|
||||||
|
### `actions`
|
||||||
|
|
||||||
|
Available in: Standalone script, NPM package, React components
|
||||||
|
|
||||||
|
Custom action buttons rendered in the sidebar alongside tabs. Each action button triggers a callback when clicked.
|
||||||
|
|
||||||
|
**Note**: This prop was previously named `buttons`. Use `actions` instead, it has the same functionality.
|
||||||
|
|
||||||
|
- **Type**: `GitBookEmbeddableActionDefinition[]`
|
||||||
|
- **Properties**:
|
||||||
|
- `icon`: `string` - Icon name. Any [FontAwesome icon](https://fontawesome.com/search) is supported. (e.g., `'rocket'`, `'comments'`, `'user-circle'`, ...)
|
||||||
|
- `label`: `string` - Button label text
|
||||||
|
- `onClick`: `() => void | Promise<void>` - Callback function when clicked
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
actions: [
|
||||||
|
{
|
||||||
|
icon: 'comments',
|
||||||
|
label: 'Contact Support',
|
||||||
|
onClick: () => window.open('https://support.example.com', '_blank')
|
||||||
|
},
|
||||||
|
{
|
||||||
|
icon: 'rocket',
|
||||||
|
label: 'Get started',
|
||||||
|
onClick: () => {
|
||||||
|
GitBook('navigateToPage', '/getting-started');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `greeting`
|
||||||
|
|
||||||
|
Available in: Standalone script, NPM package, React components
|
||||||
|
|
||||||
|
Welcome message displayed in the [Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) tab.
|
||||||
|
|
||||||
|
- **Type**: `{ title: string, subtitle: string }`
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
greeting: {
|
||||||
|
title: 'Welcome!',
|
||||||
|
subtitle: 'How can I help you today?'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### `suggestions`
|
||||||
|
|
||||||
|
Available in: Standalone script, NPM package, React components
|
||||||
|
|
||||||
|
Suggested questions displayed in the [Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant) welcome screen.
|
||||||
|
|
||||||
|
- **Type**: `string[]`
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
suggestions: [
|
||||||
|
'What is GitBook?',
|
||||||
|
'How do I get started?',
|
||||||
|
'What can you do?'
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `tools`
|
||||||
|
|
||||||
|
Available in: Standalone script, NPM package, React components
|
||||||
|
|
||||||
|
Custom AI tools to extend the [Assistant](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant). Tools allow the assistant to execute functions and integrate with your own systems.
|
||||||
|
|
||||||
|
**Note**: In addition to custom tools, the Assistant will always have access to any [MCP servers you define](https://gitbook.com/docs/publishing-documentation/gitbook-ai-assistant#extend-gitbook-assistant-with-mcp-servers) in your site's AI settings.
|
||||||
|
|
||||||
|
- **Type**: `GitBookToolDefinition[]`
|
||||||
|
- **Properties**:
|
||||||
|
- `name`: `string` - Unique tool identifier
|
||||||
|
- `description`: `string` - Description of what the tool does (used by the AI to decide when and how to use it).
|
||||||
|
- `inputSchema`: `object` - JSON schema defining the tool's input parameters
|
||||||
|
- `execute`: `(input: object) => Promise<{ output: any, summary: string }>` - Async function that executes the tool.
|
||||||
|
- `output`: The result of the tool execution, provided to the AI to continue working with. Not shown to the user.
|
||||||
|
- `summary`: The visual summary of the tool execution, shown in the user's chat window.
|
||||||
|
- `confirmation`: `{ icon?: string, label: string }` (optional) - Confirmation button shown before execution, useful for actions that require the user's express approval.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
tools: [
|
||||||
|
{
|
||||||
|
name: 'get_user_info',
|
||||||
|
description: 'Get information about the current user',
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
userId: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'The user ID to look up'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
required: ['userId']
|
||||||
|
},
|
||||||
|
execute: async (input) => {
|
||||||
|
const user = await fetch(`/api/users/${input.userId}`).then(r => r.json());
|
||||||
|
return {
|
||||||
|
output: { name: user.name, plan: user.plan },
|
||||||
|
summary: `Retrieved info for user ${user.name}`
|
||||||
|
};
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'create_ticket',
|
||||||
|
description: 'Create a support ticket',
|
||||||
|
confirmation: {
|
||||||
|
icon: 'circle-question',
|
||||||
|
label: 'Create support ticket?'
|
||||||
|
},
|
||||||
|
inputSchema: {
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
subject: { type: 'string' },
|
||||||
|
description: { type: 'string' }
|
||||||
|
},
|
||||||
|
required: ['subject', 'description']
|
||||||
|
},
|
||||||
|
execute: async (input) => {
|
||||||
|
const ticket = await fetch('/api/tickets', {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify(input)
|
||||||
|
}).then(r => r.json());
|
||||||
|
return {
|
||||||
|
output: { ticketId: ticket.id },
|
||||||
|
summary: `Created ticket #${ticket.id}`
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `visitor` (Authenticated Access)
|
||||||
|
|
||||||
|
Available in: Standalone script (via `init`), NPM package (via `getFrameURL()`), React components (as prop)
|
||||||
|
|
||||||
|
[Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access) options passed when creating the frame URL. Used for [Adaptive Content](https://gitbook.com/docs/publishing-documentation/adaptive-content) and [Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access).
|
||||||
|
|
||||||
|
**Note**: This is not a configuration option but rather a parameter when initializing the frame or creating the frame URL.
|
||||||
|
|
||||||
|
**Standalone script**: Pass as the second argument to `GitBook('init', options, frameOptions)`
|
||||||
|
**NPM package**: Pass to `getFrameURL({ visitor: {...} })`
|
||||||
|
**React components**: Pass as the `visitor` prop on `<GitBookFrame>`
|
||||||
|
|
||||||
|
- **Type**: `{ token?: string, unsignedClaims?: Record<string, unknown> }`
|
||||||
|
- **Properties**:
|
||||||
|
- `token`: `string` (optional) - Signed JWT token for [Adaptive Content](https://gitbook.com/docs/publishing-documentation/adaptive-content) or [Authenticated Access](https://gitbook.com/docs/publishing-documentation/authenticated-access)
|
||||||
|
- `unsignedClaims`: `Record<string, unknown>` (optional) - Unsigned claims that can be used in dynamic expressions via `visitor.claims.unsigned.<claim-name>`
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
visitor: {
|
||||||
|
token: 'your-jwt-token',
|
||||||
|
unsignedClaims: {
|
||||||
|
userId: '123',
|
||||||
|
plan: 'premium',
|
||||||
|
role: 'admin'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### `button`
|
||||||
|
|
||||||
|
Available in: Standalone script only
|
||||||
|
|
||||||
|
Configure the widget button for the standalone script. This option is not available when using the NPM package or React components, since they can be customized completely.
|
||||||
|
|
||||||
|
- **Type**: `{ label: string, icon: 'assistant' | 'sparkle' | 'help' | 'book' }`
|
||||||
|
- **Properties**:
|
||||||
|
- `label`: `string` - Button label text
|
||||||
|
- `icon`: `'assistant' | 'sparkle' | 'help' | 'book'` - Icon displayed on the button. Choose from one of 4 presets.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
button: {
|
||||||
|
label: 'Ask',
|
||||||
|
icon: 'assistant'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
@@ -12,19 +12,21 @@
|
|||||||
"default": "./dist/react/index.js"
|
"default": "./dist/react/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "0.1.3",
|
"sideEffects": false,
|
||||||
|
"version": "0.1.5",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gitbook/api": "catalog:",
|
"@gitbook/api": "catalog:",
|
||||||
"@gitbook/icons": "workspace:",
|
"@gitbook/icons": "workspace:",
|
||||||
"bidc": "catalog:"
|
"bidc": "catalog:"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"react": "^18.0.0"
|
"react": "*"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
"@types/react": "catalog:",
|
||||||
"tsdown": "catalog:",
|
"tsdown": "catalog:",
|
||||||
"typescript": "^5.5.3",
|
"typescript": "catalog:",
|
||||||
"react": "^19.0.0"
|
"react": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "bun run build-lib && bun run build-standalone",
|
"build": "bun run build-lib && bun run build-standalone",
|
||||||
@@ -32,11 +34,15 @@
|
|||||||
"build-standalone": "bun build src/standalone/index.ts --bundle --minify --outdir=standalone",
|
"build-standalone": "bun build src/standalone/index.ts --bundle --minify --outdir=standalone",
|
||||||
"clean": "rm -rf ./dist",
|
"clean": "rm -rf ./dist",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"dev": "bun run build -- --watch ./src"
|
"dev": "bun run build -- --watch ./src",
|
||||||
|
"publish-to-npm": "../../scripts/publish-if-new.sh"
|
||||||
},
|
},
|
||||||
"files": ["dist", "README.md", "CHANGELOG.md"],
|
"files": ["dist", "README.md", "CHANGELOG.md"],
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GitbookIO/gitbook"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ export function createGitBook(options: CreateGitBookOptions) {
|
|||||||
const client: GitBookClient = {
|
const client: GitBookClient = {
|
||||||
getFrameURL: (frameOptions) => {
|
getFrameURL: (frameOptions) => {
|
||||||
const url = new URL(options.siteURL);
|
const url = new URL(options.siteURL);
|
||||||
url.pathname = `${url.pathname.endsWith('/') ? url.pathname : `${url.pathname}/`}~gitbook/embed/assistant`;
|
url.pathname = `${url.pathname.endsWith('/') ? url.pathname : `${url.pathname}/`}~gitbook/embed`;
|
||||||
|
|
||||||
if (frameOptions.visitor?.token) {
|
if (frameOptions.visitor?.token) {
|
||||||
url.searchParams.set('token', frameOptions.visitor.token);
|
url.searchParams.set('token', frameOptions.visitor.token);
|
||||||
|
|||||||
@@ -64,8 +64,9 @@ export function createGitBookFrame(iframe: HTMLIFrameElement): GitBookFrameClien
|
|||||||
const events = new Map<string, Array<(...args: any[]) => void>>();
|
const events = new Map<string, Array<(...args: any[]) => void>>();
|
||||||
|
|
||||||
const configuration: GitBookEmbeddableConfiguration = {
|
const configuration: GitBookEmbeddableConfiguration = {
|
||||||
buttons: [],
|
tabs: ['assistant', 'docs'],
|
||||||
welcomeMessage: '',
|
actions: [],
|
||||||
|
greeting: { title: '', subtitle: '' },
|
||||||
suggestions: [],
|
suggestions: [],
|
||||||
tools: [],
|
tools: [],
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ export type GitBookToolDefinition = AIToolDefinition & {
|
|||||||
/**
|
/**
|
||||||
* Custom button definition to be passed to the embeddable GitBook.
|
* Custom button definition to be passed to the embeddable GitBook.
|
||||||
*/
|
*/
|
||||||
export type GitBookEmbeddableButtonDefinition = {
|
export type GitBookEmbeddableActionDefinition = {
|
||||||
/**
|
/**
|
||||||
* Icon to be displayed in the button.
|
* Icon to be displayed in the button.
|
||||||
*/
|
*/
|
||||||
@@ -41,16 +41,26 @@ export type GitBookEmbeddableButtonDefinition = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Overall configuration for the layout of the embeddable GitBook.
|
* Overall configuration for the layout of the GitBook embed.
|
||||||
*/
|
*/
|
||||||
export type GitBookEmbeddableConfiguration = {
|
export type GitBookEmbeddableConfiguration = {
|
||||||
|
/** Tabs to display in the embed (if enabled on the site). */
|
||||||
|
tabs: ('assistant' | 'docs')[];
|
||||||
|
|
||||||
|
/** Additional buttons to be displayed in the header of the GitBook embed. */
|
||||||
|
actions: GitBookEmbeddableActionDefinition[];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Buttons to be displayed in the header of the embeddable GitBook.
|
* Additional buttons to be displayed in the header of the GitBook embed.
|
||||||
|
* @deprecated Use `actions` instead.
|
||||||
*/
|
*/
|
||||||
buttons: GitBookEmbeddableButtonDefinition[];
|
buttons?: GitBookEmbeddableActionDefinition[];
|
||||||
|
|
||||||
/** Message to be displayed in the welcome page. */
|
/** Message to be displayed in the welcome page. */
|
||||||
welcomeMessage: string;
|
greeting: {
|
||||||
|
title: string;
|
||||||
|
subtitle: string;
|
||||||
|
};
|
||||||
|
|
||||||
/** Suggestions of questions to be displayed in the welcome page. */
|
/** Suggestions of questions to be displayed in the welcome page. */
|
||||||
suggestions: string[];
|
suggestions: string[];
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
import React from 'react';
|
'use client';
|
||||||
|
|
||||||
|
import { useEffect, useMemo, useRef, useState } from 'react';
|
||||||
import type {
|
import type {
|
||||||
GetFrameURLOptions,
|
GetFrameURLOptions,
|
||||||
GitBookEmbeddableConfiguration,
|
GitBookEmbeddableConfiguration,
|
||||||
@@ -15,28 +17,29 @@ export type GitBookFrameProps = {
|
|||||||
* Render a frame with the GitBook Assistant in it.
|
* Render a frame with the GitBook Assistant in it.
|
||||||
*/
|
*/
|
||||||
export function GitBookFrame(props: GitBookFrameProps) {
|
export function GitBookFrame(props: GitBookFrameProps) {
|
||||||
const { className, visitor, buttons, welcomeMessage, suggestions, tools } = props;
|
const { className, visitor, actions, greeting, suggestions, tools } = props;
|
||||||
|
|
||||||
const frameRef = React.useRef<HTMLIFrameElement>(null);
|
const frameRef = useRef<HTMLIFrameElement>(null);
|
||||||
const gitbook = useGitBook();
|
const gitbook = useGitBook();
|
||||||
const [gitbookFrame, setGitbookFrame] = React.useState<GitBookFrameClient | null>(null);
|
const [gitbookFrame, setGitbookFrame] = useState<GitBookFrameClient | null>(null);
|
||||||
|
|
||||||
const frameURL = React.useMemo(() => gitbook.getFrameURL({ visitor }), [gitbook, visitor]);
|
const frameURL = useMemo(() => gitbook.getFrameURL({ visitor }), [gitbook, visitor]);
|
||||||
|
|
||||||
React.useEffect(() => {
|
useEffect(() => {
|
||||||
if (frameRef.current) {
|
if (frameRef.current) {
|
||||||
setGitbookFrame(gitbook.createFrame(frameRef.current));
|
setGitbookFrame(gitbook.createFrame(frameRef.current));
|
||||||
}
|
}
|
||||||
}, [gitbook]);
|
}, [gitbook]);
|
||||||
|
|
||||||
React.useEffect(() => {
|
useEffect(() => {
|
||||||
gitbookFrame?.configure({
|
gitbookFrame?.configure({
|
||||||
buttons,
|
tabs: ['assistant', 'docs'],
|
||||||
welcomeMessage,
|
actions,
|
||||||
|
greeting,
|
||||||
suggestions,
|
suggestions,
|
||||||
tools,
|
tools,
|
||||||
});
|
});
|
||||||
}, [gitbookFrame, buttons, welcomeMessage, suggestions, tools]);
|
}, [gitbookFrame, actions, greeting, suggestions, tools]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<iframe
|
<iframe
|
||||||
|
|||||||
@@ -31,24 +31,50 @@ type StandaloneCalls =
|
|||||||
// Clear the chat
|
// Clear the chat
|
||||||
| ['clearChat']
|
| ['clearChat']
|
||||||
// Configure the embed
|
// Configure the embed
|
||||||
| ['configure', Partial<GitBookEmbeddableConfiguration>]
|
| ['configure', Partial<GitBookEmbeddableConfiguration & StandaloneConfiguration>]
|
||||||
// Navigate to a page
|
// Navigate to a page
|
||||||
| ['navigateToPage', string]
|
| ['navigateToPage', string]
|
||||||
// Navigate to the assistant
|
// Navigate to the assistant
|
||||||
| ['navigateToAssistant'];
|
| ['navigateToAssistant'];
|
||||||
|
|
||||||
|
type StandaloneConfiguration = {
|
||||||
|
/** Configure the button to open the embed */
|
||||||
|
button: {
|
||||||
|
/** Label to be displayed in the button. */
|
||||||
|
label: string;
|
||||||
|
/** Icon to be displayed in the button. */
|
||||||
|
icon: 'assistant' | 'sparkle' | 'help' | 'book';
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
export type GitBookStandalone = ((...args: StandaloneCalls) => void) & {
|
export type GitBookStandalone = ((...args: StandaloneCalls) => void) & {
|
||||||
q?: StandaloneCalls[];
|
q?: StandaloneCalls[];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
let widgetIframe: HTMLIFrameElement | undefined;
|
||||||
|
let _client: GitBookClient | undefined;
|
||||||
|
let _frame: GitBookFrameClient | undefined;
|
||||||
|
let frameOptions: GetFrameURLOptions | undefined;
|
||||||
|
let frameConfiguration: GitBookEmbeddableConfiguration & StandaloneConfiguration = {
|
||||||
|
button: {
|
||||||
|
label: 'Ask',
|
||||||
|
icon: 'assistant',
|
||||||
|
},
|
||||||
|
actions: [],
|
||||||
|
greeting: { title: '', subtitle: '' },
|
||||||
|
suggestions: [],
|
||||||
|
tools: [],
|
||||||
|
tabs: ['assistant', 'docs'],
|
||||||
|
};
|
||||||
|
|
||||||
const widgetButton = document.createElement('button');
|
const widgetButton = document.createElement('button');
|
||||||
widgetButton.id = 'gitbook-widget-button';
|
widgetButton.id = 'gitbook-widget-button';
|
||||||
widgetButton.addEventListener('click', () => {
|
widgetButton.addEventListener('click', () => {
|
||||||
GitBook('toggle');
|
GitBook('toggle');
|
||||||
});
|
});
|
||||||
widgetButton.innerHTML = `
|
widgetButton.innerHTML = `
|
||||||
<span id="gitbook-widget-button-icon"></span>
|
<span id="gitbook-widget-button-icon" data-icon="${frameConfiguration.button.icon}"></span>
|
||||||
<span id="gitbook-widget-button-label">Ask</span>
|
<span id="gitbook-widget-button-label">${frameConfiguration.button.label}</span>
|
||||||
`;
|
`;
|
||||||
|
|
||||||
const widgetWindow = document.createElement('div');
|
const widgetWindow = document.createElement('div');
|
||||||
@@ -58,17 +84,6 @@ widgetWindow.classList.add('hidden');
|
|||||||
document.body.appendChild(widgetButton);
|
document.body.appendChild(widgetButton);
|
||||||
document.body.appendChild(widgetWindow);
|
document.body.appendChild(widgetWindow);
|
||||||
|
|
||||||
let widgetIframe: HTMLIFrameElement | undefined;
|
|
||||||
let _client: GitBookClient | undefined;
|
|
||||||
let _frame: GitBookFrameClient | undefined;
|
|
||||||
let frameOptions: GetFrameURLOptions | undefined;
|
|
||||||
let frameConfiguration: GitBookEmbeddableConfiguration = {
|
|
||||||
buttons: [],
|
|
||||||
welcomeMessage: '',
|
|
||||||
suggestions: [],
|
|
||||||
tools: [],
|
|
||||||
};
|
|
||||||
|
|
||||||
function getClient() {
|
function getClient() {
|
||||||
if (!_client) {
|
if (!_client) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
@@ -135,27 +150,31 @@ const GitBook = (...args: StandaloneCalls) => {
|
|||||||
case 'postUserMessage':
|
case 'postUserMessage':
|
||||||
getIframe().frame.postUserMessage(args[1]);
|
getIframe().frame.postUserMessage(args[1]);
|
||||||
break;
|
break;
|
||||||
case 'configure':
|
case 'configure': {
|
||||||
|
const settings = args[1];
|
||||||
frameConfiguration = {
|
frameConfiguration = {
|
||||||
...frameConfiguration,
|
...frameConfiguration,
|
||||||
...args[1],
|
...settings,
|
||||||
};
|
};
|
||||||
|
// Update the button label and icon
|
||||||
|
if (settings.button?.label) {
|
||||||
|
const label = widgetButton.querySelector('#gitbook-widget-button-label');
|
||||||
|
if (label) {
|
||||||
|
label.textContent = settings.button.label;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (settings.button?.icon) {
|
||||||
|
const icon = widgetButton.querySelector('#gitbook-widget-button-icon');
|
||||||
|
if (icon) {
|
||||||
|
icon.setAttribute('data-icon', settings.button.icon);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
getIframe().frame.configure({
|
getIframe().frame.configure({
|
||||||
...frameConfiguration,
|
...frameConfiguration,
|
||||||
buttons: [
|
|
||||||
...frameConfiguration.buttons,
|
|
||||||
|
|
||||||
// Always include a close button
|
|
||||||
{
|
|
||||||
icon: 'close',
|
|
||||||
label: 'Close',
|
|
||||||
onClick: () => {
|
|
||||||
GitBook('close');
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
});
|
});
|
||||||
break;
|
break;
|
||||||
|
}
|
||||||
case 'clearChat':
|
case 'clearChat':
|
||||||
getIframe().frame.clearChat();
|
getIframe().frame.clearChat();
|
||||||
break;
|
break;
|
||||||
|
|||||||
@@ -29,6 +29,16 @@
|
|||||||
--gitbook-widget-easing-bounce: cubic-bezier(0.34, 1.56, 0.64, 1);
|
--gitbook-widget-easing-bounce: cubic-bezier(0.34, 1.56, 0.64, 1);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@media (prefers-color-scheme: dark) {
|
||||||
|
:root {
|
||||||
|
--gitbook-widget-text-color: #FFFFFF;
|
||||||
|
--gitbook-widget-border-color: #202020;
|
||||||
|
--gitbook-widget-background-translucent: rgba(15, 15, 15, 0.9);
|
||||||
|
--gitbook-widget-background-translucent-hover: rgba(20, 20, 20, 0.9);
|
||||||
|
--gitbook-widget-background-solid: #f0f0f0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
* {
|
* {
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
}
|
}
|
||||||
@@ -103,6 +113,18 @@
|
|||||||
background-color: currentColor;
|
background-color: currentColor;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#gitbook-widget-button-icon[data-icon="sparkle"] {
|
||||||
|
mask-image: url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/sparkle.svg?v=2&token=a463935e93");
|
||||||
|
}
|
||||||
|
|
||||||
|
#gitbook-widget-button-icon[data-icon="help"] {
|
||||||
|
mask-image: url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/circle-question.svg?v=2&token=a463935e93");
|
||||||
|
}
|
||||||
|
|
||||||
|
#gitbook-widget-button-icon[data-icon="book"] {
|
||||||
|
mask-image: url("https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/book-open.svg?v=2&token=a463935e93");
|
||||||
|
}
|
||||||
|
|
||||||
#gitbook-widget-button.open #gitbook-widget-button-icon {
|
#gitbook-widget-button.open #gitbook-widget-button-icon {
|
||||||
mask-image: url('https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/close.svg?v=2&token=a463935e93');
|
mask-image: url('https://ka-p.fontawesome.com/releases/v6.6.0/svgs/regular/close.svg?v=2&token=a463935e93');
|
||||||
}
|
}
|
||||||
@@ -120,7 +142,8 @@
|
|||||||
z-index: 9998;
|
z-index: 9998;
|
||||||
width: calc(min(var(--gitbook-widget-window-width), calc(100vw - var(--gitbook-widget-right) - var(--gitbook-widget-left))));
|
width: calc(min(var(--gitbook-widget-window-width), calc(100vw - var(--gitbook-widget-right) - var(--gitbook-widget-left))));
|
||||||
height: calc(min(var(--gitbook-widget-window-height), calc(100vh - var(--gitbook-widget-window-bottom) - var(--gitbook-widget-top))));
|
height: calc(min(var(--gitbook-widget-window-height), calc(100vh - var(--gitbook-widget-window-bottom) - var(--gitbook-widget-top))));
|
||||||
background-color: var(--gitbook-widget-background-solid);
|
background-color: var(--gitbook-widget-background-translucent);
|
||||||
|
backdrop-filter: blur(48px);
|
||||||
border: 1px solid var(--gitbook-widget-border-color);
|
border: 1px solid var(--gitbook-widget-border-color);
|
||||||
border-radius: var(--gitbook-widget-radius);
|
border-radius: var(--gitbook-widget-radius);
|
||||||
box-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);
|
box-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);
|
||||||
|
|||||||
@@ -2,8 +2,12 @@ import { defineConfig } from 'tsdown';
|
|||||||
|
|
||||||
export default defineConfig([
|
export default defineConfig([
|
||||||
{
|
{
|
||||||
entry: ['src/index.ts', 'src/react/index.ts'],
|
entry: 'src/index.ts',
|
||||||
dts: true,
|
outDir: 'dist',
|
||||||
format: ['esm'],
|
},
|
||||||
|
{
|
||||||
|
entry: 'src/react/index.ts',
|
||||||
|
outDir: 'dist/react',
|
||||||
|
unbundle: true,
|
||||||
},
|
},
|
||||||
]);
|
]);
|
||||||
|
|||||||
@@ -1,5 +1,11 @@
|
|||||||
# @gitbook/emoji-codepoints
|
# @gitbook/emoji-codepoints
|
||||||
|
|
||||||
|
## 0.2.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
|
||||||
## 0.2.1
|
## 0.2.1
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -1,19 +1,15 @@
|
|||||||
{
|
{
|
||||||
"name": "@gitbook/emoji-codepoints",
|
"name": "@gitbook/emoji-codepoints",
|
||||||
"description": "Optimized mapping of codepoints to the fully qualified emoji codepoints",
|
"description": "Optimized mapping of codepoints to the fully qualified emoji codepoints",
|
||||||
"version": "0.2.1",
|
"version": "0.2.2",
|
||||||
"private": true,
|
"private": true,
|
||||||
"exports": "./dist/index.ts",
|
"exports": "./dist/index.ts",
|
||||||
"dependencies": {},
|
"sideEffects": false,
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"emoji-assets": "^8.0.0"
|
"emoji-assets": "^9.0.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"generate": "bun ./build.ts",
|
"generate": "bun ./build.ts",
|
||||||
"clean": "rm -rf ./dist"
|
"clean": "rm -rf ./dist"
|
||||||
},
|
|
||||||
"publishConfig": {
|
|
||||||
"access": "public",
|
|
||||||
"registry": "https://registry.npmjs.org/"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,18 @@
|
|||||||
# @gitbook/expr
|
# @gitbook/expr
|
||||||
|
|
||||||
|
## 1.2.4
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 10995e0: Use NPM Trusted publishing for publishing the package.
|
||||||
|
- 10995e0: Use NPM dependency for eval-estree-expression
|
||||||
|
|
||||||
|
## 1.2.3
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
|
||||||
## 1.2.2
|
## 1.2.2
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -1,42 +1,47 @@
|
|||||||
{
|
{
|
||||||
"name": "@gitbook/expr",
|
"name": "@gitbook/expr",
|
||||||
"description": "Safely evaluate & parse user-defined GitBook expressions.",
|
"description": "Safely evaluate & parse user-defined GitBook expressions.",
|
||||||
"version": "1.2.2",
|
"version": "1.2.4",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"import": "./dist/index.js",
|
|
||||||
"default": "./dist/index.js"
|
"default": "./dist/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"sideEffects": false,
|
"sideEffects": false,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"eval-estree-expression": "github:jonschlinkert/eval-estree-expression#9cf28d2",
|
|
||||||
"acorn": "^8.14.0",
|
"acorn": "^8.14.0",
|
||||||
"acorn-loose": "8.4.0",
|
"acorn-loose": "8.4.0",
|
||||||
"acorn-walk": "^8.3.4",
|
"acorn-walk": "^8.3.4",
|
||||||
|
"assert-never": "catalog:",
|
||||||
"escodegen": "^2.1.0",
|
"escodegen": "^2.1.0",
|
||||||
"assert-never": "^1.2.1"
|
"eval-estree-expression": "github:jonschlinkert/eval-estree-expression#fb0246a"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"bun-types": "^1.1.20",
|
"@tsconfig/strictest": "catalog:",
|
||||||
"tsdown": "catalog:",
|
"@tsconfig/node20": "catalog:",
|
||||||
|
"@types/escodegen": "^0.0.10",
|
||||||
"@types/estree": "^1.0.6",
|
"@types/estree": "^1.0.6",
|
||||||
"@babel/types": "^7.26.0",
|
|
||||||
"@types/json-schema": "^7.0.15",
|
"@types/json-schema": "^7.0.15",
|
||||||
"@types/escodegen": "^0.0.10"
|
"bun-types": "catalog:",
|
||||||
|
"tsdown": "catalog:",
|
||||||
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsdown",
|
"build": "tsdown",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"unit": "bun test",
|
"unit": "bun test",
|
||||||
"clean": "rm -rf ./dist",
|
"clean": "rm -rf ./dist",
|
||||||
"dev": "bun run build -- --watch ./src"
|
"dev": "bun run build -- --watch ./src",
|
||||||
|
"publish-to-npm": "../../scripts/publish-if-new.sh"
|
||||||
},
|
},
|
||||||
"files": ["dist", "README.md", "CHANGELOG.md"],
|
"files": ["dist", "README.md", "CHANGELOG.md"],
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GitbookIO/gitbook"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,17 @@
|
|||||||
# @gitbook/fonts
|
# @gitbook/fonts
|
||||||
|
|
||||||
|
## 0.1.3
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 10995e0: Use NPM Trusted publishing for publishing the package.
|
||||||
|
|
||||||
|
## 0.1.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
|
||||||
## 0.1.1
|
## 0.1.1
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -4,32 +4,38 @@
|
|||||||
"exports": {
|
"exports": {
|
||||||
".": {
|
".": {
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"development": "./src/index.ts",
|
|
||||||
"default": "./dist/index.js"
|
"default": "./dist/index.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "0.1.1",
|
"sideEffects": false,
|
||||||
|
"version": "0.1.3",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@gitbook/api": "catalog:"
|
"@gitbook/api": "catalog:"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"google-font-metadata": "^6.0.3",
|
"bun-types": "catalog:",
|
||||||
"typescript": "^5.5.3"
|
"google-font-metadata": "^6.0.7",
|
||||||
|
"tsdown": "catalog:",
|
||||||
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"generate": "bun ./bin/generate.js",
|
"generate": "bun ./bin/generate.js",
|
||||||
"build": "tsc --project tsconfig.build.json",
|
"build": "tsdown",
|
||||||
"typecheck": "tsc --noEmit",
|
"typecheck": "tsc --noEmit",
|
||||||
"dev": "tsc -w",
|
"dev": "bun run build -- --watch ./src",
|
||||||
"clean": "rm -rf ./dist && rm -rf ./src/data",
|
"clean": "rm -rf ./dist && rm -rf ./src/data",
|
||||||
"unit": "bun test"
|
"unit": "bun test",
|
||||||
|
"publish-to-npm": "../../scripts/publish-if-new.sh"
|
||||||
},
|
},
|
||||||
"files": ["dist", "src", "bin", "README.md", "CHANGELOG.md"],
|
"files": ["dist", "bin", "README.md", "CHANGELOG.md"],
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=20.0.0"
|
"node": ">=20.0.0"
|
||||||
},
|
},
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public",
|
"access": "public",
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GitbookIO/gitbook"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,57 +1,57 @@
|
|||||||
// Bun Snapshot v1, https://goo.gl/fbAQLP
|
// Bun Snapshot v1, https://bun.sh/docs/test/snapshots
|
||||||
|
|
||||||
exports[`getDefaultFont should return correct object for Latin text 1`] = `
|
exports[`getDefaultFont should return correct object for Latin text 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should return correct object for Cyrillic text 1`] = `
|
exports[`getDefaultFont should return correct object for Cyrillic text 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should return correct object for Greek text 1`] = `
|
exports[`getDefaultFont should return correct object for Greek text 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhjp-Ek-_0ewmM.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZxhjp-Ek-_0ewmM.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should handle mixed script text 1`] = `
|
exports[`getDefaultFont should handle mixed script text 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZthjp-Ek-_0ewmM.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should handle different font weights: regular 1`] = `
|
exports[`getDefaultFont should handle different font weights: regular 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should handle different font weights: bold 1`] = `
|
exports[`getDefaultFont should handle different font weights: bold 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuFuYAZ9hjp-Ek-_0ew.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuFuYAZ9hjp-Ek-_0ew.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should handle different fonts: inter 1`] = `
|
exports[`getDefaultFont should handle different fonts: inter 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Inter",
|
"font": "Inter",
|
||||||
"url": "https://fonts.gstatic.com/s/inter/v18/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
|
"url": "https://fonts.gstatic.com/s/inter/v20/UcCO3FwrK3iLTeHuS_nVMrMxCp50SjIw2boKoduKmMEVuLyfAZ9hjp-Ek-_0ew.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
exports[`getDefaultFont should handle different fonts: roboto 1`] = `
|
exports[`getDefaultFont should handle different fonts: roboto 1`] = `
|
||||||
{
|
{
|
||||||
"font": "Roboto",
|
"font": "Roboto",
|
||||||
"url": "https://fonts.gstatic.com/s/roboto/v32/KFOmCnqEu92Fr1Mu4mxMKTU1Kg.woff",
|
"url": "https://fonts.gstatic.com/s/roboto/v49/KFOMCnqEu92Fr1ME7kSn66aGLdTylUAMQXC89YmC2DPNWubEbVmUiAz0klQm_20.woff",
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "./tsconfig.json",
|
|
||||||
"exclude": ["node_modules", "src/**/*.test.ts"]
|
|
||||||
}
|
|
||||||
@@ -1,5 +1,80 @@
|
|||||||
# gitbook
|
# gitbook
|
||||||
|
|
||||||
|
## 0.20.0
|
||||||
|
|
||||||
|
### Minor Changes
|
||||||
|
|
||||||
|
- 1d92dc1: Update site layout and blocks with container queries and better transitions
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 8fdc5c8: Fix webframe height issue
|
||||||
|
- 9022d87: Add breadcrumbs to search results
|
||||||
|
- 0c01832: SearchInput fixes — Translate Clear button, Bold theme color, "Esc" keyboard shortcut
|
||||||
|
- 1d1f0a7: Fix search container shadow
|
||||||
|
- 2aa4f2e: Update dropdown menu styling
|
||||||
|
- a49781e: Printable collapsed code block
|
||||||
|
- 7d6a316: Revert contentref anchor title
|
||||||
|
- e27986b: Reword "Everywhere" search scope to "All docs"
|
||||||
|
- 758b34d: Move the "Ask <query>" to the bottom of search results if query is not a question
|
||||||
|
- 0ae7cfd: Improve AI Search branding
|
||||||
|
- f9f8011: Add alt text support to card covers
|
||||||
|
- ebbb476: Improve ancestor label in references
|
||||||
|
- 1b0613e: Tweak language dropdown styling
|
||||||
|
- 3355960: Fix ToggeableLinkItem display
|
||||||
|
- c31e564: Fix icon resolution for page group
|
||||||
|
- 55c0b03: Support translations and generic variants together
|
||||||
|
- 3876f70: Edgeless Assistant window on `depth: flat` sites
|
||||||
|
- 683bb8f: Add confirmation to "Copy MCP URL" page action
|
||||||
|
- 4534ea8: Implement unique title tags for sections & variants
|
||||||
|
- 6d56df7: Treat pages without visible TOC items as `no-toc`
|
||||||
|
- 8606f22: Add padding to TOC page group items
|
||||||
|
- 3676d64: Update search scope UI
|
||||||
|
- c32d449: Fix OpenAPI path display
|
||||||
|
- 8ce7322: Add OpenAPI servers selection
|
||||||
|
- 2c3066e: Improve OAuth2 scopes handling in OpenAPI
|
||||||
|
- 6b1c9fe: Fix opacity of ScrollContainer buttons on bold themes
|
||||||
|
- Updated dependencies [b4a021a]
|
||||||
|
- Updated dependencies [a512c90]
|
||||||
|
- Updated dependencies [df1966d]
|
||||||
|
- Updated dependencies [b45feaf]
|
||||||
|
- Updated dependencies [10995e0]
|
||||||
|
- Updated dependencies [f9f8011]
|
||||||
|
- Updated dependencies [10995e0]
|
||||||
|
- Updated dependencies [8ce7322]
|
||||||
|
- Updated dependencies [2c3066e]
|
||||||
|
- @gitbook/react-openapi@1.5.3
|
||||||
|
- @gitbook/openapi-parser@3.0.5
|
||||||
|
- @gitbook/react-contentkit@0.7.8
|
||||||
|
- @gitbook/browser-types@0.1.3
|
||||||
|
- @gitbook/cache-tags@0.3.4
|
||||||
|
- @gitbook/react-math@0.6.4
|
||||||
|
- @gitbook/colors@0.4.3
|
||||||
|
- @gitbook/embed@0.1.5
|
||||||
|
- @gitbook/fonts@0.1.3
|
||||||
|
- @gitbook/icons@0.3.4
|
||||||
|
- @gitbook/expr@1.2.4
|
||||||
|
|
||||||
|
## 0.19.2
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- 6142d6b: Mark as sideEffects, fix all package bundles
|
||||||
|
- 75543b1: Update minimum Node version in .npmrc
|
||||||
|
- 511f1cf: Add scroll margin to Expandable
|
||||||
|
- Updated dependencies [6142d6b]
|
||||||
|
- @gitbook/emoji-codepoints@0.2.2
|
||||||
|
- @gitbook/react-contentkit@0.7.7
|
||||||
|
- @gitbook/openapi-parser@3.0.4
|
||||||
|
- @gitbook/browser-types@0.1.2
|
||||||
|
- @gitbook/react-openapi@1.5.2
|
||||||
|
- @gitbook/cache-tags@0.3.3
|
||||||
|
- @gitbook/react-math@0.6.3
|
||||||
|
- @gitbook/colors@0.4.2
|
||||||
|
- @gitbook/fonts@0.1.2
|
||||||
|
- @gitbook/icons@0.3.3
|
||||||
|
- @gitbook/expr@1.2.3
|
||||||
|
|
||||||
## 0.19.1
|
## 0.19.1
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -112,11 +112,11 @@ const testCases: TestsCase[] = [
|
|||||||
contentBaseURL: 'https://adiblar.gitbook.io',
|
contentBaseURL: 'https://adiblar.gitbook.io',
|
||||||
tests: [{ name: 'Home', url: '/' }],
|
tests: [{ name: 'Home', url: '/' }],
|
||||||
},
|
},
|
||||||
{
|
// {
|
||||||
name: 'docs.gradient.network',
|
// name: 'docs.gradient.network',
|
||||||
contentBaseURL: 'https://docs.gradient.network',
|
// contentBaseURL: 'https://docs.gradient.network',
|
||||||
tests: [{ name: 'Home', url: '/' }],
|
// tests: [{ name: 'Home', url: '/' }],
|
||||||
},
|
// },
|
||||||
// {
|
// {
|
||||||
// name: 'mygate-network.gitbook.io',
|
// name: 'mygate-network.gitbook.io',
|
||||||
// contentBaseURL: 'https://mygate-network.gitbook.io',
|
// contentBaseURL: 'https://mygate-network.gitbook.io',
|
||||||
@@ -172,11 +172,6 @@ const testCases: TestsCase[] = [
|
|||||||
contentBaseURL: 'https://docs.realapp.link',
|
contentBaseURL: 'https://docs.realapp.link',
|
||||||
tests: [{ name: 'Home', url: '/' }],
|
tests: [{ name: 'Home', url: '/' }],
|
||||||
},
|
},
|
||||||
{
|
|
||||||
name: 'docs.plaza.finance',
|
|
||||||
contentBaseURL: 'https://docs.plaza.finance',
|
|
||||||
tests: [{ name: 'Home', url: '/' }],
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
name: 'docs.publicai.io',
|
name: 'docs.publicai.io',
|
||||||
contentBaseURL: 'https://docs.publicai.io',
|
contentBaseURL: 'https://docs.publicai.io',
|
||||||
|
|||||||
@@ -33,9 +33,35 @@ import {
|
|||||||
headerLinks,
|
headerLinks,
|
||||||
runTestCases,
|
runTestCases,
|
||||||
waitForCookiesDialog,
|
waitForCookiesDialog,
|
||||||
|
waitForCoverImages,
|
||||||
waitForNotFound,
|
waitForNotFound,
|
||||||
} from './util';
|
} from './util';
|
||||||
|
|
||||||
|
const AI_PROMPT = `You're being invoked by the GitBook CI/CD pipeline. To make screenshot testing of the GitBook Assistant visually consistent, look up the title of the first page you find and respond with only EXACTLY its title. To find the page title, invoke the search tool with the query "GitBook". Before invoking the search tool, respond with the exact text: "I'm going to look up 'GitBook' and then respond with only the page title.". Do not execute any other tools or output any other text.`;
|
||||||
|
|
||||||
|
const overrideAIInitialState = () => {
|
||||||
|
const greeting = document.querySelector('[data-testid="ai-chat-time-greeting"]');
|
||||||
|
if (greeting) {
|
||||||
|
greeting.textContent = 'Good morning';
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const overrideAIResponse = () => {
|
||||||
|
const userMessage = document.querySelector('[data-testid="ai-chat-message-user"]');
|
||||||
|
if (userMessage) {
|
||||||
|
userMessage.textContent = '[Replaced message] Chat message sent by the user';
|
||||||
|
}
|
||||||
|
const assistantMessage = document.querySelectorAll(
|
||||||
|
'[data-testid="ai-chat-message-assistant"] .ai-response-document'
|
||||||
|
);
|
||||||
|
assistantMessage.forEach((message) => {
|
||||||
|
message.innerHTML = '[Replaced message] AI chat response';
|
||||||
|
});
|
||||||
|
const suggestions = document.querySelectorAll('[data-testid="ai-chat-followup-suggestion"]');
|
||||||
|
suggestions.forEach((suggestion) => {
|
||||||
|
suggestion.textContent = 'Follow-up suggestion';
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
const searchTestCases: Test[] = [
|
const searchTestCases: Test[] = [
|
||||||
{
|
{
|
||||||
name: 'Search - AI Mode: None - Complete flow',
|
name: 'Search - AI Mode: None - Complete flow',
|
||||||
@@ -52,7 +78,9 @@ const searchTestCases: Test[] = [
|
|||||||
|
|
||||||
// Fill search input, expecting search results
|
// Fill search input, expecting search results
|
||||||
await searchInput.fill('gitbook');
|
await searchInput.fill('gitbook');
|
||||||
await expect(page.getByTestId('search-results')).toBeVisible();
|
await expect(page.getByTestId('search-results')).toBeVisible({
|
||||||
|
timeout: 10_000,
|
||||||
|
});
|
||||||
const pageResults = await page.getByTestId('search-page-result').all();
|
const pageResults = await page.getByTestId('search-page-result').all();
|
||||||
await expect(pageResults.length).toBeGreaterThanOrEqual(1);
|
await expect(pageResults.length).toBeGreaterThanOrEqual(1);
|
||||||
const pageSectionResults = await page.getByTestId('search-page-section-result').all();
|
const pageSectionResults = await page.getByTestId('search-page-section-result').all();
|
||||||
@@ -97,9 +125,6 @@ const searchTestCases: Test[] = [
|
|||||||
await expect(page.getByTestId('search-results')).toBeVisible();
|
await expect(page.getByTestId('search-results')).toBeVisible();
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
// TODO: Re-enable the following tests when we have fixed the AI Search timing out:
|
|
||||||
// - Search - AI Mode: Search - Complete flow
|
|
||||||
// - Search - AI Mode: Search - URL query (Initial)
|
|
||||||
{
|
{
|
||||||
name: 'Search - AI Mode: Search - URL query (Results)',
|
name: 'Search - AI Mode: Search - URL query (Results)',
|
||||||
url: `${getCustomizationURL({
|
url: `${getCustomizationURL({
|
||||||
@@ -107,16 +132,12 @@ const searchTestCases: Test[] = [
|
|||||||
mode: CustomizationAIMode.Search,
|
mode: CustomizationAIMode.Search,
|
||||||
},
|
},
|
||||||
})}&q=gitbook`,
|
})}&q=gitbook`,
|
||||||
screenshot: false,
|
|
||||||
run: async (page) => {
|
run: async (page) => {
|
||||||
await expect(page.getByTestId('search-input')).toBeFocused();
|
await expect(page.getByTestId('search-input')).toBeFocused();
|
||||||
await expect(page.getByTestId('search-input')).toHaveValue('gitbook');
|
await expect(page.getByTestId('search-input')).toHaveValue('gitbook');
|
||||||
await expect(page.getByTestId('search-results')).toBeVisible();
|
await expect(page.getByTestId('search-results')).toBeVisible();
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
// TODO: Re-enable the following tests when we have fixed the AI Search timing out:
|
|
||||||
// - Ask - AI Mode: Search - URL query (Ask initial)
|
|
||||||
// - Ask - AI Mode: Search - URL query (Ask results)
|
|
||||||
{
|
{
|
||||||
name: 'Ask - AI Mode: Assistant - Complete flow',
|
name: 'Ask - AI Mode: Assistant - Complete flow',
|
||||||
url: getCustomizationURL({
|
url: getCustomizationURL({
|
||||||
@@ -124,25 +145,32 @@ const searchTestCases: Test[] = [
|
|||||||
mode: CustomizationAIMode.Assistant,
|
mode: CustomizationAIMode.Assistant,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
screenshot: false,
|
|
||||||
run: async (page) => {
|
run: async (page) => {
|
||||||
const searchInput = page.locator('css=[data-testid="search-input"]');
|
const searchInput = page.locator('css=[data-testid="search-input"]');
|
||||||
|
|
||||||
// Focus search input, expecting recommended questions
|
// Focus search input, expecting recommended questions
|
||||||
await searchInput.focus();
|
await searchInput.focus();
|
||||||
// TODO: Re-enable this part of the test when we have fixed the AI Search timing out
|
await expect(page.getByTestId('search-results')).toBeVisible({
|
||||||
// await expect(page.getByTestId('search-results')).toBeVisible();
|
timeout: 30_000,
|
||||||
// const recommendedQuestions = await page
|
});
|
||||||
// .getByTestId('search-recommended-question')
|
const recommendedQuestions = await page
|
||||||
// .all();
|
.getByTestId('search-recommended-question')
|
||||||
// await expect(recommendedQuestions.length).toBeGreaterThan(2); // Expect at least 3 questions
|
.all();
|
||||||
|
await expect(recommendedQuestions.length).toBeGreaterThan(2); // Expect at least 3 questions
|
||||||
|
|
||||||
// Fill search input, expecting AI search option
|
// Fill search input, expecting AI search option
|
||||||
await searchInput.fill('What is gitbook?');
|
await searchInput.fill(AI_PROMPT);
|
||||||
const aiSearchResult = page.getByTestId('search-ask-question');
|
const aiSearchResult = page.getByTestId('search-ask-question');
|
||||||
await expect(aiSearchResult).toBeVisible();
|
await expect(aiSearchResult).toBeVisible();
|
||||||
await aiSearchResult.click();
|
await aiSearchResult.click();
|
||||||
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
||||||
|
await expect(page.getByTestId('ai-chat-message-user').first()).toHaveText(AI_PROMPT);
|
||||||
|
await expect(page.getByTestId('ai-chat-message-assistant').first()).toBeVisible();
|
||||||
|
await expect(page.getByTestId('ai-chat-followup-suggestion')).toHaveCount(3, {
|
||||||
|
timeout: 60_000,
|
||||||
|
});
|
||||||
|
// Override text content for visual consistency in screenshots
|
||||||
|
await page.evaluate(overrideAIResponse);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -152,11 +180,12 @@ const searchTestCases: Test[] = [
|
|||||||
mode: CustomizationAIMode.Assistant,
|
mode: CustomizationAIMode.Assistant,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
screenshot: false,
|
|
||||||
run: async (page) => {
|
run: async (page) => {
|
||||||
await page.keyboard.press('ControlOrMeta+I');
|
await page.keyboard.press('ControlOrMeta+I');
|
||||||
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
||||||
await expect(page.getByTestId('ai-chat-input')).toBeFocused();
|
await expect(page.getByTestId('ai-chat-input')).toBeFocused();
|
||||||
|
// Override text content for visual consistency in screenshots
|
||||||
|
await page.evaluate(overrideAIInitialState);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -171,6 +200,8 @@ const searchTestCases: Test[] = [
|
|||||||
await page.getByTestId('ai-chat-button').click();
|
await page.getByTestId('ai-chat-button').click();
|
||||||
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
||||||
await expect(page.getByTestId('ai-chat-input')).toBeFocused();
|
await expect(page.getByTestId('ai-chat-input')).toBeFocused();
|
||||||
|
// Override text content for visual consistency in screenshots
|
||||||
|
await page.evaluate(overrideAIInitialState);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -180,12 +211,13 @@ const searchTestCases: Test[] = [
|
|||||||
mode: CustomizationAIMode.Assistant,
|
mode: CustomizationAIMode.Assistant,
|
||||||
},
|
},
|
||||||
})}&ask=`,
|
})}&ask=`,
|
||||||
screenshot: false,
|
|
||||||
run: async (page) => {
|
run: async (page) => {
|
||||||
await expect(page.getByTestId('search-input')).not.toBeFocused();
|
await expect(page.getByTestId('search-input')).not.toBeFocused();
|
||||||
await expect(page.getByTestId('search-input')).not.toHaveValue('What is GitBook?');
|
await expect(page.getByTestId('search-input')).toBeEmpty();
|
||||||
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
||||||
await expect(page.getByTestId('ai-chat-input')).toBeFocused();
|
await expect(page.getByTestId('ai-chat-input')).toBeFocused();
|
||||||
|
// Override text content for visual consistency in screenshots
|
||||||
|
await page.evaluate(overrideAIInitialState);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -194,17 +226,18 @@ const searchTestCases: Test[] = [
|
|||||||
ai: {
|
ai: {
|
||||||
mode: CustomizationAIMode.Assistant,
|
mode: CustomizationAIMode.Assistant,
|
||||||
},
|
},
|
||||||
})}&ask=What+is+GitBook%3F`,
|
})}&ask=${encodeURIComponent(AI_PROMPT)}`,
|
||||||
screenshot: false,
|
|
||||||
run: async (page) => {
|
run: async (page) => {
|
||||||
await expect(page.getByTestId('search-input')).not.toBeFocused();
|
await expect(page.getByTestId('search-input')).not.toBeFocused();
|
||||||
await expect(page.getByTestId('search-input')).not.toHaveValue('What is GitBook?');
|
await expect(page.getByTestId('search-input')).not.toHaveValue('What is GitBook?');
|
||||||
await expect(page.getByTestId('ai-chat')).toBeVisible({
|
await expect(page.getByTestId('ai-chat')).toBeVisible();
|
||||||
timeout: 15_000,
|
await expect(page.getByTestId('ai-chat-message-user').first()).toHaveText(AI_PROMPT);
|
||||||
|
await expect(page.getByTestId('ai-chat-message-assistant').first()).toBeVisible();
|
||||||
|
await expect(page.getByTestId('ai-chat-followup-suggestion')).toHaveCount(3, {
|
||||||
|
timeout: 60_000,
|
||||||
});
|
});
|
||||||
await expect(page.getByTestId('ai-chat-message').first()).toHaveText(
|
// Override text content for visual consistency in screenshots
|
||||||
'What is GitBook?'
|
await page.evaluate(overrideAIResponse);
|
||||||
);
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
@@ -228,6 +261,58 @@ const testCases: TestsCase[] = [
|
|||||||
);
|
);
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: 'Expandable TOC navigation',
|
||||||
|
url: '',
|
||||||
|
run: async (page) => {
|
||||||
|
await waitForCookiesDialog(page);
|
||||||
|
|
||||||
|
// Verify "Navigation" link is not visible initially
|
||||||
|
const navigationLink = page.getByRole('link', { name: 'Navigation' });
|
||||||
|
await expect(navigationLink).not.toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the chevron element that is next to "Editor" in the TOC
|
||||||
|
// It is a span inside the link
|
||||||
|
const editorChevron = page
|
||||||
|
.getByRole('link', { name: 'Editor' })
|
||||||
|
.locator('span');
|
||||||
|
await editorChevron.click();
|
||||||
|
|
||||||
|
// Verify "Navigation" link becomes visible after expansion
|
||||||
|
await expect(navigationLink).toBeVisible();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: 'Expandable nested TOC navigation',
|
||||||
|
url: '',
|
||||||
|
screenshot: false,
|
||||||
|
run: async (page) => {
|
||||||
|
await waitForCookiesDialog(page);
|
||||||
|
|
||||||
|
// Verify "Spaces" link is not visible initially
|
||||||
|
const navigationLink = page.getByRole('link', { name: 'Spaces' });
|
||||||
|
await expect(navigationLink).not.toBeVisible();
|
||||||
|
|
||||||
|
// Find and click the chevron element that is next to "Editor" in the TOC
|
||||||
|
// It is a span inside the link
|
||||||
|
const editorChevron = page
|
||||||
|
.getByRole('link', { name: 'Editor' })
|
||||||
|
.locator('span');
|
||||||
|
await editorChevron.click();
|
||||||
|
|
||||||
|
// At this stage the link should still not be visible
|
||||||
|
await expect(navigationLink).not.toBeVisible();
|
||||||
|
|
||||||
|
// Then we click 'Content Structure' chevron to expand further
|
||||||
|
const contentStructureChevron = page
|
||||||
|
.getByRole('link', { name: 'Content Structure' })
|
||||||
|
.locator('span');
|
||||||
|
await contentStructureChevron.click();
|
||||||
|
|
||||||
|
// Verify "Spaces" link becomes visible after expansion
|
||||||
|
await expect(navigationLink).toBeVisible();
|
||||||
|
},
|
||||||
|
},
|
||||||
...searchTestCases,
|
...searchTestCases,
|
||||||
{
|
{
|
||||||
name: 'Not found',
|
name: 'Not found',
|
||||||
@@ -285,6 +370,37 @@ const testCases: TestsCase[] = [
|
|||||||
).toBeVisible();
|
).toBeVisible();
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: 'Switch variant with alternate link in metadata',
|
||||||
|
url: 'rfcs',
|
||||||
|
run: async (page) => {
|
||||||
|
const spaceDropdown = page
|
||||||
|
.locator('[data-testid="space-dropdown-button"]')
|
||||||
|
.locator('visible=true');
|
||||||
|
await spaceDropdown.click();
|
||||||
|
|
||||||
|
const variantSelectionDropdown = page.locator(
|
||||||
|
'css=[data-testid="dropdown-menu"]'
|
||||||
|
);
|
||||||
|
|
||||||
|
// Click the variant space called 'Multi-Variants' for which
|
||||||
|
// there is an alternate link in the current (RFC variant) page metadata
|
||||||
|
await variantSelectionDropdown
|
||||||
|
.getByRole('menuitem', {
|
||||||
|
name: 'Multi-Variants',
|
||||||
|
})
|
||||||
|
.click();
|
||||||
|
|
||||||
|
// It should navigate to the alternate link defined in the metadata (a completely different page)
|
||||||
|
await page.waitForURL((url) =>
|
||||||
|
url.pathname.includes('multi-variants/reference/api-reference/pets')
|
||||||
|
);
|
||||||
|
// Verify we are on the correct page by checking the h1
|
||||||
|
await expect(
|
||||||
|
page.getByRole('heading', { level: 1, name: 'Pets' })
|
||||||
|
).toBeVisible();
|
||||||
|
},
|
||||||
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -727,7 +843,10 @@ const testCases: TestsCase[] = [
|
|||||||
url: 'blocks/integrations',
|
url: 'blocks/integrations',
|
||||||
run: async (page) => {
|
run: async (page) => {
|
||||||
await waitForCookiesDialog(page);
|
await waitForCookiesDialog(page);
|
||||||
const mermaidIframe = page.locator('iframe[title*="mermaid"]').contentFrame();
|
const mermaidIframe = page
|
||||||
|
.locator('iframe[title*="mermaid"]')
|
||||||
|
.first()
|
||||||
|
.contentFrame();
|
||||||
await expect(mermaidIframe.getByText('Mermaid', { exact: true })).toBeVisible();
|
await expect(mermaidIframe.getByText('Mermaid', { exact: true })).toBeVisible();
|
||||||
await expect(mermaidIframe.getByText('Diagram', { exact: true })).toBeVisible();
|
await expect(mermaidIframe.getByText('Diagram', { exact: true })).toBeVisible();
|
||||||
},
|
},
|
||||||
@@ -793,6 +912,11 @@ const testCases: TestsCase[] = [
|
|||||||
url: 'blocks/cards',
|
url: 'blocks/cards',
|
||||||
fullPage: true,
|
fullPage: true,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: 'Updates',
|
||||||
|
url: 'blocks/updates',
|
||||||
|
fullPage: true,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: 'Math',
|
name: 'Math',
|
||||||
url: 'blocks/math',
|
url: 'blocks/math',
|
||||||
@@ -851,7 +975,10 @@ const testCases: TestsCase[] = [
|
|||||||
{
|
{
|
||||||
name: 'With cover',
|
name: 'With cover',
|
||||||
url: 'page-options/page-with-cover',
|
url: 'page-options/page-with-cover',
|
||||||
run: waitForCookiesDialog,
|
run: async (page) => {
|
||||||
|
await waitForCookiesDialog(page);
|
||||||
|
await waitForCoverImages(page);
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'With cover for dark mode',
|
name: 'With cover for dark mode',
|
||||||
@@ -866,12 +993,18 @@ const testCases: TestsCase[] = [
|
|||||||
{
|
{
|
||||||
name: 'With hero cover',
|
name: 'With hero cover',
|
||||||
url: 'page-options/page-with-hero-cover',
|
url: 'page-options/page-with-hero-cover',
|
||||||
run: waitForCookiesDialog,
|
run: async (page) => {
|
||||||
|
await waitForCookiesDialog(page);
|
||||||
|
await waitForCoverImages(page);
|
||||||
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: 'With cover and no TOC',
|
name: 'With cover and no TOC',
|
||||||
url: 'page-options/page-with-cover-and-no-toc',
|
url: 'page-options/page-with-cover-and-no-toc',
|
||||||
run: waitForCookiesDialog,
|
run: async (page) => {
|
||||||
|
await waitForCookiesDialog(page);
|
||||||
|
await waitForCoverImages(page);
|
||||||
|
},
|
||||||
screenshot: {
|
screenshot: {
|
||||||
waitForTOCScrolling: false,
|
waitForTOCScrolling: false,
|
||||||
},
|
},
|
||||||
@@ -1454,10 +1587,7 @@ const testCases: TestsCase[] = [
|
|||||||
locale,
|
locale,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
run: async (page) => {
|
run: waitForCookiesDialog,
|
||||||
const dialog = page.getByTestId('cookies-dialog');
|
|
||||||
await expect(dialog).toBeVisible();
|
|
||||||
},
|
|
||||||
})),
|
})),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -143,7 +143,10 @@ export const headerLinks: CustomizationHeaderItem[] = [
|
|||||||
|
|
||||||
export async function waitForCookiesDialog(page: Page) {
|
export async function waitForCookiesDialog(page: Page) {
|
||||||
const dialog = page.getByTestId('cookies-dialog');
|
const dialog = page.getByTestId('cookies-dialog');
|
||||||
await expect(dialog).toBeVisible();
|
await expect(dialog).toBeVisible({
|
||||||
|
// Cookies dialog may take some times to appear
|
||||||
|
timeout: 10_000,
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function waitForNotFound(_page: Page, response: Response | null) {
|
export async function waitForNotFound(_page: Page, response: Response | null) {
|
||||||
@@ -151,6 +154,13 @@ export async function waitForNotFound(_page: Page, response: Response | null) {
|
|||||||
expect(response?.status()).toBe(404);
|
expect(response?.status()).toBe(404);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export async function waitForCoverImages(page: Page) {
|
||||||
|
// Wait for cover images to exist (not the shimmer placeholder)
|
||||||
|
await expect(page.locator('img[alt="Page cover"]').first()).toBeVisible({
|
||||||
|
timeout: 10_000,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Transform test cases into Playwright tests and run it.
|
* Transform test cases into Playwright tests and run it.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -7,7 +7,8 @@ export default {
|
|||||||
converter: 'edge',
|
converter: 'edge',
|
||||||
proxyExternalRequest: 'fetch',
|
proxyExternalRequest: 'fetch',
|
||||||
queue: () => import('./openNext/queue/middleware').then((m) => m.default),
|
queue: () => import('./openNext/queue/middleware').then((m) => m.default),
|
||||||
incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
|
incrementalCache: () =>
|
||||||
|
import('./openNext/incrementalCache/server').then((m) => m.default),
|
||||||
tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
|
tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -18,7 +19,8 @@ export default {
|
|||||||
converter: 'edge',
|
converter: 'edge',
|
||||||
proxyExternalRequest: 'fetch',
|
proxyExternalRequest: 'fetch',
|
||||||
queue: () => import('./openNext/queue/middleware').then((m) => m.default),
|
queue: () => import('./openNext/queue/middleware').then((m) => m.default),
|
||||||
incrementalCache: () => import('./openNext/incrementalCache').then((m) => m.default),
|
incrementalCache: () =>
|
||||||
|
import('./openNext/incrementalCache/middleware').then((m) => m.default),
|
||||||
tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
|
tagCache: () => import('./openNext/tagCache/middleware').then((m) => m.default),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,15 +1,13 @@
|
|||||||
{
|
{
|
||||||
"main": "default.js",
|
"main": "default.js",
|
||||||
"name": "gitbook-open-v2-server",
|
"name": "gitbook-open-v2-server",
|
||||||
|
"keep_names": false,
|
||||||
"compatibility_date": "2025-04-14",
|
"compatibility_date": "2025-04-14",
|
||||||
"compatibility_flags": [
|
"compatibility_flags": [
|
||||||
"nodejs_compat",
|
"nodejs_compat",
|
||||||
"allow_importable_env",
|
"allow_importable_env",
|
||||||
"global_fetch_strictly_public"
|
"global_fetch_strictly_public"
|
||||||
],
|
],
|
||||||
"observability": {
|
|
||||||
"enabled": true
|
|
||||||
},
|
|
||||||
"vars": {
|
"vars": {
|
||||||
"NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
|
"NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -2,14 +2,12 @@
|
|||||||
"main": "do.js",
|
"main": "do.js",
|
||||||
"name": "gitbook-open-v2-do",
|
"name": "gitbook-open-v2-do",
|
||||||
"compatibility_date": "2025-04-14",
|
"compatibility_date": "2025-04-14",
|
||||||
|
"keep_names": false,
|
||||||
"compatibility_flags": [
|
"compatibility_flags": [
|
||||||
"nodejs_compat",
|
"nodejs_compat",
|
||||||
"allow_importable_env",
|
"allow_importable_env",
|
||||||
"global_fetch_strictly_public"
|
"global_fetch_strictly_public"
|
||||||
],
|
],
|
||||||
"observability": {
|
|
||||||
"enabled": true
|
|
||||||
},
|
|
||||||
"env": {
|
"env": {
|
||||||
"preview": {
|
"preview": {
|
||||||
"vars": {
|
"vars": {
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
"main": "middleware.js",
|
"main": "middleware.js",
|
||||||
"name": "gitbook-open-v2",
|
"name": "gitbook-open-v2",
|
||||||
"compatibility_date": "2025-04-14",
|
"compatibility_date": "2025-04-14",
|
||||||
|
"keep_names": false,
|
||||||
"compatibility_flags": [
|
"compatibility_flags": [
|
||||||
"nodejs_compat",
|
"nodejs_compat",
|
||||||
"allow_importable_env",
|
"allow_importable_env",
|
||||||
@@ -11,9 +12,6 @@
|
|||||||
"directory": "../../.open-next/assets",
|
"directory": "../../.open-next/assets",
|
||||||
"binding": "ASSETS"
|
"binding": "ASSETS"
|
||||||
},
|
},
|
||||||
"observability": {
|
|
||||||
"enabled": true
|
|
||||||
},
|
|
||||||
"vars": {
|
"vars": {
|
||||||
"NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
|
"NEXT_CACHE_DO_QUEUE_DISABLE_SQLITE": "true"
|
||||||
},
|
},
|
||||||
|
|||||||
+1
-12
@@ -7,8 +7,6 @@ import type {
|
|||||||
} from '@opennextjs/aws/types/overrides.js';
|
} from '@opennextjs/aws/types/overrides.js';
|
||||||
import { getCloudflareContext } from '@opennextjs/cloudflare';
|
import { getCloudflareContext } from '@opennextjs/cloudflare';
|
||||||
|
|
||||||
import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
|
|
||||||
|
|
||||||
import type { DurableObjectNamespace, Rpc } from '@cloudflare/workers-types';
|
import type { DurableObjectNamespace, Rpc } from '@cloudflare/workers-types';
|
||||||
|
|
||||||
export const BINDING_NAME = 'NEXT_INC_CACHE_R2_BUCKET';
|
export const BINDING_NAME = 'NEXT_INC_CACHE_R2_BUCKET';
|
||||||
@@ -23,7 +21,7 @@ export type KeyOptions = {
|
|||||||
* It is very similar to the `R2IncrementalCache` in the `@opennextjs/cloudflare` package, but it has an additional
|
* It is very similar to the `R2IncrementalCache` in the `@opennextjs/cloudflare` package, but it has an additional
|
||||||
* R2WriteBuffer Durable Object to handle writes to R2. Given how we set up cache, we often end up writing to the same key too fast.
|
* R2WriteBuffer Durable Object to handle writes to R2. Given how we set up cache, we often end up writing to the same key too fast.
|
||||||
*/
|
*/
|
||||||
class GitbookIncrementalCache implements IncrementalCache {
|
export class GitbookIncrementalCache implements IncrementalCache {
|
||||||
name = 'GitbookIncrementalCache';
|
name = 'GitbookIncrementalCache';
|
||||||
|
|
||||||
async get<CacheType extends CacheEntryType = 'cache'>(
|
async get<CacheType extends CacheEntryType = 'cache'>(
|
||||||
@@ -137,12 +135,3 @@ class GitbookIncrementalCache implements IncrementalCache {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export default withRegionalCache(new GitbookIncrementalCache(), {
|
|
||||||
mode: 'long-lived',
|
|
||||||
// We can do it because we use our own logic to invalidate the cache
|
|
||||||
bypassTagCacheOnCacheHit: true,
|
|
||||||
defaultLongLivedTtlSec: 60 * 60 * 24 /* 24 hours */,
|
|
||||||
// We don't want to update the cache entry on every cache hit
|
|
||||||
shouldLazilyUpdateOnCacheHit: false,
|
|
||||||
});
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
|
||||||
|
import { GitbookIncrementalCache } from './incrementalCache';
|
||||||
|
|
||||||
|
export default withRegionalCache(new GitbookIncrementalCache(), {
|
||||||
|
mode: 'long-lived',
|
||||||
|
// We can do it because we use our own logic to invalidate the cache
|
||||||
|
bypassTagCacheOnCacheHit: true,
|
||||||
|
defaultLongLivedTtlSec: 60 * 60 * 24 /* 24 hours */,
|
||||||
|
// We don't want to update the cache entry on every cache hit
|
||||||
|
shouldLazilyUpdateOnCacheHit: false,
|
||||||
|
});
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
|
||||||
|
import { GitbookIncrementalCache } from './incrementalCache';
|
||||||
|
|
||||||
|
export default withRegionalCache(new GitbookIncrementalCache(), {
|
||||||
|
mode: 'long-lived',
|
||||||
|
// Because of a race condition, the middleware may have populated the cache entry before `cache.match` had time to run on the server.
|
||||||
|
// TODO: We should bypass the incremental cache entirely when the interceptor has caught the request. Should be done in OpenNext.
|
||||||
|
bypassTagCacheOnCacheHit: false,
|
||||||
|
defaultLongLivedTtlSec: 60 * 60 * 24 /* 24 hours */,
|
||||||
|
// We don't want to update the cache entry on every cache hit
|
||||||
|
shouldLazilyUpdateOnCacheHit: false,
|
||||||
|
});
|
||||||
@@ -1,12 +1,14 @@
|
|||||||
{
|
{
|
||||||
"name": "gitbook",
|
"name": "gitbook",
|
||||||
"version": "0.19.1",
|
"version": "0.20.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@cloudflare/workers-types": "^4.20251011.0",
|
||||||
"@gitbook/api": "catalog:",
|
"@gitbook/api": "catalog:",
|
||||||
"@gitbook/browser-types": "workspace:*",
|
"@gitbook/browser-types": "workspace:*",
|
||||||
"@gitbook/cache-tags": "workspace:*",
|
"@gitbook/cache-tags": "workspace:*",
|
||||||
"@gitbook/colors": "workspace:*",
|
"@gitbook/colors": "workspace:*",
|
||||||
|
"@gitbook/embed": "workspace:*",
|
||||||
"@gitbook/emoji-codepoints": "workspace:*",
|
"@gitbook/emoji-codepoints": "workspace:*",
|
||||||
"@gitbook/expr": "workspace:*",
|
"@gitbook/expr": "workspace:*",
|
||||||
"@gitbook/fonts": "workspace:*",
|
"@gitbook/fonts": "workspace:*",
|
||||||
@@ -15,8 +17,9 @@
|
|||||||
"@gitbook/react-contentkit": "workspace:*",
|
"@gitbook/react-contentkit": "workspace:*",
|
||||||
"@gitbook/react-math": "workspace:*",
|
"@gitbook/react-math": "workspace:*",
|
||||||
"@gitbook/react-openapi": "workspace:*",
|
"@gitbook/react-openapi": "workspace:*",
|
||||||
"@modelcontextprotocol/sdk": "^1.17.5",
|
"@modelcontextprotocol/sdk": "1.17.5",
|
||||||
"@opennextjs/cloudflare": "^1.9.2",
|
"@opennextjs/aws": "^3.8.5",
|
||||||
|
"@opennextjs/cloudflare": "^1.11.0",
|
||||||
"@radix-ui/react-checkbox": "^1.0.4",
|
"@radix-ui/react-checkbox": "^1.0.4",
|
||||||
"@radix-ui/react-dropdown-menu": "^2.1.12",
|
"@radix-ui/react-dropdown-menu": "^2.1.12",
|
||||||
"@radix-ui/react-hover-card": "^1.1.15",
|
"@radix-ui/react-hover-card": "^1.1.15",
|
||||||
@@ -28,19 +31,16 @@
|
|||||||
"@tailwindcss/typography": "^0.5.16",
|
"@tailwindcss/typography": "^0.5.16",
|
||||||
"@tusbar/cache-control": "^1.0.2",
|
"@tusbar/cache-control": "^1.0.2",
|
||||||
"ai": "^4.2.2",
|
"ai": "^4.2.2",
|
||||||
"assert-never": "^1.2.1",
|
"assert-never": "catalog:",
|
||||||
"bidc": "catalog:",
|
"bidc": "catalog:",
|
||||||
"bun-types": "^1.1.20",
|
"classnames": "catalog:",
|
||||||
"classnames": "^2.5.1",
|
|
||||||
"direction": "^2.0.1",
|
"direction": "^2.0.1",
|
||||||
"event-iterator": "^2.0.0",
|
"event-iterator": "^2.0.0",
|
||||||
"framer-motion": "^10.16.14",
|
"feed": "^5.1.0",
|
||||||
"image-size": "^2.0.2",
|
"image-size": "^2.0.2",
|
||||||
"js-cookie": "^3.0.5",
|
"js-cookie": "^3.0.5",
|
||||||
"jsontoxml": "^1.0.1",
|
"jsontoxml": "^1.0.1",
|
||||||
"jwt-decode": "^4.0.0",
|
"jwt-decode": "^4.0.0",
|
||||||
"katex": "^0.16.9",
|
|
||||||
"mathjax": "^3.2.2",
|
|
||||||
"mcp-handler": "^1.0.2",
|
"mcp-handler": "^1.0.2",
|
||||||
"mdast-util-from-markdown": "^2.0.2",
|
"mdast-util-from-markdown": "^2.0.2",
|
||||||
"mdast-util-frontmatter": "^2.0.1",
|
"mdast-util-frontmatter": "^2.0.1",
|
||||||
@@ -49,7 +49,7 @@
|
|||||||
"memoizee": "^0.4.17",
|
"memoizee": "^0.4.17",
|
||||||
"micromark-extension-frontmatter": "^2.0.0",
|
"micromark-extension-frontmatter": "^2.0.0",
|
||||||
"micromark-extension-gfm": "^3.0.0",
|
"micromark-extension-gfm": "^3.0.0",
|
||||||
"motion": "^12.23.12",
|
"motion": "^12.23.24",
|
||||||
"next": "15.4.0",
|
"next": "15.4.0",
|
||||||
"next-themes": "^0.4.6",
|
"next-themes": "^0.4.6",
|
||||||
"nuqs": "^2.2.3",
|
"nuqs": "^2.2.3",
|
||||||
@@ -58,6 +58,8 @@
|
|||||||
"openapi-types": "^12.1.3",
|
"openapi-types": "^12.1.3",
|
||||||
"p-map": "^7.0.3",
|
"p-map": "^7.0.3",
|
||||||
"quick-lru": "^7.0.1",
|
"quick-lru": "^7.0.1",
|
||||||
|
"react": "catalog:",
|
||||||
|
"react-dom": "catalog:",
|
||||||
"react-hotkeys-hook": "^4.4.1",
|
"react-hotkeys-hook": "^4.4.1",
|
||||||
"rehype-sanitize": "^6.0.0",
|
"rehype-sanitize": "^6.0.0",
|
||||||
"rehype-stringify": "^10.0.1",
|
"rehype-stringify": "^10.0.1",
|
||||||
@@ -73,7 +75,7 @@
|
|||||||
"unist-util-remove": "^4.0.0",
|
"unist-util-remove": "^4.0.0",
|
||||||
"unist-util-visit": "^5.0.0",
|
"unist-util-visit": "^5.0.0",
|
||||||
"url-join": "^5.0.0",
|
"url-join": "^5.0.0",
|
||||||
"usehooks-ts": "^3.1.0",
|
"usehooks-ts": "catalog:",
|
||||||
"warn-once": "^0.1.1",
|
"warn-once": "^0.1.1",
|
||||||
"zod": "^3",
|
"zod": "^3",
|
||||||
"zustand": "^5.0.3"
|
"zustand": "^5.0.3"
|
||||||
@@ -81,6 +83,7 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@argos-ci/playwright": "^5.0.9",
|
"@argos-ci/playwright": "^5.0.9",
|
||||||
"@playwright/test": "^1.54.2",
|
"@playwright/test": "^1.54.2",
|
||||||
|
"@scalar/api-client-react": "catalog:",
|
||||||
"@tailwindcss/postcss": "^4.1.11",
|
"@tailwindcss/postcss": "^4.1.11",
|
||||||
"@types/js-cookie": "^3.0.6",
|
"@types/js-cookie": "^3.0.6",
|
||||||
"@types/jsontoxml": "^1.0.5",
|
"@types/jsontoxml": "^1.0.5",
|
||||||
@@ -89,9 +92,10 @@
|
|||||||
"@types/node": "^20",
|
"@types/node": "^20",
|
||||||
"@types/object-hash": "^3.0.6",
|
"@types/object-hash": "^3.0.6",
|
||||||
"@types/parse-cache-control": "^1.0.4",
|
"@types/parse-cache-control": "^1.0.4",
|
||||||
"@types/react": "18.3.13",
|
"@types/react": "catalog:",
|
||||||
"@types/react-dom": "18.3.1",
|
"@types/react-dom": "catalog:",
|
||||||
"@types/rison": "^0.0.9",
|
"@types/rison": "^0.0.9",
|
||||||
|
"bun-types": "catalog:",
|
||||||
"deepmerge": "^4.3.1",
|
"deepmerge": "^4.3.1",
|
||||||
"env-cmd": "^10.1.0",
|
"env-cmd": "^10.1.0",
|
||||||
"jsonwebtoken": "^9.0.2",
|
"jsonwebtoken": "^9.0.2",
|
||||||
@@ -99,8 +103,10 @@
|
|||||||
"stylelint": "^16.16.0",
|
"stylelint": "^16.16.0",
|
||||||
"tailwindcss": "^4.1.11",
|
"tailwindcss": "^4.1.11",
|
||||||
"ts-essentials": "^10.0.1",
|
"ts-essentials": "^10.0.1",
|
||||||
"typescript": "^5.5.3",
|
"typescript": "catalog:",
|
||||||
"vercel": "^39.3.0"
|
"vercel": "^39.3.0",
|
||||||
|
"wrangler": "^4.43.0",
|
||||||
|
"rss-parser": "^3.13.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"generate": "./scripts/generate.sh",
|
"generate": "./scripts/generate.sh",
|
||||||
|
|||||||
+5
-1
@@ -22,7 +22,11 @@ export default async function SiteDynamicLayout({
|
|||||||
const withTracking = shouldTrackEvents(await headers());
|
const withTracking = shouldTrackEvents(await headers());
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<CustomizationRootLayout forcedTheme={forcedTheme} context={context}>
|
<CustomizationRootLayout
|
||||||
|
className="site-background"
|
||||||
|
forcedTheme={forcedTheme}
|
||||||
|
context={context}
|
||||||
|
>
|
||||||
<SiteLayout
|
<SiteLayout
|
||||||
context={context}
|
context={context}
|
||||||
forcedTheme={forcedTheme}
|
forcedTheme={forcedTheme}
|
||||||
|
|||||||
+15
-3
@@ -1,16 +1,28 @@
|
|||||||
import type { RouteLayoutParams } from '@/app/utils';
|
import type { RouteLayoutParams } from '@/app/utils';
|
||||||
import { EmbeddableAssistantPage } from '@/components/Embeddable';
|
import { EmbeddableAssistantPage } from '@/components/Embeddable';
|
||||||
import { getEmbeddableDynamicContext } from '@/lib/embeddable';
|
import { getEmbeddableDynamicContext } from '@/lib/embeddable';
|
||||||
|
import { CustomizationAIMode } from '@gitbook/api';
|
||||||
export const dynamic = 'force-static';
|
import { redirect } from 'next/navigation';
|
||||||
|
|
||||||
type PageProps = {
|
type PageProps = {
|
||||||
params: Promise<RouteLayoutParams>;
|
params: Promise<RouteLayoutParams>;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const dynamic = 'force-static';
|
||||||
|
|
||||||
export default async function Page(props: PageProps) {
|
export default async function Page(props: PageProps) {
|
||||||
const params = await props.params;
|
const params = await props.params;
|
||||||
const { context } = await getEmbeddableDynamicContext(params);
|
const { context } = await getEmbeddableDynamicContext(params);
|
||||||
|
|
||||||
return <EmbeddableAssistantPage context={context} />;
|
// If the assistant is not enabled, redirect to the docs
|
||||||
|
if (context.customization.ai.mode !== CustomizationAIMode.Assistant) {
|
||||||
|
redirect(`${context.linker.toPathInSite('~gitbook/embed/page/')}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<EmbeddableAssistantPage
|
||||||
|
baseURL={context.linker.toPathInSite('~gitbook/embed/')}
|
||||||
|
siteTitle={context.site.title}
|
||||||
|
/>
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
+21
@@ -0,0 +1,21 @@
|
|||||||
|
import type { RouteLayoutParams } from '@/app/utils';
|
||||||
|
import { getEmbeddableDynamicContext } from '@/lib/embeddable';
|
||||||
|
import { CustomizationAIMode } from '@gitbook/api';
|
||||||
|
import { redirect } from 'next/navigation';
|
||||||
|
|
||||||
|
type PageProps = {
|
||||||
|
params: Promise<RouteLayoutParams>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default async function Page(props: PageProps) {
|
||||||
|
const params = await props.params;
|
||||||
|
const { context } = await getEmbeddableDynamicContext(params);
|
||||||
|
const baseURL = context.linker.toPathInSite('~gitbook/embed/');
|
||||||
|
|
||||||
|
// If assistant is enabled, redirect to assistant, otherwise to docs
|
||||||
|
if (context.customization.ai.mode === CustomizationAIMode.Assistant) {
|
||||||
|
redirect(`${baseURL}/assistant`);
|
||||||
|
} else {
|
||||||
|
redirect(`${baseURL}/page/`);
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -19,7 +19,7 @@ export default async function SiteStaticLayout({
|
|||||||
const withTracking = shouldTrackEvents();
|
const withTracking = shouldTrackEvents();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<CustomizationRootLayout context={context}>
|
<CustomizationRootLayout className="site-background" context={context}>
|
||||||
<SiteLayout
|
<SiteLayout
|
||||||
context={context}
|
context={context}
|
||||||
withTracking={withTracking}
|
withTracking={withTracking}
|
||||||
|
|||||||
+15
-3
@@ -1,16 +1,28 @@
|
|||||||
import type { RouteLayoutParams } from '@/app/utils';
|
import type { RouteParams } from '@/app/utils';
|
||||||
import { EmbeddableAssistantPage } from '@/components/Embeddable';
|
import { EmbeddableAssistantPage } from '@/components/Embeddable';
|
||||||
import { getEmbeddableStaticContext } from '@/lib/embeddable';
|
import { getEmbeddableStaticContext } from '@/lib/embeddable';
|
||||||
|
import { CustomizationAIMode } from '@gitbook/api';
|
||||||
|
import { redirect } from 'next/navigation';
|
||||||
|
|
||||||
export const dynamic = 'force-static';
|
export const dynamic = 'force-static';
|
||||||
|
|
||||||
type PageProps = {
|
type PageProps = {
|
||||||
params: Promise<RouteLayoutParams>;
|
params: Promise<RouteParams>;
|
||||||
};
|
};
|
||||||
|
|
||||||
export default async function Page(props: PageProps) {
|
export default async function Page(props: PageProps) {
|
||||||
const params = await props.params;
|
const params = await props.params;
|
||||||
const { context } = await getEmbeddableStaticContext(params);
|
const { context } = await getEmbeddableStaticContext(params);
|
||||||
|
|
||||||
return <EmbeddableAssistantPage context={context} />;
|
// If the assistant is not enabled, redirect to the docs
|
||||||
|
if (context.customization.ai.mode !== CustomizationAIMode.Assistant) {
|
||||||
|
redirect(`${context.linker.toPathInSite('~gitbook/embed/page/')}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<EmbeddableAssistantPage
|
||||||
|
baseURL={context.linker.toPathInSite('~gitbook/embed/')}
|
||||||
|
siteTitle={context.site.title}
|
||||||
|
/>
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
+23
@@ -0,0 +1,23 @@
|
|||||||
|
import type { RouteLayoutParams } from '@/app/utils';
|
||||||
|
import { getEmbeddableStaticContext } from '@/lib/embeddable';
|
||||||
|
import { CustomizationAIMode } from '@gitbook/api';
|
||||||
|
import { redirect } from 'next/navigation';
|
||||||
|
|
||||||
|
export const dynamic = 'force-static';
|
||||||
|
|
||||||
|
type PageProps = {
|
||||||
|
params: Promise<RouteLayoutParams>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default async function Page(props: PageProps) {
|
||||||
|
const params = await props.params;
|
||||||
|
const { context } = await getEmbeddableStaticContext(params);
|
||||||
|
const baseURL = context.linker.toPathInSite('~gitbook/embed/');
|
||||||
|
|
||||||
|
// If assistant is enabled, redirect to assistant, otherwise to docs
|
||||||
|
if (context.customization.ai.mode === CustomizationAIMode.Assistant) {
|
||||||
|
redirect(`${baseURL}/assistant`);
|
||||||
|
} else {
|
||||||
|
redirect(`${baseURL}/page/`);
|
||||||
|
}
|
||||||
|
}
|
||||||
+9
-1
@@ -7,6 +7,14 @@ import type { NextRequest } from 'next/server';
|
|||||||
|
|
||||||
export const dynamic = 'force-static';
|
export const dynamic = 'force-static';
|
||||||
|
|
||||||
|
const EMBEDDABLE_RESPONSE_HEADERS = {
|
||||||
|
'Access-Control-Allow-Origin': '*',
|
||||||
|
'Access-Control-Allow-Methods': 'GET, OPTIONS',
|
||||||
|
'Access-Control-Allow-Headers': '*',
|
||||||
|
'Cross-Origin-Resource-Policy': 'cross-origin',
|
||||||
|
'Cache-Control': 'public, s-maxage=86400, stale-while-revalidate=604800',
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This route is used to serve the assistant.js script.
|
* This route is used to serve the assistant.js script.
|
||||||
*/
|
*/
|
||||||
@@ -69,8 +77,8 @@ export async function GET(
|
|||||||
`,
|
`,
|
||||||
{
|
{
|
||||||
headers: {
|
headers: {
|
||||||
|
...EMBEDDABLE_RESPONSE_HEADERS,
|
||||||
'Content-Type': 'application/javascript',
|
'Content-Type': 'application/javascript',
|
||||||
'Cache-Control': 'public, max-age=86400, stale-while-revalidate=604800',
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
import { type RouteParams, getPagePathFromParams, getStaticSiteContext } from '@/app/utils';
|
||||||
|
import { servePageRSS } from '@/routes/rss';
|
||||||
|
import type { NextRequest } from 'next/server';
|
||||||
|
|
||||||
|
export const dynamic = 'force-static';
|
||||||
|
|
||||||
|
export async function GET(_request: NextRequest, { params }: { params: Promise<RouteParams> }) {
|
||||||
|
const { context } = await getStaticSiteContext(await params);
|
||||||
|
const pathname = getPagePathFromParams(await params);
|
||||||
|
|
||||||
|
return servePageRSS(context, pathname);
|
||||||
|
}
|
||||||
@@ -16,14 +16,14 @@ export function AIMessageView(
|
|||||||
) {
|
) {
|
||||||
const { message, context, withToolCalls = true, withLinkPreviews = true } = props;
|
const { message, context, withToolCalls = true, withLinkPreviews = true } = props;
|
||||||
|
|
||||||
return (
|
return message.steps.length > 0 ? (
|
||||||
<div className="flex flex-col gap-2">
|
<div className="flex flex-col gap-2">
|
||||||
{message.steps.map((step, index) => {
|
{message.steps.map((step, index) => {
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
key={index}
|
key={index}
|
||||||
className={tcls(
|
className={tcls(
|
||||||
'flex animate-fade-in-slow flex-col gap-2',
|
'flex flex-col gap-2',
|
||||||
step.content.nodes.length > 0 ? 'has-content' : ''
|
step.content.nodes.length > 0 ? 'has-content' : ''
|
||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
@@ -35,7 +35,7 @@ export function AIMessageView(
|
|||||||
wrapBlocksInSuspense: false,
|
wrapBlocksInSuspense: false,
|
||||||
withLinkPreviews,
|
withLinkPreviews,
|
||||||
}}
|
}}
|
||||||
style="mt-2 space-y-4 empty:hidden"
|
style="ai-response-document mt-2 space-y-4 *:origin-top-left *:animate-blur-in-slow"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
{withToolCalls && step.toolCalls && step.toolCalls.length > 0 ? (
|
{withToolCalls && step.toolCalls && step.toolCalls.length > 0 ? (
|
||||||
@@ -45,5 +45,5 @@ export function AIMessageView(
|
|||||||
);
|
);
|
||||||
})}
|
})}
|
||||||
</div>
|
</div>
|
||||||
);
|
) : null;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ function ToolCallSummary(props: { toolCall: AIToolCall; context: GitBookSiteCont
|
|||||||
const { toolCall, context } = props;
|
const { toolCall, context } = props;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex origin-left animate-scale-in-slow items-start gap-2 text-sm text-tint-subtle">
|
<div className="mt-2 flex origin-top-left animate-blur-in-slow items-start gap-2 text-sm text-tint-subtle">
|
||||||
<Icon
|
<Icon
|
||||||
icon={getIconForToolCall(toolCall)}
|
icon={getIconForToolCall(toolCall)}
|
||||||
className="mt-1 size-3 shrink-0 text-tint-subtle/8"
|
className="mt-1 size-3 shrink-0 text-tint-subtle/8"
|
||||||
@@ -160,7 +160,7 @@ async function DescriptionForSearchToolCall(props: {
|
|||||||
const hasResults = toolCall.results.length > 0;
|
const hasResults = toolCall.results.length > 0;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<details className={tcls('-ml-5 group flex w-full flex-col', hasResults ? 'gap-2' : '')}>
|
<details className="-ml-5 group flex w-full flex-col">
|
||||||
<summary
|
<summary
|
||||||
className={tcls(
|
className={tcls(
|
||||||
'-mx-2 flex list-none items-center gap-2 circular-corners:rounded-2xl rounded-corners:rounded-md pr-4 pl-7 transition-colors marker:hidden',
|
'-mx-2 flex list-none items-center gap-2 circular-corners:rounded-2xl rounded-corners:rounded-md pr-4 pl-7 transition-colors marker:hidden',
|
||||||
@@ -187,7 +187,7 @@ async function DescriptionForSearchToolCall(props: {
|
|||||||
) : null}
|
) : null}
|
||||||
</summary>
|
</summary>
|
||||||
{hasResults ? (
|
{hasResults ? (
|
||||||
<div className="hide-scrollbar mt-1 max-h-0 overflow-y-auto circular-corners:rounded-2xl rounded-corners:rounded-lg border border-tint-subtle p-2 opacity-0 transition-all transition-discrete duration-500 group-open:max-h-96 group-open:opacity-11">
|
<div className="hide-scrollbar mt-4 max-h-0 overflow-y-auto circular-corners:rounded-2xl rounded-corners:rounded-lg border border-tint-subtle p-2 opacity-0 transition-all transition-discrete duration-500 group-open:max-h-96 group-open:opacity-11">
|
||||||
<ol className="space-y-1">
|
<ol className="space-y-1">
|
||||||
{searchResultsWithHrefs.map((result, index) => (
|
{searchResultsWithHrefs.map((result, index) => (
|
||||||
<li
|
<li
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
'use client';
|
'use client';
|
||||||
|
|
||||||
import { CustomizationAIMode } from '@gitbook/api';
|
import { CustomizationAIMode } from '@gitbook/api';
|
||||||
import { Icon, type IconName, IconStyle } from '@gitbook/icons';
|
import { Icon, type IconName } from '@gitbook/icons';
|
||||||
import * as React from 'react';
|
import * as React from 'react';
|
||||||
import type { ReactNode } from 'react';
|
import type { ReactNode } from 'react';
|
||||||
|
|
||||||
import { tString, useLanguage } from '@/intl/client';
|
import { tString, useLanguage } from '@/intl/client';
|
||||||
import type { GitBookAssistant } from '@gitbook/browser-types';
|
import type { GitBookAssistant } from '@gitbook/browser-types';
|
||||||
import { useAIChatController, useAIChatState } from '.';
|
import { useAIChatController, useAIChatState } from '.';
|
||||||
import { AIChatIcon, getAIChatName } from '../AIChat';
|
import { AIChatIcon, AISearchIcon, getAIChatName } from '../AIChat';
|
||||||
import { useIntegrationAssistants } from '../Integrations';
|
import { useIntegrationAssistants } from '../Integrations';
|
||||||
import { useSearch } from '../Search/useSearch';
|
import { useSearch } from '../Search/useSearch';
|
||||||
|
|
||||||
@@ -88,6 +88,7 @@ export function useAI(): AIContext {
|
|||||||
<AIChatIcon
|
<AIChatIcon
|
||||||
state={chat.loading ? 'thinking' : 'default'}
|
state={chat.loading ? 'thinking' : 'default'}
|
||||||
trademark={config.trademark}
|
trademark={config.trademark}
|
||||||
|
className="size-4"
|
||||||
/>
|
/>
|
||||||
),
|
),
|
||||||
open: (query?: string) => {
|
open: (query?: string) => {
|
||||||
@@ -104,16 +105,7 @@ export function useAI(): AIContext {
|
|||||||
assistants.push({
|
assistants.push({
|
||||||
id: 'gitbook-ai-search',
|
id: 'gitbook-ai-search',
|
||||||
label: tString(language, 'ai_chat_context_badge'),
|
label: tString(language, 'ai_chat_context_badge'),
|
||||||
icon: (
|
icon: <AISearchIcon />,
|
||||||
<div className="relative">
|
|
||||||
<Icon icon="search" className="size-4" />
|
|
||||||
<Icon
|
|
||||||
icon="sparkle"
|
|
||||||
iconStyle={IconStyle.Solid}
|
|
||||||
className="absolute top-[2.5px] left-[2.6px] size-2"
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
),
|
|
||||||
open: (query?: string) => {
|
open: (query?: string) => {
|
||||||
if (query) {
|
if (query) {
|
||||||
setSearchState((prev) =>
|
setSearchState((prev) =>
|
||||||
|
|||||||
@@ -87,6 +87,19 @@ export type AIChatState = {
|
|||||||
error: boolean;
|
error: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type AIChatEvent =
|
||||||
|
| { type: 'open' }
|
||||||
|
| { type: 'postMessage'; message: string }
|
||||||
|
| { type: 'clear' }
|
||||||
|
| { type: 'close' };
|
||||||
|
|
||||||
|
type AIChatEventData<T extends AIChatEvent['type']> = Omit<
|
||||||
|
Extract<AIChatEvent, { type: T }>,
|
||||||
|
'type'
|
||||||
|
>;
|
||||||
|
|
||||||
|
type AIChatEventListener = (input?: Omit<AIChatEvent, 'type'>) => void;
|
||||||
|
|
||||||
export type AIChatController = {
|
export type AIChatController = {
|
||||||
/** Open the dialog */
|
/** Open the dialog */
|
||||||
open: () => void;
|
open: () => void;
|
||||||
@@ -96,6 +109,11 @@ export type AIChatController = {
|
|||||||
postMessage: (input: { message: string }) => void;
|
postMessage: (input: { message: string }) => void;
|
||||||
/** Clear the conversation */
|
/** Clear the conversation */
|
||||||
clear: () => void;
|
clear: () => void;
|
||||||
|
/** Register an event listener */
|
||||||
|
on: <T extends AIChatEvent['type']>(
|
||||||
|
event: T,
|
||||||
|
listener: (input?: AIChatEventData<T>) => void
|
||||||
|
) => () => void;
|
||||||
};
|
};
|
||||||
|
|
||||||
const AIChatControllerContext = React.createContext<AIChatController | null>(null);
|
const AIChatControllerContext = React.createContext<AIChatController | null>(null);
|
||||||
@@ -123,6 +141,17 @@ export function useAIChatState(): AIChatState {
|
|||||||
return state;
|
return state;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function notify(
|
||||||
|
listeners: AIChatEventListener[] | undefined,
|
||||||
|
input: Omit<AIChatEvent, 'type'>
|
||||||
|
): void {
|
||||||
|
if (!listeners) return;
|
||||||
|
// Defer event listeners to next tick so React can process state updates first
|
||||||
|
setTimeout(() => {
|
||||||
|
listeners.forEach((listener) => listener(input));
|
||||||
|
}, 0);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provide the controller to interact with the AI chat.
|
* Provide the controller to interact with the AI chat.
|
||||||
*/
|
*/
|
||||||
@@ -137,6 +166,9 @@ export function AIChatProvider(props: {
|
|||||||
const [, setSearchState] = useSearch();
|
const [, setSearchState] = useSearch();
|
||||||
const language = useLanguage();
|
const language = useLanguage();
|
||||||
|
|
||||||
|
// Event listeners storage
|
||||||
|
const eventsRef = React.useRef<Map<AIChatEvent['type'], AIChatEventListener[]>>(new Map());
|
||||||
|
|
||||||
// Open AI chat and sync with search state
|
// Open AI chat and sync with search state
|
||||||
const onOpen = React.useCallback(() => {
|
const onOpen = React.useCallback(() => {
|
||||||
const { initialQuery } = globalState.getState();
|
const { initialQuery } = globalState.getState();
|
||||||
@@ -149,6 +181,8 @@ export function AIChatProvider(props: {
|
|||||||
scope: prev?.scope ?? 'default',
|
scope: prev?.scope ?? 'default',
|
||||||
open: false, // Close search popover when opening chat
|
open: false, // Close search popover when opening chat
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
notify(eventsRef.current.get('open'), {});
|
||||||
}, [setSearchState]);
|
}, [setSearchState]);
|
||||||
|
|
||||||
// Close AI chat and clear ask parameter
|
// Close AI chat and clear ask parameter
|
||||||
@@ -162,6 +196,8 @@ export function AIChatProvider(props: {
|
|||||||
scope: prev?.scope ?? 'default',
|
scope: prev?.scope ?? 'default',
|
||||||
open: false,
|
open: false,
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
notify(eventsRef.current.get('close'), {});
|
||||||
}, [setSearchState]);
|
}, [setSearchState]);
|
||||||
|
|
||||||
// Stream a message with the AI backend
|
// Stream a message with the AI backend
|
||||||
@@ -379,8 +415,14 @@ export function AIChatProvider(props: {
|
|||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
notify(eventsRef.current.get('postMessage'), { message: input.message });
|
||||||
|
|
||||||
if (query === input.message) {
|
if (query === input.message) {
|
||||||
// Return early if the message is the same as the previous message
|
// Return early if the message is the same as the previous message
|
||||||
|
globalState.setState((state) => ({
|
||||||
|
...state,
|
||||||
|
opened: true,
|
||||||
|
}));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -440,14 +482,34 @@ export function AIChatProvider(props: {
|
|||||||
}));
|
}));
|
||||||
}, [setSearchState]);
|
}, [setSearchState]);
|
||||||
|
|
||||||
|
const onEvent = React.useCallback(
|
||||||
|
<T extends AIChatEvent['type']>(
|
||||||
|
event: T,
|
||||||
|
listener: (input?: AIChatEventData<T>) => void
|
||||||
|
) => {
|
||||||
|
const listeners = eventsRef.current.get(event) || [];
|
||||||
|
listeners.push(listener as AIChatEventListener);
|
||||||
|
eventsRef.current.set(event, listeners);
|
||||||
|
return () => {
|
||||||
|
const currentListeners = eventsRef.current.get(event) || [];
|
||||||
|
eventsRef.current.set(
|
||||||
|
event,
|
||||||
|
currentListeners.filter((l) => l !== listener)
|
||||||
|
);
|
||||||
|
};
|
||||||
|
},
|
||||||
|
[]
|
||||||
|
);
|
||||||
|
|
||||||
const controller = React.useMemo(() => {
|
const controller = React.useMemo(() => {
|
||||||
return {
|
return {
|
||||||
open: onOpen,
|
open: onOpen,
|
||||||
close: onClose,
|
close: onClose,
|
||||||
clear: onClear,
|
clear: onClear,
|
||||||
postMessage: onPostMessage,
|
postMessage: onPostMessage,
|
||||||
|
on: onEvent,
|
||||||
};
|
};
|
||||||
}, [onOpen, onClose, onClear, onPostMessage]);
|
}, [onOpen, onClose, onClear, onPostMessage, onEvent]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<AIChatControllerContext.Provider value={controller}>
|
<AIChatControllerContext.Provider value={controller}>
|
||||||
|
|||||||
@@ -2,12 +2,14 @@
|
|||||||
|
|
||||||
import { t, tString, useLanguage } from '@/intl/client';
|
import { t, tString, useLanguage } from '@/intl/client';
|
||||||
import type { TranslationLanguage } from '@/intl/translations';
|
import type { TranslationLanguage } from '@/intl/translations';
|
||||||
|
import { tcls } from '@/lib/tailwind';
|
||||||
import { Icon } from '@gitbook/icons';
|
import { Icon } from '@gitbook/icons';
|
||||||
import React from 'react';
|
import React from 'react';
|
||||||
import { useHotkeys } from 'react-hotkeys-hook';
|
import { useHotkeys } from 'react-hotkeys-hook';
|
||||||
import {
|
import {
|
||||||
type AIChatController,
|
type AIChatController,
|
||||||
type AIChatState,
|
type AIChatState,
|
||||||
|
useAI,
|
||||||
useAIChatController,
|
useAIChatController,
|
||||||
useAIChatState,
|
useAIChatState,
|
||||||
} from '../AI';
|
} from '../AI';
|
||||||
@@ -17,21 +19,22 @@ import {
|
|||||||
EmbeddableFrameButtons,
|
EmbeddableFrameButtons,
|
||||||
EmbeddableFrameHeader,
|
EmbeddableFrameHeader,
|
||||||
EmbeddableFrameHeaderMain,
|
EmbeddableFrameHeaderMain,
|
||||||
|
EmbeddableFrameMain,
|
||||||
EmbeddableFrameSubtitle,
|
EmbeddableFrameSubtitle,
|
||||||
EmbeddableFrameTitle,
|
EmbeddableFrameTitle,
|
||||||
} from '../Embeddable/EmbeddableFrame';
|
} from '../Embeddable/EmbeddableFrame';
|
||||||
import { useTrackEvent } from '../Insights';
|
import { useTrackEvent } from '../Insights';
|
||||||
import { useNow } from '../hooks';
|
import { useNow } from '../hooks';
|
||||||
import { Button } from '../primitives';
|
import { Button } from '../primitives';
|
||||||
|
import { ScrollContainer } from '../primitives/ScrollContainer';
|
||||||
import { AIChatControlButton } from './AIChatControlButton';
|
import { AIChatControlButton } from './AIChatControlButton';
|
||||||
import { AIChatIcon } from './AIChatIcon';
|
import { AIChatIcon } from './AIChatIcon';
|
||||||
import { AIChatInput } from './AIChatInput';
|
import { AIChatInput } from './AIChatInput';
|
||||||
import { AIChatMessages } from './AIChatMessages';
|
import { AIChatMessages } from './AIChatMessages';
|
||||||
import AIChatSuggestedQuestions from './AIChatSuggestedQuestions';
|
import AIChatSuggestedQuestions from './AIChatSuggestedQuestions';
|
||||||
|
|
||||||
export function AIChat(props: { trademark: boolean }) {
|
export function AIChat() {
|
||||||
const { trademark } = props;
|
const { config } = useAI();
|
||||||
|
|
||||||
const language = useLanguage();
|
const language = useLanguage();
|
||||||
const chat = useAIChatState();
|
const chat = useAIChatState();
|
||||||
const chatController = useAIChatController();
|
const chatController = useAIChatController();
|
||||||
@@ -65,39 +68,42 @@ export function AIChat(props: { trademark: boolean }) {
|
|||||||
}
|
}
|
||||||
}, [chat.opened, trackEvent]);
|
}, [chat.opened, trackEvent]);
|
||||||
|
|
||||||
if (!chat.opened) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
data-testid="ai-chat"
|
data-testid="ai-chat"
|
||||||
className="ai-chat inset-y-0 right-0 z-40 mx-auto flex max-w-3xl animate-present scroll-mt-36 px-4 py-4 transition-all duration-300 sm:px-6 lg:fixed lg:w-80 lg:animate-enter-from-right lg:pr-4 lg:pl-0 xl:w-96"
|
className={tcls(
|
||||||
|
'ai-chat inset-y-0 right-0 z-40 mx-auto flex max-w-3xl scroll-mt-36 px-4 py-4 transition-[width,opacity,margin,display] transition-discrete duration-300 sm:px-6 lg:fixed lg:w-80 lg:p-0 xl:w-96',
|
||||||
|
chat.opened
|
||||||
|
? 'lg:starting:ml-0 lg:starting:w-0 lg:starting:opacity-0'
|
||||||
|
: 'hidden lg:ml-0 lg:w-0! lg:opacity-0'
|
||||||
|
)}
|
||||||
>
|
>
|
||||||
<EmbeddableFrame className="relative circular-corners:rounded-3xl rounded-corners:rounded-md depth-subtle:shadow-lg shadow-tint ring-1 ring-tint-subtle">
|
<EmbeddableFrame className="relative shrink-0 border-tint-subtle border-l to-tint-base transition-all duration-300 max-lg:circular-corners:rounded-3xl max-lg:rounded-corners:rounded-md max-lg:border lg:w-80 xl:w-96">
|
||||||
<EmbeddableFrameHeader>
|
<EmbeddableFrameMain>
|
||||||
<AIChatDynamicIcon trademark={trademark} />
|
<EmbeddableFrameHeader>
|
||||||
<EmbeddableFrameHeaderMain>
|
<AIChatDynamicIcon trademark={config.trademark} />
|
||||||
<EmbeddableFrameTitle>
|
<EmbeddableFrameHeaderMain>
|
||||||
{getAIChatName(language, trademark)}
|
<EmbeddableFrameTitle>
|
||||||
</EmbeddableFrameTitle>
|
{getAIChatName(language, config.trademark)}
|
||||||
<AIChatSubtitle chat={chat} />
|
</EmbeddableFrameTitle>
|
||||||
</EmbeddableFrameHeaderMain>
|
<AIChatSubtitle chat={chat} />
|
||||||
<EmbeddableFrameButtons>
|
</EmbeddableFrameHeaderMain>
|
||||||
<AIChatControlButton />
|
<EmbeddableFrameButtons>
|
||||||
<Button
|
<AIChatControlButton />
|
||||||
onClick={() => chatController.close()}
|
<Button
|
||||||
iconOnly
|
onClick={() => chatController.close()}
|
||||||
icon="close"
|
iconOnly
|
||||||
label={tString(language, 'close')}
|
icon="close"
|
||||||
variant="blank"
|
label={tString(language, 'close')}
|
||||||
size="default"
|
variant="blank"
|
||||||
/>
|
size="default"
|
||||||
</EmbeddableFrameButtons>
|
/>
|
||||||
</EmbeddableFrameHeader>
|
</EmbeddableFrameButtons>
|
||||||
<EmbeddableFrameBody>
|
</EmbeddableFrameHeader>
|
||||||
<AIChatBody chatController={chatController} chat={chat} trademark={trademark} />
|
<EmbeddableFrameBody>
|
||||||
</EmbeddableFrameBody>
|
<AIChatBody chatController={chatController} chat={chat} />
|
||||||
|
</EmbeddableFrameBody>
|
||||||
|
</EmbeddableFrameMain>
|
||||||
</EmbeddableFrame>
|
</EmbeddableFrame>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
@@ -108,13 +114,14 @@ export function AIChat(props: { trademark: boolean }) {
|
|||||||
*/
|
*/
|
||||||
export function AIChatDynamicIcon(props: {
|
export function AIChatDynamicIcon(props: {
|
||||||
trademark: boolean;
|
trademark: boolean;
|
||||||
|
className?: string;
|
||||||
}) {
|
}) {
|
||||||
const { trademark } = props;
|
const { trademark, className } = props;
|
||||||
const chat = useAIChatState();
|
const chat = useAIChatState();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<AIChatIcon
|
<AIChatIcon
|
||||||
className="size-5 text-tint"
|
className={tcls('size-5 text-tint', className)}
|
||||||
trademark={trademark}
|
trademark={trademark}
|
||||||
state={
|
state={
|
||||||
chat.error
|
chat.error
|
||||||
@@ -143,10 +150,33 @@ export function AIChatSubtitle(props: {
|
|||||||
const language = useLanguage();
|
const language = useLanguage();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<EmbeddableFrameSubtitle className={chat.loading ? 'h-3 opacity-11' : 'h-0 opacity-0'}>
|
<EmbeddableFrameSubtitle
|
||||||
{chat.messages[chat.messages.length - 1]?.content
|
className={tcls('relative', chat.loading ? 'h-3 opacity-11' : 'h-0 opacity-0')}
|
||||||
? tString(language, 'ai_chat_working')
|
>
|
||||||
: tString(language, 'ai_chat_thinking')}
|
<span
|
||||||
|
className={tcls(
|
||||||
|
'absolute left-0',
|
||||||
|
chat.loading
|
||||||
|
? chat.messages[chat.messages.length - 1]?.content
|
||||||
|
? 'animate-blur-in-slow'
|
||||||
|
: 'hidden'
|
||||||
|
: 'animate-blur-out-slow'
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
{t(language, 'ai_chat_working')}
|
||||||
|
</span>
|
||||||
|
<span
|
||||||
|
className={tcls(
|
||||||
|
'absolute left-0',
|
||||||
|
chat.loading
|
||||||
|
? chat.messages[chat.messages.length - 1]?.content
|
||||||
|
? 'animate-blur-out-slow'
|
||||||
|
: 'animate-blur-in-slow'
|
||||||
|
: 'hidden'
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
{t(language, 'ai_chat_thinking')}
|
||||||
|
</span>
|
||||||
</EmbeddableFrameSubtitle>
|
</EmbeddableFrameSubtitle>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -157,20 +187,13 @@ export function AIChatSubtitle(props: {
|
|||||||
export function AIChatBody(props: {
|
export function AIChatBody(props: {
|
||||||
chatController: AIChatController;
|
chatController: AIChatController;
|
||||||
chat: AIChatState;
|
chat: AIChatState;
|
||||||
trademark: boolean;
|
|
||||||
welcomeMessage?: string;
|
welcomeMessage?: string;
|
||||||
suggestions?: string[];
|
suggestions?: string[];
|
||||||
}) {
|
}) {
|
||||||
const { chatController, chat, trademark, suggestions } = props;
|
const { chatController, chat, suggestions } = props;
|
||||||
|
const { trademark } = useAI().config;
|
||||||
|
|
||||||
const [input, setInput] = React.useState('');
|
const [input, setInput] = React.useState('');
|
||||||
|
|
||||||
const scrollContainerRef = React.useRef<HTMLDivElement>(null);
|
|
||||||
// Ref for the last user message element
|
|
||||||
const lastUserMessageRef = React.useRef<HTMLDivElement>(null);
|
|
||||||
const inputRef = React.useRef<HTMLDivElement>(null);
|
|
||||||
|
|
||||||
const [inputHeight, setInputHeight] = React.useState(0);
|
|
||||||
const language = useLanguage();
|
const language = useLanguage();
|
||||||
const now = useNow(60 * 60 * 1000); // Refresh every hour for greeting
|
const now = useNow(60 * 60 * 1000); // Refresh every hour for greeting
|
||||||
|
|
||||||
@@ -184,67 +207,43 @@ export function AIChatBody(props: {
|
|||||||
return tString(language, 'ai_chat_assistant_greeting_evening');
|
return tString(language, 'ai_chat_assistant_greeting_evening');
|
||||||
}, [now, language]);
|
}, [now, language]);
|
||||||
|
|
||||||
// Auto-scroll to the latest user message when messages change
|
|
||||||
React.useEffect(() => {
|
|
||||||
if (chat.messages.length > 0 && lastUserMessageRef.current) {
|
|
||||||
lastUserMessageRef.current.scrollIntoView({
|
|
||||||
behavior: 'smooth',
|
|
||||||
block: 'start',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}, [chat.messages.length]);
|
|
||||||
|
|
||||||
React.useEffect(() => {
|
|
||||||
const timeout = setTimeout(() => {
|
|
||||||
if (lastUserMessageRef.current) {
|
|
||||||
lastUserMessageRef.current.scrollIntoView({
|
|
||||||
behavior: 'smooth',
|
|
||||||
block: 'start',
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}, 100);
|
|
||||||
|
|
||||||
// We want the chat messages to scroll underneath the input, but they should scroll past the input when scrolling all the way down.
|
|
||||||
// The best way to do this is to observe the input height and adjust the padding bottom of the scroll container accordingly.
|
|
||||||
const observer = new ResizeObserver((entries) => {
|
|
||||||
entries.forEach((entry) => {
|
|
||||||
setInputHeight(entry.contentRect.height + 32);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
if (inputRef.current) {
|
|
||||||
observer.observe(inputRef.current);
|
|
||||||
}
|
|
||||||
return () => {
|
|
||||||
observer.disconnect();
|
|
||||||
clearTimeout(timeout);
|
|
||||||
};
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<div
|
<ScrollContainer
|
||||||
ref={scrollContainerRef}
|
className="shrink grow basis-80 animate-fade-in-slow [container-type:size]"
|
||||||
className="gutter-stable flex grow scroll-pt-4 flex-col gap-4 overflow-y-auto p-4"
|
contentClassName="p-4 gutter-stable flex flex-col gap-4"
|
||||||
style={{
|
orientation="vertical"
|
||||||
paddingBottom: `${inputHeight}px`,
|
fadeEdges={['leading']}
|
||||||
}}
|
active={`message-group-${chat.messages.filter((message) => message.role === 'user').length - 1}`}
|
||||||
>
|
>
|
||||||
{isEmpty ? (
|
{isEmpty ? (
|
||||||
<div className="flex min-h-full w-full shrink-0 flex-col items-center justify-center gap-6 py-4">
|
<div className="flex grow flex-col">
|
||||||
<div className="flex size-32 animate-fade-in-slow items-center justify-center rounded-full bg-tint-subtle">
|
<div className="my-auto flex flex-row items-center gap-4 pb-6 [@container(min-height:400px)]:flex-col">
|
||||||
<AIChatIcon
|
<div
|
||||||
state="intro"
|
className="flex size-16 shrink-0 animate-scale-in items-center justify-center rounded-full bg-primary-solid/1 [@container(min-height:400px)]:size-32"
|
||||||
trademark={trademark}
|
style={{ animationDelay: '.3s' }}
|
||||||
className="size-16 animate-[present_500ms_200ms_both]"
|
>
|
||||||
/>
|
<AIChatIcon
|
||||||
</div>
|
state="intro"
|
||||||
<div className="animate-[fadeIn_500ms_400ms_both]">
|
trademark={trademark}
|
||||||
<h5 className=" text-center font-bold text-lg text-tint-strong">
|
className="size-8 text-primary [@container(min-height:400px)]:size-16"
|
||||||
{timeGreeting}
|
/>
|
||||||
</h5>
|
</div>
|
||||||
<p className="text-center text-tint">
|
<div className="flex flex-col items-start [@container(min-height:400px)]:items-center">
|
||||||
{t(language, 'ai_chat_assistant_description')}
|
<h5
|
||||||
</p>
|
className="animate-blur-in-slow font-bold text-lg text-tint-strong [@container(min-height:400px)]:text-center"
|
||||||
|
style={{ animationDelay: '.5s' }}
|
||||||
|
data-testid="ai-chat-time-greeting"
|
||||||
|
>
|
||||||
|
{timeGreeting}
|
||||||
|
</h5>
|
||||||
|
<p
|
||||||
|
className="animate-blur-in-slow text-tint [@container(min-height:400px)]:text-center"
|
||||||
|
style={{ animationDelay: '.6s' }}
|
||||||
|
>
|
||||||
|
{t(language, 'ai_chat_assistant_description')}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{!chat.error ? (
|
{!chat.error ? (
|
||||||
<AIChatSuggestedQuestions
|
<AIChatSuggestedQuestions
|
||||||
@@ -254,17 +253,11 @@ export function AIChatBody(props: {
|
|||||||
) : null}
|
) : null}
|
||||||
</div>
|
</div>
|
||||||
) : (
|
) : (
|
||||||
<AIChatMessages
|
<AIChatMessages chat={chat} chatController={chatController} />
|
||||||
chat={chat}
|
|
||||||
chatController={chatController}
|
|
||||||
lastUserMessageRef={lastUserMessageRef}
|
|
||||||
/>
|
|
||||||
)}
|
)}
|
||||||
</div>
|
</ScrollContainer>
|
||||||
<div
|
|
||||||
ref={inputRef}
|
<div className="flex flex-col gap-2 px-4 pb-4">
|
||||||
className="absolute inset-x-0 bottom-0 mr-2 flex select-none flex-col gap-4 bg-linear-to-b from-transparent to-50% to-tint-base/9 p-4 pr-2"
|
|
||||||
>
|
|
||||||
{/* Display an error banner when something went wrong. */}
|
{/* Display an error banner when something went wrong. */}
|
||||||
{chat.error ? <AIChatError chatController={chatController} /> : null}
|
{chat.error ? <AIChatError chatController={chatController} /> : null}
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ export function AIChatButton(props: {
|
|||||||
iconOnly={!showLabel}
|
iconOnly={!showLabel}
|
||||||
size="medium"
|
size="medium"
|
||||||
variant="header"
|
variant="header"
|
||||||
className="h-9 px-2.5 max-md:[&_.button-content]:hidden"
|
className="h-9 px-2.5 @max-2xl:[&_.button-content]:hidden"
|
||||||
label={
|
label={
|
||||||
<div className="flex items-center gap-2">
|
<div className="flex items-center gap-2">
|
||||||
{t(language, 'ai_chat_ask', assistant.label)}
|
{t(language, 'ai_chat_ask', assistant.label)}
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
'use client';
|
'use client';
|
||||||
|
|
||||||
import { useLanguage } from '@/intl/client';
|
import { useLanguage } from '@/intl/client';
|
||||||
import { t, tString } from '@/intl/translate';
|
import { t } from '@/intl/translate';
|
||||||
import { Icon } from '@gitbook/icons';
|
|
||||||
import { useAIChatController, useAIChatState } from '../AI';
|
import { useAIChatController, useAIChatState } from '../AI';
|
||||||
import { Button, DropdownMenu, DropdownMenuItem } from '../primitives';
|
import { Button } from '../primitives';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Button to control the chat (clear, etc.)
|
* Button to control the chat (clear, etc.)
|
||||||
@@ -15,26 +14,16 @@ export function AIChatControlButton() {
|
|||||||
const chatController = useAIChatController();
|
const chatController = useAIChatController();
|
||||||
|
|
||||||
return chat.messages.length > 0 ? (
|
return chat.messages.length > 0 ? (
|
||||||
<DropdownMenu
|
<Button
|
||||||
button={
|
onClick={() => {
|
||||||
<Button
|
chatController.clear();
|
||||||
onClick={() => {}}
|
}}
|
||||||
iconOnly
|
iconOnly
|
||||||
icon="ellipsis"
|
icon="trash-can"
|
||||||
label={tString(language, 'actions')}
|
label={t(language, 'ai_chat_clear_conversation')}
|
||||||
variant="blank"
|
variant="blank"
|
||||||
size="default"
|
size="default"
|
||||||
/>
|
className="animate-blur-in-slow"
|
||||||
}
|
/>
|
||||||
>
|
|
||||||
<DropdownMenuItem
|
|
||||||
onClick={() => {
|
|
||||||
chatController.clear();
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<Icon icon="broom-wide" className="size-3 shrink-0 text-tint-subtle" />
|
|
||||||
{t(language, 'ai_chat_clear_conversation')}
|
|
||||||
</DropdownMenuItem>
|
|
||||||
</DropdownMenu>
|
|
||||||
) : null;
|
) : null;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
import { tcls } from '@/lib/tailwind';
|
import { tcls } from '@/lib/tailwind';
|
||||||
import { Icon } from '@gitbook/icons';
|
import { Icon, IconStyle } from '@gitbook/icons';
|
||||||
import type React from 'react';
|
import type React from 'react';
|
||||||
|
|
||||||
interface AIChatIconProps extends React.SVGProps<SVGSVGElement> {
|
interface AIChatIconProps extends React.SVGProps<SVGSVGElement> {
|
||||||
@@ -9,17 +9,18 @@ interface AIChatIconProps extends React.SVGProps<SVGSVGElement> {
|
|||||||
trademark?: boolean;
|
trademark?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const AIChatIcon = ({
|
export function AIChatIcon({
|
||||||
className = 'size-4',
|
className = 'size-4',
|
||||||
size,
|
size,
|
||||||
trademark = true,
|
trademark = true,
|
||||||
state = 'default',
|
state = 'default',
|
||||||
...props
|
...props
|
||||||
}: AIChatIconProps) => {
|
}: AIChatIconProps) {
|
||||||
if (!trademark) {
|
if (!trademark) {
|
||||||
return (
|
return (
|
||||||
<Icon
|
<Icon
|
||||||
icon="sparkle"
|
icon="sparkle"
|
||||||
|
{...props}
|
||||||
className={tcls(
|
className={tcls(
|
||||||
className,
|
className,
|
||||||
(state === 'thinking' || state === 'working') &&
|
(state === 'thinking' || state === 'working') &&
|
||||||
@@ -163,4 +164,36 @@ export const AIChatIcon = ({
|
|||||||
</g>
|
</g>
|
||||||
</svg>
|
</svg>
|
||||||
);
|
);
|
||||||
};
|
}
|
||||||
|
|
||||||
|
export function AISearchIcon({
|
||||||
|
className = 'size-4',
|
||||||
|
state = 'default',
|
||||||
|
}: Pick<AIChatIconProps, 'className' | 'state'>) {
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={tcls(
|
||||||
|
'relative',
|
||||||
|
state === 'intro' && 'animate-[fadeIn_1s_both,orbit_1s_cubic-bezier(0.16,1,0.3,1)]',
|
||||||
|
state === 'thinking' || state === 'working'
|
||||||
|
? 'animate-[fadeIn_1s_both,orbit_1s_ease-out,orbit_2s_1s_infinite_forwards_linear]'
|
||||||
|
: ''
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<Icon icon="search" className={className} />
|
||||||
|
<Icon
|
||||||
|
icon="sparkle"
|
||||||
|
iconStyle={IconStyle.Solid}
|
||||||
|
className={tcls(
|
||||||
|
'absolute top-[15.7%] left-[15.6%] size-[50%]',
|
||||||
|
state === 'thinking' || state === 'working'
|
||||||
|
? 'animate-[spin_2s_infinite_forwards_cubic-bezier(0.16,1,0.3,1)]'
|
||||||
|
: '',
|
||||||
|
state === 'intro'
|
||||||
|
? 'animate-[spin_2s_.5s_forwards_cubic-bezier(0.16,1,0.3,1)]'
|
||||||
|
: ''
|
||||||
|
)}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { tcls } from '@/lib/tailwind';
|
|||||||
import { Icon } from '@gitbook/icons';
|
import { Icon } from '@gitbook/icons';
|
||||||
import { useEffect, useRef } from 'react';
|
import { useEffect, useRef } from 'react';
|
||||||
import { useHotkeys } from 'react-hotkeys-hook';
|
import { useHotkeys } from 'react-hotkeys-hook';
|
||||||
|
import { useAIChatState } from '../AI/useAIChat';
|
||||||
import { Button, HoverCard, HoverCardRoot, HoverCardTrigger } from '../primitives';
|
import { Button, HoverCard, HoverCardRoot, HoverCardTrigger } from '../primitives';
|
||||||
import { KeyboardShortcut } from '../primitives/KeyboardShortcut';
|
import { KeyboardShortcut } from '../primitives/KeyboardShortcut';
|
||||||
|
|
||||||
@@ -19,6 +20,7 @@ export function AIChatInput(props: {
|
|||||||
const { value, onChange, onSubmit, disabled, loading } = props;
|
const { value, onChange, onSubmit, disabled, loading } = props;
|
||||||
|
|
||||||
const language = useLanguage();
|
const language = useLanguage();
|
||||||
|
const chat = useAIChatState();
|
||||||
|
|
||||||
const inputRef = useRef<HTMLTextAreaElement>(null);
|
const inputRef = useRef<HTMLTextAreaElement>(null);
|
||||||
|
|
||||||
@@ -32,7 +34,7 @@ export function AIChatInput(props: {
|
|||||||
};
|
};
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!disabled && !loading) {
|
if (chat.opened && !disabled && !loading) {
|
||||||
// Add a small delay to ensure the input is rendered before focusing
|
// Add a small delay to ensure the input is rendered before focusing
|
||||||
// This fixes inconsistent focus behaviour across browsers
|
// This fixes inconsistent focus behaviour across browsers
|
||||||
const timeout = setTimeout(() => {
|
const timeout = setTimeout(() => {
|
||||||
@@ -41,7 +43,7 @@ export function AIChatInput(props: {
|
|||||||
|
|
||||||
return () => clearTimeout(timeout);
|
return () => clearTimeout(timeout);
|
||||||
}
|
}
|
||||||
}, [disabled, loading]);
|
}, [disabled, loading, chat.opened]);
|
||||||
|
|
||||||
useHotkeys(
|
useHotkeys(
|
||||||
'mod+i',
|
'mod+i',
|
||||||
@@ -55,7 +57,7 @@ export function AIChatInput(props: {
|
|||||||
);
|
);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="depth-subtle:has-[textarea:focus]:-translate-y-px relative flex flex-col overflow-hidden circular-corners:rounded-2xl rounded-corners:rounded-md bg-tint-base/9 depth-subtle:shadow-sm shadow-tint/6 ring-1 ring-tint-subtle backdrop-blur-lg transition-all depth-subtle:has-[textarea:focus]:shadow-lg has-[textarea:focus]:shadow-primary-subtle has-[textarea:focus]:ring-2 has-[textarea:focus]:ring-primary-hover contrast-more:bg-tint-base dark:shadow-tint-1">
|
<div className="depth-subtle:has-[textarea:focus]:-translate-y-px relative flex animate-blur-in-slow flex-col overflow-hidden circular-corners:rounded-3xl rounded-corners:rounded-xl bg-tint-base/9 depth-subtle:shadow-sm shadow-tint/6 ring-1 ring-tint-subtle backdrop-blur-lg transition-all depth-subtle:has-[textarea:focus]:shadow-lg has-[textarea:focus]:shadow-primary-subtle has-[textarea:focus]:ring-2 has-[textarea:focus]:ring-primary-hover contrast-more:bg-tint-base dark:shadow-tint-1">
|
||||||
<textarea
|
<textarea
|
||||||
ref={inputRef}
|
ref={inputRef}
|
||||||
disabled={disabled || loading}
|
disabled={disabled || loading}
|
||||||
@@ -106,7 +108,7 @@ export function AIChatInput(props: {
|
|||||||
</div>
|
</div>
|
||||||
) : null}
|
) : null}
|
||||||
<div className="absolute inset-x-0 bottom-0 flex items-center gap-2 px-2 py-2">
|
<div className="absolute inset-x-0 bottom-0 flex items-center gap-2 px-2 py-2">
|
||||||
<HoverCardRoot>
|
<HoverCardRoot openDelay={500}>
|
||||||
<HoverCard
|
<HoverCard
|
||||||
className="max-w-xs bg-tint p-2 text-sm text-tint"
|
className="max-w-xs bg-tint p-2 text-sm text-tint"
|
||||||
arrow={{ className: 'fill-tint-3' }}
|
arrow={{ className: 'fill-tint-3' }}
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ import { useLanguage } from '@/intl/client';
|
|||||||
import { tString } from '@/intl/translate';
|
import { tString } from '@/intl/translate';
|
||||||
import { tcls } from '@/lib/tailwind';
|
import { tcls } from '@/lib/tailwind';
|
||||||
import { AIMessageRole } from '@gitbook/api';
|
import { AIMessageRole } from '@gitbook/api';
|
||||||
import type React from 'react';
|
|
||||||
import type { AIChatController, AIChatState } from '../AI';
|
import type { AIChatController, AIChatState } from '../AI';
|
||||||
import { AIChatToolConfirmations } from './AIChatToolConfirmations';
|
import { AIChatToolConfirmations } from './AIChatToolConfirmations';
|
||||||
import { AIResponseFeedback } from './AIResponseFeedback';
|
import { AIResponseFeedback } from './AIResponseFeedback';
|
||||||
@@ -11,87 +10,133 @@ import { AIChatFollowupSuggestions } from './AiChatFollowupSuggestions';
|
|||||||
export function AIChatMessages(props: {
|
export function AIChatMessages(props: {
|
||||||
chat: AIChatState;
|
chat: AIChatState;
|
||||||
chatController: AIChatController;
|
chatController: AIChatController;
|
||||||
lastUserMessageRef?: React.RefObject<HTMLDivElement>;
|
|
||||||
}) {
|
}) {
|
||||||
const { chat, chatController, lastUserMessageRef } = props;
|
const { chat, chatController } = props;
|
||||||
|
|
||||||
return (
|
// Group messages: user messages start a new group, all following messages until next user message belong to that group
|
||||||
<>
|
type Message = (typeof chat.messages)[0];
|
||||||
{chat.messages.map((message, index) => {
|
type MessageGroup = { message: Message; originalIndex: number };
|
||||||
const isLastMessage = index === chat.messages.length - 1;
|
const messageGroups: Array<Array<MessageGroup>> = [];
|
||||||
const isLastUserMessage =
|
let currentGroup: Array<MessageGroup> = [];
|
||||||
message.role === AIMessageRole.User &&
|
|
||||||
index === chat.messages.map((m) => m.role).lastIndexOf(AIMessageRole.User);
|
|
||||||
|
|
||||||
return (
|
chat.messages.forEach((message, index) => {
|
||||||
<div
|
if (message.role === AIMessageRole.User) {
|
||||||
ref={isLastUserMessage ? lastUserMessageRef : undefined}
|
// Start a new group
|
||||||
data-testid="ai-chat-message"
|
if (currentGroup.length > 0) {
|
||||||
className={tcls(
|
messageGroups.push(currentGroup);
|
||||||
message.content ? 'animate-fade-in-slow' : '',
|
}
|
||||||
'shrink-0',
|
currentGroup = [{ message, originalIndex: index }];
|
||||||
'last:min-h-[calc(100%-5rem)]',
|
} else {
|
||||||
'scroll-mt-36',
|
// Add to current group
|
||||||
'lg:scroll-mt-0',
|
currentGroup.push({ message, originalIndex: index });
|
||||||
'flex flex-col gap-6',
|
}
|
||||||
'break-words',
|
});
|
||||||
'group/message',
|
|
||||||
message.role === AIMessageRole.User
|
|
||||||
? 'max-w-[80%] self-end circular-corners:rounded-2xl rounded-corners:rounded-md bg-tint px-4 py-2'
|
|
||||||
: 'text-tint-strong'
|
|
||||||
)}
|
|
||||||
style={{
|
|
||||||
animationDelay: `${Math.min(index * 0.05, 0.5)}s`,
|
|
||||||
}}
|
|
||||||
key={index}
|
|
||||||
>
|
|
||||||
{message.content ? message.content : null}
|
|
||||||
|
|
||||||
{isLastMessage && chat.loading ? (
|
// Add the last group if it exists
|
||||||
<div className="flex w-full animate-fade-in-slow flex-col gap-2">
|
if (currentGroup.length > 0) {
|
||||||
{!message.content ? <HoldMessage /> : null}
|
messageGroups.push(currentGroup);
|
||||||
<LoadingSkeleton />
|
}
|
||||||
</div>
|
|
||||||
) : null}
|
|
||||||
|
|
||||||
{isLastMessage ? (
|
return messageGroups.map((group, groupIndex) => {
|
||||||
<>
|
const isLastGroup = group === messageGroups[messageGroups.length - 1];
|
||||||
{!chat.loading &&
|
return (
|
||||||
!chat.error &&
|
<div
|
||||||
chat.query &&
|
key={groupIndex}
|
||||||
chat.responseId &&
|
id={`message-group-${groupIndex}`}
|
||||||
chat.pendingTools.length === 0 ? (
|
className={tcls(
|
||||||
<AIResponseFeedback
|
'flex flex-col gap-2 pt-2',
|
||||||
responseId={chat.responseId}
|
isLastGroup ? 'shrink-0 basis-full' : '',
|
||||||
query={chat.query}
|
|
||||||
className="-ml-1 -mt-4"
|
'transition-discrete'
|
||||||
|
)}
|
||||||
|
style={{ animationDelay: '.2s' }}
|
||||||
|
>
|
||||||
|
{group.map(({ message, originalIndex }) => {
|
||||||
|
const isLastMessage = originalIndex === chat.messages.length - 1;
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
key={originalIndex}
|
||||||
|
data-testid={
|
||||||
|
message.role === AIMessageRole.User
|
||||||
|
? 'ai-chat-message-user'
|
||||||
|
: 'ai-chat-message-assistant'
|
||||||
|
}
|
||||||
|
id={`message-${originalIndex}`}
|
||||||
|
className={tcls(
|
||||||
|
'flex flex-col gap-6',
|
||||||
|
'break-words',
|
||||||
|
'group/message',
|
||||||
|
'animate-blur-in-slow',
|
||||||
|
isLastMessage ? 'basis-full' : '',
|
||||||
|
message.role === AIMessageRole.User
|
||||||
|
? 'max-w-[80%] origin-top-right self-end circular-corners:rounded-2xl rounded-corners:rounded-md bg-tint px-4 py-2'
|
||||||
|
: 'origin-top-left text-tint-strong'
|
||||||
|
)}
|
||||||
|
style={{
|
||||||
|
animationDelay: `${Math.min(originalIndex * 0.1, 0.6)}s`,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{message.content}
|
||||||
|
|
||||||
|
{isLastMessage && message.role === AIMessageRole.Assistant ? (
|
||||||
|
<div
|
||||||
|
className={tcls(
|
||||||
|
'flex w-full shrink-0 flex-col gap-2 starting:opacity-0 transition-all transition-discrete duration-500',
|
||||||
|
chat.loading ? '' : 'hidden opacity-0'
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<HoldMessage className={message.content ? 'hidden' : ''} />
|
||||||
|
<LoadingSkeleton />
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
|
|
||||||
|
{isLastMessage ? (
|
||||||
|
<>
|
||||||
|
{!chat.loading &&
|
||||||
|
!chat.error &&
|
||||||
|
chat.query &&
|
||||||
|
chat.responseId &&
|
||||||
|
chat.pendingTools.length === 0 ? (
|
||||||
|
<AIResponseFeedback
|
||||||
|
responseId={chat.responseId}
|
||||||
|
query={chat.query}
|
||||||
|
className="-ml-1 -mt-4"
|
||||||
|
/>
|
||||||
|
) : null}
|
||||||
|
<AIChatToolConfirmations chat={chat} />
|
||||||
|
<AIChatFollowupSuggestions
|
||||||
|
chat={chat}
|
||||||
|
chatController={chatController}
|
||||||
/>
|
/>
|
||||||
) : null}
|
</>
|
||||||
<AIChatToolConfirmations chat={chat} />
|
) : null}
|
||||||
<AIChatFollowupSuggestions
|
</div>
|
||||||
chat={chat}
|
);
|
||||||
chatController={chatController}
|
})}
|
||||||
/>
|
</div>
|
||||||
</>
|
);
|
||||||
) : null}
|
});
|
||||||
</div>
|
|
||||||
);
|
|
||||||
})}
|
|
||||||
</>
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function HoldMessage() {
|
export function HoldMessage({
|
||||||
|
breakLines = false,
|
||||||
|
className,
|
||||||
|
}: { breakLines?: boolean; className?: string }) {
|
||||||
const language = useLanguage();
|
const language = useLanguage();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="animate-[heightIn_500ms_4500ms_ease_both] py-2 text-tint-subtle">
|
<div
|
||||||
|
className={tcls(
|
||||||
|
'animate-[heightIn_.5s_5s_ease_both] overflow-hidden py-2 text-tint-subtle [&.hidden]:animate-[heightOut_1s_ease-in_both]',
|
||||||
|
className
|
||||||
|
)}
|
||||||
|
>
|
||||||
{tString(language, 'ai_chat_hold_message_1')
|
{tString(language, 'ai_chat_hold_message_1')
|
||||||
.split(' ')
|
.split(' ')
|
||||||
.map((word, index) => (
|
.map((word, index) => (
|
||||||
<span
|
<span
|
||||||
key={index}
|
key={index}
|
||||||
className="animate-fade-in-slow"
|
className="animate-blur-in-slow"
|
||||||
style={{
|
style={{
|
||||||
animationDelay: `${5000 + index * 200}ms`,
|
animationDelay: `${5000 + index * 200}ms`,
|
||||||
}}
|
}}
|
||||||
@@ -99,12 +144,13 @@ function HoldMessage() {
|
|||||||
{word}{' '}
|
{word}{' '}
|
||||||
</span>
|
</span>
|
||||||
))}
|
))}
|
||||||
|
{breakLines ? <br /> : null}
|
||||||
{tString(language, 'ai_chat_hold_message_2')
|
{tString(language, 'ai_chat_hold_message_2')
|
||||||
.split(' ')
|
.split(' ')
|
||||||
.map((word, index) => (
|
.map((word, index) => (
|
||||||
<span
|
<span
|
||||||
key={index}
|
key={index}
|
||||||
className="animate-fade-in-slow"
|
className="animate-blur-in-slow"
|
||||||
style={{
|
style={{
|
||||||
animationDelay: `${10000 + index * 200}ms`,
|
animationDelay: `${10000 + index * 200}ms`,
|
||||||
}}
|
}}
|
||||||
@@ -122,9 +168,9 @@ function LoadingSkeleton() {
|
|||||||
{Array.from({ length: 7 }).map((_, index) => (
|
{Array.from({ length: 7 }).map((_, index) => (
|
||||||
<div
|
<div
|
||||||
key={index}
|
key={index}
|
||||||
className="h-4 animate-[fadeIn_500ms_ease_both,pulse_1.5s_infinite] circular-corners:rounded-2xl rounded-corners:rounded-md bg-tint-4"
|
className="h-4 animate-[blurIn_500ms_ease-out_both,pulse_1.5s_infinite] circular-corners:rounded-2xl rounded-corners:rounded-md bg-tint-solid/2"
|
||||||
style={{
|
style={{
|
||||||
width: `calc(${(index % 4) * 20 + 10}% - 4px)`,
|
width: `calc(${(4 - (index % 4)) * 8 + 14}% - 4px)`,
|
||||||
animationDelay: `${index * 0.1}s`,
|
animationDelay: `${index * 0.1}s`,
|
||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
|
|||||||
@@ -17,15 +17,15 @@ export default function AIChatSuggestedQuestions(props: {
|
|||||||
} = props;
|
} = props;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex flex-col items-center gap-2">
|
<div className="flex flex-col items-start gap-2 self-start">
|
||||||
{suggestions.map((question, index) => (
|
{suggestions.map((question, index) => (
|
||||||
<Button
|
<Button
|
||||||
key={question}
|
key={question}
|
||||||
variant="secondary"
|
variant="blank"
|
||||||
size="medium"
|
size="medium"
|
||||||
className="max-w-full animate-[present_500ms_both] whitespace-normal"
|
className="max-w-full animate-blur-in-slow border-none bg-primary-solid/1 px-3 py-1.5 hover:bg-primary-hover"
|
||||||
style={{
|
style={{
|
||||||
animationDelay: `${800 + index * 100}ms`,
|
animationDelay: `${1000 + index * 100}ms`,
|
||||||
}}
|
}}
|
||||||
onClick={() => chatController.postMessage({ message: question })}
|
onClick={() => chatController.postMessage({ message: question })}
|
||||||
>
|
>
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ export function AIChatToolConfirmations(props: {
|
|||||||
);
|
);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="flex w-full flex-wrap justify-end gap-2">
|
<div className="flex w-full flex-wrap justify-end gap-2 empty:hidden">
|
||||||
{chat.pendingTools.map((tool, index) => (
|
{chat.pendingTools.map((tool, index) => (
|
||||||
<div
|
<div
|
||||||
className="flex w-full animate-present-slow flex-col gap-1"
|
className="flex w-full animate-present-slow flex-col gap-1"
|
||||||
|
|||||||
@@ -24,7 +24,9 @@ export function AIResponseFeedback(props: {
|
|||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={tcls('flex h-fit items-center', className)}>
|
<div
|
||||||
|
className={tcls('flex h-fit animate-[heightIn_.5s_ease_both] items-center', className)}
|
||||||
|
>
|
||||||
<Button
|
<Button
|
||||||
icon="thumbs-up"
|
icon="thumbs-up"
|
||||||
iconOnly
|
iconOnly
|
||||||
@@ -35,7 +37,7 @@ export function AIResponseFeedback(props: {
|
|||||||
rating !== null && rating !== 1 && 'px-0 text-[0rem] opacity-0'
|
rating !== null && rating !== 1 && 'px-0 text-[0rem] opacity-0'
|
||||||
)}
|
)}
|
||||||
size="medium"
|
size="medium"
|
||||||
style={{ animationDuration: '.5s' }}
|
style={{ animationDelay: '.5s', animationDuration: '.5s' }}
|
||||||
onClick={() => handleRating(1)}
|
onClick={() => handleRating(1)}
|
||||||
disabled={rating !== null}
|
disabled={rating !== null}
|
||||||
active={rating === 1}
|
active={rating === 1}
|
||||||
@@ -51,7 +53,7 @@ export function AIResponseFeedback(props: {
|
|||||||
rating !== null && rating !== -1 && 'px-0 text-[0rem] opacity-0'
|
rating !== null && rating !== -1 && 'px-0 text-[0rem] opacity-0'
|
||||||
)}
|
)}
|
||||||
size="medium"
|
size="medium"
|
||||||
style={{ animationDelay: '.2s', animationDuration: '.5s' }}
|
style={{ animationDelay: '.7s', animationDuration: '.5s' }}
|
||||||
onClick={() => handleRating(-1)}
|
onClick={() => handleRating(-1)}
|
||||||
disabled={rating !== null}
|
disabled={rating !== null}
|
||||||
active={rating === -1}
|
active={rating === -1}
|
||||||
@@ -59,8 +61,8 @@ export function AIResponseFeedback(props: {
|
|||||||
/>
|
/>
|
||||||
{rating !== null ? (
|
{rating !== null ? (
|
||||||
<span
|
<span
|
||||||
className="ml-2 animate-fade-in-slow text-tint-subtle"
|
className="ml-2 animate-blur-in-slow text-tint-subtle"
|
||||||
style={{ animationDelay: '.3s' }}
|
style={{ animationDelay: '.5s' }}
|
||||||
>
|
>
|
||||||
{t(language, 'was_this_helpful_thank_you')}
|
{t(language, 'was_this_helpful_thank_you')}
|
||||||
</span>
|
</span>
|
||||||
|
|||||||
@@ -15,22 +15,28 @@ export function AIChatFollowupSuggestions(props: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="mt-auto flex w-full flex-wrap justify-end gap-2">
|
<div className="flex grow flex-col">
|
||||||
{chat.followUpSuggestions.map((suggestion, index) => (
|
<div
|
||||||
<Button
|
className="sticky bottom-0 mt-auto flex flex-col items-start gap-2"
|
||||||
key={index}
|
data-testid="ai-chat-followup-suggestions"
|
||||||
onClick={() => {
|
>
|
||||||
chatController.postMessage({ message: suggestion });
|
{chat.followUpSuggestions.map((suggestion, index) => (
|
||||||
}}
|
<Button
|
||||||
label={suggestion}
|
data-testid="ai-chat-followup-suggestion"
|
||||||
className="whitespace-normal! max-w-full animate-[present_500ms_both] text-left ring-1 ring-tint-subtle"
|
key={index}
|
||||||
size="medium"
|
onClick={() => {
|
||||||
variant="blank"
|
chatController.postMessage({ message: suggestion });
|
||||||
style={{
|
}}
|
||||||
animationDelay: `${250 + Math.min(index * 50, 150)}ms`,
|
label={suggestion}
|
||||||
}}
|
className="starting:h-0 max-w-full origin-left animate-blur-in-slow whitespace-normal border-none bg-primary-11/1 px-3 py-1.5 starting:py-0 text-left transition-all transition-discrete duration-500 *:whitespace-normal hover:bg-primary-hover"
|
||||||
/>
|
size="medium"
|
||||||
))}
|
variant="blank"
|
||||||
|
style={{
|
||||||
|
animationDelay: `${250 + Math.min(index * 50, 150)}ms`,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -167,10 +167,10 @@ function ChangeRequestToolbar(props: ToolbarViewProps) {
|
|||||||
icon="comment"
|
icon="comment"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
{/* Open production site */}
|
{/* Open published/live site */}
|
||||||
{site.urls.published ? (
|
{site.urls.published ? (
|
||||||
<ToolbarButton
|
<ToolbarButton
|
||||||
title="Open production site"
|
title="Open live site"
|
||||||
href={getToolbarHref({
|
href={getToolbarHref({
|
||||||
href: site.urls.published,
|
href: site.urls.published,
|
||||||
siteId: site.id,
|
siteId: site.id,
|
||||||
@@ -249,7 +249,7 @@ function RevisionToolbar(props: ToolbarViewProps) {
|
|||||||
/>
|
/>
|
||||||
{site.urls.published ? (
|
{site.urls.published ? (
|
||||||
<ToolbarButton
|
<ToolbarButton
|
||||||
title="Open production site"
|
title="Open live site"
|
||||||
href={getToolbarHref({
|
href={getToolbarHref({
|
||||||
href: site.urls.published,
|
href: site.urls.published,
|
||||||
siteId: site.id,
|
siteId: site.id,
|
||||||
|
|||||||
@@ -35,6 +35,7 @@ export function HideToolbarButton(props: HideToolbarButtonProps) {
|
|||||||
}
|
}
|
||||||
setOpen(false);
|
setOpen(false);
|
||||||
};
|
};
|
||||||
|
// @ts-expect-error wrong type for ref
|
||||||
useOnClickOutside(ref, handleClickOutsideArcMenu);
|
useOnClickOutside(ref, handleClickOutsideArcMenu);
|
||||||
|
|
||||||
// Close arc menu on scroll
|
// Close arc menu on scroll
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import {
|
|||||||
useReducedMotion,
|
useReducedMotion,
|
||||||
useSpring,
|
useSpring,
|
||||||
} from 'motion/react';
|
} from 'motion/react';
|
||||||
import React from 'react';
|
import React, { isValidElement } from 'react';
|
||||||
import { AnimatedLogo } from './AnimatedLogo';
|
import { AnimatedLogo } from './AnimatedLogo';
|
||||||
import { useToolbarControls } from './ToolbarControlsContext';
|
import { useToolbarControls } from './ToolbarControlsContext';
|
||||||
|
|
||||||
@@ -291,6 +291,10 @@ function ToolbarButtonWrapper(props: {
|
|||||||
x: springX,
|
x: springX,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
if (!isValidElement<{ motionValues: typeof motionValues }>(child)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
return React.cloneElement(child, {
|
return React.cloneElement(child, {
|
||||||
motionValues,
|
motionValues,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -136,7 +136,7 @@ const calculateSpacing = (
|
|||||||
|
|
||||||
export function useMagnificationEffect(props: {
|
export function useMagnificationEffect(props: {
|
||||||
childrenCount: number;
|
childrenCount: number;
|
||||||
containerRef: React.RefObject<HTMLElement>;
|
containerRef: React.RefObject<HTMLElement | null>;
|
||||||
config?: MagnificationConfig;
|
config?: MagnificationConfig;
|
||||||
}) {
|
}) {
|
||||||
const { childrenCount, containerRef, config } = props;
|
const { childrenCount, containerRef, config } = props;
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ export function Annotation(props: InlineProps<DocumentInlineAnnotation>) {
|
|||||||
ancestorBlocks={[]}
|
ancestorBlocks={[]}
|
||||||
context={context}
|
context={context}
|
||||||
nodes={fragment.nodes}
|
nodes={fragment.nodes}
|
||||||
style={['space-y-4']}
|
style={['contents']}
|
||||||
/>
|
/>
|
||||||
}
|
}
|
||||||
>
|
>
|
||||||
|
|||||||
@@ -1,84 +1,30 @@
|
|||||||
'use client';
|
'use client';
|
||||||
|
|
||||||
import * as Popover from '@radix-ui/react-popover';
|
|
||||||
import type React from 'react';
|
import type React from 'react';
|
||||||
|
|
||||||
import { tString, useLanguage } from '@/intl/client';
|
import { Tooltip } from '@/components/primitives';
|
||||||
import { tcls } from '@/lib/tailwind';
|
|
||||||
|
|
||||||
export function AnnotationPopover(props: { children: React.ReactNode; body: React.ReactNode }) {
|
export function AnnotationPopover(props: { children: React.ReactNode; body: React.ReactNode }) {
|
||||||
const { children, body } = props;
|
const { children, body } = props;
|
||||||
const language = useLanguage();
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Popover.Root>
|
<Tooltip
|
||||||
<Popover.Trigger asChild>
|
label={body}
|
||||||
<button
|
contentProps={{
|
||||||
data-testid="annotation-button"
|
role: 'definition',
|
||||||
aria-label={tString(language, 'annotation_button_label')}
|
}}
|
||||||
className={tcls(
|
className="bg-tint-base px-4 py-3 text-sm text-tint-strong shadow-lg shadow-tint-12/4 ring-1 ring-tint-subtle dark:shadow-tint-1"
|
||||||
'decoration-dotted',
|
arrow={true}
|
||||||
'decoration-1',
|
arrowProps={{ className: 'fill-tint-1' }}
|
||||||
'underline',
|
>
|
||||||
'underline-offset-2'
|
<dfn
|
||||||
)}
|
data-testid="annotation-button"
|
||||||
>
|
className="cursor-help underline decoration-1 decoration-dotted underline-offset-2"
|
||||||
{children}
|
// biome-ignore lint/a11y/noNoninteractiveTabindex: we want to be able to focus the definition to open the tooltip
|
||||||
</button>
|
tabIndex={0}
|
||||||
</Popover.Trigger>
|
>
|
||||||
<Popover.Portal>
|
{children}
|
||||||
<Popover.Content
|
</dfn>
|
||||||
className={tcls(
|
</Tooltip>
|
||||||
'text-sm',
|
|
||||||
'max-w-[280px]',
|
|
||||||
'bg-tint',
|
|
||||||
'ring-1',
|
|
||||||
'ring-tint',
|
|
||||||
'rounded-sm',
|
|
||||||
'shadow-1xs',
|
|
||||||
'shadow-tint-12/1',
|
|
||||||
'dark:shadow-tint-1/2',
|
|
||||||
'p-3',
|
|
||||||
'[&_p]:leading-snug',
|
|
||||||
'-outline-offset-2',
|
|
||||||
'outline-2',
|
|
||||||
'outline-primary/8',
|
|
||||||
'z-20'
|
|
||||||
)}
|
|
||||||
sideOffset={4}
|
|
||||||
>
|
|
||||||
{body}
|
|
||||||
<Popover.Arrow asChild>
|
|
||||||
<svg
|
|
||||||
viewBox="0 0 8 5"
|
|
||||||
className={tcls(
|
|
||||||
'relative',
|
|
||||||
'z-2',
|
|
||||||
'fill-tint-3', // Same as bg-tint
|
|
||||||
'stroke-tint-7', // Same as ring-tint
|
|
||||||
'[paint-order:stroke_fill]'
|
|
||||||
)}
|
|
||||||
fill="none"
|
|
||||||
xmlns="http://www.w3.org/2000/svg"
|
|
||||||
>
|
|
||||||
<g clip-path="url(#clipAnnotation)">
|
|
||||||
<path
|
|
||||||
d="M0 0L4 4L8 0"
|
|
||||||
strokeWidth="2"
|
|
||||||
strokeLinecap="round"
|
|
||||||
stroke="inherit"
|
|
||||||
fill="inherit"
|
|
||||||
/>
|
|
||||||
</g>
|
|
||||||
<defs>
|
|
||||||
<clipPath id="clipAnnotation">
|
|
||||||
<rect width="8" height="5" fill="white" />
|
|
||||||
</clipPath>
|
|
||||||
</defs>
|
|
||||||
</svg>
|
|
||||||
</Popover.Arrow>
|
|
||||||
</Popover.Content>
|
|
||||||
</Popover.Portal>
|
|
||||||
</Popover.Root>
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import {
|
|||||||
SkeletonImage,
|
SkeletonImage,
|
||||||
SkeletonParagraph,
|
SkeletonParagraph,
|
||||||
SkeletonSmall,
|
SkeletonSmall,
|
||||||
|
SkeletonUpdate,
|
||||||
} from '@/components/primitives';
|
} from '@/components/primitives';
|
||||||
import type { ClassValue } from '@/lib/tailwind';
|
import type { ClassValue } from '@/lib/tailwind';
|
||||||
|
|
||||||
@@ -34,6 +35,8 @@ import { Stepper } from './Stepper';
|
|||||||
import { StepperStep } from './StepperStep';
|
import { StepperStep } from './StepperStep';
|
||||||
import { Table } from './Table';
|
import { Table } from './Table';
|
||||||
import { Tabs } from './Tabs';
|
import { Tabs } from './Tabs';
|
||||||
|
import { Update } from './Update';
|
||||||
|
import { Updates } from './Updates';
|
||||||
|
|
||||||
export interface BlockProps<Block extends DocumentBlock> extends DocumentContextProps {
|
export interface BlockProps<Block extends DocumentBlock> extends DocumentContextProps {
|
||||||
block: Block;
|
block: Block;
|
||||||
@@ -105,6 +108,10 @@ export function Block<T extends DocumentBlock>(props: BlockProps<T>) {
|
|||||||
return <Stepper {...props} block={block} />;
|
return <Stepper {...props} block={block} />;
|
||||||
case 'stepper-step':
|
case 'stepper-step':
|
||||||
return <StepperStep {...props} block={block} />;
|
return <StepperStep {...props} block={block} />;
|
||||||
|
case 'updates':
|
||||||
|
return <Updates {...props} block={block} />;
|
||||||
|
case 'update':
|
||||||
|
return <Update {...props} block={block} />;
|
||||||
case 'if':
|
case 'if':
|
||||||
// If block should be processed by the API.
|
// If block should be processed by the API.
|
||||||
return null;
|
return null;
|
||||||
@@ -165,10 +172,13 @@ export function BlockSkeleton(props: { block: DocumentBlock; style: ClassValue }
|
|||||||
case 'images':
|
case 'images':
|
||||||
case 'drawing':
|
case 'drawing':
|
||||||
return <SkeletonImage id={id} style={style} />;
|
return <SkeletonImage id={id} style={style} />;
|
||||||
|
case 'updates':
|
||||||
|
return <SkeletonUpdate id={id} style={style} />;
|
||||||
case 'image':
|
case 'image':
|
||||||
case 'code-line':
|
case 'code-line':
|
||||||
case 'tabs-item':
|
case 'tabs-item':
|
||||||
case 'column':
|
case 'column':
|
||||||
|
case 'update':
|
||||||
throw new Error(`Blocks (${block.type}) should be directly rendered by parent`);
|
throw new Error(`Blocks (${block.type}) should be directly rendered by parent`);
|
||||||
default:
|
default:
|
||||||
return nullIfNever(block);
|
return nullIfNever(block);
|
||||||
|
|||||||
@@ -1,9 +1,18 @@
|
|||||||
import { type DocumentBlockContentRef, SiteInsightsLinkPosition } from '@gitbook/api';
|
import {
|
||||||
|
type ContentRef,
|
||||||
|
type DocumentBlockContentRef,
|
||||||
|
SiteInsightsLinkPosition,
|
||||||
|
} from '@gitbook/api';
|
||||||
|
|
||||||
import { Card } from '@/components/primitives';
|
import { Card, type CardProps } from '@/components/primitives';
|
||||||
import { type ResolvedContentRef, resolveContentRef } from '@/lib/references';
|
import {
|
||||||
|
type ResolvedContentRef,
|
||||||
|
resolveContentRef,
|
||||||
|
resolveContentRefFallback,
|
||||||
|
} from '@/lib/references';
|
||||||
|
|
||||||
import type { BlockProps } from './Block';
|
import type { BlockProps } from './Block';
|
||||||
|
import { NotFoundRefHoverCard } from './NotFoundRefHoverCard';
|
||||||
|
|
||||||
export async function BlockContentRef(props: BlockProps<DocumentBlockContentRef>) {
|
export async function BlockContentRef(props: BlockProps<DocumentBlockContentRef>) {
|
||||||
const { block, context, style } = props;
|
const { block, context, style } = props;
|
||||||
@@ -16,51 +25,45 @@ export async function BlockContentRef(props: BlockProps<DocumentBlockContentRef>
|
|||||||
: null;
|
: null;
|
||||||
|
|
||||||
if (!resolved) {
|
if (!resolved) {
|
||||||
return null;
|
const fallback = resolveContentRefFallback(block.data.ref);
|
||||||
|
if (!fallback) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return (
|
||||||
|
<NotFoundRefHoverCard context={context}>
|
||||||
|
<BlockContentRefCard
|
||||||
|
contentRef={block.data.ref}
|
||||||
|
resolved={fallback}
|
||||||
|
style={style}
|
||||||
|
/>
|
||||||
|
</NotFoundRefHoverCard>
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
const isContentInOtherSpace =
|
return <BlockContentRefCard contentRef={block.data.ref} resolved={resolved} style={style} />;
|
||||||
context.contentContext?.space &&
|
}
|
||||||
'space' in block.data.ref &&
|
|
||||||
context.contentContext.space.id !== block.data.ref.space;
|
|
||||||
const kind = block?.data?.ref?.kind;
|
|
||||||
if ((resolved.active && kind === 'space') || isContentInOtherSpace) {
|
|
||||||
return <SpaceRefCard {...props} resolved={resolved} />;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
function BlockContentRefCard(
|
||||||
|
props: {
|
||||||
|
resolved: ResolvedContentRef;
|
||||||
|
contentRef: ContentRef;
|
||||||
|
} & Omit<CardProps, 'href' | 'title'>
|
||||||
|
) {
|
||||||
|
const { ref, resolved, contentRef, ...rest } = props;
|
||||||
return (
|
return (
|
||||||
<Card
|
<Card
|
||||||
|
ref={ref}
|
||||||
leadingIcon={resolved.icon ? resolved.icon : null}
|
leadingIcon={resolved.icon ? resolved.icon : null}
|
||||||
href={resolved.href}
|
href={resolved.href}
|
||||||
title={resolved.text}
|
title={resolved.text}
|
||||||
style={style}
|
|
||||||
insights={{
|
insights={{
|
||||||
type: 'link_click',
|
type: 'link_click',
|
||||||
link: {
|
link: {
|
||||||
target: block.data.ref,
|
target: contentRef,
|
||||||
position: SiteInsightsLinkPosition.Content,
|
position: SiteInsightsLinkPosition.Content,
|
||||||
},
|
},
|
||||||
}}
|
}}
|
||||||
/>
|
{...rest}
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function SpaceRefCard(
|
|
||||||
props: { resolved: ResolvedContentRef } & BlockProps<DocumentBlockContentRef>
|
|
||||||
) {
|
|
||||||
const { context, style, resolved } = props;
|
|
||||||
const spaceId = context.contentContext?.space.id;
|
|
||||||
|
|
||||||
if (!spaceId) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Card
|
|
||||||
href={resolved.href}
|
|
||||||
title={resolved.text}
|
|
||||||
postTitle={resolved.subText}
|
|
||||||
style={style}
|
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -51,11 +51,13 @@ type UnwrappedBlocksProps<TBlock extends DocumentBlock> = DocumentContextProps &
|
|||||||
* Ideally we'd rely on the block type to determine if it can be full width, but
|
* Ideally we'd rely on the block type to determine if it can be full width, but
|
||||||
* the block's `fullWidth` property does not differentiate between `undefined` and `false`.
|
* the block's `fullWidth` property does not differentiate between `undefined` and `false`.
|
||||||
* So instead we hardcode a list of blocks that can be full width. */
|
* So instead we hardcode a list of blocks that can be full width. */
|
||||||
const FULL_WIDTH_BLOCKS = [
|
const FULL_WIDTH_BLOCKS: DocumentBlock['type'][] = [
|
||||||
'table',
|
'table',
|
||||||
'tabs',
|
'tabs',
|
||||||
'integration',
|
'integration',
|
||||||
'openapi',
|
'openapi-operation',
|
||||||
|
'openapi-schemas',
|
||||||
|
'openapi-webhook',
|
||||||
'images',
|
'images',
|
||||||
'embed',
|
'embed',
|
||||||
'columns',
|
'columns',
|
||||||
@@ -64,6 +66,8 @@ const FULL_WIDTH_BLOCKS = [
|
|||||||
'hint',
|
'hint',
|
||||||
];
|
];
|
||||||
|
|
||||||
|
const LIST_BLOCKS: DocumentBlock['type'][] = ['list-ordered', 'list-tasks', 'list-unordered'];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Renders a list of blocks without a wrapper element.
|
* Renders a list of blocks without a wrapper element.
|
||||||
*/
|
*/
|
||||||
@@ -85,10 +89,11 @@ export function UnwrappedBlocks<TBlock extends DocumentBlock>(props: UnwrappedBl
|
|||||||
key={node.key || `${node.type}-${index}`}
|
key={node.key || `${node.type}-${index}`}
|
||||||
block={node}
|
block={node}
|
||||||
style={[
|
style={[
|
||||||
'mx-auto page-width-wide:mx-0 w-full decoration-primary/6 print:break-inside-avoid',
|
'mx-auto page-width-wide:mx-0 w-full decoration-primary/6',
|
||||||
node.data && 'fullWidth' in node.data && node.data.fullWidth
|
node.data && 'fullWidth' in node.data && node.data.fullWidth
|
||||||
? 'max-w-screen-xl'
|
? 'max-w-screen-xl'
|
||||||
: 'max-w-3xl',
|
: 'max-w-3xl',
|
||||||
|
!LIST_BLOCKS.includes(node.type) && 'print:break-inside-avoid',
|
||||||
FULL_WIDTH_BLOCKS.includes(node.type) && 'page-width-wide:max-w-full',
|
FULL_WIDTH_BLOCKS.includes(node.type) && 'page-width-wide:max-w-full',
|
||||||
blockStyle,
|
blockStyle,
|
||||||
]}
|
]}
|
||||||
|
|||||||
@@ -1,11 +1,14 @@
|
|||||||
'use client';
|
'use client';
|
||||||
|
|
||||||
import type { DocumentBlockCode } from '@gitbook/api';
|
import type { DocumentBlockCode } from '@gitbook/api';
|
||||||
import { useEffect, useMemo, useRef, useState } from 'react';
|
import { useEffect, useId, useMemo, useRef, useState } from 'react';
|
||||||
|
|
||||||
import { useAdaptiveVisitor } from '@/components/Adaptive';
|
import { useAdaptiveVisitor } from '@/components/Adaptive';
|
||||||
import { useInViewportListener } from '@/components/hooks/useInViewportListener';
|
import { useInViewportListener } from '@/components/hooks/useInViewportListener';
|
||||||
import { useScrollListener } from '@/components/hooks/useScrollListener';
|
import { useScrollListener } from '@/components/hooks/useScrollListener';
|
||||||
|
import { Button } from '@/components/primitives';
|
||||||
|
import { t, useLanguage } from '@/intl/client';
|
||||||
|
import { tcls } from '@/lib/tailwind';
|
||||||
import { useDebounceCallback } from 'usehooks-ts';
|
import { useDebounceCallback } from 'usehooks-ts';
|
||||||
import type { BlockProps } from '../Block';
|
import type { BlockProps } from '../Block';
|
||||||
import { type InlineExpressionVariables, useEvaluateInlineExpression } from '../InlineExpression';
|
import { type InlineExpressionVariables, useEvaluateInlineExpression } from '../InlineExpression';
|
||||||
@@ -16,14 +19,17 @@ import { plainHighlight } from './plain-highlight';
|
|||||||
type ClientBlockProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> & {
|
type ClientBlockProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> & {
|
||||||
inlines: RenderedInline[];
|
inlines: RenderedInline[];
|
||||||
inlineExprVariables: InlineExpressionVariables;
|
inlineExprVariables: InlineExpressionVariables;
|
||||||
|
mode: BlockProps<DocumentBlockCode>['context']['mode'];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const CODE_BLOCK_DEFAULT_COLLAPSED_LINE_COUNT = 10;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Render a code-block client-side by loading the highlighter asynchronously.
|
* Render a code-block client-side by loading the highlighter asynchronously.
|
||||||
* It allows us to defer some load to avoid blocking the rendering of the whole page with block highlighting.
|
* It allows us to defer some load to avoid blocking the rendering of the whole page with block highlighting.
|
||||||
*/
|
*/
|
||||||
export function ClientCodeBlock(props: ClientBlockProps) {
|
export function ClientCodeBlock(props: ClientBlockProps) {
|
||||||
const { block, style, inlines, inlineExprVariables } = props;
|
const { block, mode, style, inlines, inlineExprVariables } = props;
|
||||||
const blockRef = useRef<HTMLDivElement>(null);
|
const blockRef = useRef<HTMLDivElement>(null);
|
||||||
const isInViewportRef = useRef(false);
|
const isInViewportRef = useRef(false);
|
||||||
const [isInViewport, setIsInViewport] = useState(false);
|
const [isInViewport, setIsInViewport] = useState(false);
|
||||||
@@ -113,13 +119,84 @@ export function ClientCodeBlock(props: ClientBlockProps) {
|
|||||||
setLines(null);
|
setLines(null);
|
||||||
}, [isInViewport, block, inlines, evaluateInlineExpression]);
|
}, [isInViewport, block, inlines, evaluateInlineExpression]);
|
||||||
|
|
||||||
return (
|
const expandable = block.data.expandable;
|
||||||
|
|
||||||
|
const numberOfLinesOfCode = lines?.length ?? plainLines.length;
|
||||||
|
const collapsedLineCount =
|
||||||
|
block.data.collapsedLineCount || CODE_BLOCK_DEFAULT_COLLAPSED_LINE_COUNT;
|
||||||
|
const isExpandable = Boolean(
|
||||||
|
expandable && mode !== 'print' && numberOfLinesOfCode > collapsedLineCount
|
||||||
|
);
|
||||||
|
|
||||||
|
const codeBlockBodyId = useId();
|
||||||
|
|
||||||
|
const renderer = (
|
||||||
<CodeBlockRenderer
|
<CodeBlockRenderer
|
||||||
ref={blockRef}
|
ref={blockRef}
|
||||||
aria-busy={highlighting}
|
aria-busy={highlighting}
|
||||||
block={block}
|
block={block}
|
||||||
style={style}
|
style={style}
|
||||||
lines={lines ?? plainLines}
|
lines={lines ?? plainLines}
|
||||||
|
id={codeBlockBodyId}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
|
|
||||||
|
return isExpandable ? (
|
||||||
|
<CodeBlockExpandable
|
||||||
|
lines={lines ?? plainLines}
|
||||||
|
controls={codeBlockBodyId}
|
||||||
|
collapsedLineCount={collapsedLineCount}
|
||||||
|
>
|
||||||
|
{renderer}
|
||||||
|
</CodeBlockExpandable>
|
||||||
|
) : (
|
||||||
|
renderer
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function CodeBlockExpandable(props: {
|
||||||
|
children: React.ReactNode;
|
||||||
|
lines: HighlightLine[];
|
||||||
|
collapsedLineCount: number;
|
||||||
|
controls?: string;
|
||||||
|
}) {
|
||||||
|
const { children, controls, lines = [], collapsedLineCount } = props;
|
||||||
|
const [isExpanded, setIsExpanded] = useState(false);
|
||||||
|
const language = useLanguage();
|
||||||
|
return (
|
||||||
|
<div className="group/codeblock-expandable relative">
|
||||||
|
<div
|
||||||
|
className={tcls(
|
||||||
|
isExpanded
|
||||||
|
? '[&_pre]:after:opacity-0'
|
||||||
|
: '[&_pre]:h-[calc(2rem+var(--line-count)*var(--line-height))] [&_pre]:overflow-y-hidden [&_pre]:after:opacity-100',
|
||||||
|
'[&_pre]:after:pointer-events-none [&_pre]:after:absolute [&_pre]:after:inset-0 [&_pre]:after:z-1 [&_pre]:after:bg-gradient-to-t [&_pre]:after:from-0% [&_pre]:after:from-tint-2 [&_pre]:after:to-70% [&_pre]:after:to-transparent [&_pre]:after:content-[""]'
|
||||||
|
)}
|
||||||
|
style={
|
||||||
|
{
|
||||||
|
'--line-count': collapsedLineCount,
|
||||||
|
'--line-height': '1.25rem',
|
||||||
|
} as React.CSSProperties
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
<div className="pointer-events-none absolute bottom-0 flex w-full justify-center">
|
||||||
|
<Button
|
||||||
|
icon={isExpanded ? 'chevron-up' : 'chevron-down'}
|
||||||
|
size="xsmall"
|
||||||
|
variant="blank"
|
||||||
|
type="button"
|
||||||
|
onClick={() => setIsExpanded(!isExpanded)}
|
||||||
|
className="pointer-events-auto z-1 my-2 text-primary text-sm opacity-0 focus:opacity-11 group-hover/codeblock-expandable:opacity-11"
|
||||||
|
aria-expanded={isExpanded}
|
||||||
|
aria-controls={controls}
|
||||||
|
>
|
||||||
|
{isExpanded
|
||||||
|
? t(language, 'code_block_expanded')
|
||||||
|
: t(language, 'code_block_collapsed', lines.length)}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ export async function CodeBlock(props: BlockProps<DocumentBlockCode>) {
|
|||||||
return { inline, body };
|
return { inline, body };
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!isEstimatedOffscreen && !hasInlineExpression) {
|
if (!isEstimatedOffscreen && !hasInlineExpression && !block.data.expandable) {
|
||||||
// In v2, we render the code block server-side
|
// In v2, we render the code block server-side
|
||||||
const lines = await highlight(block, richInlines);
|
const lines = await highlight(block, richInlines);
|
||||||
return <CodeBlockRenderer block={block} style={style} lines={lines} />;
|
return <CodeBlockRenderer block={block} style={style} lines={lines} />;
|
||||||
@@ -73,6 +73,7 @@ export async function CodeBlock(props: BlockProps<DocumentBlockCode>) {
|
|||||||
style={style}
|
style={style}
|
||||||
inlines={richInlines}
|
inlines={richInlines}
|
||||||
inlineExprVariables={variables}
|
inlineExprVariables={variables}
|
||||||
|
mode={context.mode}
|
||||||
/>
|
/>
|
||||||
</React.Suspense>
|
</React.Suspense>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import type { HighlightLine, HighlightToken } from './highlight';
|
|||||||
type CodeBlockRendererProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> & {
|
type CodeBlockRendererProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> & {
|
||||||
lines: HighlightLine[];
|
lines: HighlightLine[];
|
||||||
'aria-busy'?: boolean;
|
'aria-busy'?: boolean;
|
||||||
|
id?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -23,11 +24,12 @@ export const CodeBlockRenderer = forwardRef(function CodeBlockRenderer(
|
|||||||
) {
|
) {
|
||||||
const { block, style, lines, 'aria-busy': ariaBusy } = props;
|
const { block, style, lines, 'aria-busy': ariaBusy } = props;
|
||||||
|
|
||||||
const id = useId();
|
|
||||||
const withLineNumbers = Boolean(block.data.lineNumbers) && block.nodes.length > 1;
|
const withLineNumbers = Boolean(block.data.lineNumbers) && block.nodes.length > 1;
|
||||||
const withWrap = block.data.overflow === 'wrap';
|
const withWrap = block.data.overflow === 'wrap';
|
||||||
const title = block.data.title;
|
const title = block.data.title;
|
||||||
|
|
||||||
|
const id = useId();
|
||||||
|
const codeId = props.id || id;
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
ref={ref}
|
ref={ref}
|
||||||
@@ -42,7 +44,7 @@ export const CodeBlockRenderer = forwardRef(function CodeBlockRenderer(
|
|||||||
) : null}
|
) : null}
|
||||||
</div>
|
</div>
|
||||||
<CopyCodeButton
|
<CopyCodeButton
|
||||||
codeId={id}
|
codeId={codeId}
|
||||||
style="z-2 mt-2 mr-2 self-start justify-self-end leading-none opacity-0 backdrop-blur-md [grid-area:2/1] group-hover/codeblock:opacity-11"
|
style="z-2 mt-2 mr-2 self-start justify-self-end leading-none opacity-0 backdrop-blur-md [grid-area:2/1] group-hover/codeblock:opacity-11"
|
||||||
/>
|
/>
|
||||||
<pre
|
<pre
|
||||||
@@ -53,7 +55,7 @@ export const CodeBlockRenderer = forwardRef(function CodeBlockRenderer(
|
|||||||
)}
|
)}
|
||||||
>
|
>
|
||||||
<code
|
<code
|
||||||
id={id}
|
id={codeId}
|
||||||
className={tcls(
|
className={tcls(
|
||||||
'inline-grid min-w-full grid-cols-[auto_1fr] [count-reset:line] print:whitespace-pre-wrap',
|
'inline-grid min-w-full grid-cols-[auto_1fr] [count-reset:line] print:whitespace-pre-wrap',
|
||||||
withWrap && 'whitespace-pre-wrap'
|
withWrap && 'whitespace-pre-wrap'
|
||||||
|
|||||||
@@ -80,6 +80,7 @@ export function Column(props: {
|
|||||||
<div
|
<div
|
||||||
className={tcls(
|
className={tcls(
|
||||||
'flex flex-col',
|
'flex flex-col',
|
||||||
|
'@container/column',
|
||||||
(verticalAlignment === VerticalAlignment.Top || !verticalAlignment) &&
|
(verticalAlignment === VerticalAlignment.Top || !verticalAlignment) &&
|
||||||
'justify-start',
|
'justify-start',
|
||||||
verticalAlignment === VerticalAlignment.Middle && 'justify-center',
|
verticalAlignment === VerticalAlignment.Middle && 'justify-center',
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ export async function Drawing(props: BlockProps<DocumentBlockDrawing>) {
|
|||||||
alt="Drawing"
|
alt="Drawing"
|
||||||
sizes={imageBlockSizes}
|
sizes={imageBlockSizes}
|
||||||
zoom
|
zoom
|
||||||
|
loading="lazy"
|
||||||
/>
|
/>
|
||||||
</Caption>
|
</Caption>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -60,6 +60,7 @@ export async function Embed(props: BlockProps<gitbookAPI.DocumentBlockEmbed>) {
|
|||||||
sources={{ light: { src: embed.icon } }}
|
sources={{ light: { src: embed.icon } }}
|
||||||
sizes={[{ width: 20 }]}
|
sizes={[{ width: 20 }]}
|
||||||
resize={context.contentContext.imageResizer}
|
resize={context.contentContext.imageResizer}
|
||||||
|
loading="lazy"
|
||||||
/>
|
/>
|
||||||
) : null
|
) : null
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,29 +17,34 @@ export function Details(props: {
|
|||||||
}) {
|
}) {
|
||||||
const { children, id, className } = props;
|
const { children, id, className } = props;
|
||||||
|
|
||||||
const detailsRef = React.useRef<HTMLDetailsElement>(null);
|
const ref = React.useRef<HTMLDetailsElement>(null);
|
||||||
|
|
||||||
const [openFromHash, setOpenFromHash] = React.useState(false);
|
const [openFromHash, setOpenFromHash] = React.useState(false);
|
||||||
|
|
||||||
const hash = useHash();
|
const hash = useHash();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Open the details element if the url hash refers to the id of the details element
|
* Open the details element if the url hash refers to the id of the details element
|
||||||
* or the id of some element contained within the details element.
|
* or the id of some element contained within the details element.
|
||||||
*/
|
*/
|
||||||
React.useEffect(() => {
|
React.useEffect(() => {
|
||||||
if (!hash || !detailsRef.current) {
|
if (!hash || !ref.current) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (hash === id) {
|
if (hash === id) {
|
||||||
setOpenFromHash(true);
|
setOpenFromHash(true);
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const activeElement = document.getElementById(hash);
|
const activeElement = document.getElementById(hash);
|
||||||
setOpenFromHash(Boolean(activeElement && detailsRef.current?.contains(activeElement)));
|
const isOpen = Boolean(activeElement && ref.current.contains(activeElement));
|
||||||
|
setOpenFromHash(isOpen);
|
||||||
}, [hash, id]);
|
}, [hash, id]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<details
|
<details
|
||||||
ref={detailsRef}
|
ref={ref}
|
||||||
id={id}
|
id={id}
|
||||||
open={props.open || openFromHash}
|
open={props.open || openFromHash}
|
||||||
className={tcls(
|
className={tcls(
|
||||||
|
|||||||
@@ -25,7 +25,11 @@ export function Expandable(props: BlockProps<DocumentBlockExpandable>) {
|
|||||||
id = context.getId ? context.getId(id) : id;
|
id = context.getId ? context.getId(id) : id;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Details id={id} open={context.mode === 'print'} className={style}>
|
<Details
|
||||||
|
id={id}
|
||||||
|
open={context.mode === 'print'}
|
||||||
|
className={tcls('scroll-mt-(--content-scroll-margin)', style)}
|
||||||
|
>
|
||||||
<summary
|
<summary
|
||||||
className={tcls(
|
className={tcls(
|
||||||
'cursor-pointer',
|
'cursor-pointer',
|
||||||
@@ -47,7 +51,7 @@ export function Expandable(props: BlockProps<DocumentBlockExpandable>) {
|
|||||||
className={tcls(
|
className={tcls(
|
||||||
'inline-block',
|
'inline-block',
|
||||||
'size-3',
|
'size-3',
|
||||||
'mr-2',
|
'mr-3',
|
||||||
'mb-1',
|
'mb-1',
|
||||||
'transition-transform',
|
'transition-transform',
|
||||||
'shrink-0',
|
'shrink-0',
|
||||||
@@ -92,7 +96,7 @@ export function Expandable(props: BlockProps<DocumentBlockExpandable>) {
|
|||||||
document={document}
|
document={document}
|
||||||
ancestorBlocks={[...ancestorBlocks, block]}
|
ancestorBlocks={[...ancestorBlocks, block]}
|
||||||
context={context}
|
context={context}
|
||||||
style={['px-10', 'pb-5', 'space-y-4']}
|
style="space-y-4 px-10 pb-5"
|
||||||
/>
|
/>
|
||||||
</Details>
|
</Details>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
import { type DocumentBlockFile, SiteInsightsLinkPosition } from '@gitbook/api';
|
import { type DocumentBlockFile, SiteInsightsLinkPosition } from '@gitbook/api';
|
||||||
|
|
||||||
|
import { t } from '@/intl/translate';
|
||||||
import { getSimplifiedContentType } from '@/lib/files';
|
import { getSimplifiedContentType } from '@/lib/files';
|
||||||
import { resolveContentRef } from '@/lib/references';
|
import { resolveContentRef } from '@/lib/references';
|
||||||
import { tcls } from '@/lib/tailwind';
|
|
||||||
|
|
||||||
import { Link } from '../primitives';
|
import { getSpaceLanguage } from '@/intl/server';
|
||||||
|
import { Button, Link } from '../primitives';
|
||||||
|
import { DownloadButton } from '../primitives/DownloadButton';
|
||||||
import type { BlockProps } from './Block';
|
import type { BlockProps } from './Block';
|
||||||
import { Caption } from './Caption';
|
import { Caption } from './Caption';
|
||||||
import { FileIcon } from './FileIcon';
|
import { FileIcon } from './FileIcon';
|
||||||
@@ -12,67 +14,70 @@ import { FileIcon } from './FileIcon';
|
|||||||
export async function File(props: BlockProps<DocumentBlockFile>) {
|
export async function File(props: BlockProps<DocumentBlockFile>) {
|
||||||
const { block, context } = props;
|
const { block, context } = props;
|
||||||
|
|
||||||
const contentRef = context.contentContext
|
if (!context.contentContext) {
|
||||||
? await resolveContentRef(block.data.ref, context.contentContext)
|
return null;
|
||||||
: null;
|
}
|
||||||
|
|
||||||
|
const contentRef = await resolveContentRef(block.data.ref, context.contentContext);
|
||||||
const file = contentRef?.file;
|
const file = contentRef?.file;
|
||||||
|
|
||||||
if (!file) {
|
if (!file) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const language = getSpaceLanguage(context.contentContext);
|
||||||
const contentType = getSimplifiedContentType(file.contentType);
|
const contentType = getSimplifiedContentType(file.contentType);
|
||||||
|
const insights = {
|
||||||
|
type: 'link_click' as const,
|
||||||
|
link: {
|
||||||
|
target: block.data.ref,
|
||||||
|
position: SiteInsightsLinkPosition.Content,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Caption {...props} withBorder>
|
<Caption {...props} withBorder>
|
||||||
<Link
|
<div className="flex flex-wrap items-center gap-5 px-5 py-3">
|
||||||
href={file.downloadURL}
|
<div className="flex min-w-14 flex-col items-center gap-1 border-tint-subtle border-r pr-5">
|
||||||
download={file.name}
|
<FileIcon contentType={contentType} className="size-5 text-primary" />
|
||||||
insights={{
|
<div className="text-hint text-xs">{getHumanFileSize(file.size)}</div>
|
||||||
type: 'link_click',
|
</div>
|
||||||
link: {
|
<div className="min-w-24 flex-1">
|
||||||
target: block.data.ref,
|
<div className="text-base">
|
||||||
position: SiteInsightsLinkPosition.Content,
|
<Link
|
||||||
},
|
href={file.downloadURL}
|
||||||
}}
|
target="_blank"
|
||||||
className={tcls('group/file', 'flex', 'flex-row', 'items-center', 'px-5', 'py-3')}
|
insights={insights}
|
||||||
>
|
className="hover:underline"
|
||||||
<div
|
>
|
||||||
className={tcls(
|
{file.name}
|
||||||
'min-w-14',
|
</Link>
|
||||||
'mr-5',
|
|
||||||
'pr-5',
|
|
||||||
'flex',
|
|
||||||
'flex-col',
|
|
||||||
'items-center',
|
|
||||||
'gap-1',
|
|
||||||
'border-r',
|
|
||||||
'border-tint-subtle'
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<div>
|
|
||||||
<FileIcon
|
|
||||||
contentType={contentType}
|
|
||||||
className={tcls('size-5', 'text-primary')}
|
|
||||||
/>
|
|
||||||
</div>
|
</div>
|
||||||
<div
|
<div className="text-sm opacity-9 dark:opacity-8">{contentType}</div>
|
||||||
className={tcls(
|
</div>
|
||||||
'text-xs',
|
<div className="flex shrink-0 flex-wrap gap-2">
|
||||||
'text-tint',
|
<DownloadButton
|
||||||
'group-hover/file:text-tint-strong'
|
icon="download"
|
||||||
)}
|
size="xsmall"
|
||||||
|
variant="secondary"
|
||||||
|
downloadUrl={file.downloadURL}
|
||||||
|
filename={file.name}
|
||||||
|
insights={insights}
|
||||||
>
|
>
|
||||||
{getHumanFileSize(file.size)}
|
{t(language, 'download')}
|
||||||
</div>
|
</DownloadButton>
|
||||||
|
<Button
|
||||||
|
icon="arrow-up-right-from-square"
|
||||||
|
size="xsmall"
|
||||||
|
variant="secondary"
|
||||||
|
href={file.downloadURL}
|
||||||
|
target="_blank"
|
||||||
|
insights={insights}
|
||||||
|
>
|
||||||
|
{t(language, 'open')}
|
||||||
|
</Button>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
</div>
|
||||||
<div className={tcls('text-base')}>{file.name}</div>
|
|
||||||
<div className={tcls('text-sm', 'opacity-9', 'dark:opacity-8')}>
|
|
||||||
{contentType}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</Link>
|
|
||||||
</Caption>
|
</Caption>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ export function FileIcon(props: { contentType: SimplifiedFileType | null; classN
|
|||||||
const { contentType, className } = props;
|
const { contentType, className } = props;
|
||||||
|
|
||||||
switch (contentType) {
|
switch (contentType) {
|
||||||
case 'pdf':
|
case 'PDF':
|
||||||
return <Icon icon="file-pdf" className={className} />;
|
return <Icon icon="file-pdf" className={className} />;
|
||||||
case 'image':
|
case 'image':
|
||||||
return <Icon icon="file-image" className={className} />;
|
return <Icon icon="file-image" className={className} />;
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user