mirror of
https://github.com/GitbookIO/gitbook.git
synced 2026-09-14 06:35:17 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 81af6bb077 |
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Fix an issue with the cookie banner buttons being non responsive
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@gitbook/cache-do': patch
|
||||
---
|
||||
|
||||
Disable cloudflare observability in production
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Update styling of search+ask modal
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Fix a regression in variant drop-down caused by missing z-index.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Add scroll margin to the top when there are sections
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Smoother tab transition for sections
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': minor
|
||||
---
|
||||
|
||||
Fix an issue where the active site section indicator appeared above any dropdowns.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Don't adjust fallback font for mono font.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
Fixed scalar api client routing
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Optimize performances by using new API endpoint for fetching site data.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
Bump @scalar/api-client-react version
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
Support Integers in Response example
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Restyle hint blocks
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Fix security issue with image resizing that could be used for phishing
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
bumped the scalar api client dependency
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'@gitbook/react-openapi': patch
|
||||
---
|
||||
|
||||
Bumped scalar api client pacakge
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': minor
|
||||
---
|
||||
|
||||
Fix an issue where the space dropdown was shown under the site sections in Safari.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Fix - whitespace added to site section tabs with icons.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
Add icons to sections
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': patch
|
||||
---
|
||||
|
||||
style: adds missing scalar css variables
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': minor
|
||||
---
|
||||
|
||||
Fix an issue where the space dropdown could appear behind the header.
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
'gitbook': minor
|
||||
---
|
||||
|
||||
Fix the styling of site section tabs on smaller screens.
|
||||
@@ -12,7 +12,7 @@ runs:
|
||||
|
||||
# Cache browser binaries, cache key is based on Playwright version and OS
|
||||
- name: 🧰 Cache Playwright browser binaries
|
||||
uses: actions/cache@v4
|
||||
uses: actions/cache@v3
|
||||
id: playwright-cache
|
||||
with:
|
||||
path: '~/.cache/ms-playwright'
|
||||
|
||||
@@ -30,6 +30,16 @@ jobs:
|
||||
run: bun install --frozen-lockfile
|
||||
env:
|
||||
PUPPETEER_SKIP_DOWNLOAD: 1
|
||||
- name: Cache Next.js build
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
${{ github.workspace }}/.next/cache
|
||||
# Generate a new cache whenever packages or source files change.
|
||||
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx') }}
|
||||
# If source files changed but packages didn't, rebuild from a prior cache.
|
||||
restore-keys: |
|
||||
${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-
|
||||
- name: Sets env vars for production
|
||||
run: |
|
||||
echo "SENTRY_ENVIRONMENT=production" >> $GITHUB_ENV
|
||||
|
||||
@@ -1,11 +1,5 @@
|
||||
# @gitbook/cache-do
|
||||
|
||||
## 0.1.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- b7a5106: Disable cloudflare observability in production
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
"default": "./dist/api.js"
|
||||
}
|
||||
},
|
||||
"version": "0.1.1",
|
||||
"version": "0.1.0",
|
||||
"dependencies": {
|
||||
"@msgpack/msgpack": "^3.0.0-beta2",
|
||||
"lru_map": "^0.4.1"
|
||||
|
||||
@@ -1,45 +1,5 @@
|
||||
# gitbook
|
||||
|
||||
## 0.5.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 57cdd25: GitBook Open now supports Ask AI in sites. When asking a question to Ask AI, GitBook will use context from across your site sections and variants to provide the best answer.
|
||||
- ca134c8: Fix an issue where the active site section indicator appeared above any dropdowns.
|
||||
- d48926e: Fix an issue where the space dropdown was shown under the site sections in Safari.
|
||||
- 9fe8142: Fix an issue where Ask AI was erroring due to an object being passed as a param.
|
||||
- d843e5e: Fix an issue where the space dropdown could appear behind the header.
|
||||
- a2e5647: Fix the styling of site section tabs on smaller screens.
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 076dc48: Fix expandable block anchore resolution
|
||||
- d9bb9f9: Fix an issue with the cookie banner buttons being non responsive
|
||||
- 23584c9: Update the site header with new styling, a new search button, and refactored layout
|
||||
- 664debc: Add support for tint color
|
||||
- 4d56f11: Update styling of search+ask modal
|
||||
- 061c0c1: Fix a regression in variant drop-down caused by missing z-index.
|
||||
- 2f76712: Add breadcrumbs above page title
|
||||
- 07cf835: Add scroll margin to the top when there are sections
|
||||
- 5d72b35: Smoother tab transition for sections
|
||||
- 7c71363: Don't adjust fallback font for mono font.
|
||||
- 7675c2c: Optimize performances by using new API endpoint for fetching site data.
|
||||
- 87eea73: Fix margin and image resolution of header logo
|
||||
- aa2ed0f: Restyle hint blocks
|
||||
- ffd3937: Fix security issue with image resizing that could be used for phishing
|
||||
- 2ce59d7: Fix - whitespace added to site section tabs with icons.
|
||||
- c73e07d: Increase token max length to fix code not highlighted
|
||||
- 3b3d6e2: Add icons to sections
|
||||
- 1ed18c0: style: adds missing scalar css variables
|
||||
- Updated dependencies [b7a5106]
|
||||
- Updated dependencies [4771c78]
|
||||
- Updated dependencies [ff50ac2]
|
||||
- Updated dependencies [867481c]
|
||||
- Updated dependencies [7ba67fd]
|
||||
- Updated dependencies [a78c1ec]
|
||||
- @gitbook/cache-do@0.1.1
|
||||
- @gitbook/react-openapi@0.7.1
|
||||
|
||||
## 0.4.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -1,16 +1,11 @@
|
||||
import { argosScreenshot } from '@argos-ci/playwright';
|
||||
import {
|
||||
CustomizationBackground,
|
||||
CustomizationCorners,
|
||||
CustomizationFont,
|
||||
CustomizationHeaderPreset,
|
||||
CustomizationIconsStyle,
|
||||
CustomizationLocale,
|
||||
CustomizationThemeMode,
|
||||
SiteCustomizationSettings,
|
||||
} from '@gitbook/api';
|
||||
import { test, expect, Page } from '@playwright/test';
|
||||
import deepMerge from 'deepmerge';
|
||||
import jwt from 'jsonwebtoken';
|
||||
import rison from 'rison';
|
||||
import { DeepPartial } from 'ts-essentials';
|
||||
@@ -39,18 +34,6 @@ const allLocales: CustomizationLocale[] = [
|
||||
CustomizationLocale.Zh,
|
||||
];
|
||||
|
||||
const allThemeModes: CustomizationThemeMode[] = [
|
||||
CustomizationThemeMode.Light,
|
||||
CustomizationThemeMode.Dark,
|
||||
];
|
||||
|
||||
const allThemePresets: CustomizationHeaderPreset[] = [
|
||||
CustomizationHeaderPreset.Default,
|
||||
CustomizationHeaderPreset.Bold,
|
||||
CustomizationHeaderPreset.Contrast,
|
||||
CustomizationHeaderPreset.Custom,
|
||||
];
|
||||
|
||||
async function waitForCookiesDialog(page: Page) {
|
||||
const dialog = page.getByRole('dialog', { name: 'Cookies' });
|
||||
const accept = dialog.getByRole('button', { name: 'Accept' });
|
||||
@@ -112,9 +95,7 @@ const testCases: TestsCase[] = [
|
||||
name: 'Variants dropdown',
|
||||
url: '',
|
||||
run: async (page) => {
|
||||
const spaceDrowpdown = page
|
||||
.locator('[data-testid="space-dropdown-button"]')
|
||||
.locator('visible=true');
|
||||
const spaceDrowpdown = page.locator('[data-testid="space-dropdown-button"]');
|
||||
await spaceDrowpdown.waitFor();
|
||||
},
|
||||
},
|
||||
@@ -130,9 +111,7 @@ const testCases: TestsCase[] = [
|
||||
name: 'Customized variant titles are displayed',
|
||||
url: '',
|
||||
run: async (page) => {
|
||||
const spaceDrowpdown = page
|
||||
.locator('[data-testid="space-dropdown-button"]')
|
||||
.locator('visible=true');
|
||||
const spaceDrowpdown = page.locator('[data-testid="space-dropdown-button"]');
|
||||
await spaceDrowpdown.click();
|
||||
|
||||
const variantSelectionDropdown = page.locator(
|
||||
@@ -164,9 +143,9 @@ const testCases: TestsCase[] = [
|
||||
url: 'api-multi-versions/reference/api-reference/pets',
|
||||
screenshot: false,
|
||||
run: async (page) => {
|
||||
const spaceDrowpdown = await page
|
||||
.locator('[data-testid="space-dropdown-button"]')
|
||||
.locator('visible=true');
|
||||
const spaceDrowpdown = await page.waitForSelector(
|
||||
'[data-testid="space-dropdown-button"]',
|
||||
);
|
||||
await spaceDrowpdown.click();
|
||||
|
||||
// Click the second variant in the dropdown
|
||||
@@ -187,9 +166,9 @@ const testCases: TestsCase[] = [
|
||||
url: 'api-multi-versions-share-links/8tNo6MeXg7CkFMzSSz81/reference/api-reference/pets',
|
||||
screenshot: false,
|
||||
run: async (page) => {
|
||||
const spaceDrowpdown = await page
|
||||
.locator('[data-testid="space-dropdown-button"]')
|
||||
.locator('visible=true');
|
||||
const spaceDrowpdown = await page.waitForSelector(
|
||||
'[data-testid="space-dropdown-button"]',
|
||||
);
|
||||
await spaceDrowpdown.click();
|
||||
|
||||
// Click the second variant in the dropdown
|
||||
@@ -222,9 +201,9 @@ const testCases: TestsCase[] = [
|
||||
return `api-multi-versions-va/reference/api-reference/pets?jwt_token=${token}`;
|
||||
})(),
|
||||
run: async (page) => {
|
||||
const spaceDrowpdown = await page
|
||||
.locator('[data-testid="space-dropdown-button"]')
|
||||
.locator('visible=true');
|
||||
const spaceDrowpdown = await page.waitForSelector(
|
||||
'[data-testid="space-dropdown-button"]',
|
||||
);
|
||||
await spaceDrowpdown.click();
|
||||
|
||||
// Click the second variant in the dropdown
|
||||
@@ -456,38 +435,30 @@ const testCases: TestsCase[] = [
|
||||
{
|
||||
name: 'Customization',
|
||||
baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
|
||||
tests: allThemeModes.flatMap((theme) => [
|
||||
tests: [
|
||||
{
|
||||
name: `Without header - Theme ${theme}`,
|
||||
name: 'Without header',
|
||||
url: getCustomizationURL({
|
||||
header: {
|
||||
preset: CustomizationHeaderPreset.None,
|
||||
links: [],
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
},
|
||||
{
|
||||
name: `With duotone icons - Theme ${theme}`,
|
||||
name: 'With duotone icons',
|
||||
url:
|
||||
'page-options/page-with-icon' +
|
||||
getCustomizationURL({
|
||||
styling: {
|
||||
icons: CustomizationIconsStyle.Duotone,
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
},
|
||||
{
|
||||
name: `With header buttons - Theme ${theme}`,
|
||||
name: 'With header buttons',
|
||||
url: getCustomizationURL({
|
||||
header: {
|
||||
preset: CustomizationHeaderPreset.Default,
|
||||
@@ -504,101 +475,10 @@ const testCases: TestsCase[] = [
|
||||
},
|
||||
],
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
},
|
||||
{
|
||||
name: `Without tint - Default preset - Theme ${theme}`,
|
||||
url: getCustomizationURL({
|
||||
header: {
|
||||
preset: CustomizationHeaderPreset.Default,
|
||||
links: [
|
||||
{
|
||||
title: 'Secondary button',
|
||||
to: { kind: 'url', url: 'https://www.gitbook.com' },
|
||||
style: 'button-secondary',
|
||||
},
|
||||
{
|
||||
title: 'Primary button',
|
||||
to: { kind: 'url', url: 'https://www.gitbook.com' },
|
||||
style: 'button-primary',
|
||||
},
|
||||
],
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
},
|
||||
...allThemePresets.flatMap((preset) => ({
|
||||
name: `With tint - Preset ${preset} - Theme ${theme}`,
|
||||
url: getCustomizationURL({
|
||||
styling: {
|
||||
tint: { color: { light: '#346DDB', dark: '#346DDB' } },
|
||||
},
|
||||
header: {
|
||||
preset,
|
||||
...(preset === CustomizationHeaderPreset.Custom
|
||||
? {
|
||||
backgroundColor: { light: '#C62C68', dark: '#EF96B8' },
|
||||
linkColor: { light: '#4DDE98', dark: '#0C693D' },
|
||||
}
|
||||
: {}),
|
||||
links: [
|
||||
{
|
||||
title: 'Secondary button',
|
||||
to: { kind: 'url', url: 'https://www.gitbook.com' },
|
||||
style: 'button-secondary',
|
||||
},
|
||||
{
|
||||
title: 'Primary button',
|
||||
to: { kind: 'url', url: 'https://www.gitbook.com' },
|
||||
style: 'button-primary',
|
||||
},
|
||||
],
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
})),
|
||||
{
|
||||
name: `With tint - Legacy background match - Theme ${theme}`,
|
||||
url: getCustomizationURL({
|
||||
styling: {
|
||||
background: CustomizationBackground.Match,
|
||||
},
|
||||
header: {
|
||||
preset: CustomizationHeaderPreset.Default,
|
||||
links: [
|
||||
{
|
||||
title: 'Secondary button',
|
||||
to: { kind: 'url', url: 'https://www.gitbook.com' },
|
||||
style: 'button-secondary',
|
||||
},
|
||||
{
|
||||
title: 'Primary button',
|
||||
to: { kind: 'url', url: 'https://www.gitbook.com' },
|
||||
style: 'button-primary',
|
||||
},
|
||||
],
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
},
|
||||
]),
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Ads',
|
||||
@@ -934,178 +814,6 @@ const testCases: TestsCase[] = [
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Adaptive Content - VA',
|
||||
baseUrl: `https://gitbook-open-e2e-sites.gitbook.io/adaptive-content-va/`,
|
||||
tests: [
|
||||
{
|
||||
name: 'isAlphaUser',
|
||||
url: (() => {
|
||||
const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
|
||||
const token = jwt.sign(
|
||||
{
|
||||
name: 'gitbook-open-tests',
|
||||
isAlphaUser: true,
|
||||
},
|
||||
privateKey,
|
||||
{
|
||||
expiresIn: '24h',
|
||||
},
|
||||
);
|
||||
return `?jwt_token=${token}`;
|
||||
})(),
|
||||
run: async (page) => {
|
||||
const alphaUserPage = page
|
||||
.locator('a[class*="group\\/toclink"]')
|
||||
.filter({ hasText: 'Alpha users' });
|
||||
const betaUserPage = page
|
||||
.locator('a[class*="group\\/toclink"]')
|
||||
.filter({ hasText: 'Beta users' });
|
||||
await expect(alphaUserPage).toBeVisible();
|
||||
await expect(betaUserPage).toHaveCount(0);
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'isBetaUser',
|
||||
url: (() => {
|
||||
const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
|
||||
const token = jwt.sign(
|
||||
{
|
||||
name: 'gitbook-open-tests',
|
||||
isBetaUser: true,
|
||||
},
|
||||
privateKey,
|
||||
{
|
||||
expiresIn: '24h',
|
||||
},
|
||||
);
|
||||
return `?jwt_token=${token}`;
|
||||
})(),
|
||||
run: async (page) => {
|
||||
const alphaUserPage = page
|
||||
.locator('a[class*="group\\/toclink"]')
|
||||
.filter({ hasText: 'Alpha users' });
|
||||
const betaUserPage = page
|
||||
.locator('a[class*="group\\/toclink"]')
|
||||
.filter({ hasText: 'Beta users' });
|
||||
await expect(betaUserPage).toBeVisible();
|
||||
await expect(alphaUserPage).toHaveCount(0);
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'isAlphaUser & isBetaUser',
|
||||
url: (() => {
|
||||
const privateKey = 'afe09cdf-0f43-480a-b54c-8b1f62f174f9';
|
||||
const token = jwt.sign(
|
||||
{
|
||||
name: 'gitbook-open-tests',
|
||||
isAlphaUser: true,
|
||||
isBetaUser: true,
|
||||
},
|
||||
privateKey,
|
||||
{
|
||||
expiresIn: '24h',
|
||||
},
|
||||
);
|
||||
return `?jwt_token=${token}`;
|
||||
})(),
|
||||
run: async (page) => {
|
||||
const alphaUserPage = page
|
||||
.locator('a[class*="group\\/toclink"]')
|
||||
.filter({ hasText: 'Alpha users' });
|
||||
const betaUserPage = page
|
||||
.locator('a[class*="group\\/toclink"]')
|
||||
.filter({ hasText: 'Beta users' });
|
||||
await expect(alphaUserPage).toBeVisible();
|
||||
await expect(betaUserPage).toBeVisible();
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
name: 'Tables',
|
||||
baseUrl: 'https://gitbook.gitbook.io/test-gitbook-open/',
|
||||
tests: [
|
||||
{
|
||||
name: 'Default table',
|
||||
url: 'blocks/tables',
|
||||
run: waitForCookiesDialog,
|
||||
fullPage: true,
|
||||
},
|
||||
{
|
||||
name: 'Table with straight corners',
|
||||
url:
|
||||
'blocks/tables' +
|
||||
getCustomizationURL({
|
||||
styling: {
|
||||
corners: CustomizationCorners.Straight,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
fullPage: true,
|
||||
},
|
||||
{
|
||||
name: 'Table with primary color',
|
||||
url:
|
||||
'blocks/tables' +
|
||||
getCustomizationURL({
|
||||
styling: {
|
||||
tint: { color: { light: '#346DDB', dark: '#346DDB' } },
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
fullPage: true,
|
||||
},
|
||||
// Test dark mode for each variant
|
||||
...allThemeModes.flatMap((theme) => [
|
||||
{
|
||||
name: `Table in ${theme} mode`,
|
||||
url:
|
||||
'blocks/tables' +
|
||||
getCustomizationURL({
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
fullPage: true,
|
||||
},
|
||||
{
|
||||
name: `Table with straight corners in ${theme} mode`,
|
||||
url:
|
||||
'blocks/tables' +
|
||||
getCustomizationURL({
|
||||
styling: {
|
||||
corners: CustomizationCorners.Straight,
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
fullPage: true,
|
||||
},
|
||||
{
|
||||
name: `Table with primary color in ${theme} mode`,
|
||||
url:
|
||||
'blocks/tables' +
|
||||
getCustomizationURL({
|
||||
styling: {
|
||||
tint: { color: { light: '#346DDB', dark: '#346DDB' } },
|
||||
},
|
||||
themes: {
|
||||
default: theme,
|
||||
toggeable: false,
|
||||
},
|
||||
}),
|
||||
run: waitForCookiesDialog,
|
||||
fullPage: true,
|
||||
},
|
||||
]),
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
for (const testCase of testCases) {
|
||||
@@ -1140,62 +848,7 @@ for (const testCase of testCases) {
|
||||
* Create a URL with customization settings.
|
||||
*/
|
||||
function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettings>): string {
|
||||
/**
|
||||
* Default customization settings.
|
||||
*
|
||||
* The customization object passed to the URL should be a valid API settings object. Hence we extend the test with necessary defaults.
|
||||
*/
|
||||
const DEFAULT_CUSTOMIZATION: SiteCustomizationSettings = {
|
||||
styling: {
|
||||
primaryColor: { light: '#346DDB', dark: '#346DDB' },
|
||||
corners: CustomizationCorners.Rounded,
|
||||
font: CustomizationFont.Inter,
|
||||
background: CustomizationBackground.Plain,
|
||||
icons: CustomizationIconsStyle.Regular,
|
||||
},
|
||||
internationalization: {
|
||||
locale: CustomizationLocale.En,
|
||||
},
|
||||
favicon: {},
|
||||
header: {
|
||||
preset: CustomizationHeaderPreset.Default,
|
||||
links: [],
|
||||
},
|
||||
footer: {
|
||||
groups: [],
|
||||
},
|
||||
themes: {
|
||||
default: CustomizationThemeMode.Light,
|
||||
toggeable: true,
|
||||
},
|
||||
pdf: {
|
||||
enabled: true,
|
||||
},
|
||||
feedback: {
|
||||
enabled: false,
|
||||
},
|
||||
aiSearch: {
|
||||
enabled: true,
|
||||
},
|
||||
advancedCustomization: {
|
||||
enabled: true,
|
||||
},
|
||||
git: {
|
||||
showEditLink: false,
|
||||
},
|
||||
pagination: {
|
||||
enabled: true,
|
||||
},
|
||||
trademark: {
|
||||
enabled: true,
|
||||
},
|
||||
privacyPolicy: {
|
||||
url: 'https://www.gitbook.com/privacy',
|
||||
},
|
||||
socialPreview: {},
|
||||
};
|
||||
|
||||
const encoded = rison.encode_object(deepMerge(DEFAULT_CUSTOMIZATION, partial));
|
||||
const encoded = rison.encode_object(partial);
|
||||
|
||||
const searchParams = new URLSearchParams();
|
||||
searchParams.set('customization', encoded);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "gitbook",
|
||||
"version": "0.5.0",
|
||||
"version": "0.4.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "env-cmd --silent -f ../../.env.local next dev",
|
||||
@@ -16,7 +16,7 @@
|
||||
"clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static"
|
||||
},
|
||||
"dependencies": {
|
||||
"@gitbook/api": "^0.81.0",
|
||||
"@gitbook/api": "^0.80.0",
|
||||
"@gitbook/cache-do": "workspace:*",
|
||||
"@gitbook/emoji-codepoints": "workspace:*",
|
||||
"@gitbook/icons": "workspace:*",
|
||||
@@ -49,8 +49,8 @@
|
||||
"p-map": "^7.0.0",
|
||||
"parse-cache-control": "^1.0.1",
|
||||
"postcss-color-contrast": "^1.1.0",
|
||||
"react": "18.3.1",
|
||||
"react-dom": "18.3.1",
|
||||
"react": "^18",
|
||||
"react-dom": "^18",
|
||||
"react-hotkeys-hook": "^4.4.1",
|
||||
"recoil": "^0.7.7",
|
||||
"rehype-sanitize": "^6.0.0",
|
||||
@@ -68,9 +68,9 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@argos-ci/playwright": "^2.0.0",
|
||||
"@playwright/test": "^1.42.1",
|
||||
"@cloudflare/next-on-pages": "^1.13.5",
|
||||
"@cloudflare/workers-types": "^4.20240725.0",
|
||||
"@playwright/test": "^1.42.1",
|
||||
"@types/js-cookie": "^3.0.6",
|
||||
"@types/jsontoxml": "^1.0.5",
|
||||
"@types/jsonwebtoken": "^9.0.6",
|
||||
@@ -78,12 +78,10 @@
|
||||
"@types/object-hash": "^3.0.6",
|
||||
"@types/parse-cache-control": "^1.0.4",
|
||||
"@types/psi": "^4.1.6",
|
||||
"@types/react": "18.3.13",
|
||||
"@types/react-dom": "18.3.1",
|
||||
"@types/react": "^18.3.3",
|
||||
"@types/react-dom": "^18.3.0",
|
||||
"@types/rison": "^0.0.9",
|
||||
"autoprefixer": "^10",
|
||||
"deepmerge": "^4.3.1",
|
||||
"env-cmd": "^10.1.0",
|
||||
"eslint": "^8",
|
||||
"eslint-config-next": "^14.2.5",
|
||||
"eslint-plugin-import": "^2.29.1",
|
||||
@@ -91,7 +89,8 @@
|
||||
"postcss": "^8",
|
||||
"psi": "^4.1.0",
|
||||
"tailwindcss": "^3.4.0",
|
||||
"ts-essentials": "^10.0.1",
|
||||
"typescript": "^5.5.3"
|
||||
"typescript": "^5.5.3",
|
||||
"env-cmd": "^10.1.0",
|
||||
"ts-essentials": "^10.0.1"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -35,7 +35,6 @@ export default async function Page(props: {
|
||||
customization,
|
||||
pages,
|
||||
page,
|
||||
ancestors,
|
||||
document,
|
||||
} = await getPageDataWithFallback({
|
||||
pagePathParams: params,
|
||||
@@ -104,7 +103,6 @@ export default async function Page(props: {
|
||||
customization={customization}
|
||||
context={contentRefContext}
|
||||
page={page}
|
||||
ancestors={ancestors}
|
||||
document={document}
|
||||
withPageFeedback={
|
||||
// Display the page feedback in the page footer if the aside is not visible
|
||||
@@ -152,8 +150,7 @@ export async function generateMetadata({
|
||||
.join(' | '),
|
||||
description: page.description ?? '',
|
||||
alternates: {
|
||||
// Trim trailing slashes in canonical URL to match the redirect behavior
|
||||
canonical: absoluteHref(getPagePath(pages, page), true).replace(/\/+$/, ''),
|
||||
canonical: absoluteHref(getPagePath(pages, page), true),
|
||||
},
|
||||
openGraph: {
|
||||
images: [
|
||||
|
||||
@@ -42,7 +42,7 @@ export default async function ContentLayout(props: { children: React.ReactNode }
|
||||
sections,
|
||||
} = await fetchContentData();
|
||||
|
||||
ReactDOM.preconnect(api().client.endpoint);
|
||||
ReactDOM.preconnect(api().endpoint);
|
||||
if (assetsDomain) {
|
||||
ReactDOM.preconnect(assetsDomain);
|
||||
}
|
||||
|
||||
@@ -50,7 +50,7 @@ export async function highlight(block: DocumentBlockCode): Promise<HighlightLine
|
||||
|
||||
const lines = highlighter.codeToTokensBase(code, {
|
||||
lang: langName,
|
||||
tokenizeMaxLineLength: 400,
|
||||
tokenizeMaxLineLength: 120,
|
||||
});
|
||||
|
||||
let currentIndex = 0;
|
||||
|
||||
@@ -25,11 +25,7 @@ export async function InlineImage(props: InlineProps<DocumentInlineImage>) {
|
||||
|
||||
return (
|
||||
/* Ensure images dont expand to the size of the container where this Image may be nested in. Now it's always nested in a size-restricted container */
|
||||
<span
|
||||
className={tcls(
|
||||
size !== 'line' ? ['inline-flex', 'max-w-[300px]', 'align-middle'] : null,
|
||||
)}
|
||||
>
|
||||
<span className={tcls(size !== 'line' ? ['inline-flex', 'max-w-[300px]'] : null)}>
|
||||
<Image
|
||||
alt={inline.data.caption ?? ''}
|
||||
sizes={await getImageSizes(size, src)}
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
.light .scalar {
|
||||
--scalar-color-1: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-300, 180 180 180)),
|
||||
rgb(var(--primary-base-300, 180 180 180)),
|
||||
rgb(var(--dark-base, 23 23 23)) 96%
|
||||
);
|
||||
--scalar-color-2: color-mix(
|
||||
@@ -23,12 +23,12 @@
|
||||
--scalar-background-1: rgb(var(--light-base, 255 255 255));
|
||||
--scalar-background-2: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-800, 30 30 30)),
|
||||
rgb(var(--primary-base-800, 30 30 30)),
|
||||
var(--scalar-background-1) 96%
|
||||
);
|
||||
--scalar-background-3: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-800, 30 30 30)),
|
||||
rgb(var(--primary-base-800, 30 30 30)),
|
||||
var(--scalar-background-1) 90%
|
||||
);
|
||||
--scalar-background-accent: #007d9c1f;
|
||||
@@ -66,7 +66,7 @@
|
||||
.dark .scalar {
|
||||
--scalar-color-1: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-700, 70 70 70)),
|
||||
rgb(var(--primary-base-700, 70 70 70)),
|
||||
rgb(var(--light-base, 255 255 255)) 100%
|
||||
);
|
||||
--scalar-color-2: color-mix(
|
||||
@@ -84,12 +84,12 @@
|
||||
--scalar-background-1: rgb(var(--dark-base, 22 22 22));
|
||||
--scalar-background-2: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-200, 200 200 200)),
|
||||
rgb(var(--primary-base-200, 200 200 200)),
|
||||
var(--scalar-background-1) 92%
|
||||
);
|
||||
--scalar-background-3: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-200, 200 200 200)),
|
||||
rgb(var(--primary-base-200, 200 200 200)),
|
||||
var(--scalar-background-1) 88%
|
||||
);
|
||||
--scalar-background-accent: #8ab4f81f;
|
||||
|
||||
@@ -2,7 +2,7 @@ import { ContentRef, DocumentBlockTable } from '@gitbook/api';
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import assertNever from 'assert-never';
|
||||
|
||||
import { Checkbox } from '@/components/primitives';
|
||||
import { Checkbox, Emoji } from '@/components/primitives';
|
||||
import { StyledLink } from '@/components/primitives';
|
||||
import { Image } from '@/components/utils';
|
||||
import { getNodeFragmentByName } from '@/lib/document';
|
||||
|
||||
@@ -1,43 +1,44 @@
|
||||
import { DocumentTableViewGrid } from '@gitbook/api';
|
||||
import React from 'react';
|
||||
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { RecordColumnValue } from './RecordColumnValue';
|
||||
import { TableRecordKV, TableViewProps } from './Table';
|
||||
import styles from './table.module.css';
|
||||
import { getColumnWidth } from './ViewGrid';
|
||||
|
||||
export function RecordRow(
|
||||
export async function RecordRow(
|
||||
props: TableViewProps<DocumentTableViewGrid> & {
|
||||
record: TableRecordKV;
|
||||
autoSizedColumns: string[];
|
||||
fixedColumns: string[];
|
||||
},
|
||||
) {
|
||||
const { view, autoSizedColumns, fixedColumns } = props;
|
||||
const { view } = props;
|
||||
const columnsLengthThreshold = view.columns.length >= 7;
|
||||
|
||||
const tableTR = columnsLengthThreshold
|
||||
? ['[&>*+*]:border-l', '[&>*]:px-4']
|
||||
: ['[&>*+*]:border-l', '[&>*+*]:pl-4'];
|
||||
|
||||
return (
|
||||
<div className={styles.row} role="row">
|
||||
<tr className={tcls(tableTR, 'border-dark/3', 'dark:border-light/2')}>
|
||||
{view.columns.map((column) => {
|
||||
const columnWidth = getColumnWidth({
|
||||
column,
|
||||
columnWidths: view.columnWidths,
|
||||
autoSizedColumns,
|
||||
fixedColumns,
|
||||
});
|
||||
return (
|
||||
<div
|
||||
<td
|
||||
key={column}
|
||||
role="cell"
|
||||
className={styles.cell}
|
||||
style={{
|
||||
width: columnWidth,
|
||||
minWidth: columnWidth || '100px',
|
||||
}}
|
||||
className={tcls(
|
||||
'align-middle',
|
||||
'min-w-[8rem]',
|
||||
'border-dark/2',
|
||||
'py-3',
|
||||
'text-sm',
|
||||
'lg:text-base',
|
||||
'dark:border-light/2',
|
||||
)}
|
||||
>
|
||||
<RecordColumnValue {...props} column={column} />
|
||||
</div>
|
||||
<div className={tcls('pr-4 ', 'text-balance')}>
|
||||
<RecordColumnValue key={column} {...props} column={column} />
|
||||
</div>
|
||||
</td>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
</tr>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { DocumentTableViewGrid } from '@gitbook/api';
|
||||
import * as React from 'react';
|
||||
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
@@ -8,113 +7,159 @@ import { TableViewProps } from './Table';
|
||||
import styles from './table.module.css';
|
||||
import { getColumnAlignment } from './utils';
|
||||
|
||||
/* Columns are sized in 3 ways:
|
||||
1. Set to auto-size by default, these columns share the available width
|
||||
2. Explicitly set by the user by dragging column separator (we then turn off auto-size)
|
||||
3. Auto-size is turned off without setting a width, we then default to a fixed width of 100px
|
||||
*/
|
||||
export function ViewGrid(props: TableViewProps<DocumentTableViewGrid>) {
|
||||
const { block, view, records, style } = props;
|
||||
const columnsOverThreshold = view.columns.length >= 7;
|
||||
|
||||
/* Calculate how many columns are auto-sized vs fixed width */
|
||||
const columnWidths = view.columnWidths;
|
||||
const autoSizedColumns = view.columns.filter((column) => !columnWidths?.[column]);
|
||||
const fixedColumns = view.columns.filter((column) => columnWidths?.[column]);
|
||||
const tableWrapper = columnsOverThreshold
|
||||
? [
|
||||
// has over X columns
|
||||
'overflow-x-auto',
|
||||
'overflow-y-hidden',
|
||||
'mx-auto',
|
||||
'rounded-md',
|
||||
'border',
|
||||
'border-dark/3',
|
||||
'dark:border-light/2',
|
||||
]
|
||||
: ['overflow-x-auto', 'overflow-y-hidden', 'mx-auto'];
|
||||
|
||||
const tableWidth = autoSizedColumns.length > 0 ? 'w-full' : 'w-fit';
|
||||
const tableTR = columnsOverThreshold
|
||||
? ['[&>*+*]:border-l', '[&>*]:px-4']
|
||||
: ['[&>*+*]:border-l', '[&>*+*]:px-4'];
|
||||
|
||||
/* Only show the header when configured and not empty */
|
||||
const tableTH = columnsOverThreshold ? ['py-3'] : ['py-1', 'pt-0'];
|
||||
|
||||
// Only show the header when configured and not empty
|
||||
const withHeader =
|
||||
!view.hideHeader &&
|
||||
view.columns.some((columnId) => block.data.definition[columnId].title.trim().length > 0);
|
||||
|
||||
return (
|
||||
<div className={tcls(style, styles.tableWrapper)}>
|
||||
{/* Table */}
|
||||
<div role="table" className={tcls('flex', 'flex-col')}>
|
||||
{/* Header */}
|
||||
{withHeader && (
|
||||
<div
|
||||
role="rowgroup"
|
||||
className={tcls(
|
||||
tableWidth,
|
||||
styles.rowGroup,
|
||||
'straight-corners:rounded-none',
|
||||
)}
|
||||
>
|
||||
<div role="row" className={tcls('flex', 'w-full')}>
|
||||
<div
|
||||
className={`${tcls(style, 'relative', 'grid', tableWrapper, styles.progressContainer)}`}
|
||||
>
|
||||
{/* ProgressScroller: */}
|
||||
<div
|
||||
className={`${styles.progressOpacitySharp} ${tcls(
|
||||
'grid',
|
||||
'items-center',
|
||||
'grid-area-1-1',
|
||||
'w-[5rem]',
|
||||
'h-full',
|
||||
'top-0',
|
||||
'z-[1]',
|
||||
'sticky',
|
||||
'left-[calc(100%-5rem)]',
|
||||
'pointer-events-none',
|
||||
)}`}
|
||||
>
|
||||
<svg
|
||||
className={`${styles.progressSvg} ${tcls(
|
||||
'grid-area-1-1',
|
||||
'relative',
|
||||
'[strokeDasharray:_0_100]',
|
||||
'z-[1]',
|
||||
'w-7',
|
||||
'mt-3',
|
||||
'mr-3',
|
||||
'self-start',
|
||||
'justify-self-end',
|
||||
'stroke-primary-600',
|
||||
'shadow-1xs',
|
||||
'bg-light',
|
||||
'ring-1',
|
||||
'ring-inset',
|
||||
'rounded-full',
|
||||
'ring-dark/2',
|
||||
'dark:ring-light/2',
|
||||
'dark:bg-dark',
|
||||
'dark:stroke-primary-400',
|
||||
)}`}
|
||||
preserveAspectRatio="xMaxYMid meet"
|
||||
width="100%"
|
||||
viewBox="0 0 26 26"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<circle
|
||||
cx="13"
|
||||
className={`${styles.strokeOpacityProgressInverted}`}
|
||||
cy="13"
|
||||
r="12.5"
|
||||
fill="none"
|
||||
stroke="inherit"
|
||||
strokeWidth="1.5"
|
||||
pathLength="100"
|
||||
strokeLinecap="round"
|
||||
strokeOpacity={0}
|
||||
/>
|
||||
|
||||
<path
|
||||
strokeDasharray="none"
|
||||
d="M12 10L15 13L12 16"
|
||||
stroke="inherit"
|
||||
fill="none"
|
||||
strokeOpacity={0.64}
|
||||
/>
|
||||
</svg>
|
||||
|
||||
<div
|
||||
className={`${styles.progressOpacity} ${tcls(
|
||||
'bg-gradient-to-r',
|
||||
'from-transparent',
|
||||
'to-light',
|
||||
'to-40%',
|
||||
'grid-area-1-1',
|
||||
'w-full',
|
||||
'h-full',
|
||||
'dark:from-transparent',
|
||||
'dark:to-dark/10',
|
||||
)}`}
|
||||
></div>
|
||||
</div>
|
||||
|
||||
{/* Table: */}
|
||||
<table className={tcls('w-full', 'grid-area-1-1', 'table-auto')}>
|
||||
{withHeader ? (
|
||||
<thead>
|
||||
<tr className={tcls(tableTR)}>
|
||||
{view.columns.map((column) => {
|
||||
const columnWidth = view.columnWidths?.[column];
|
||||
const alignment = getColumnAlignment(block.data.definition[column]);
|
||||
|
||||
return (
|
||||
<div
|
||||
<th
|
||||
key={column}
|
||||
role="columnheader"
|
||||
className={tcls(
|
||||
styles.columnHeader,
|
||||
tableTH,
|
||||
'align-middle',
|
||||
'text-balance',
|
||||
'border-b',
|
||||
'border-b-dark/5',
|
||||
'text-left',
|
||||
'text-xs',
|
||||
'lg:text-base',
|
||||
'dark:border-l-light/2',
|
||||
'dark:border-b-light/4',
|
||||
alignment === 'right' ? 'text-right' : null,
|
||||
alignment === 'center' ? 'text-center' : null,
|
||||
)}
|
||||
style={{
|
||||
width: getColumnWidth({
|
||||
column,
|
||||
columnWidths,
|
||||
autoSizedColumns,
|
||||
fixedColumns,
|
||||
}),
|
||||
minWidth: columnWidths?.[column] || '100px',
|
||||
}}
|
||||
title={block.data.definition[column].title}
|
||||
style={columnWidth ? { width: columnWidth } : undefined}
|
||||
>
|
||||
{block.data.definition[column].title}
|
||||
</div>
|
||||
</th>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
<div
|
||||
role="rowgroup"
|
||||
className={tcls('flex', 'flex-col', tableWidth, '[&>*+*]:border-t')}
|
||||
>
|
||||
{records.map((record) => (
|
||||
<RecordRow
|
||||
key={record[0]}
|
||||
record={record}
|
||||
autoSizedColumns={autoSizedColumns}
|
||||
fixedColumns={fixedColumns}
|
||||
{...props}
|
||||
/>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</tr>
|
||||
</thead>
|
||||
) : null}
|
||||
<tbody className={tcls('[&>*+*]:border-t')}>
|
||||
{records.map((record) => {
|
||||
return <RecordRow key={record[0]} {...props} record={record} />;
|
||||
})}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export const getColumnWidth = ({
|
||||
column,
|
||||
columnWidths,
|
||||
autoSizedColumns,
|
||||
fixedColumns,
|
||||
}: {
|
||||
column: string;
|
||||
columnWidths: Record<string, number> | undefined;
|
||||
autoSizedColumns: string[];
|
||||
fixedColumns: string[];
|
||||
}) => {
|
||||
const columnWidth = columnWidths?.[column];
|
||||
|
||||
/* Column was explicitly set by user or user turned off auto-sizing (in that case, columnWidth should've also been set to 100px) */
|
||||
if (columnWidth) return `${columnWidth}px`;
|
||||
|
||||
/* Fallback minimum width for columns, so the columns don't become unreadable from being too narrow and instead table will become scrollable. */
|
||||
const minAutoColumnWidth = '100px';
|
||||
|
||||
const totalFixedWidth = fixedColumns.reduce((sum, col) => {
|
||||
return sum + (columnWidths?.[col] || 0);
|
||||
}, 0);
|
||||
|
||||
/* Column should use auto-sizing, which means it grows to fill available space */
|
||||
const availableWidth = `calc((100% - ${totalFixedWidth}px) / ${autoSizedColumns.length})`;
|
||||
return `clamp(${minAutoColumnWidth}, ${availableWidth}, 100%)`;
|
||||
};
|
||||
|
||||
@@ -1,59 +1,87 @@
|
||||
/* Detect whether a scrollbar exists on the table */
|
||||
@keyframes detect-scroll {
|
||||
from,
|
||||
to {
|
||||
--can-scroll: ;
|
||||
/* Hide it on browsers (firefox / safari) that do not support it */
|
||||
.progressOpacitySharp {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@supports (animation-timeline: scroll()) {
|
||||
.progressContainer {
|
||||
scroll-timeline-name: --squareTimeline;
|
||||
scroll-timeline-axis: x;
|
||||
}
|
||||
|
||||
.progressOpacity {
|
||||
animation-name: opacityProgress;
|
||||
animation-duration: 1ms;
|
||||
animation-direction: alternate;
|
||||
animation-timeline: --squareTimeline;
|
||||
animation-timing-function: linear;
|
||||
}
|
||||
|
||||
.progressOpacitySharp {
|
||||
display: grid;
|
||||
opacity: 0;
|
||||
animation-name: opacityProgressSharp;
|
||||
animation-duration: 1ms;
|
||||
animation-direction: alternate;
|
||||
animation-timeline: --squareTimeline;
|
||||
animation-timing-function: linear;
|
||||
}
|
||||
|
||||
.strokeOpacityProgressInverted {
|
||||
animation-name: strokeOpacityProgressInverted;
|
||||
animation-duration: 1ms;
|
||||
animation-direction: alternate;
|
||||
animation-timeline: --squareTimeline;
|
||||
animation-timing-function: linear;
|
||||
}
|
||||
|
||||
.progressSvg {
|
||||
animation-name: svgProgress;
|
||||
animation-duration: 1ms;
|
||||
animation-direction: alternate;
|
||||
animation-timeline: --squareTimeline;
|
||||
animation-timing-function: linear;
|
||||
}
|
||||
|
||||
@keyframes opacityProgress {
|
||||
0%,
|
||||
50% {
|
||||
opacity: 1;
|
||||
}
|
||||
100% {
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes opacityProgressSharp {
|
||||
0%,
|
||||
98% {
|
||||
opacity: 1;
|
||||
}
|
||||
100% {
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes strokeOpacityProgressInverted {
|
||||
0%,
|
||||
10% {
|
||||
stroke-opacity: 0;
|
||||
}
|
||||
30% {
|
||||
stroke-opacity: 0.88;
|
||||
}
|
||||
100% {
|
||||
stroke-opacity: 0.88;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes svgProgress {
|
||||
from {
|
||||
stroke-dasharray: 0 100;
|
||||
}
|
||||
to {
|
||||
stroke-dasharray: 100 100;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/* Apply styles to the Table if scrollbar exists */
|
||||
.tableWrapper {
|
||||
animation: detect-scroll linear;
|
||||
animation-timeline: scroll(self x);
|
||||
|
||||
--border-radius-if-can-scroll: var(--can-scroll) 0.375rem;
|
||||
--border-radius-if-cant-scroll: 0;
|
||||
border-radius: var(--border-radius-if-can-scroll, var(--border-radius-if-cant-scroll));
|
||||
|
||||
--border-width-if-can-scroll: var(--can-scroll) 1px;
|
||||
--border-width-if-cant-scroll: 0;
|
||||
border-width: var(--border-width-if-can-scroll, var(--border-width-if-cant-scroll));
|
||||
|
||||
@apply relative grid w-full overflow-x-auto overflow-y-hidden mx-auto border-dark/3;
|
||||
}
|
||||
|
||||
:global(.dark) .tableWrapper {
|
||||
@apply border-tint-50;
|
||||
}
|
||||
|
||||
.columnHeader {
|
||||
@apply text-sm font-medium py-3 px-4 text-tint-900;
|
||||
}
|
||||
|
||||
:global(.dark) .columnHeader {
|
||||
@apply text-white;
|
||||
}
|
||||
|
||||
.row {
|
||||
@apply flex border-tint-700/2;
|
||||
}
|
||||
|
||||
:global(.dark) .row {
|
||||
@apply border-tint-300/3;
|
||||
}
|
||||
|
||||
.rowGroup {
|
||||
@apply flex flex-col border rounded-lg bg-tint-800/1 border-tint-700/2;
|
||||
}
|
||||
|
||||
:global(.dark) .rowGroup {
|
||||
@apply bg-tint-300/2 border-tint-300/3;
|
||||
}
|
||||
|
||||
.cell {
|
||||
@apply flex-1 align-middle border-dark/2 py-2 px-4 text-sm;
|
||||
}
|
||||
|
||||
:global(.dark) .cell {
|
||||
@apply border-light/2;
|
||||
}
|
||||
|
||||
@@ -25,7 +25,7 @@ export function Dropdown<E extends HTMLElement>(props: {
|
||||
const dropdownId = useId();
|
||||
|
||||
return (
|
||||
<div className={tcls('group/dropdown', 'relative flex shrink min-w-0')}>
|
||||
<div className={tcls('group/dropdown', 'relative flex')}>
|
||||
{button({
|
||||
id: dropdownId,
|
||||
tabIndex: 0,
|
||||
@@ -39,7 +39,7 @@ export function Dropdown<E extends HTMLElement>(props: {
|
||||
aria-labelledby={dropdownId}
|
||||
className={tcls(
|
||||
'w-52',
|
||||
'max-h-80',
|
||||
'max-h-56',
|
||||
'flex',
|
||||
'absolute',
|
||||
'top-full',
|
||||
@@ -111,38 +111,31 @@ export function DropdownMenu(props: { children: React.ReactNode }) {
|
||||
* Menu item in a dropdown.
|
||||
*/
|
||||
export function DropdownMenuItem(props: {
|
||||
href: string | null;
|
||||
href: string;
|
||||
active?: boolean;
|
||||
className?: ClassValue;
|
||||
children: React.ReactNode;
|
||||
}) {
|
||||
const { children, active = false, href, className } = props;
|
||||
|
||||
if (href) {
|
||||
return (
|
||||
<Link
|
||||
href={href}
|
||||
prefetch={false}
|
||||
className={tcls(
|
||||
'px-3 py-1 text-sm rounded straight-corners:rounded-sm',
|
||||
active ? 'bg-primary/3 dark:bg-light/2 text-primary-600' : null,
|
||||
'hover:bg-dark/2 dark:hover:bg-light/2',
|
||||
className,
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
</Link>
|
||||
);
|
||||
}
|
||||
const { children, active = false, href } = props;
|
||||
|
||||
return (
|
||||
<div
|
||||
<Link
|
||||
href={href}
|
||||
prefetch={false}
|
||||
className={tcls(
|
||||
'text-xs px-3 py-1 font-medium text-dark/8 dark:text-light/8',
|
||||
className,
|
||||
'flex',
|
||||
'flex-row',
|
||||
'items-center',
|
||||
'text-sm',
|
||||
'px-3',
|
||||
'py-1',
|
||||
'rounded',
|
||||
'straight-corners:rounded-sm',
|
||||
active
|
||||
? ['bg-primary/3', 'dark:bg-light/2', 'text-primary-600']
|
||||
: ['hover:bg-dark/2', 'dark:hover:bg-light/2'],
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
</Link>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -15,7 +15,6 @@ import { HeaderLogo } from './HeaderLogo';
|
||||
import { SpacesDropdown } from './SpacesDropdown';
|
||||
import { SearchButton } from '../Search';
|
||||
import { SiteSectionTabs } from '../SiteSectionTabs';
|
||||
import { HeaderMobileMenu } from './HeaderMobileMenu';
|
||||
/**
|
||||
* Render the header for the space.
|
||||
*/
|
||||
@@ -46,156 +45,104 @@ export function Header(props: {
|
||||
'w-full',
|
||||
'flex-none',
|
||||
'shadow-thinbottom',
|
||||
'dark:shadow-light/2',
|
||||
'bg-light',
|
||||
'dark:bg-dark',
|
||||
withTopHeader ? null : 'lg:hidden',
|
||||
'text-sm',
|
||||
'bg-opacity-9',
|
||||
'dark:bg-opacity-9',
|
||||
'backdrop-blur-lg',
|
||||
'contrast-more:bg-opacity-11',
|
||||
'contrast-more:dark:bg-opacity-11',
|
||||
'lg:z-10',
|
||||
'dark:shadow-light/1',
|
||||
`${isCustomizationDefault || !withTopHeader ? 'bg-light' : 'bg-header-background'}`,
|
||||
`${
|
||||
isCustomizationDefault || !withTopHeader
|
||||
? 'dark:bg-dark'
|
||||
: 'bg-header-background'
|
||||
}`,
|
||||
)}
|
||||
>
|
||||
<div
|
||||
className={tcls(
|
||||
!isCustomizationDefault &&
|
||||
withTopHeader && [
|
||||
'bg-header-background',
|
||||
'shadow-thinbottom',
|
||||
'dark:shadow-light/2',
|
||||
],
|
||||
)}
|
||||
>
|
||||
<div className={tcls('scroll-nojump')}>
|
||||
<div
|
||||
className={tcls(
|
||||
'gap-4',
|
||||
'lg:gap-8',
|
||||
'flex',
|
||||
'h-16',
|
||||
'items-center',
|
||||
'justify-between',
|
||||
'w-full',
|
||||
CONTAINER_STYLE,
|
||||
)}
|
||||
>
|
||||
<div className="flex max-w-full shrink min-w-0 gap-2 lg:gap-4 justify-start items-center">
|
||||
<HeaderMobileMenu
|
||||
className={tcls(
|
||||
'lg:hidden',
|
||||
'-ml-2',
|
||||
customization.header.preset ===
|
||||
CustomizationHeaderPreset.Default
|
||||
? ['text-dark', 'dark:text-light']
|
||||
: 'text-header-link',
|
||||
)}
|
||||
/>
|
||||
<HeaderLogo site={site} space={space} customization={customization} />
|
||||
{!hasSiteSections && isMultiVariants ? (
|
||||
<div className="z-20 shrink hidden sm:block">
|
||||
<SpacesDropdown space={space} spaces={spaces} />
|
||||
</div>
|
||||
) : null}
|
||||
</div>
|
||||
|
||||
{customization.header.links.length > 0 && (
|
||||
<HeaderLinks>
|
||||
{customization.header.links.map((link, index) => {
|
||||
return (
|
||||
<HeaderLink
|
||||
key={index}
|
||||
link={link}
|
||||
context={context}
|
||||
customization={customization}
|
||||
/>
|
||||
);
|
||||
})}
|
||||
<HeaderLinkMore
|
||||
label={t(getSpaceLanguage(customization), 'more')}
|
||||
links={customization.header.links}
|
||||
<div className={tcls('scroll-nojump')}>
|
||||
<div
|
||||
className={tcls(
|
||||
'gap-4',
|
||||
'grid',
|
||||
'grid-flow-col',
|
||||
'auto-cols-[auto_auto_1fr_auto]',
|
||||
'h-16',
|
||||
'items-center',
|
||||
'align-center',
|
||||
'justify-between',
|
||||
'w-full',
|
||||
CONTAINER_STYLE,
|
||||
)}
|
||||
>
|
||||
<HeaderLogo site={site} space={space} customization={customization} />
|
||||
<div className="z-20">
|
||||
{!hasSiteSections && isMultiVariants ? (
|
||||
<SpacesDropdown space={space} spaces={spaces} />
|
||||
) : null}
|
||||
</div>
|
||||
<HeaderLinks>
|
||||
{customization.header.links.map((link, index) => {
|
||||
return (
|
||||
<HeaderLink
|
||||
key={index}
|
||||
link={link}
|
||||
context={context}
|
||||
customization={customization}
|
||||
/>
|
||||
</HeaderLinks>
|
||||
);
|
||||
})}
|
||||
<HeaderLinkMore
|
||||
label={t(getSpaceLanguage(customization), 'more')}
|
||||
links={customization.header.links}
|
||||
context={context}
|
||||
customization={customization}
|
||||
/>
|
||||
</HeaderLinks>
|
||||
<div
|
||||
className={tcls(
|
||||
'flex',
|
||||
'md:w-56',
|
||||
'grow-0',
|
||||
'shrink-0',
|
||||
'justify-self-end',
|
||||
)}
|
||||
<div
|
||||
className={tcls(
|
||||
'flex',
|
||||
'md:min-w-56',
|
||||
'grow-0',
|
||||
'shrink-0',
|
||||
'justify-self-end',
|
||||
)}
|
||||
>
|
||||
<Suspense fallback={null}>
|
||||
<SearchButton
|
||||
style={
|
||||
!isCustomizationDefault && withTopHeader
|
||||
? [
|
||||
'bg-header-link/2',
|
||||
'dark:bg-header-link/2',
|
||||
'hover:bg-header-link/3',
|
||||
'dark:hover:bg-header-link/3',
|
||||
|
||||
'text-header-link/8',
|
||||
'dark:text-header-link/8',
|
||||
'hover:text-header-link',
|
||||
'dark:hover:text-header-link',
|
||||
|
||||
'ring-header-link/4',
|
||||
'dark:ring-header-link/4',
|
||||
'hover:ring-header-link/5',
|
||||
'dark:hover:ring-header-link/5',
|
||||
|
||||
'[&_svg]:text-header-link/10',
|
||||
'dark:[&_svg]:text-header-link/10',
|
||||
'[&_.shortcut]:text-header-link/8',
|
||||
'dark:[&_.shortcut]:text-header-link/8',
|
||||
|
||||
'contrast-more:bg-header-background',
|
||||
'contrast-more:text-header-link',
|
||||
'contrast-more:ring-header-link',
|
||||
'contrast-more:hover:bg-header-background',
|
||||
'contrast-more:hover:ring-header-link',
|
||||
'contrast-more:focus:text-header-link',
|
||||
'contrast-more:focus:bg-header-background',
|
||||
'contrast-more:focus:ring-header-link',
|
||||
'dark:contrast-more:bg-header-background',
|
||||
'dark:contrast-more:text-header-link',
|
||||
'dark:contrast-more:ring-header-link',
|
||||
'dark:contrast-more:hover:bg-header-background',
|
||||
'dark:contrast-more:hover:ring-header-link',
|
||||
'dark:contrast-more:focus:text-header-link',
|
||||
'dark:contrast-more:focus:bg-header-background',
|
||||
'dark:contrast-more:focus:ring-header-link',
|
||||
|
||||
'shadow-none',
|
||||
]
|
||||
: null
|
||||
}
|
||||
>
|
||||
<span className={tcls('flex-1')}>
|
||||
{t(
|
||||
getSpaceLanguage(customization),
|
||||
customization.aiSearch.enabled
|
||||
? 'search_or_ask'
|
||||
: 'search',
|
||||
)}
|
||||
...
|
||||
</span>
|
||||
</SearchButton>
|
||||
</Suspense>
|
||||
</div>
|
||||
>
|
||||
<Suspense fallback={null}>
|
||||
<SearchButton
|
||||
style={
|
||||
!isCustomizationDefault && withTopHeader
|
||||
? [
|
||||
'bg-header-link/3',
|
||||
'shadow-sm',
|
||||
'ring-header-link/3',
|
||||
'[&>span]:!text-header-link/7',
|
||||
'[&_svg]:text-header-link',
|
||||
'contrast-more:bg-transparent',
|
||||
'contrast-more:ring-header-link',
|
||||
'contrast-more:[&>span]:!text-header-link',
|
||||
'dark:bg-header-link/3',
|
||||
'dark:ring-header-link/3',
|
||||
'[&>span]:!text-header-link/7',
|
||||
'dark:[&_svg]:text-header-link',
|
||||
'dark:contrast-more:bg-transparent',
|
||||
'dark:contrast-more:ring-header-link',
|
||||
'dark:contrast-more:[&>span]:!text-header-link',
|
||||
]
|
||||
: null
|
||||
}
|
||||
>
|
||||
<span className={tcls('flex-1')}>
|
||||
{t(
|
||||
getSpaceLanguage(customization),
|
||||
customization.aiSearch.enabled ? 'search_or_ask' : 'search',
|
||||
)}
|
||||
</span>
|
||||
</SearchButton>
|
||||
</Suspense>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{sections ? (
|
||||
<div
|
||||
className={tcls(
|
||||
'scroll-nojump',
|
||||
'w-full',
|
||||
'w-full shadow-thintop dark:shadow-light/1 bg-light dark:bg-dark mt-0.5',
|
||||
// Handle long section tabs, particularly on smaller screens.
|
||||
'overflow-x-auto hide-scroll',
|
||||
)}
|
||||
|
||||
@@ -33,7 +33,6 @@ export async function HeaderLink(props: {
|
||||
if (link.links && link.links.length > 0) {
|
||||
return (
|
||||
<Dropdown
|
||||
className="shrink"
|
||||
button={(buttonProps) => {
|
||||
if (!target) {
|
||||
return (
|
||||
@@ -105,7 +104,7 @@ function HeaderItemButton(
|
||||
linkStyle: 'button-secondary' | 'button-primary';
|
||||
},
|
||||
) {
|
||||
const { linkStyle, headerPreset, title, href, isDropdown, ...rest } = props;
|
||||
const { linkStyle, headerPreset, title, href, ...rest } = props;
|
||||
const variant = (() => {
|
||||
switch (linkStyle) {
|
||||
case 'button-secondary':
|
||||
@@ -148,9 +147,12 @@ function HeaderItemButton(
|
||||
|
||||
function getHeaderLinkClassName(props: { headerPreset: CustomizationHeaderPreset }) {
|
||||
return tcls(
|
||||
'flex items-center shrink',
|
||||
'overflow-hidden',
|
||||
'text-sm lg:text-base',
|
||||
'flex flex-row items-center',
|
||||
'whitespace-nowrap',
|
||||
'hover:text-header-link-400 dark:hover:text-light',
|
||||
'min-w-0',
|
||||
'truncate',
|
||||
|
||||
props.headerPreset === CustomizationHeaderPreset.Default
|
||||
? ['text-dark/8', 'dark:text-light/8']
|
||||
@@ -162,7 +164,7 @@ function HeaderItemLink(props: HeaderLinkNavItemProps) {
|
||||
const { headerPreset, title, isDropdown, href, ...rest } = props;
|
||||
return (
|
||||
<Link href={href} className={getHeaderLinkClassName({ headerPreset })} {...rest}>
|
||||
<span className="truncate min-w-0">{title}</span>
|
||||
{title}
|
||||
{isDropdown ? <DropdownChevron /> : null}
|
||||
</Link>
|
||||
);
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import {
|
||||
CustomizationContentLink,
|
||||
CustomizationHeaderItem,
|
||||
CustomizationHeaderPreset,
|
||||
CustomizationSettings,
|
||||
@@ -11,9 +10,10 @@ import React from 'react';
|
||||
import { ContentRefContext, resolveContentRef } from '@/lib/references';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { Dropdown, DropdownChevron, DropdownMenu, DropdownMenuItem } from './Dropdown';
|
||||
import { Dropdown, DropdownMenu, DropdownMenuItem } from './Dropdown';
|
||||
import styles from './headerLinks.module.css';
|
||||
|
||||
|
||||
/**
|
||||
* Dropdown menu for header links hidden at small screen size.
|
||||
*/
|
||||
@@ -31,22 +31,15 @@ export function HeaderLinkMore(props: {
|
||||
const renderButton = () => (
|
||||
<button
|
||||
className={tcls(
|
||||
isCustomizationDefault
|
||||
? [
|
||||
'text-dark/8',
|
||||
'dark:text-light/8',
|
||||
'hover:text-primary',
|
||||
'dark:hover:text-primary',
|
||||
]
|
||||
: ['text-header-link', 'hover:text-header-link/8'],
|
||||
'flex',
|
||||
'gap-1',
|
||||
'items-center',
|
||||
'px-1',
|
||||
!isCustomizationDefault
|
||||
? ['text-header-link-500']
|
||||
: ['text-dark/8', 'dark:text-light/8', 'dark:hover:text-light'],
|
||||
'hover:text-header-link-400',
|
||||
)}
|
||||
>
|
||||
<span className="sr-only">{label}</span>
|
||||
<Icon icon="ellipsis" className={tcls('size-4')} />
|
||||
<DropdownChevron />
|
||||
<Icon icon="ellipsis" className={tcls('opacity-6', 'size-3', 'ms-1')} />
|
||||
</button>
|
||||
);
|
||||
|
||||
@@ -63,25 +56,14 @@ export function HeaderLinkMore(props: {
|
||||
);
|
||||
}
|
||||
|
||||
async function MoreMenuLink(props: {
|
||||
context: ContentRefContext;
|
||||
link: CustomizationHeaderItem | CustomizationContentLink;
|
||||
}) {
|
||||
async function MoreMenuLink(props: { context: ContentRefContext; link: CustomizationHeaderItem }) {
|
||||
const { context, link } = props;
|
||||
|
||||
const target = link.to ? await resolveContentRef(link.to, context) : null;
|
||||
|
||||
return (
|
||||
<>
|
||||
{'links' in link && link.links.length > 0 && (
|
||||
<hr className="first:hidden border-t border-light-3 dark:border-dark-3 my-1 -mx-2" />
|
||||
)}
|
||||
<DropdownMenuItem href={target?.href ?? null}>{link.title}</DropdownMenuItem>
|
||||
{'links' in link
|
||||
? link.links.map((subLink, index) => (
|
||||
<MoreMenuLink key={index} {...props} link={subLink} />
|
||||
))
|
||||
: null}
|
||||
</>
|
||||
);
|
||||
if (!target) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return <DropdownMenuItem href={target.href}>{link.title}</DropdownMenuItem>;
|
||||
}
|
||||
|
||||
@@ -13,7 +13,7 @@ export async function HeaderLinks({ children }: HeaderLinksProps) {
|
||||
<div
|
||||
className={tcls(
|
||||
styles.containerHeaderlinks,
|
||||
'grow shrink flex justify-end items-center gap-x-6 lg:gap-x-8 min-w-9 z-20',
|
||||
'flex justify-end items-center gap-x-2.5 mr-2.5 lg:gap-x-5 lg:mr-2.5 *:max-w-56 z-20',
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
|
||||
@@ -30,51 +30,65 @@ export function HeaderLogo(props: HeaderLogoProps) {
|
||||
const { customization } = props;
|
||||
|
||||
return (
|
||||
<Link
|
||||
href={absoluteHref('')}
|
||||
className={tcls('group/headerlogo', 'min-w-0', 'shrink', 'flex', 'items-center')}
|
||||
>
|
||||
{customization.header.logo ? (
|
||||
<Image
|
||||
alt="Logo"
|
||||
sources={{
|
||||
light: {
|
||||
src: customization.header.logo.light,
|
||||
},
|
||||
dark: customization.header.logo.dark
|
||||
? {
|
||||
src: customization.header.logo.dark,
|
||||
}
|
||||
: null,
|
||||
}}
|
||||
sizes={[
|
||||
{
|
||||
media: '(max-width: 1024px)',
|
||||
width: 160,
|
||||
},
|
||||
{
|
||||
width: 260,
|
||||
},
|
||||
]}
|
||||
priority="high"
|
||||
style={tcls(
|
||||
'rounded',
|
||||
'straight-corners:rounded-sm',
|
||||
'overflow-hidden',
|
||||
'shrink',
|
||||
'min-w-0',
|
||||
'max-w-40',
|
||||
'lg:max-w-64',
|
||||
'max-h-10',
|
||||
'lg:max-h-12',
|
||||
'h-full',
|
||||
'w-auto',
|
||||
)}
|
||||
/>
|
||||
) : (
|
||||
<LogoFallback {...props} />
|
||||
)}
|
||||
</Link>
|
||||
<div className={tcls('flex', 'flex-row', 'gap-2')}>
|
||||
<HeaderMobileMenu
|
||||
className={tcls(
|
||||
'lg:hidden',
|
||||
customization.header.preset === CustomizationHeaderPreset.Default
|
||||
? ['text-dark', 'dark:text-light']
|
||||
: 'text-header-link',
|
||||
)}
|
||||
/>
|
||||
<Link
|
||||
href={absoluteHref('')}
|
||||
className={tcls(
|
||||
'group/headerlogo',
|
||||
'flex-1',
|
||||
'flex',
|
||||
'flex-row',
|
||||
'items-center',
|
||||
'shrink-0',
|
||||
)}
|
||||
>
|
||||
{customization.header.logo ? (
|
||||
<Image
|
||||
alt="Logo"
|
||||
sources={{
|
||||
light: {
|
||||
src: customization.header.logo.light,
|
||||
},
|
||||
dark: customization.header.logo.dark
|
||||
? {
|
||||
src: customization.header.logo.dark,
|
||||
}
|
||||
: null,
|
||||
}}
|
||||
sizes={[
|
||||
{
|
||||
media: '(max-width: 1024px)',
|
||||
width: 128,
|
||||
},
|
||||
{
|
||||
width: 192,
|
||||
},
|
||||
]}
|
||||
priority="high"
|
||||
style={tcls(
|
||||
'max-w-[8rem]',
|
||||
'lg:max-w-[12rem]',
|
||||
'max-h-[3rem]',
|
||||
'rounded',
|
||||
'straight-corners:rounded-sm',
|
||||
'overflow-hidden',
|
||||
'object-contain',
|
||||
'object-left',
|
||||
)}
|
||||
/>
|
||||
) : (
|
||||
<LogoFallback {...props} />
|
||||
)}
|
||||
</Link>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -97,13 +111,13 @@ function LogoFallback(props: HeaderLogoProps) {
|
||||
className={tcls(
|
||||
'text-pretty',
|
||||
'line-clamp-3',
|
||||
'leading-[1.1]',
|
||||
'tracking-tight',
|
||||
'max-w-[18ch]',
|
||||
'lg:max-w-[24ch]',
|
||||
'lg:text-lg/tight',
|
||||
'font-semibold',
|
||||
'ms-3',
|
||||
'text-base/tight',
|
||||
'lg:text-lg/tight',
|
||||
customization.header.preset === CustomizationHeaderPreset.Default ||
|
||||
customization.header.preset === CustomizationHeaderPreset.None
|
||||
? ['text-dark', 'dark:text-light']
|
||||
|
||||
@@ -5,8 +5,8 @@ import { tcls } from '@/lib/tailwind';
|
||||
import { Dropdown, DropdownChevron, DropdownMenu } from './Dropdown';
|
||||
import { SpacesDropdownMenuItem } from './SpacesDropdownMenuItem';
|
||||
|
||||
export function SpacesDropdown(props: { space: Space; spaces: Space[]; className?: string }) {
|
||||
const { space, spaces, className } = props;
|
||||
export function SpacesDropdown(props: { space: Space; spaces: Space[] }) {
|
||||
const { space, spaces } = props;
|
||||
|
||||
return (
|
||||
<Dropdown
|
||||
@@ -20,27 +20,25 @@ export function SpacesDropdown(props: { space: Space; spaces: Space[]; className
|
||||
'items-center',
|
||||
'rounded-2xl',
|
||||
'straight-corners:rounded-none',
|
||||
|
||||
'hover:cursor-pointer',
|
||||
'bg-dark/1',
|
||||
'dark:bg-light/1',
|
||||
|
||||
'text-sm',
|
||||
'bg-light-2',
|
||||
'border',
|
||||
'border-light-3',
|
||||
'text-dark-4',
|
||||
'dark:text-light-4',
|
||||
|
||||
'contrast-more:bg-light',
|
||||
'contrast-more:ring-1',
|
||||
'contrast-more:ring-dark',
|
||||
'dark:contrast-more:ring-light',
|
||||
'dark:contrast-more:bg-dark',
|
||||
|
||||
'text-sm',
|
||||
'px-3',
|
||||
'py-1',
|
||||
className,
|
||||
'contrast-more:border-dark',
|
||||
'contrast-more:bg-light',
|
||||
'contrast-more:text-dark',
|
||||
'dark:bg-dark-3',
|
||||
'dark:border-dark-4',
|
||||
'dark:text-light-4',
|
||||
'contrast-more:dark:border-light',
|
||||
'contrast-more:dark:bg-dark',
|
||||
'contrast-more:dark:text-light',
|
||||
)}
|
||||
>
|
||||
<span className="line-clamp-2">{space.title}</span>
|
||||
{space.title}
|
||||
<DropdownChevron />
|
||||
</div>
|
||||
)}
|
||||
|
||||
@@ -60,12 +60,12 @@
|
||||
}
|
||||
.containerHeaderlinks > :nth-child(n + 5) ~ .linkEllipsis {
|
||||
display: flex;
|
||||
& div > a:nth-of-type(n + 5) {
|
||||
& div > :nth-child(n + 5) {
|
||||
display: flex;
|
||||
}
|
||||
}
|
||||
}
|
||||
@container headerlinks ( width < 850px ) {
|
||||
@container headerlinks ( width < 900px ) {
|
||||
.containerHeaderlinks > :nth-child(n + 6) {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -11,7 +11,6 @@ import { getSpaceLanguage } from '@/intl/server';
|
||||
import { t } from '@/intl/translate';
|
||||
import { ContentTarget, SiteContentPointer, api } from '@/lib/api';
|
||||
import { hasFullWidthBlock, isNodeEmpty } from '@/lib/document';
|
||||
import { AncestorRevisionPage } from '@/lib/pages';
|
||||
import { ContentRefContext, resolveContentRef } from '@/lib/references';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
import { shouldTrackPageViews } from '@/lib/tracking';
|
||||
@@ -32,7 +31,6 @@ export function PageBody(props: {
|
||||
contentTarget: ContentTarget;
|
||||
customization: CustomizationSettings | SiteCustomizationSettings;
|
||||
page: RevisionPageDocument;
|
||||
ancestors: AncestorRevisionPage[];
|
||||
document: JSONDocument | null;
|
||||
context: ContentRefContext;
|
||||
withPageFeedback: boolean;
|
||||
@@ -44,7 +42,6 @@ export function PageBody(props: {
|
||||
customization,
|
||||
context,
|
||||
page,
|
||||
ancestors,
|
||||
document,
|
||||
withPageFeedback,
|
||||
} = props;
|
||||
@@ -82,7 +79,7 @@ export function PageBody(props: {
|
||||
<PageCover as="hero" page={page} cover={page.cover} context={context} />
|
||||
) : null}
|
||||
|
||||
<PageHeader page={page} ancestors={ancestors} pages={context.pages} />
|
||||
<PageHeader page={page} />
|
||||
{document && !isNodeEmpty(document) ? (
|
||||
<React.Suspense
|
||||
fallback={
|
||||
@@ -151,7 +148,7 @@ export function PageBody(props: {
|
||||
sitePointer={pointer}
|
||||
spaceId={space.id}
|
||||
pageId={page.id}
|
||||
apiHost={api().client.endpoint}
|
||||
apiHost={api().endpoint}
|
||||
/>
|
||||
) : null}
|
||||
</>
|
||||
|
||||
@@ -1,19 +1,11 @@
|
||||
import { RevisionPage, RevisionPageDocument } from '@gitbook/api';
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import { RevisionPageDocument } from '@gitbook/api';
|
||||
|
||||
import { pageHref } from '@/lib/links';
|
||||
import { AncestorRevisionPage } from '@/lib/pages';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { PageIcon } from '../PageIcon';
|
||||
import { StyledLink } from '../primitives';
|
||||
|
||||
export function PageHeader(props: {
|
||||
page: RevisionPageDocument;
|
||||
ancestors: AncestorRevisionPage[];
|
||||
pages: RevisionPage[];
|
||||
}) {
|
||||
const { page, ancestors, pages } = props;
|
||||
export function PageHeader(props: { page: RevisionPageDocument }) {
|
||||
const { page } = props;
|
||||
|
||||
if (!page.layout.title && !page.layout.description) {
|
||||
return null;
|
||||
@@ -23,48 +15,6 @@ export function PageHeader(props: {
|
||||
<header
|
||||
className={tcls('max-w-3xl', 'mx-auto', 'mb-6', 'space-y-3', 'page-api-block:ml-0')}
|
||||
>
|
||||
{ancestors.length > 0 && (
|
||||
<nav>
|
||||
<ol className={tcls('flex', 'flex-wrap', 'items-center', 'gap-2')}>
|
||||
{ancestors.map((breadcrumb, index) => (
|
||||
<>
|
||||
<li key={breadcrumb.id}>
|
||||
<StyledLink
|
||||
href={pageHref(pages, breadcrumb)}
|
||||
style={tcls(
|
||||
'no-underline',
|
||||
'hover:underline',
|
||||
'text-xs',
|
||||
'tracking-wide',
|
||||
'font-semibold',
|
||||
'uppercase',
|
||||
'flex',
|
||||
'items-center',
|
||||
'gap-1',
|
||||
)}
|
||||
>
|
||||
<PageIcon
|
||||
page={breadcrumb}
|
||||
style={tcls('size-4', 'text-base', 'leading-none')}
|
||||
/>
|
||||
{breadcrumb.title}
|
||||
</StyledLink>
|
||||
</li>
|
||||
{index != ancestors.length - 1 && (
|
||||
<Icon
|
||||
icon="chevron-right"
|
||||
className={tcls(
|
||||
'size-3',
|
||||
'text-light-4',
|
||||
'dark:text-dark-4',
|
||||
)}
|
||||
/>
|
||||
)}
|
||||
</>
|
||||
))}
|
||||
</ol>
|
||||
</nav>
|
||||
)}
|
||||
{page.layout.title ? (
|
||||
<h1 className={tcls('text-4xl', 'font-bold', 'flex', 'items-center', 'gap-4')}>
|
||||
<PageIcon page={page} style={['text-dark/6', 'dark:text-light/6']} />
|
||||
|
||||
@@ -18,7 +18,7 @@ export async function postPageFeedback(args: {
|
||||
`No siteSpaceId in pointer. organizationId: ${organizationId}, siteId: ${siteId}, pageId: ${args.pageId}`,
|
||||
);
|
||||
|
||||
await api().client.orgs.createSitesPageFeedback(
|
||||
await api().orgs.createSitesPageFeedback(
|
||||
organizationId,
|
||||
siteId,
|
||||
siteSpaceId,
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import {
|
||||
CustomizationBackground,
|
||||
CustomizationCorners,
|
||||
CustomizationHeaderPreset,
|
||||
CustomizationIconsStyle,
|
||||
CustomizationSettings,
|
||||
CustomizationTint,
|
||||
SiteCustomizationSettings,
|
||||
} from '@gitbook/api';
|
||||
import { IconsProvider, IconStyle } from '@gitbook/icons';
|
||||
@@ -17,13 +17,11 @@ import { getStaticFileURL } from '@/lib/assets';
|
||||
import { hexToRgb, shadesOfColor } from '@/lib/colors';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { emojiFontClassName } from '../primitives';
|
||||
import { ClientContexts } from './ClientContexts';
|
||||
import { emojiFontClassName } from '../primitives';
|
||||
|
||||
import '@gitbook/icons/style.css';
|
||||
import './globals.css';
|
||||
|
||||
const DEFAULT_TINT_COLOR = '#787878';
|
||||
import '@gitbook/icons/style.css';
|
||||
|
||||
/**
|
||||
* Layout shared between the content and the PDF renderer.
|
||||
@@ -38,21 +36,26 @@ export async function CustomizationRootLayout(props: {
|
||||
const headerTheme = generateHeaderTheme(customization);
|
||||
const language = getSpaceLanguage(customization);
|
||||
|
||||
const tintColor = getTintColor(customization);
|
||||
|
||||
return (
|
||||
<html
|
||||
suppressHydrationWarning
|
||||
lang={customization.internationalization.locale}
|
||||
className={tcls(
|
||||
customization.header.preset === CustomizationHeaderPreset.None
|
||||
? null
|
||||
: 'scroll-pt-[76px]', // Take the sticky header in consideration for the scrolling
|
||||
customization.styling.corners === CustomizationCorners.Straight
|
||||
className={
|
||||
tcls(
|
||||
customization.header.preset === CustomizationHeaderPreset.None
|
||||
? null
|
||||
: [
|
||||
// Take the sticky header in consideration for the scrolling
|
||||
`scroll-pt-[76px]`,
|
||||
],
|
||||
) +
|
||||
(customization.styling.corners === CustomizationCorners.Straight
|
||||
? ' straight-corners'
|
||||
: '',
|
||||
tintColor ? ' tint' : 'no-tint',
|
||||
)}
|
||||
: '') +
|
||||
(customization.styling.background === CustomizationBackground.Plain
|
||||
? ' plain-background'
|
||||
: '')
|
||||
}
|
||||
>
|
||||
<head>
|
||||
{customization.privacyPolicy.url ? (
|
||||
@@ -84,22 +87,10 @@ export async function CustomizationRootLayout(props: {
|
||||
)
|
||||
}
|
||||
|
||||
${generateColorVariable('tint-color', tintColor?.light ?? DEFAULT_TINT_COLOR)}
|
||||
${
|
||||
// Generate the right contrast color for each shade of tint-color
|
||||
generateColorVariable(
|
||||
'contrast-tint',
|
||||
Object.fromEntries(
|
||||
Object.entries(
|
||||
shadesOfColor(tintColor?.light || DEFAULT_TINT_COLOR),
|
||||
).map(([index, color]) => [
|
||||
index,
|
||||
colorContrast(color, ['#000', '#fff']),
|
||||
]),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
${generateColorVariable(
|
||||
'primary-base',
|
||||
customization.styling.primaryColor.light,
|
||||
)}
|
||||
${generateColorVariable(
|
||||
'header-background',
|
||||
headerTheme.backgroundColor.light,
|
||||
@@ -112,6 +103,10 @@ export async function CustomizationRootLayout(props: {
|
||||
'primary-color',
|
||||
customization.styling.primaryColor.dark,
|
||||
)}
|
||||
${generateColorVariable(
|
||||
'primary-base',
|
||||
customization.styling.primaryColor.dark,
|
||||
)}
|
||||
${
|
||||
// Generate the right contrast color for each shade of primary-color
|
||||
generateColorVariable(
|
||||
@@ -126,23 +121,6 @@ export async function CustomizationRootLayout(props: {
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
${generateColorVariable('tint-color', tintColor?.dark ?? DEFAULT_TINT_COLOR)}
|
||||
${
|
||||
// Generate the right contrast color for each shade of tint-color
|
||||
generateColorVariable(
|
||||
'contrast-tint',
|
||||
Object.fromEntries(
|
||||
Object.entries(
|
||||
shadesOfColor(tintColor?.dark || DEFAULT_TINT_COLOR),
|
||||
).map(([index, color]) => [
|
||||
index,
|
||||
colorContrast(color, ['#000', '#fff']),
|
||||
]),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
||||
${generateColorVariable(
|
||||
'header-background',
|
||||
headerTheme.backgroundColor.dark,
|
||||
@@ -182,21 +160,6 @@ export async function CustomizationRootLayout(props: {
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the tint color from the customization settings.
|
||||
* If the tint color is not set or it is a space customization, it will return the default color.
|
||||
*/
|
||||
export function getTintColor(
|
||||
customization: CustomizationSettings | SiteCustomizationSettings,
|
||||
): CustomizationTint['color'] | undefined {
|
||||
if ('tint' in customization.styling && customization.styling.tint) {
|
||||
return {
|
||||
light: customization.styling.tint?.color.light ?? DEFAULT_TINT_COLOR,
|
||||
dark: customization.styling.tint?.color.dark ?? DEFAULT_TINT_COLOR,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
type ColorInput = string | Record<string, string>;
|
||||
function generateColorVariable(name: string, color: ColorInput) {
|
||||
const shades: Record<string, string> = typeof color === 'string' ? shadesOfColor(color) : color;
|
||||
@@ -214,8 +177,6 @@ function generateHeaderTheme(customization: CustomizationSettings | SiteCustomiz
|
||||
backgroundColor: { light: ColorInput; dark: ColorInput };
|
||||
linkColor: { light: ColorInput; dark: ColorInput };
|
||||
} {
|
||||
const tintColor = getTintColor(customization);
|
||||
|
||||
switch (customization.header.preset) {
|
||||
case CustomizationHeaderPreset.None:
|
||||
case CustomizationHeaderPreset.Default: {
|
||||
@@ -233,17 +194,17 @@ function generateHeaderTheme(customization: CustomizationSettings | SiteCustomiz
|
||||
case CustomizationHeaderPreset.Bold: {
|
||||
return {
|
||||
backgroundColor: {
|
||||
light: tintColor?.light ?? customization.styling.primaryColor.light,
|
||||
dark: tintColor?.dark ?? customization.styling.primaryColor.dark,
|
||||
light: customization.styling.primaryColor.light,
|
||||
dark: customization.styling.primaryColor.dark,
|
||||
},
|
||||
linkColor: {
|
||||
light: colorContrast(
|
||||
tintColor?.light ?? customization.styling.primaryColor.light,
|
||||
customization.styling.primaryColor.light,
|
||||
[colors.white, colors.black],
|
||||
'aaa',
|
||||
),
|
||||
dark: colorContrast(
|
||||
tintColor?.dark ?? customization.styling.primaryColor.dark,
|
||||
customization.styling.primaryColor.dark,
|
||||
[colors.white, colors.black],
|
||||
'aaa',
|
||||
),
|
||||
@@ -265,25 +226,15 @@ function generateHeaderTheme(customization: CustomizationSettings | SiteCustomiz
|
||||
case CustomizationHeaderPreset.Custom: {
|
||||
return {
|
||||
backgroundColor: {
|
||||
light:
|
||||
customization.header.backgroundColor?.light ??
|
||||
tintColor?.light ??
|
||||
colors.white,
|
||||
dark:
|
||||
customization.header.backgroundColor?.dark ??
|
||||
tintColor?.dark ??
|
||||
colors.black,
|
||||
light: customization.header.backgroundColor?.light ?? colors.white,
|
||||
dark: customization.header.backgroundColor?.dark ?? colors.black,
|
||||
},
|
||||
linkColor: {
|
||||
light:
|
||||
customization.header.linkColor?.light ??
|
||||
(tintColor?.light &&
|
||||
colorContrast(tintColor.light, [colors.white, colors.black], 'aaa')) ??
|
||||
customization.styling.primaryColor.light,
|
||||
dark:
|
||||
customization.header.linkColor?.dark ??
|
||||
(tintColor?.dark &&
|
||||
colorContrast(tintColor.dark, [colors.white, colors.black], 'aaa')) ??
|
||||
customization.styling.primaryColor.dark,
|
||||
},
|
||||
};
|
||||
|
||||
@@ -7,19 +7,27 @@
|
||||
--scrollbar-width: calc(100vw - 100%);
|
||||
|
||||
--dark-base: 20 20 20;
|
||||
--light-base: 251 251 251;
|
||||
--light-base: 251 252 252;
|
||||
|
||||
--light-1: color-mix(in srgb, rgb(var(--tint-color-600)), rgb(var(--light-base)) 99%);
|
||||
--light-DEFAULT: color-mix(in srgb, rgb(var(--tint-color-700)), rgb(var(--light-base)) 96%);
|
||||
--light-2: color-mix(in srgb, rgb(var(--tint-color-700)), rgb(var(--light-base)) 94%);
|
||||
--light-3: color-mix(in srgb, rgb(var(--tint-color-800)), rgb(var(--light-base)) 88%);
|
||||
--light-4: color-mix(in srgb, rgb(var(--tint-color-800)), rgb(var(--light-base)) 72%);
|
||||
--light-1: color-mix(in srgb, rgb(var(--primary-base-600)), rgb(var(--light-base)) 99%);
|
||||
--light-DEFAULT: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--primary-base-700)),
|
||||
rgb(var(--light-base)) 96%
|
||||
);
|
||||
--light-2: color-mix(in srgb, rgb(var(--primary-base-800)), rgb(var(--light-base)) 92%);
|
||||
--light-3: color-mix(in srgb, rgb(var(--primary-base-800)), rgb(var(--light-base)) 88%);
|
||||
--light-4: color-mix(in srgb, rgb(var(--primary-base-800)), rgb(var(--light-base)) 72%);
|
||||
|
||||
--dark-1: color-mix(in srgb, rgb(var(--tint-color-400)), rgb(var(--dark-base)) 96%);
|
||||
--dark-DEFAULT: color-mix(in srgb, rgb(var(--tint-color-300)), rgb(var(--dark-base)) 94%);
|
||||
--dark-2: color-mix(in srgb, rgb(var(--tint-color-300)), rgb(var(--dark-base)) 92%);
|
||||
--dark-3: color-mix(in srgb, rgb(var(--tint-color-200)), rgb(var(--dark-base)) 91%);
|
||||
--dark-4: color-mix(in srgb, rgb(var(--tint-color-200)), rgb(var(--dark-base)) 64%);
|
||||
--dark-1: color-mix(in srgb, rgb(var(--primary-base-100)), rgb(1 1 1) 96%);
|
||||
--dark-DEFAULT: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--primary-base-300)),
|
||||
rgb(var(--dark-base)) 94.5%
|
||||
);
|
||||
--dark-2: color-mix(in srgb, rgb(var(--primary-base-200)), rgb(var(--dark-base)) 92%);
|
||||
--dark-3: color-mix(in srgb, rgb(var(--primary-base-200)), rgb(25 25 25) 91%);
|
||||
--dark-4: color-mix(in srgb, rgb(var(--primary-base-200)), rgb(var(--dark-base)) 64%);
|
||||
@apply leading-relaxed;
|
||||
}
|
||||
body {
|
||||
@@ -28,13 +36,29 @@
|
||||
html {
|
||||
@apply gutter-stable;
|
||||
}
|
||||
html:is(.no-tint) {
|
||||
html:is(.plain-background) {
|
||||
--dark-base: 22 22 22;
|
||||
--light-base: 255 255 255;
|
||||
/* reset primaries as greys */
|
||||
--primary-base-50: 239 239 239;
|
||||
--primary-base-100: 222 222 222;
|
||||
--primary-base-200: 200 200 200;
|
||||
--primary-base-300: 180 180 180;
|
||||
--primary-base-400: 150 150 150;
|
||||
--primary-base-500: 120 120 120;
|
||||
--primary-base-600: 90 90 90;
|
||||
--primary-base-700: 70 70 70;
|
||||
--primary-base-800: 30 30 30;
|
||||
--primary-base-900: 19 19 19;
|
||||
|
||||
--light-DEFAULT: color-mix(
|
||||
in srgb,
|
||||
rgb(var(--tint-color-500)),
|
||||
rgb(var(--primary-base-700)),
|
||||
rgb(var(--light-base)) 100%
|
||||
);
|
||||
--light-2: color-mix(in srgb, rgb(var(--primary-base-800)), rgb(var(--light-base)) 96%);
|
||||
--light-3: color-mix(in srgb, rgb(var(--primary-base-800)), rgb(var(--light-base)) 90%);
|
||||
--light-4: color-mix(in srgb, rgb(var(--primary-base-800)), rgb(var(--light-base)) 76%);
|
||||
}
|
||||
h1 {
|
||||
@apply tracking-[-0.025em] text-dark dark:text-light text-balance;
|
||||
@@ -192,30 +216,3 @@ html {
|
||||
html.dark {
|
||||
color-scheme: dark light;
|
||||
}
|
||||
|
||||
/* Emojis */
|
||||
|
||||
[class*='emoji'] {
|
||||
font-family: var(--font-emojis-sbix);
|
||||
}
|
||||
|
||||
/* Safari Only CSS here */
|
||||
_::-webkit-full-page-media,
|
||||
_:future,
|
||||
:root [class*='emoji'] {
|
||||
font-family: var(--font-emojis-sbix);
|
||||
}
|
||||
|
||||
/* Chrome Only CSS here */
|
||||
@media screen and (-webkit-min-device-pixel-ratio: 0) {
|
||||
.emoji {
|
||||
font-family: var(--font-emojis-colrv1);
|
||||
}
|
||||
}
|
||||
|
||||
/* Firefox Only CSS here */
|
||||
@-moz-document url-prefix() {
|
||||
.emoji {
|
||||
font-family: var(--font-emojis-colrv1);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,22 +25,18 @@ export function HighlightQuery(props: {
|
||||
'py-0.5',
|
||||
'rounded',
|
||||
'straight-corners:rounded-sm',
|
||||
'group-[.is-active]:bg-primary-200',
|
||||
'group-[.is-active]:text-contrast-primary-200',
|
||||
'dark:group-[.is-active]:bg-primary-700',
|
||||
'dark:group-[.is-active]:text-contrast-primary-700',
|
||||
],
|
||||
} = props;
|
||||
const matches = matchString(text, query);
|
||||
|
||||
return (
|
||||
<span className={tcls('whitespace-break-spaces')}>
|
||||
<div className={tcls('whitespace-break-spaces')}>
|
||||
{matches.map((entry, index) => (
|
||||
<span key={index} className={tcls(entry.match ? highlight : null)}>
|
||||
{entry.text}
|
||||
</span>
|
||||
))}
|
||||
</span>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
'use client';
|
||||
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import React from 'react';
|
||||
import { atom, useRecoilState } from 'recoil';
|
||||
@@ -9,30 +7,29 @@ import { useLanguage } from '@/intl/client';
|
||||
import { t } from '@/intl/translate';
|
||||
import { TranslationLanguage } from '@/intl/translations';
|
||||
import { iterateStreamResponse } from '@/lib/actions';
|
||||
import { SiteContentPointer } from '@/lib/api';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { AskAnswerResult, AskAnswerSource, streamAskQuestion } from './server-actions';
|
||||
import { useSearch, useSearchLink } from './useSearch';
|
||||
import { Link } from '../primitives';
|
||||
|
||||
type SearchState =
|
||||
/**
|
||||
* Store the state of the answer in a global state so that it can be
|
||||
* accessed from anywhere to show a loading indicator.
|
||||
*/
|
||||
export const searchAskState = atom<
|
||||
| {
|
||||
type: 'answer';
|
||||
answer: AskAnswerResult;
|
||||
answer: AskAnswerResult | null;
|
||||
}
|
||||
| {
|
||||
type: 'error';
|
||||
}
|
||||
| {
|
||||
type: 'loading';
|
||||
};
|
||||
|
||||
/**
|
||||
- * Store the state of the answer in a global state so that it can be
|
||||
- * accessed from anywhere to show a loading indicator.
|
||||
- */
|
||||
export const searchAskState = atom<SearchState | null>({
|
||||
}
|
||||
| null
|
||||
>({
|
||||
key: 'searchAskState',
|
||||
default: null,
|
||||
});
|
||||
@@ -40,13 +37,12 @@ export const searchAskState = atom<SearchState | null>({
|
||||
/**
|
||||
* Fetch and render the answers to a question.
|
||||
*/
|
||||
export function SearchAskAnswer(props: { pointer: SiteContentPointer; query: string }) {
|
||||
const { pointer, query } = props;
|
||||
export function SearchAskAnswer(props: { spaceId: string; query: string }) {
|
||||
const { spaceId, query } = props;
|
||||
|
||||
const language = useLanguage();
|
||||
const [, setSearchState] = useSearch();
|
||||
const [state, setState] = useRecoilState(searchAskState);
|
||||
const { organizationId, siteId, siteSpaceId } = pointer;
|
||||
|
||||
React.useEffect(() => {
|
||||
let cancelled = false;
|
||||
@@ -56,9 +52,7 @@ export function SearchAskAnswer(props: { pointer: SiteContentPointer; query: str
|
||||
});
|
||||
|
||||
(async () => {
|
||||
const stream = iterateStreamResponse(
|
||||
streamAskQuestion(organizationId, siteId, siteSpaceId ?? null, query),
|
||||
);
|
||||
const stream = iterateStreamResponse(streamAskQuestion(spaceId, query));
|
||||
|
||||
setSearchState((prev) =>
|
||||
prev
|
||||
@@ -74,6 +68,7 @@ export function SearchAskAnswer(props: { pointer: SiteContentPointer; query: str
|
||||
if (cancelled) {
|
||||
return;
|
||||
}
|
||||
|
||||
setState({
|
||||
type: 'answer',
|
||||
answer: chunk,
|
||||
@@ -96,7 +91,7 @@ export function SearchAskAnswer(props: { pointer: SiteContentPointer; query: str
|
||||
cancelled = true;
|
||||
}
|
||||
};
|
||||
}, [organizationId, siteId, siteSpaceId, query]);
|
||||
}, [spaceId, query, setSearchState, setState]);
|
||||
|
||||
React.useEffect(() => {
|
||||
return () => {
|
||||
@@ -113,9 +108,15 @@ export function SearchAskAnswer(props: { pointer: SiteContentPointer; query: str
|
||||
return (
|
||||
<div className={tcls('max-h-[60vh]', 'overflow-y-auto')}>
|
||||
{state?.type === 'answer' ? (
|
||||
<React.Suspense fallback={loading}>
|
||||
<TransitionAnswerBody answer={state.answer} placeholder={loading} />
|
||||
</React.Suspense>
|
||||
<>
|
||||
{state.answer ? (
|
||||
<React.Suspense fallback={loading}>
|
||||
<TransitionAnswerBody answer={state.answer} placeholder={loading} />
|
||||
</React.Suspense>
|
||||
) : (
|
||||
<div className={tcls('p-4')}>{t(language, 'search_ask_no_answer')}</div>
|
||||
)}
|
||||
</>
|
||||
) : null}
|
||||
{state?.type === 'error' ? (
|
||||
<div className={tcls('p-4')}>{t(language, 'search_ask_error')}</div>
|
||||
@@ -158,7 +159,7 @@ function AnswerBody(props: { answer: AskAnswerResult }) {
|
||||
<div
|
||||
data-test="search-ask-answer"
|
||||
className={tcls(
|
||||
'my-4',
|
||||
'mt-4',
|
||||
'sm:mt-6',
|
||||
'px-4',
|
||||
'sm:px-12',
|
||||
@@ -166,16 +167,16 @@ function AnswerBody(props: { answer: AskAnswerResult }) {
|
||||
'dark:text-light/8',
|
||||
)}
|
||||
>
|
||||
{answer.body ?? t(language, 'search_ask_no_answer')}
|
||||
{answer.hasAnswer ? answer.body : t(language, 'search_ask_no_answer')}
|
||||
{answer.followupQuestions.length > 0 ? (
|
||||
<AnswerFollowupQuestions followupQuestions={answer.followupQuestions} />
|
||||
) : null}
|
||||
</div>
|
||||
{answer.sources.length > 0 ? (
|
||||
<AnswerSources
|
||||
hasAnswer={answer.hasAnswer}
|
||||
sources={answer.sources}
|
||||
language={language}
|
||||
hasAnswer={Boolean(answer.body)}
|
||||
/>
|
||||
) : null}
|
||||
</>
|
||||
@@ -232,7 +233,7 @@ function AnswerFollowupQuestions(props: { followupQuestions: string[] }) {
|
||||
function AnswerSources(props: {
|
||||
sources: AskAnswerSource[];
|
||||
language: TranslationLanguage;
|
||||
hasAnswer: boolean;
|
||||
hasAnswer?: boolean;
|
||||
}) {
|
||||
const { sources, language, hasAnswer } = props;
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
'use client';
|
||||
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import { motion } from 'framer-motion';
|
||||
import { useEffect, useState } from 'react';
|
||||
|
||||
import { useLanguage, tString } from '@/intl/client';
|
||||
@@ -36,69 +35,45 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
|
||||
'flex-row',
|
||||
'justify-center',
|
||||
'items-center',
|
||||
'w-full',
|
||||
'px-3',
|
||||
'py-2',
|
||||
'gap-2',
|
||||
|
||||
'bg-light',
|
||||
'dark:bg-dark',
|
||||
|
||||
'ring-1',
|
||||
'ring-dark/1',
|
||||
'dark:ring-light/2',
|
||||
|
||||
'shadow-sm',
|
||||
'shadow-dark/4',
|
||||
'dark:shadow-none',
|
||||
|
||||
'text-dark/6',
|
||||
'dark:text-light/6',
|
||||
|
||||
'px-2',
|
||||
'gap-3',
|
||||
'text-dark/7',
|
||||
'min-h-[2.5rem]',
|
||||
'w-[2.5rem]',
|
||||
'rounded-lg',
|
||||
'straight-corners:rounded-sm',
|
||||
|
||||
'straight-corners:rounded-none',
|
||||
'bg-dark/2',
|
||||
'transition-colors',
|
||||
'transition-opacity',
|
||||
'ease-out',
|
||||
'hover:opacity-8',
|
||||
'ring-1',
|
||||
'ring-inset',
|
||||
'ring-dark/1',
|
||||
'contrast-more:ring-dark',
|
||||
'contrast-more:bg-light',
|
||||
'contrast-more:text-dark',
|
||||
'dark:bg-light/1',
|
||||
'dark:ring-light/1',
|
||||
'dark:text-light/7',
|
||||
'contrast-more:dark:ring-light',
|
||||
'contrast-more:dark:bg-dark',
|
||||
'contrast-more:dark:text-light',
|
||||
|
||||
'transition-all',
|
||||
'hover:shadow-md',
|
||||
'hover:scale-102',
|
||||
'hover:ring-dark/2',
|
||||
'hover:text-dark/10',
|
||||
'focus:shadow-md',
|
||||
'focus:scale-102',
|
||||
'focus:ring-dark/2',
|
||||
'focus:text-dark/10',
|
||||
'dark:hover:bg-dark-3',
|
||||
'dark:hover:ring-light/4',
|
||||
'dark:hover:text-light',
|
||||
'dark:focus:bg-dark-3',
|
||||
'dark:focus:ring-light/4',
|
||||
'dark:focus:text-light',
|
||||
|
||||
'contrast-more:hover:ring-2',
|
||||
'contrast-more:hover:ring-dark',
|
||||
'dark:contrast-more:hover:ring-light',
|
||||
'contrast-more:focus:ring-2',
|
||||
'contrast-more:focus:ring-dark',
|
||||
'dark:contrast-more:focus:ring-light',
|
||||
|
||||
'active:shadow-sm',
|
||||
'active:scale-98',
|
||||
|
||||
'[&>p]:hidden',
|
||||
'[&>span]:hidden',
|
||||
'md:justify-start',
|
||||
'md:[&>p]:flex',
|
||||
'md:[&>span]:flex',
|
||||
'md:w-full',
|
||||
'md:px-3.5',
|
||||
'text-base',
|
||||
style,
|
||||
)}
|
||||
>
|
||||
<Icon
|
||||
icon="magnifying-glass"
|
||||
className={tcls('text-dark/8', 'dark:text-light/8', 'shrink-0', 'size-4')}
|
||||
/>
|
||||
<div className={tcls('w-full', 'hidden', 'md:block', 'text-left')}>{children}</div>
|
||||
<div className={tcls('text-dark/7', 'pt-1.5', 'pb-2', 'dark:text-light/7')}>
|
||||
<Icon icon="magnifying-glass" className={tcls('shrink-0', 'size-4')} />
|
||||
</div>
|
||||
{children}
|
||||
<Shortcut />
|
||||
</button>
|
||||
);
|
||||
@@ -121,22 +96,20 @@ const Shortcut = () => {
|
||||
}, []);
|
||||
|
||||
return (
|
||||
<div
|
||||
<span
|
||||
className={tcls(
|
||||
'shortcut',
|
||||
'hidden',
|
||||
'md:inline',
|
||||
'justify-end',
|
||||
'text-xs',
|
||||
'text-dark/6',
|
||||
'text-dark/5',
|
||||
'contrast-more:text-dark',
|
||||
'dark:text-light/6',
|
||||
'whitespace-nowrap',
|
||||
'dark:text-light/5',
|
||||
'contrast-more:dark:text-light',
|
||||
`[font-feature-settings:"calt",_"case"]`,
|
||||
)}
|
||||
>
|
||||
{operatingSystem === 'mac' ? '⌘' : 'Ctrl +'} K
|
||||
</div>
|
||||
</span>
|
||||
);
|
||||
};
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
'use client';
|
||||
|
||||
import { Collection, Site } from '@gitbook/api';
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import { AnimatePresence, motion } from 'framer-motion';
|
||||
import { useRouter } from 'next/navigation';
|
||||
@@ -55,6 +56,10 @@ export function SearchModal(props: SearchModalProps) {
|
||||
};
|
||||
}, [isSearchOpened]);
|
||||
|
||||
if (state === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const onChangeQuery = (newQuery: SearchState) => {
|
||||
setSearchState(newQuery);
|
||||
};
|
||||
@@ -67,75 +72,62 @@ export function SearchModal(props: SearchModalProps) {
|
||||
};
|
||||
|
||||
return (
|
||||
<AnimatePresence>
|
||||
{state !== null ? (
|
||||
<motion.div
|
||||
initial={{
|
||||
opacity: 0,
|
||||
}}
|
||||
animate={{
|
||||
opacity: 1,
|
||||
}}
|
||||
exit={{
|
||||
opacity: 0,
|
||||
}}
|
||||
transition={{
|
||||
duration: 0.2,
|
||||
delay: 0.1,
|
||||
}}
|
||||
role="dialog"
|
||||
className={tcls(
|
||||
'fixed',
|
||||
'inset-0',
|
||||
'bg-dark/4',
|
||||
'backdrop-blur-2xl',
|
||||
'z-30',
|
||||
'px-4',
|
||||
'pt-4',
|
||||
'dark:bg-dark/8',
|
||||
'md:pt-[min(8vh,6rem)]',
|
||||
)}
|
||||
onClick={() => {
|
||||
onClose();
|
||||
}}
|
||||
>
|
||||
<div className="scroll-nojump">
|
||||
<AnimatePresence>
|
||||
{askState?.type === 'loading' ? (
|
||||
<motion.div
|
||||
key="loading"
|
||||
initial={{ opacity: 0 }}
|
||||
animate={{ opacity: 1 }}
|
||||
exit={{ opacity: 0 }}
|
||||
transition={{ duration: 1 }}
|
||||
className={tcls(
|
||||
'w-screen',
|
||||
'h-screen',
|
||||
'fixed',
|
||||
'inset-0',
|
||||
'z-10',
|
||||
'pointer-events-none',
|
||||
)}
|
||||
>
|
||||
<LoadingPane
|
||||
gridStyle={['h-screen', 'aspect-auto', 'top-[-30%]']}
|
||||
pulse
|
||||
tile={96}
|
||||
style={['grid']}
|
||||
/>
|
||||
</motion.div>
|
||||
) : null}
|
||||
</AnimatePresence>
|
||||
<SearchModalBody
|
||||
{...props}
|
||||
state={state}
|
||||
onChangeQuery={onChangeQuery}
|
||||
onClose={onClose}
|
||||
/>
|
||||
</div>
|
||||
</motion.div>
|
||||
) : null}
|
||||
</AnimatePresence>
|
||||
<>
|
||||
<div
|
||||
role="dialog"
|
||||
className={tcls(
|
||||
'flex',
|
||||
'items-start',
|
||||
'justify-center',
|
||||
'fixed',
|
||||
'inset-0',
|
||||
'bg-dark/4',
|
||||
'backdrop-blur-2xl',
|
||||
'opacity-[1]',
|
||||
'z-30',
|
||||
'px-4',
|
||||
'pt-4',
|
||||
'dark:bg-dark/8',
|
||||
'md:pt-[min(8vw,_6rem)]',
|
||||
)}
|
||||
onClick={() => {
|
||||
onClose();
|
||||
}}
|
||||
>
|
||||
<AnimatePresence>
|
||||
{askState?.type === 'loading' ? (
|
||||
<motion.div
|
||||
key="loading"
|
||||
initial={{ opacity: 0 }}
|
||||
animate={{ opacity: 1 }}
|
||||
exit={{ opacity: 0 }}
|
||||
transition={{ duration: 1 }}
|
||||
className={tcls(
|
||||
'w-[100vw]',
|
||||
'h-[100vh]',
|
||||
'fixed',
|
||||
'inset-0',
|
||||
'z-10',
|
||||
'pointer-events-none',
|
||||
)}
|
||||
>
|
||||
<LoadingPane
|
||||
gridStyle={['h-[100vh]', 'aspect-auto', 'top-[-30%]']}
|
||||
pulse
|
||||
tile={96}
|
||||
style={['grid']}
|
||||
/>
|
||||
</motion.div>
|
||||
) : null}
|
||||
</AnimatePresence>
|
||||
<SearchModalBody
|
||||
{...props}
|
||||
state={state}
|
||||
onChangeQuery={onChangeQuery}
|
||||
onClose={onClose}
|
||||
/>
|
||||
</div>
|
||||
</>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -166,21 +158,10 @@ function SearchModalBody(
|
||||
inputRef.current?.focus();
|
||||
}, []);
|
||||
|
||||
React.useEffect(() => {
|
||||
const handleKeyDown = (event: KeyboardEvent) => {
|
||||
if (event.key === 'Escape') {
|
||||
onClose();
|
||||
}
|
||||
};
|
||||
document.addEventListener('keydown', handleKeyDown);
|
||||
|
||||
return () => {
|
||||
document.removeEventListener('keydown', handleKeyDown);
|
||||
};
|
||||
}, [onClose]);
|
||||
|
||||
const onKeyDown = (event: React.KeyboardEvent<HTMLInputElement>) => {
|
||||
if (event.key === 'ArrowUp') {
|
||||
if (event.key === 'Escape') {
|
||||
onClose();
|
||||
} else if (event.key === 'ArrowUp') {
|
||||
event.preventDefault();
|
||||
resultsRef.current?.moveUp();
|
||||
} else if (event.key === 'ArrowDown') {
|
||||
@@ -202,34 +183,15 @@ function SearchModalBody(
|
||||
|
||||
return (
|
||||
<motion.div
|
||||
transition={{
|
||||
duration: 0.2,
|
||||
delay: 0.1,
|
||||
ease: 'easeOut',
|
||||
}}
|
||||
initial={{
|
||||
scale: 0.95,
|
||||
opacity: 0,
|
||||
}}
|
||||
animate={{
|
||||
scale: 1,
|
||||
opacity: 1,
|
||||
}}
|
||||
exit={{
|
||||
scale: 0.95,
|
||||
opacity: 0,
|
||||
}}
|
||||
role="dialog"
|
||||
aria-label={tString(language, 'search')}
|
||||
className={tcls(
|
||||
'z-40',
|
||||
'relative',
|
||||
'flex',
|
||||
'flex-col',
|
||||
'bg-white',
|
||||
'max-w-prose',
|
||||
'mx-auto',
|
||||
'max-h-[70dvh]',
|
||||
'max-w-[768px]',
|
||||
'mt-[-1px]',
|
||||
'w-full',
|
||||
'rounded-lg',
|
||||
'straight-corners:rounded-sm',
|
||||
@@ -241,6 +203,14 @@ function SearchModalBody(
|
||||
'dark:bg-dark-3',
|
||||
'dark:ring-light/2',
|
||||
)}
|
||||
initial={{
|
||||
scale: 0.95,
|
||||
opacity: 0,
|
||||
}}
|
||||
animate={{
|
||||
scale: 1,
|
||||
opacity: 1,
|
||||
}}
|
||||
onClick={(event) => {
|
||||
event.stopPropagation();
|
||||
}}
|
||||
@@ -321,7 +291,7 @@ function SearchModalBody(
|
||||
></SearchResults>
|
||||
) : null}
|
||||
{state.query && state.ask && withAsk ? (
|
||||
<SearchAskAnswer pointer={pointer} query={state.query} />
|
||||
<SearchAskAnswer spaceId={spaceId} query={state.query} />
|
||||
) : null}
|
||||
</motion.div>
|
||||
);
|
||||
|
||||
@@ -23,38 +23,26 @@ export const SearchPageResultItem = React.forwardRef(function SearchPageResultIt
|
||||
href={item.href}
|
||||
className={tcls(
|
||||
'flex',
|
||||
'gap-4',
|
||||
'flex-row',
|
||||
'items-center',
|
||||
'p-4',
|
||||
'px-4',
|
||||
'sm:px-12',
|
||||
'py-4',
|
||||
'sm:py-6',
|
||||
'border-t',
|
||||
'first:border-t-0',
|
||||
'border-dark/2',
|
||||
'dark:border-light/1',
|
||||
'first:border-none',
|
||||
'dark:border-light/2',
|
||||
'hover:bg-dark-4/2',
|
||||
'text-base',
|
||||
'text-dark',
|
||||
'font-medium',
|
||||
'hover:bg-dark/1',
|
||||
'dark:hover:bg-light/1',
|
||||
'group',
|
||||
active
|
||||
? [
|
||||
'is-active',
|
||||
'bg-primary-50',
|
||||
'text-contrast-primary-50',
|
||||
'dark:bg-primary-800',
|
||||
'dark:text-contrast-primary-800',
|
||||
'hover:bg-primary-100/8',
|
||||
'dark:hover:bg-primary-700/7',
|
||||
]
|
||||
: null,
|
||||
'first:mt-0',
|
||||
'dark:text-light',
|
||||
'dark:hover:bg-light-4/2',
|
||||
active ? ['bg-dark/1', 'dark:bg-light/1'] : null,
|
||||
)}
|
||||
>
|
||||
<div className="size-4">
|
||||
<Icon
|
||||
icon="file-lines"
|
||||
className={tcls('size-4', active ? 'text-primary' : 'opacity-5')}
|
||||
/>
|
||||
</div>
|
||||
<div className={tcls('flex', 'flex-col', 'w-full')}>
|
||||
{item.spaceTitle ? (
|
||||
<div
|
||||
@@ -72,19 +60,10 @@ export const SearchPageResultItem = React.forwardRef(function SearchPageResultIt
|
||||
) : null}
|
||||
<HighlightQuery query={query} text={item.title} />
|
||||
</div>
|
||||
<div
|
||||
className={tcls(
|
||||
'p-2',
|
||||
'rounded',
|
||||
'straight-corners:rounded-none',
|
||||
active ? ['bg-primary', 'text-contrast-primary'] : ['opacity-6'],
|
||||
)}
|
||||
>
|
||||
<Icon
|
||||
icon={active ? 'arrow-turn-down-left' : 'chevron-right'}
|
||||
className={tcls('size-4')}
|
||||
/>
|
||||
</div>
|
||||
<Icon
|
||||
icon="chevron-right"
|
||||
className={tcls('size-4', 'text-dark', 'dark:text-light', 'opacity-6')}
|
||||
/>
|
||||
</Link>
|
||||
);
|
||||
});
|
||||
|
||||
@@ -26,21 +26,16 @@ export const SearchQuestionResultItem = React.forwardRef(function SearchQuestion
|
||||
onClick={onClick}
|
||||
className={tcls(
|
||||
'flex',
|
||||
'flex-row',
|
||||
'px-4',
|
||||
recommended ? ['py-2', 'text-dark/7', 'dark:text-light/8'] : 'py-4',
|
||||
'hover:bg-dark/1',
|
||||
'dark:hover:bg-light/1',
|
||||
'py-2',
|
||||
'hover:bg-dark-4/2',
|
||||
'text-dark/7',
|
||||
'first:mt-0',
|
||||
'last:pb-3',
|
||||
active && [
|
||||
'is-active',
|
||||
'bg-primary-50',
|
||||
'text-contrast-primary-50',
|
||||
'dark:bg-primary-800',
|
||||
'dark:text-contrast-primary-800',
|
||||
'hover:bg-primary-100/8',
|
||||
'dark:hover:bg-primary-700/7',
|
||||
],
|
||||
'dark:text-light/8',
|
||||
'dark:hover:bg-light-4/2',
|
||||
active ? ['bg-dark/1', 'dark:bg-light/1'] : null,
|
||||
)}
|
||||
{...getLinkProp({
|
||||
ask: true,
|
||||
@@ -48,41 +43,18 @@ export const SearchQuestionResultItem = React.forwardRef(function SearchQuestion
|
||||
})}
|
||||
>
|
||||
<Icon
|
||||
icon={recommended ? 'search' : 'sparkles'}
|
||||
icon="magnifying-glass"
|
||||
className={tcls(
|
||||
'size-4',
|
||||
'shrink-0',
|
||||
'mt-1.5',
|
||||
'mt-0.5',
|
||||
'mr-4',
|
||||
active ? ['text-primary'] : ['text-dark/5', 'dark:text-light/5'],
|
||||
'mt-1',
|
||||
'text-dark/5',
|
||||
'dark:text-light/5',
|
||||
)}
|
||||
/>
|
||||
<div className="w-full">
|
||||
{recommended ? (
|
||||
question
|
||||
) : (
|
||||
<>
|
||||
<div className="font-medium">{t(language, 'search_ask', [question])}</div>
|
||||
<div className={tcls('text-sm', 'text-dark/8', 'dark:text-light/8')}>
|
||||
{t(language, 'search_ask_description')}
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
<div
|
||||
className={tcls(
|
||||
'p-2',
|
||||
'rounded',
|
||||
'self-center',
|
||||
'straight-corners:rounded-none',
|
||||
active ? ['bg-primary', 'text-contrast-primary'] : ['opacity-6'],
|
||||
)}
|
||||
>
|
||||
<Icon
|
||||
icon={active ? 'arrow-turn-down-left' : 'chevron-right'}
|
||||
className={tcls('size-4')}
|
||||
/>
|
||||
</div>
|
||||
{recommended ? question : t(language, 'search_ask', [question])}
|
||||
</Link>
|
||||
);
|
||||
});
|
||||
|
||||
@@ -5,6 +5,7 @@ import { t, useLanguage } from '@/intl/client';
|
||||
import { SiteContentPointer } from '@/lib/api';
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
|
||||
import { isQuestion } from './isQuestion';
|
||||
import { SearchPageResultItem } from './SearchPageResultItem';
|
||||
import { SearchQuestionResultItem } from './SearchQuestionResultItem';
|
||||
import { SearchSectionResultItem } from './SearchSectionResultItem';
|
||||
@@ -91,6 +92,8 @@ export const SearchResults = React.forwardRef(function SearchResults(
|
||||
}
|
||||
|
||||
debounceTimeout.current = setTimeout(async () => {
|
||||
setCursor(null);
|
||||
|
||||
const fetchedResults = await (global
|
||||
? searchAllSiteContent(query, pointer)
|
||||
: searchSiteSpaceContent(query, pointer, revisionId));
|
||||
@@ -107,16 +110,6 @@ export const SearchResults = React.forwardRef(function SearchResults(
|
||||
}
|
||||
}, [query, global, pointer, spaceId, revisionId, withAsk]);
|
||||
|
||||
React.useEffect(() => {
|
||||
if (!query) {
|
||||
// Reset the cursor when there's no query
|
||||
setCursor(null);
|
||||
} else if (results && results.length > 0) {
|
||||
// Auto-focus the first result
|
||||
setCursor(0);
|
||||
}
|
||||
}, [results, query]);
|
||||
|
||||
// Scroll to the active result.
|
||||
React.useEffect(() => {
|
||||
if (cursor === null || !refs.current[cursor]) {
|
||||
@@ -181,7 +174,7 @@ export const SearchResults = React.forwardRef(function SearchResults(
|
||||
}
|
||||
|
||||
return (
|
||||
<div className={tcls('overflow-auto')}>
|
||||
<div className={tcls('max-h-[70vh]', 'overflow-auto', 'relative')}>
|
||||
{children}
|
||||
{results.length === 0 ? (
|
||||
<div
|
||||
@@ -263,13 +256,10 @@ export const SearchResults = React.forwardRef(function SearchResults(
|
||||
);
|
||||
});
|
||||
|
||||
/**
|
||||
* Add a "Ask <question>" item at the top of the results list.
|
||||
*/
|
||||
function withQuestionResult(results: null | ResultType[], query: string): null | ResultType[] {
|
||||
const without = results ? results.filter((result) => result.type !== 'question') : null;
|
||||
|
||||
if (query.length === 0) {
|
||||
if (!isQuestion(query)) {
|
||||
return without;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import { Icon } from '@gitbook/icons';
|
||||
import React from 'react';
|
||||
|
||||
import { tcls } from '@/lib/tailwind';
|
||||
@@ -22,39 +21,27 @@ export const SearchSectionResultItem = React.forwardRef(function SearchSectionRe
|
||||
ref={ref}
|
||||
href={item.href}
|
||||
className={tcls(
|
||||
'search-section-result-item',
|
||||
'[&:has(+:not(&))]:mb-6',
|
||||
'flex',
|
||||
'items-center',
|
||||
'pl-6',
|
||||
'sm:pl-12',
|
||||
'pr-4',
|
||||
'flex-col',
|
||||
'mb-2',
|
||||
'px-4',
|
||||
'sm:px-12',
|
||||
'hover:bg-dark-4/2',
|
||||
'dark:hover:bg-light-4/2',
|
||||
'text-dark/8',
|
||||
'dark:text-light/8',
|
||||
'hover:bg-dark/1',
|
||||
'dark:hover:bg-light/1',
|
||||
'font-normal',
|
||||
'py-2',
|
||||
'group',
|
||||
active && [
|
||||
'is-active',
|
||||
'bg-primary-50',
|
||||
'text-contrast-primary-50',
|
||||
'dark:bg-primary-800',
|
||||
'dark:text-contrast-primary-800',
|
||||
'hover:bg-primary-100/8',
|
||||
'dark:hover:bg-primary-700/7',
|
||||
],
|
||||
'transition-colors',
|
||||
active ? ['bg-dark/1', 'dark:bg-light/1'] : null,
|
||||
)}
|
||||
>
|
||||
<div
|
||||
className={tcls(
|
||||
'border-l-2',
|
||||
'px-4',
|
||||
'py-1',
|
||||
'flex',
|
||||
'flex-1',
|
||||
'overflow-hidden',
|
||||
'flex-col',
|
||||
'py-2',
|
||||
'border-dark/2',
|
||||
'dark:border-light/2',
|
||||
)}
|
||||
@@ -65,25 +52,18 @@ export const SearchSectionResultItem = React.forwardRef(function SearchSectionRe
|
||||
</p>
|
||||
) : null}
|
||||
{item.body ? (
|
||||
<p className={tcls('text-sm', 'line-clamp-3', 'relative')}>
|
||||
<p
|
||||
className={tcls(
|
||||
'text-sm',
|
||||
'line-clamp-3',
|
||||
'z-[-1]', //to force stacking order
|
||||
'relative',
|
||||
)}
|
||||
>
|
||||
<HighlightQuery query={query} text={item.body} />
|
||||
</p>
|
||||
) : null}
|
||||
</div>
|
||||
<div
|
||||
className={tcls(
|
||||
'p-2',
|
||||
'rounded',
|
||||
'straight-corners:rounded-none',
|
||||
'bg-primary',
|
||||
'text-contrast-primary',
|
||||
'hidden',
|
||||
'sm:block',
|
||||
active ? ['opacity-11', 'block'] : ['opacity-0'],
|
||||
)}
|
||||
>
|
||||
<Icon icon="arrow-turn-down-left" className={tcls('size-4')} />
|
||||
</div>
|
||||
</Link>
|
||||
);
|
||||
});
|
||||
|
||||
@@ -39,10 +39,10 @@ export interface AskAnswerSource {
|
||||
}
|
||||
|
||||
export interface AskAnswerResult {
|
||||
/** Undefined if no answer. */
|
||||
body?: React.ReactNode;
|
||||
followupQuestions: string[];
|
||||
sources: AskAnswerSource[];
|
||||
hasAnswer: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -152,53 +152,16 @@ export async function searchSiteSpaceContent(
|
||||
/**
|
||||
* Server action to ask a question in a space.
|
||||
*/
|
||||
export const streamAskQuestion = streamResponse(async function* (
|
||||
organizationId: string,
|
||||
siteId: string,
|
||||
siteSpaceId: string | null,
|
||||
question: string,
|
||||
) {
|
||||
const stream = api.api().client.orgs.streamAskInSite(
|
||||
organizationId,
|
||||
siteId,
|
||||
{
|
||||
question,
|
||||
context: siteSpaceId
|
||||
? {
|
||||
siteSpaceId,
|
||||
}
|
||||
: undefined,
|
||||
scope: {
|
||||
mode: 'default',
|
||||
export const streamAskQuestion = streamResponse(async function* (spaceId: string, query: string) {
|
||||
const stream = api
|
||||
.api()
|
||||
.spaces.streamAskInSpace(spaceId, { query, format: 'document', details: true });
|
||||
const pagesPromise = api.getSpaceContentData({ spaceId }, undefined);
|
||||
|
||||
// Include the current site space regardless.
|
||||
includedSiteSpaces: siteSpaceId ? [siteSpaceId] : undefined,
|
||||
},
|
||||
},
|
||||
{ format: 'document' },
|
||||
);
|
||||
|
||||
const spaceData = new PromiseQueue<string, RevisionPage[]>();
|
||||
for await (const chunk of stream) {
|
||||
const answer = chunk.answer;
|
||||
// We run the AI search and fetch the pages in parallel
|
||||
const { pages } = await pagesPromise;
|
||||
|
||||
// Register the space of each page source into the promise queue.
|
||||
const spaces = answer.sources
|
||||
.map((source) => {
|
||||
if (source.type !== 'page') {
|
||||
return null;
|
||||
}
|
||||
|
||||
spaceData.registerPromise(source.space, () => {
|
||||
return api.getRevisionPages(source.space, source.revision, { metadata: false });
|
||||
});
|
||||
|
||||
return source.space;
|
||||
})
|
||||
.filter(filterOutNullable);
|
||||
|
||||
// Get the pages for all spaces referenced by this answer.
|
||||
const pages = await spaceData.getPromises(spaces);
|
||||
yield transformAnswer(chunk.answer, pages);
|
||||
}
|
||||
});
|
||||
@@ -212,28 +175,26 @@ export async function getRecommendedQuestions(spaceId: string): Promise<string[]
|
||||
}
|
||||
|
||||
function transformAnswer(
|
||||
answer: SearchAIAnswer,
|
||||
spacePages: Map<string, RevisionPage[]>,
|
||||
): AskAnswerResult {
|
||||
answer: SearchAIAnswer | undefined,
|
||||
pages: RevisionPage[],
|
||||
): AskAnswerResult | null {
|
||||
if (!answer) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const sources = answer.sources
|
||||
.map((source) => {
|
||||
if (source.type !== 'page') {
|
||||
return null;
|
||||
}
|
||||
|
||||
const pages = spacePages.get(source.space);
|
||||
|
||||
if (!pages) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const page = resolvePageId(pages, source.page);
|
||||
if (!page) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
id: source.page,
|
||||
id: page.page.id,
|
||||
title: page.page.title,
|
||||
href: pageHref(pages, page.page),
|
||||
};
|
||||
@@ -256,6 +217,7 @@ function transformAnswer(
|
||||
) : null,
|
||||
followupQuestions: answer.followupQuestions,
|
||||
sources,
|
||||
hasAnswer: !!answer.answer && 'document' in answer.answer,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -321,70 +283,3 @@ function transformPageResult(item: SearchPageResult, space?: Space) {
|
||||
|
||||
return [page, ...sections];
|
||||
}
|
||||
|
||||
/**
|
||||
* A queue for promises that performs deduplication of requests
|
||||
* and ensures they run sequentially.
|
||||
*
|
||||
* This is useful when you want to make multiple async requests
|
||||
* but want to avoid making the same request multiple times.
|
||||
*
|
||||
* Running the promises sequentially gives us some safety about
|
||||
* hitting Cloudflare Worker's 6 parallel subrequest limits.
|
||||
*/
|
||||
class PromiseQueue<Key extends string, Value> {
|
||||
private promiseQueue: (() => Promise<Value>)[] = [];
|
||||
private results: Map<Key, Value> = new Map();
|
||||
private registeredKeys: Set<Key> = new Set();
|
||||
private currentExecution: Promise<void> | null = null;
|
||||
|
||||
private async executeQueue() {
|
||||
while (this.promiseQueue.length > 0) {
|
||||
const promiseFn = this.promiseQueue.shift()!;
|
||||
await promiseFn();
|
||||
}
|
||||
this.currentExecution = null; // Mark the queue as idle
|
||||
}
|
||||
|
||||
registerPromise(key: Key, fn: () => Promise<Value>): void {
|
||||
if (this.registeredKeys.has(key)) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.registeredKeys.add(key);
|
||||
|
||||
const wrapperFn = async () => {
|
||||
const result = await fn();
|
||||
this.results.set(key, result);
|
||||
return result;
|
||||
};
|
||||
|
||||
this.promiseQueue.push(wrapperFn);
|
||||
|
||||
// Start executing if not already running
|
||||
if (!this.currentExecution) {
|
||||
this.currentExecution = this.executeQueue();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a promise that resolves to a map of results for the given keys.
|
||||
* If the key has not been registered in the queue, it will be ignored.
|
||||
*/
|
||||
async getPromises(keys: Key[]): Promise<Map<Key, Value>> {
|
||||
// Wait for any ongoing executions to finish
|
||||
if (this.currentExecution) {
|
||||
await this.currentExecution;
|
||||
}
|
||||
|
||||
return keys.reduce((map, key) => {
|
||||
const data = this.results.get(key);
|
||||
|
||||
if (data) {
|
||||
return map.set(key, data);
|
||||
}
|
||||
|
||||
return map;
|
||||
}, new Map<Key, Value>());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -106,13 +106,9 @@ export function SpaceLayout(props: {
|
||||
)
|
||||
}
|
||||
innerHeader={
|
||||
withVariants && (
|
||||
<SpacesDropdown
|
||||
className={withTopHeader && !sections ? 'sm:hidden' : undefined}
|
||||
space={space}
|
||||
spaces={spaces}
|
||||
/>
|
||||
)
|
||||
(sections || !withTopHeader) && withVariants ? (
|
||||
<SpacesDropdown space={space} spaces={spaces} />
|
||||
) : null
|
||||
}
|
||||
headerOffset={headerOffset}
|
||||
/>
|
||||
|
||||
@@ -45,7 +45,7 @@ export function Button({
|
||||
|
||||
const sizes = {
|
||||
default: ['text-base', 'px-4', 'py-2'],
|
||||
medium: ['text-sm', 'px-3', 'py-1'],
|
||||
medium: ['text-base', 'px-3', 'py-1'],
|
||||
small: ['text-xs', 'px-3 py-2'],
|
||||
};
|
||||
|
||||
|
||||
@@ -3,38 +3,24 @@ import localFont from 'next/font/local';
|
||||
import { getEmojiForCode } from '@/lib/emojis';
|
||||
import { ClassValue, tcls } from '@/lib/tailwind';
|
||||
|
||||
/**
|
||||
COLRv1 font.
|
||||
- lightweight, top quality
|
||||
- widely supported by modern browsers
|
||||
- currently not by Safari (or iOS)
|
||||
*/
|
||||
const colrv1Font = localFont({
|
||||
src: './joypixels-colrv1.woff2',
|
||||
import './emoji.css';
|
||||
|
||||
/* Load the 3 variants of the font as CSS variables and let the emoji.css decide on the best one to use */
|
||||
|
||||
const svgFont = localFont({
|
||||
src: './svg.woff2',
|
||||
preload: false,
|
||||
variable: '--font-emojis-colrv1',
|
||||
variable: '--font-emojis-svg',
|
||||
});
|
||||
|
||||
/**
|
||||
SBIX font.
|
||||
- narrowly supported
|
||||
- currently required for Safari (or iOS)
|
||||
- provide alternative font-family name (see below)
|
||||
*/
|
||||
const sbixFont = localFont({
|
||||
src: './joypixels-sbix.woff2',
|
||||
src: './sbix.woff2',
|
||||
preload: false,
|
||||
variable: '--font-emojis-sbix',
|
||||
});
|
||||
|
||||
/**
|
||||
CBDT font.
|
||||
- widely supported
|
||||
- currently not by Safari (or iOS)
|
||||
- retain for legacy browser support
|
||||
*/
|
||||
const cbdtFont = localFont({
|
||||
src: './joypixels-cbdt.woff2',
|
||||
src: './cbdt.woff2',
|
||||
preload: false,
|
||||
variable: '--font-emojis-cbdt',
|
||||
});
|
||||
@@ -42,7 +28,7 @@ const cbdtFont = localFont({
|
||||
/**
|
||||
* Class name to set on the <html> tag to use the emoji font.
|
||||
*/
|
||||
export const emojiFontClassName = [colrv1Font.variable, sbixFont.variable, cbdtFont.variable].join(
|
||||
export const emojiFontClassName = [svgFont.variable, sbixFont.variable, cbdtFont.variable].join(
|
||||
' ',
|
||||
);
|
||||
|
||||
@@ -54,5 +40,5 @@ export async function Emoji(props: { code: string; style?: ClassValue }) {
|
||||
const { code, style } = props;
|
||||
|
||||
const fallback = getEmojiForCode(code);
|
||||
return <span className={tcls('emoji', style)}>{fallback}</span>;
|
||||
return <span className={'emoji ' + tcls(style)}>{fallback}</span>;
|
||||
}
|
||||
|
||||
BIN
Binary file not shown.
@@ -0,0 +1,24 @@
|
||||
[class*='emoji'] {
|
||||
font-family: var(--font-emojis-cbdt);
|
||||
}
|
||||
|
||||
/* Safari Only CSS here */
|
||||
_::-webkit-full-page-media,
|
||||
_:future,
|
||||
:root [class*='emoji'] {
|
||||
font-family: var(--font-emojis-sbix);
|
||||
}
|
||||
|
||||
/* Chrome Only CSS here */
|
||||
@media screen and (-webkit-min-device-pixel-ratio: 0) {
|
||||
.emoji {
|
||||
font-family: var(--font-emojis-svg);
|
||||
}
|
||||
}
|
||||
|
||||
/* Firefox Only CSS here */
|
||||
@-moz-document url-prefix() {
|
||||
.emoji {
|
||||
font-family: var(--font-emojis-svg);
|
||||
}
|
||||
}
|
||||
Binary file not shown.
BIN
Binary file not shown.
Binary file not shown.
@@ -13,7 +13,6 @@ export const de = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'Alle Inhalte',
|
||||
search_ask: 'Fragen "${1}"',
|
||||
search_ask_description: 'Finden Sie die Antwort mit AI',
|
||||
search_ask_sources: 'Quellen',
|
||||
search_ask_sources_no_answer: 'Verwandte Seiten',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -6,14 +6,13 @@ export const en = {
|
||||
switch_to_light_theme: 'Switch to light theme',
|
||||
switch_to_system_theme: 'Switch to system theme',
|
||||
search: 'Search',
|
||||
search_or_ask: 'Ask or search',
|
||||
search_or_ask: 'Ask or Search',
|
||||
search_input_placeholder: 'Search content',
|
||||
search_ask_input_placeholder: 'Search content or ask a question',
|
||||
search_no_results: 'No results for "${1}".',
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'All content',
|
||||
search_ask: 'Ask "${1}"',
|
||||
search_ask_description: 'Find the answer with AI',
|
||||
search_ask_sources: 'Sources',
|
||||
search_ask_sources_no_answer: 'Related pages',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -15,7 +15,6 @@ export const es: TranslationLanguage = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'Todo el contenido',
|
||||
search_ask: 'Preguntar "${1}"',
|
||||
search_ask_description: 'Encuentra la respuesta con IA',
|
||||
search_ask_sources: 'Fuentes',
|
||||
search_ask_sources_no_answer: 'Páginas relacionadas',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -15,7 +15,6 @@ export const fr: TranslationLanguage = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'Tout le contenu',
|
||||
search_ask: 'Demander "${1}"',
|
||||
search_ask_description: "Trouvez la réponse avec l'IA",
|
||||
search_ask_sources: 'Sources',
|
||||
search_ask_sources_no_answer: 'Pages connexes',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -15,7 +15,6 @@ export const ja: TranslationLanguage = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: '全てのコンテンツ',
|
||||
search_ask: '"${1}" を質問する',
|
||||
search_ask_description: 'AIで答えを見つける',
|
||||
search_ask_sources: '情報源',
|
||||
search_ask_sources_no_answer: '関連ページ',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -15,7 +15,6 @@ export const nl: TranslationLanguage = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'Alle inhoud',
|
||||
search_ask: 'Vraag "${1}"',
|
||||
search_ask_description: 'Vind het antwoord met AI',
|
||||
search_ask_sources: 'Bronnen',
|
||||
search_ask_sources_no_answer: 'Gerelateerde pagina’s',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -15,7 +15,6 @@ export const no: TranslationLanguage = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'Alt innhold',
|
||||
search_ask: 'Spør "${1}"',
|
||||
search_ask_description: 'Finn svaret med AI',
|
||||
search_ask_sources: 'Kilder',
|
||||
search_ask_sources_no_answer: 'Relaterte sider',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -13,7 +13,6 @@ export const pt_br = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: 'Todo o conteúdo',
|
||||
search_ask: 'Perguntar "${1}"',
|
||||
search_ask_description: 'Encontre a resposta com IA',
|
||||
search_ask_sources: 'Fontes',
|
||||
search_ask_sources_no_answer: 'Páginas relacionadas',
|
||||
search_ask_no_answer:
|
||||
|
||||
@@ -15,7 +15,6 @@ export const zh: TranslationLanguage = {
|
||||
search_scope_space: '${1}',
|
||||
search_scope_all: '所有内容',
|
||||
search_ask: '询问"${1}"',
|
||||
search_ask_description: '利用人工智能找到答案',
|
||||
search_ask_sources: '来源',
|
||||
search_ask_sources_no_answer: '相关页面',
|
||||
search_ask_no_answer: '无法找到您的问题的答案。您可以尝试改述问题或提供更具体的信息。',
|
||||
|
||||
@@ -87,30 +87,14 @@ const cacheTtl_1day = {
|
||||
ttl: 24 * 60 * 60,
|
||||
};
|
||||
|
||||
export type GitBookAPIContext = {
|
||||
/**
|
||||
* Instance of the GitBook API client.
|
||||
*/
|
||||
client: GitBookAPI;
|
||||
|
||||
/**
|
||||
* Context ID representing a hash of the visitor's attributes/assertions that are
|
||||
* included in the claims property of the content API JWT token.
|
||||
*
|
||||
* It serves as a suffix for the cache key to ensure that the content cache is invalidated
|
||||
* when these attributees/assertions change.
|
||||
*/
|
||||
contextId: string | undefined;
|
||||
};
|
||||
|
||||
const apiSyncStorage = new AsyncLocalStorage<GitBookAPIContext>();
|
||||
const apiSyncStorage = new AsyncLocalStorage<GitBookAPI>();
|
||||
|
||||
export const DEFAULT_API_ENDPOINT = process.env.GITBOOK_API_URL ?? 'https://api.gitbook.com';
|
||||
|
||||
/**
|
||||
* Create a new API client with a token.
|
||||
*/
|
||||
export function apiWithToken(apiToken: string, contextId: string | undefined): GitBookAPIContext {
|
||||
export function apiWithToken(apiToken: string): GitBookAPI {
|
||||
const headersList = headers();
|
||||
const apiEndpoint = headersList.get('x-gitbook-api') ?? DEFAULT_API_ENDPOINT;
|
||||
|
||||
@@ -120,13 +104,13 @@ export function apiWithToken(apiToken: string, contextId: string | undefined): G
|
||||
userAgent: userAgent(),
|
||||
});
|
||||
|
||||
return { client: gitbook, contextId };
|
||||
return gitbook;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an API client for the current request.
|
||||
*/
|
||||
export function api(): GitBookAPIContext {
|
||||
export function api(): GitBookAPI {
|
||||
const existing = apiSyncStorage.getStore();
|
||||
if (existing) {
|
||||
return existing;
|
||||
@@ -134,7 +118,6 @@ export function api(): GitBookAPIContext {
|
||||
|
||||
const headersList = headers();
|
||||
const apiToken = headersList.get('x-gitbook-token');
|
||||
const contextId = headersList.get('x-gitbook-token-context') ?? undefined;
|
||||
|
||||
if (!apiToken) {
|
||||
throw new Error(
|
||||
@@ -142,13 +125,13 @@ export function api(): GitBookAPIContext {
|
||||
);
|
||||
}
|
||||
|
||||
return apiWithToken(apiToken, contextId);
|
||||
return apiWithToken(apiToken);
|
||||
}
|
||||
|
||||
/**
|
||||
* Use an API client for an async function.
|
||||
*/
|
||||
export function withAPI<T>(client: GitBookAPIContext, fn: () => Promise<T>): Promise<T> {
|
||||
export function withAPI<T>(client: GitBookAPI, fn: () => Promise<T>): Promise<T> {
|
||||
return apiSyncStorage.run(client, fn);
|
||||
}
|
||||
|
||||
@@ -181,7 +164,7 @@ export const getUserById = cache({
|
||||
}),
|
||||
get: async (userId: string, options: CacheFunctionOptions) => {
|
||||
try {
|
||||
const response = await api().client.users.getUserById(userId, {
|
||||
const response = await api().users.getUserById(userId, {
|
||||
signal: options.signal,
|
||||
...noCacheFetchOptions,
|
||||
});
|
||||
@@ -217,7 +200,7 @@ export const getPublishedContentByUrl = cache({
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
try {
|
||||
const response = await api().client.urls.getPublishedContentByUrl(
|
||||
const response = await api().urls.getPublishedContentByUrl(
|
||||
{
|
||||
url,
|
||||
visitorAuthToken,
|
||||
@@ -266,7 +249,7 @@ export const getSpace = cache({
|
||||
name: 'api.getSpace',
|
||||
tag: (spaceId) => getAPICacheTag({ tag: 'space', space: spaceId }),
|
||||
get: async (spaceId: string, shareKey: string | undefined, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.spaces.getSpaceById(
|
||||
const response = await api().spaces.getSpaceById(
|
||||
spaceId,
|
||||
{
|
||||
shareKey,
|
||||
@@ -290,7 +273,7 @@ export const getChangeRequest = cache({
|
||||
tag: (spaceId, changeRequestId) =>
|
||||
getAPICacheTag({ tag: 'change-request', space: spaceId, changeRequest: changeRequestId }),
|
||||
get: async (spaceId: string, changeRequestId: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.spaces.getChangeRequestById(spaceId, changeRequestId, {
|
||||
const response = await api().spaces.getChangeRequestById(spaceId, changeRequestId, {
|
||||
...noCacheFetchOptions,
|
||||
signal: options.signal,
|
||||
});
|
||||
@@ -318,14 +301,13 @@ export const getRevision = cache({
|
||||
name: 'api.getRevision.v2',
|
||||
tag: (spaceId, revisionId) =>
|
||||
getAPICacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
spaceId: string,
|
||||
revisionId: string,
|
||||
fetchOptions: GetRevisionOptions,
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
const response = await api().client.spaces.getRevisionById(
|
||||
const response = await api().spaces.getRevisionById(
|
||||
spaceId,
|
||||
revisionId,
|
||||
{
|
||||
@@ -349,14 +331,13 @@ export const getRevisionPages = cache({
|
||||
name: 'api.getRevisionPages.v4',
|
||||
tag: (spaceId, revisionId) =>
|
||||
getAPICacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
spaceId: string,
|
||||
revisionId: string,
|
||||
fetchOptions: GetRevisionOptions,
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
const response = await api().client.spaces.listPagesInRevisionById(
|
||||
const response = await api().spaces.listPagesInRevisionById(
|
||||
spaceId,
|
||||
revisionId,
|
||||
{
|
||||
@@ -383,7 +364,6 @@ export const getRevisionPageByPath = cache({
|
||||
name: 'api.getRevisionPageByPath.v3',
|
||||
tag: (spaceId, revisionId) =>
|
||||
getAPICacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
spaceId: string,
|
||||
revisionId: string,
|
||||
@@ -393,7 +373,7 @@ export const getRevisionPageByPath = cache({
|
||||
const encodedPath = encodeURIComponent(pagePath);
|
||||
|
||||
try {
|
||||
const response = await api().client.spaces.getPageInRevisionByPath(
|
||||
const response = await api().spaces.getPageInRevisionByPath(
|
||||
spaceId,
|
||||
revisionId,
|
||||
encodedPath,
|
||||
@@ -436,7 +416,7 @@ const getRevisionFileById = cache({
|
||||
) => {
|
||||
try {
|
||||
const response = await (async () => {
|
||||
return api().client.spaces.getFileInRevisionById(
|
||||
return api().spaces.getFileInRevisionById(
|
||||
spaceId,
|
||||
revisionId,
|
||||
fileId,
|
||||
@@ -465,7 +445,6 @@ const getRevisionReusableContentById = cache({
|
||||
name: 'api.getRevisionReusableContentById.v1',
|
||||
tag: (spaceId, revisionId) =>
|
||||
getAPICacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
spaceId: string,
|
||||
revisionId: string,
|
||||
@@ -474,7 +453,7 @@ const getRevisionReusableContentById = cache({
|
||||
) => {
|
||||
try {
|
||||
const response = await (async () => {
|
||||
return api().client.spaces.getReusableContentInRevisionById(
|
||||
return api().spaces.getReusableContentInRevisionById(
|
||||
spaceId,
|
||||
revisionId,
|
||||
reusableContentId,
|
||||
@@ -510,7 +489,7 @@ const getRevisionAllFiles = cache({
|
||||
get: async (spaceId: string, revisionId: string, options: CacheFunctionOptions) => {
|
||||
const response = await getAll(
|
||||
(params) =>
|
||||
api().client.spaces.listFilesInRevisionById(
|
||||
api().spaces.listFilesInRevisionById(
|
||||
spaceId,
|
||||
revisionId,
|
||||
{
|
||||
@@ -621,9 +600,8 @@ export const getDocument = cache({
|
||||
name: 'api.getDocument.v2',
|
||||
tag: (spaceId, documentId) =>
|
||||
getAPICacheTag({ tag: 'document', space: spaceId, document: documentId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (spaceId: string, documentId: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.spaces.getDocumentById(
|
||||
const response = await api().spaces.getDocumentById(
|
||||
spaceId,
|
||||
documentId,
|
||||
{
|
||||
@@ -648,7 +626,6 @@ export const getDocument = cache({
|
||||
export const getSiteRedirectBySource = cache({
|
||||
name: 'api.getSiteRedirectBySource',
|
||||
tag: ({ siteId }) => getAPICacheTag({ tag: 'site', site: siteId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
args: {
|
||||
organizationId: string;
|
||||
@@ -660,7 +637,7 @@ export const getSiteRedirectBySource = cache({
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
try {
|
||||
const response = await api().client.orgs.getSiteRedirectBySource(
|
||||
const response = await api().orgs.getSiteRedirectBySource(
|
||||
args.organizationId,
|
||||
args.siteId,
|
||||
{
|
||||
@@ -692,9 +669,8 @@ export const getSiteRedirectBySource = cache({
|
||||
export const getSite = cache({
|
||||
name: 'api.getSite',
|
||||
tag: (organizationId, siteId) => getAPICacheTag({ tag: 'site', site: siteId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (organizationId: string, siteId: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.orgs.getSiteById(organizationId, siteId, {
|
||||
const response = await api().orgs.getSiteById(organizationId, siteId, {
|
||||
...noCacheFetchOptions,
|
||||
signal: options.signal,
|
||||
});
|
||||
@@ -710,7 +686,6 @@ export const getSite = cache({
|
||||
export const getPublishedContentSite = cache({
|
||||
name: 'api.getPublishedContentSite',
|
||||
tag: ({ siteId }) => getAPICacheTag({ tag: 'site', site: siteId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
args: {
|
||||
organizationId: string;
|
||||
@@ -719,7 +694,7 @@ export const getPublishedContentSite = cache({
|
||||
},
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
const response = await api().client.orgs.getPublishedContentSite(
|
||||
const response = await api().orgs.getPublishedContentSite(
|
||||
args.organizationId,
|
||||
args.siteId,
|
||||
{
|
||||
@@ -804,7 +779,7 @@ export async function getSiteData(
|
||||
const spaces =
|
||||
siteSpaces ?? (sections ? parseSpacesFromSiteSpaces(sections.section.siteSpaces) : []);
|
||||
|
||||
const customization = getActiveCustomizationSettings(
|
||||
const customization = mergeCustomizationWithExtend(
|
||||
pointer.siteSpaceId ? customizations.siteSpaces[pointer.siteSpaceId] : customizations.site,
|
||||
);
|
||||
|
||||
@@ -851,7 +826,7 @@ export const getCollection = cache({
|
||||
name: 'api.getCollection',
|
||||
tag: (collectionId) => getAPICacheTag({ tag: 'collection', collection: collectionId }),
|
||||
get: async (collectionId: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.collections.getCollectionById(collectionId, {
|
||||
const response = await api().collections.getCollectionById(collectionId, {
|
||||
...noCacheFetchOptions,
|
||||
signal: options.signal,
|
||||
});
|
||||
@@ -869,7 +844,7 @@ export const getCollectionSpaces = cache({
|
||||
tag: (collectionId) => getAPICacheTag({ tag: 'collection', collection: collectionId }),
|
||||
get: async (collectionId: string, options: CacheFunctionOptions) => {
|
||||
const response = await getAll((params) =>
|
||||
api().client.collections.listSpacesInCollectionById(collectionId, params, {
|
||||
api().collections.listSpacesInCollectionById(collectionId, params, {
|
||||
...noCacheFetchOptions,
|
||||
signal: options.signal,
|
||||
}),
|
||||
@@ -921,7 +896,6 @@ export async function getSpaceContentData(
|
||||
export const searchSpaceContent = cache({
|
||||
name: 'api.searchSpaceContent',
|
||||
tag: (spaceId) => getAPICacheTag({ tag: 'space', space: spaceId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
spaceId: string,
|
||||
/** The revision ID is used as a cache bust key, to avoid revalidating lot of cache entries by tags */
|
||||
@@ -929,7 +903,7 @@ export const searchSpaceContent = cache({
|
||||
query: string,
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
const response = await api().client.spaces.searchSpaceContent(
|
||||
const response = await api().spaces.searchSpaceContent(
|
||||
spaceId,
|
||||
{ query },
|
||||
{
|
||||
@@ -947,9 +921,8 @@ export const searchSpaceContent = cache({
|
||||
export const searchParentContent = cache({
|
||||
name: 'api.searchParentContent',
|
||||
tag: (spaceId) => getAPICacheTag({ tag: 'space', space: spaceId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (parentId: string, query: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.search.searchContent(
|
||||
const response = await api().search.searchContent(
|
||||
{ query },
|
||||
{
|
||||
...noCacheFetchOptions,
|
||||
@@ -968,7 +941,6 @@ export const searchParentContent = cache({
|
||||
export const searchSiteContent = cache({
|
||||
name: 'api.searchSiteContent',
|
||||
tag: (organizationId, siteId) => getAPICacheTag({ tag: 'site', site: siteId }),
|
||||
getKeySuffix: () => api().contextId,
|
||||
get: async (
|
||||
organizationId: string,
|
||||
siteId: string,
|
||||
@@ -981,7 +953,7 @@ export const searchSiteContent = cache({
|
||||
cacheBust?: string,
|
||||
options?: CacheFunctionOptions,
|
||||
) => {
|
||||
const response = await api().client.orgs.searchSiteContent(
|
||||
const response = await api().orgs.searchSiteContent(
|
||||
organizationId,
|
||||
siteId,
|
||||
{
|
||||
@@ -1008,7 +980,7 @@ export const getRecommendedQuestionsInSpace = cache({
|
||||
name: 'api.getRecommendedQuestionsInSpace',
|
||||
tag: (spaceId) => getAPICacheTag({ tag: 'space', space: spaceId }),
|
||||
get: async (spaceId: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.spaces.getRecommendedQuestionsInSpace(spaceId, {
|
||||
const response = await api().spaces.getRecommendedQuestionsInSpace(spaceId, {
|
||||
...noCacheFetchOptions,
|
||||
signal: options.signal,
|
||||
});
|
||||
@@ -1027,7 +999,7 @@ export const renderIntegrationUi = cache({
|
||||
request: RequestRenderIntegrationUI,
|
||||
options: CacheFunctionOptions,
|
||||
) => {
|
||||
const response = await api().client.integrations.renderIntegrationUiWithPost(
|
||||
const response = await api().integrations.renderIntegrationUiWithPost(
|
||||
integrationName,
|
||||
request,
|
||||
{
|
||||
@@ -1046,7 +1018,7 @@ export const renderIntegrationUi = cache({
|
||||
export const getEmbedByUrl = cache({
|
||||
name: 'api.getEmbedByUrl',
|
||||
get: async (url: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.urls.getEmbedByUrl(
|
||||
const response = await api().urls.getEmbedByUrl(
|
||||
{ url },
|
||||
{
|
||||
...noCacheFetchOptions,
|
||||
@@ -1064,7 +1036,7 @@ export const getEmbedByUrlInSpace = cache({
|
||||
name: 'api.getEmbedByUrlInSpace',
|
||||
tag: (spaceId) => getAPICacheTag({ tag: 'space', space: spaceId }),
|
||||
get: async (spaceId: string, url: string, options: CacheFunctionOptions) => {
|
||||
const response = await api().client.spaces.getEmbedByUrlInSpace(
|
||||
const response = await api().spaces.getEmbedByUrlInSpace(
|
||||
spaceId,
|
||||
{ url },
|
||||
{
|
||||
@@ -1232,19 +1204,19 @@ async function getAll<T, E>(
|
||||
}
|
||||
|
||||
/**
|
||||
* Selects the customization settings from the x-gitbook-customization header if present,
|
||||
* otherwise returns the original API-provided settings.
|
||||
* Merge the customization settings with the ones passed in the x-gitbook-customization header if present.
|
||||
*/
|
||||
function getActiveCustomizationSettings(
|
||||
settings: SiteCustomizationSettings,
|
||||
): SiteCustomizationSettings {
|
||||
function mergeCustomizationWithExtend<T extends SiteCustomizationSettings | CustomizationSettings>(
|
||||
raw: T,
|
||||
) {
|
||||
const headersList = headers();
|
||||
const extend = headersList.get('x-gitbook-customization');
|
||||
if (extend) {
|
||||
try {
|
||||
const parsedSettings = rison.decode_object<SiteCustomizationSettings>(extend);
|
||||
const parsed = rison.decode_object<DeepPartial<T>>(extend);
|
||||
|
||||
return parsedSettings;
|
||||
// Merge objects and some properties deep
|
||||
return mergeDeepPlainObject(raw, parsed, ['styling', 'themes']);
|
||||
} catch (error) {
|
||||
console.error(
|
||||
`Failed to parse x-gitbook-customization header (ignored): ${
|
||||
@@ -1254,5 +1226,35 @@ function getActiveCustomizationSettings(
|
||||
}
|
||||
}
|
||||
|
||||
return settings;
|
||||
return raw;
|
||||
}
|
||||
|
||||
function mergeDeepPlainObject<T>(target: T, source: DeepPartial<T>, keys: Array<keyof T>): T {
|
||||
if (typeof target !== 'object' || target === null) {
|
||||
return target;
|
||||
}
|
||||
|
||||
const result = { ...target };
|
||||
|
||||
for (const key in source) {
|
||||
const value = source[key];
|
||||
if (value === undefined) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (
|
||||
typeof value === 'object' &&
|
||||
!Array.isArray(value) &&
|
||||
value !== null &&
|
||||
keys.includes(key as keyof T)
|
||||
) {
|
||||
// @ts-ignore
|
||||
result[key] = mergeDeepPlainObject(target[key] ?? {}, value, []);
|
||||
} else {
|
||||
// @ts-ignore
|
||||
result[key] = value;
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
+2
-79
@@ -1,7 +1,6 @@
|
||||
import { beforeEach, describe, expect, it, Mock, mock } from 'bun:test';
|
||||
import hash from 'object-hash';
|
||||
import { Mock, beforeEach, describe, expect, it, mock } from 'bun:test';
|
||||
|
||||
import { CacheDefinition, CacheFunction, CacheFunctionOptions, cache } from './cache';
|
||||
import { CacheFunction, CacheFunctionOptions, cache } from './cache';
|
||||
|
||||
describe('cache', () => {
|
||||
const impl = mock((arg: string) => 'test-' + arg);
|
||||
@@ -70,79 +69,3 @@ describe('cache', () => {
|
||||
expect(impl).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
describe('cache with suffix key', () => {
|
||||
const impl = mock((arg: string) => 'test-' + arg);
|
||||
const getKeySuffixImpl: Mock<NonNullable<CacheDefinition<[string], string>['getKeySuffix']>> =
|
||||
mock(() => hash({ test: 1 }));
|
||||
|
||||
let fn: CacheFunction<[string], string>;
|
||||
let testId = 0;
|
||||
let getTtl: () => number;
|
||||
|
||||
beforeEach(() => {
|
||||
impl.mockClear();
|
||||
|
||||
testId += 1;
|
||||
getTtl = () => 1000;
|
||||
|
||||
fn = cache({
|
||||
name: `cache-with-suffix-${testId}`,
|
||||
getKeySuffix: getKeySuffixImpl,
|
||||
tag: (arg) => 'test',
|
||||
get: async (arg: string, options: CacheFunctionOptions) => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 20));
|
||||
return {
|
||||
data: impl(arg),
|
||||
ttl: getTtl(),
|
||||
};
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it('should execute when the key suffix changes even if the args do not change', async () => {
|
||||
const result = await Promise.all([fn('a'), fn('b')]);
|
||||
|
||||
expect(result).toEqual(['test-a', 'test-b']);
|
||||
|
||||
expect(impl).toHaveBeenCalled();
|
||||
expect(impl).toHaveBeenCalledTimes(2);
|
||||
|
||||
expect(await fn('a')).toEqual('test-a');
|
||||
|
||||
expect(impl).toHaveBeenCalledTimes(2);
|
||||
|
||||
getKeySuffixImpl.mockImplementation(() => hash({ test: 2 }));
|
||||
expect(await fn('a')).toEqual('test-a');
|
||||
|
||||
expect(impl).toHaveBeenCalledTimes(3);
|
||||
});
|
||||
|
||||
it('should preserve behaviour even when the returned key suffix is undefined', async () => {
|
||||
// Start with the returned suffix being undefined
|
||||
getKeySuffixImpl.mockImplementation(() => undefined);
|
||||
const result = await fn('a');
|
||||
expect(result).toEqual('test-a');
|
||||
|
||||
expect(impl).toHaveBeenCalled();
|
||||
expect(impl).toHaveBeenCalledTimes(1);
|
||||
|
||||
// The returned suffix changes so we should get the value computed by the function
|
||||
getKeySuffixImpl.mockImplementation(() => hash({ test: 1 }));
|
||||
expect(await fn('a')).toEqual('test-a');
|
||||
|
||||
expect(impl).toHaveBeenCalledTimes(2);
|
||||
|
||||
// The returned suffix is undefined again so we should get the value from a previous cache entry
|
||||
getKeySuffixImpl.mockImplementation(() => undefined);
|
||||
expect(await fn('a')).toEqual('test-a');
|
||||
|
||||
expect(impl).toHaveBeenCalledTimes(2);
|
||||
|
||||
// The returned suffix goes back to a previous hash so we should the value from a previous cache entry
|
||||
getKeySuffixImpl.mockImplementation(() => hash({ test: 1 }));
|
||||
expect(await fn('a')).toEqual('test-a');
|
||||
|
||||
expect(impl).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
+5
-16
@@ -55,9 +55,6 @@ export interface CacheDefinition<Args extends any[], Result> {
|
||||
/** Filter the arguments that should be taken into consideration for the cache key */
|
||||
getKeyArgs?: (args: Args) => any[];
|
||||
|
||||
/** Returns a precomputed hash that is used alongside arguments to generate the cache key */
|
||||
getKeySuffix?: () => string | undefined;
|
||||
|
||||
/** Default ttl (in seconds) */
|
||||
defaultTtl?: number;
|
||||
|
||||
@@ -225,8 +222,7 @@ export function cache<Args extends any[], Result>(
|
||||
const [args, { signal }] = extractCacheFunctionOptions<Args>(rawArgs);
|
||||
|
||||
const cacheArgs = cacheDef.getKeyArgs ? cacheDef.getKeyArgs(args) : args;
|
||||
const cacheKeySuffix = cacheDef.getKeySuffix ? cacheDef.getKeySuffix() : undefined;
|
||||
const key = getCacheKey(cacheDef.name, cacheArgs, cacheKeySuffix);
|
||||
const key = getCacheKey(cacheDef.name, cacheArgs);
|
||||
|
||||
return await trace(
|
||||
{
|
||||
@@ -243,8 +239,7 @@ export function cache<Args extends any[], Result>(
|
||||
cacheFn.revalidate = async (...rawArgs: Args | [...Args, CacheFunctionOptions]) => {
|
||||
const [args, { signal }] = extractCacheFunctionOptions<Args>(rawArgs);
|
||||
const cacheArgs = cacheDef.getKeyArgs ? cacheDef.getKeyArgs(args) : args;
|
||||
const cacheKeySuffix = cacheDef.getKeySuffix ? cacheDef.getKeySuffix() : undefined;
|
||||
const key = getCacheKey(cacheDef.name, cacheArgs, cacheKeySuffix);
|
||||
const key = getCacheKey(cacheDef.name, cacheArgs);
|
||||
|
||||
const result = await revalidate(key, signal, ...args);
|
||||
return result.data;
|
||||
@@ -252,8 +247,7 @@ export function cache<Args extends any[], Result>(
|
||||
|
||||
cacheFn.hasInMemory = async (...args: Args) => {
|
||||
const cacheArgs = cacheDef.getKeyArgs ? cacheDef.getKeyArgs(args) : args;
|
||||
const cacheKeySuffix = cacheDef.getKeySuffix ? cacheDef.getKeySuffix() : undefined;
|
||||
const key = getCacheKey(cacheDef.name, cacheArgs, cacheKeySuffix);
|
||||
const key = getCacheKey(cacheDef.name, cacheArgs);
|
||||
const tag = cacheDef.tag?.(...args);
|
||||
|
||||
const memoryEntry = await memoryCache.get({ key, tag });
|
||||
@@ -281,13 +275,8 @@ export function getCache(name: string): CacheFunction<any[], any> | null {
|
||||
/**
|
||||
* Get a cache key for a function and its arguments.
|
||||
*/
|
||||
export function getCacheKey(fnName: string, args: any[], suffix: string | undefined) {
|
||||
const hashedArgs = args.map((arg) => hashValue(arg));
|
||||
|
||||
if (suffix) {
|
||||
hashedArgs.push(suffix);
|
||||
}
|
||||
let innerKey = hashedArgs.join(',');
|
||||
export function getCacheKey(fnName: string, args: any[]) {
|
||||
let innerKey = args.map((arg) => hashValue(arg)).join(',');
|
||||
|
||||
// Avoid crazy long keys, by fallbacking to a hash
|
||||
if (innerKey.length > 400) {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { describe, expect, it } from 'bun:test';
|
||||
|
||||
import { getBlockTitle, isNodeEmpty } from './document';
|
||||
import { isNodeEmpty } from './document';
|
||||
|
||||
describe('isNodeEmpty', () => {
|
||||
it('should return true for a document with an empty paragraph', () => {
|
||||
@@ -54,76 +54,3 @@ describe('isNodeEmpty', () => {
|
||||
).toEqual(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('#getBlockTitle', () => {
|
||||
it('should return the title of an expandable block', () => {
|
||||
expect(
|
||||
getBlockTitle({
|
||||
object: 'block',
|
||||
type: 'expandable',
|
||||
isVoid: true,
|
||||
data: {},
|
||||
key: 'OX8znB9VmbgK',
|
||||
fragments: [
|
||||
{
|
||||
object: 'fragment',
|
||||
nodes: [
|
||||
{
|
||||
object: 'block',
|
||||
type: 'paragraph',
|
||||
isVoid: false,
|
||||
data: {},
|
||||
nodes: [
|
||||
{
|
||||
object: 'text',
|
||||
leaves: [
|
||||
{
|
||||
object: 'leaf',
|
||||
text: 'Title of expandable block',
|
||||
marks: [],
|
||||
},
|
||||
],
|
||||
key: '7sZdCBHTw6Si',
|
||||
},
|
||||
],
|
||||
key: 'msYtjdwNmiAB',
|
||||
},
|
||||
],
|
||||
key: 'cNhmBygbrP8N',
|
||||
fragment: 'expandable-title',
|
||||
type: 'expandable-title',
|
||||
},
|
||||
{
|
||||
object: 'fragment',
|
||||
nodes: [
|
||||
{
|
||||
object: 'block',
|
||||
type: 'paragraph',
|
||||
isVoid: false,
|
||||
data: {},
|
||||
nodes: [
|
||||
{
|
||||
object: 'text',
|
||||
leaves: [
|
||||
{
|
||||
object: 'leaf',
|
||||
text: 'And content of the expandable',
|
||||
marks: [],
|
||||
},
|
||||
],
|
||||
key: '0GEghVKyWRBt',
|
||||
},
|
||||
],
|
||||
key: '9iEwdHdZ5y0S',
|
||||
},
|
||||
],
|
||||
key: 'newg71i9Ujjl',
|
||||
fragment: 'expandable-body',
|
||||
type: 'expandable-body',
|
||||
},
|
||||
],
|
||||
meta: { id: 'expandable-block' },
|
||||
}),
|
||||
).toEqual('Title of expandable block');
|
||||
});
|
||||
});
|
||||
|
||||
@@ -154,7 +154,7 @@ export function isNodeEmpty(
|
||||
export function getBlockTitle(block: DocumentBlock): string {
|
||||
switch (block.type) {
|
||||
case 'expandable': {
|
||||
const titleFragment = getNodeFragmentByType(block, 'expandable-title');
|
||||
const titleFragment = getNodeFragmentByType(block, 'title');
|
||||
if (titleFragment) {
|
||||
return getNodeText(titleFragment);
|
||||
}
|
||||
|
||||
@@ -9,8 +9,6 @@ describe('getEmojiForCode', () => {
|
||||
|
||||
it('should handle complex codes', () => {
|
||||
expect(getEmojiForCode('1f935-2642')).toEqual('🤵♂️');
|
||||
expect(getEmojiForCode('1f3c3-2642')).toEqual('🏃♂️');
|
||||
expect(getEmojiForCode('1f468-2696')).toEqual('👨⚖️');
|
||||
});
|
||||
|
||||
it('should return an empty string if invalid', () => {
|
||||
|
||||
@@ -67,7 +67,7 @@ export function checkIsSizableImageURL(input: string): boolean {
|
||||
}
|
||||
|
||||
const parsed = new URL(input);
|
||||
if (parsed.pathname.endsWith('.svg') || parsed.pathname.endsWith('.avif')) {
|
||||
if (parsed.pathname.endsWith('.svg')) {
|
||||
return false;
|
||||
}
|
||||
if (!checkIsHttpURL(parsed)) {
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
import { ContentAPITokenPayload, GitBookAPI } from '@gitbook/api';
|
||||
import { GitBookAPI, ContentAPITokenPayload } from '@gitbook/api';
|
||||
import { setTag, setContext } from '@sentry/nextjs';
|
||||
import assertNever from 'assert-never';
|
||||
import jwt from 'jsonwebtoken';
|
||||
import type { ResponseCookie } from 'next/dist/compiled/@edge-runtime/cookies';
|
||||
import { NextResponse, NextRequest } from 'next/server';
|
||||
import hash from 'object-hash';
|
||||
|
||||
import {
|
||||
PublishedContentWithCache,
|
||||
@@ -44,12 +43,6 @@ type URLLookupMode =
|
||||
* This mode is useful when self-hosting a single space.
|
||||
*/
|
||||
| 'single'
|
||||
/**
|
||||
* Mode when a site is being proxied on a different base URL.
|
||||
* - x-gitbook-site-url is used to determine the site to serve.
|
||||
* - host / x-forwarded-host / x-gitbook-host + x-gitbook-basepath is used to determine the base URL.
|
||||
*/
|
||||
| 'proxy'
|
||||
/**
|
||||
* Spaces are located using the incoming URL (using forwarded host headers).
|
||||
* This mode is the default one when serving on the GitBook infrastructure.
|
||||
@@ -83,14 +76,11 @@ export type LookupResult = PublishedContentWithCache & {
|
||||
};
|
||||
|
||||
/**
|
||||
* Middleware to lookup the site to render.
|
||||
* Middleware to lookup the space to render.
|
||||
* It takes as input a request with an URL, and a set of headers:
|
||||
* - x-gitbook-api: the API endpoint to use, if undefined, the default one is used
|
||||
* - x-gitbook-basepath: base in the path that should be ignored for routing
|
||||
*
|
||||
* Once the site has been looked-up, the middleware passes the info to the rendering
|
||||
* using a rewrite with a set of headers. This is the only way in next.js to do this (basically similar to AsyncLocalStorage).
|
||||
*
|
||||
* The middleware also takes care of persisting the visitor authentication state.
|
||||
*/
|
||||
export async function middleware(request: NextRequest) {
|
||||
@@ -115,18 +105,15 @@ export async function middleware(request: NextRequest) {
|
||||
let apiEndpoint = request.headers.get('x-gitbook-api') ?? DEFAULT_API_ENDPOINT;
|
||||
const originBasePath = request.headers.get('x-gitbook-basepath') ?? '';
|
||||
|
||||
const inputURL = mode === 'proxy' ? url : stripURLBasePath(url, originBasePath);
|
||||
const inputURL = stripURLBasePath(url, originBasePath);
|
||||
|
||||
const resolved = await withAPI(
|
||||
{
|
||||
client: new GitBookAPI({
|
||||
endpoint: apiEndpoint,
|
||||
authToken: getDefaultAPIToken(apiEndpoint),
|
||||
userAgent: userAgent(),
|
||||
}),
|
||||
contextId: undefined,
|
||||
},
|
||||
() => lookupSiteForURL(mode, request, inputURL),
|
||||
new GitBookAPI({
|
||||
endpoint: apiEndpoint,
|
||||
authToken: getDefaultAPIToken(apiEndpoint),
|
||||
userAgent: userAgent(),
|
||||
}),
|
||||
() => lookupSpaceForURL(mode, request, inputURL),
|
||||
);
|
||||
if ('error' in resolved) {
|
||||
return new NextResponse(resolved.error.message, {
|
||||
@@ -166,17 +153,13 @@ export async function middleware(request: NextRequest) {
|
||||
// Resolution might have changed the API endpoint
|
||||
apiEndpoint = resolved.apiEndpoint ?? apiEndpoint;
|
||||
|
||||
const contextId = 'site' in resolved ? resolved.contextId : undefined;
|
||||
const nonce = createContentSecurityPolicyNonce();
|
||||
const csp = await withAPI(
|
||||
{
|
||||
client: new GitBookAPI({
|
||||
endpoint: apiEndpoint,
|
||||
authToken: resolved.apiToken,
|
||||
userAgent: userAgent(),
|
||||
}),
|
||||
contextId,
|
||||
},
|
||||
new GitBookAPI({
|
||||
endpoint: apiEndpoint,
|
||||
authToken: resolved.apiToken,
|
||||
userAgent: userAgent(),
|
||||
}),
|
||||
async () => {
|
||||
const [siteData] = await Promise.all([
|
||||
'site' in resolved
|
||||
@@ -215,15 +198,9 @@ export async function middleware(request: NextRequest) {
|
||||
headers.set('x-forwarded-host', inputURL.host);
|
||||
headers.set('origin', inputURL.origin);
|
||||
headers.set('x-gitbook-token', resolved.apiToken);
|
||||
if (contextId) {
|
||||
headers.set('x-gitbook-token-context', contextId);
|
||||
}
|
||||
headers.set('x-gitbook-mode', mode);
|
||||
headers.set('x-gitbook-origin-basepath', originBasePath);
|
||||
headers.set(
|
||||
'x-gitbook-basepath',
|
||||
mode === 'proxy' ? originBasePath : joinPath(originBasePath, resolved.basePath),
|
||||
);
|
||||
headers.set('x-gitbook-basepath', joinPath(originBasePath, resolved.basePath));
|
||||
headers.set('x-gitbook-content-space', resolved.space);
|
||||
if ('site' in resolved) {
|
||||
headers.set('x-gitbook-content-organization', resolved.organization);
|
||||
@@ -314,10 +291,7 @@ export async function middleware(request: NextRequest) {
|
||||
/**
|
||||
* Compute the input URL the user is trying to access.
|
||||
*/
|
||||
function getInputURL(request: NextRequest): {
|
||||
url: URL;
|
||||
mode: URLLookupMode;
|
||||
} {
|
||||
function getInputURL(request: NextRequest): { url: URL; mode: URLLookupMode } {
|
||||
const url = new URL(request.url);
|
||||
let mode: URLLookupMode =
|
||||
(process.env.GITBOOK_MODE as URLLookupMode | undefined) ?? 'multi-path';
|
||||
@@ -347,36 +321,27 @@ function getInputURL(request: NextRequest): {
|
||||
mode = 'multi-id';
|
||||
}
|
||||
|
||||
// When passing a x-gitbook-site-url header, this URL is used instead of the request URL
|
||||
// to determine the site to serve.
|
||||
const xGitbookSite = request.headers.get('x-gitbook-site-url');
|
||||
if (xGitbookSite) {
|
||||
mode = 'proxy';
|
||||
}
|
||||
|
||||
return { url, mode };
|
||||
}
|
||||
|
||||
async function lookupSiteForURL(
|
||||
async function lookupSpaceForURL(
|
||||
mode: URLLookupMode,
|
||||
request: NextRequest,
|
||||
url: URL,
|
||||
): Promise<LookupResult> {
|
||||
switch (mode) {
|
||||
case 'single': {
|
||||
return await lookupSiteInSingleMode(url);
|
||||
return await lookupSpaceInSingleMode(url);
|
||||
}
|
||||
case 'multi': {
|
||||
return await lookupSiteInMultiMode(request, url);
|
||||
return await lookupSpaceInMultiMode(request, url);
|
||||
}
|
||||
case 'multi-path': {
|
||||
return await lookupSiteInMultiPathMode(request, url);
|
||||
return await lookupSpaceInMultiPathMode(request, url);
|
||||
}
|
||||
case 'multi-id': {
|
||||
return await lookupSiteOrSpaceInMultiIdMode(request, url);
|
||||
}
|
||||
case 'proxy':
|
||||
return await lookupSiteInProxy(request, url);
|
||||
default:
|
||||
assertNever(mode);
|
||||
}
|
||||
@@ -386,7 +351,7 @@ async function lookupSiteForURL(
|
||||
* GITBOOK_MODE=single
|
||||
* When serving a single space, configured using GITBOOK_SPACE_ID and GITBOOK_TOKEN.
|
||||
*/
|
||||
async function lookupSiteInSingleMode(url: URL): Promise<LookupResult> {
|
||||
async function lookupSpaceInSingleMode(url: URL): Promise<LookupResult> {
|
||||
const spaceId = process.env.GITBOOK_SPACE_ID;
|
||||
if (!spaceId) {
|
||||
throw new Error(
|
||||
@@ -394,7 +359,7 @@ async function lookupSiteInSingleMode(url: URL): Promise<LookupResult> {
|
||||
);
|
||||
}
|
||||
|
||||
const apiToken = getDefaultAPIToken(api().client.endpoint);
|
||||
const apiToken = getDefaultAPIToken(api().endpoint);
|
||||
if (!apiToken) {
|
||||
throw new Error(
|
||||
`Missing GITBOOK_TOKEN environment variable. It should be passed when using GITBOOK_MODE=single.`,
|
||||
@@ -410,31 +375,13 @@ async function lookupSiteInSingleMode(url: URL): Promise<LookupResult> {
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* GITBOOK_MODE=proxy
|
||||
* When proxying a site on a different base URL.
|
||||
*/
|
||||
async function lookupSiteInProxy(request: NextRequest, url: URL): Promise<LookupResult> {
|
||||
const rawSiteUrl = request.headers.get('x-gitbook-site-url');
|
||||
if (!rawSiteUrl) {
|
||||
throw new Error(
|
||||
`Missing x-gitbook-site-url header. It should be passed when using GITBOOK_MODE=proxy.`,
|
||||
);
|
||||
}
|
||||
|
||||
const siteUrl = new URL(rawSiteUrl);
|
||||
siteUrl.pathname = joinPath(siteUrl.pathname, url.pathname);
|
||||
|
||||
return await lookupSiteInMultiMode(request, siteUrl);
|
||||
}
|
||||
|
||||
/**
|
||||
* GITBOOK_MODE=multi
|
||||
* When serving multi spaces based on the current URL.
|
||||
*/
|
||||
async function lookupSiteInMultiMode(request: NextRequest, url: URL): Promise<LookupResult> {
|
||||
async function lookupSpaceInMultiMode(request: NextRequest, url: URL): Promise<LookupResult> {
|
||||
const visitorAuthToken = getVisitorAuthToken(request, url);
|
||||
const lookup = await lookupSiteByAPI(url, visitorAuthToken);
|
||||
const lookup = await lookupSpaceByAPI(url, visitorAuthToken);
|
||||
return {
|
||||
...lookup,
|
||||
...('basePath' in lookup && visitorAuthToken
|
||||
@@ -523,16 +470,8 @@ async function lookupSiteOrSpaceInMultiIdMode(
|
||||
throw new Error('Collection is not supported in multi-id mode');
|
||||
}
|
||||
|
||||
// The claims property in the content API token is included when
|
||||
// visitor attributes/assertions are passed to the site preview URL.
|
||||
//
|
||||
// When it's present, we generate a hash using the same method as
|
||||
// getPublishedContentByURL to get the context ID so the cache can be
|
||||
// invalidated when trying to preview the site with different visitor
|
||||
// attributes.
|
||||
const contextId = decoded.claims ? hash(decoded.claims) : undefined;
|
||||
const gitbookAPI = new GitBookAPI({
|
||||
endpoint: apiEndpoint ?? api().client.endpoint,
|
||||
endpoint: apiEndpoint ?? api().endpoint,
|
||||
authToken: apiToken,
|
||||
userAgent: userAgent(),
|
||||
});
|
||||
@@ -540,15 +479,13 @@ async function lookupSiteOrSpaceInMultiIdMode(
|
||||
// Verify access to the space to avoid leaking cached data in this mode
|
||||
// (the cache is not dependend on the auth token, so it could leak data)
|
||||
if (source.kind === 'space') {
|
||||
await withAPI({ client: gitbookAPI, contextId }, () =>
|
||||
getSpace.revalidate(source.id, undefined),
|
||||
);
|
||||
await withAPI(gitbookAPI, () => getSpace.revalidate(source.id, undefined));
|
||||
}
|
||||
|
||||
// Verify access to the site to avoid leaking cached data in this mode
|
||||
// (the cache is not dependend on the auth token, so it could leak data)
|
||||
if (source.kind === 'site') {
|
||||
await withAPI({ client: gitbookAPI, contextId }, () =>
|
||||
await withAPI(gitbookAPI, () =>
|
||||
getPublishedContentSite.revalidate({
|
||||
organizationId: decoded.organization,
|
||||
siteId: source.id,
|
||||
@@ -599,7 +536,7 @@ async function lookupSiteOrSpaceInMultiIdMode(
|
||||
* GITBOOK_MODE=multi-path
|
||||
* When serving multi spaces with the url passed in the path.
|
||||
*/
|
||||
async function lookupSiteInMultiPathMode(request: NextRequest, url: URL): Promise<LookupResult> {
|
||||
async function lookupSpaceInMultiPathMode(request: NextRequest, url: URL): Promise<LookupResult> {
|
||||
// Skip useless requests
|
||||
if (
|
||||
url.pathname === '/favicon.ico' ||
|
||||
@@ -638,7 +575,7 @@ async function lookupSiteInMultiPathMode(request: NextRequest, url: URL): Promis
|
||||
|
||||
const visitorAuthToken = getVisitorAuthToken(request, target);
|
||||
|
||||
const lookup = await lookupSiteByAPI(target, visitorAuthToken);
|
||||
const lookup = await lookupSpaceByAPI(target, visitorAuthToken);
|
||||
if ('error' in lookup) {
|
||||
return lookup;
|
||||
}
|
||||
@@ -674,7 +611,7 @@ async function lookupSiteInMultiPathMode(request: NextRequest, url: URL): Promis
|
||||
* Lookup a space by its URL using the GitBook API.
|
||||
* To optimize caching, we try multiple lookup alternatives and return the first one that matches.
|
||||
*/
|
||||
async function lookupSiteByAPI(
|
||||
async function lookupSpaceByAPI(
|
||||
lookupURL: URL,
|
||||
visitorAuthToken: ReturnType<typeof getVisitorAuthToken>,
|
||||
): Promise<LookupResult> {
|
||||
@@ -764,7 +701,6 @@ async function lookupSiteByAPI(
|
||||
siteSpace: data.siteSpace,
|
||||
organization: data.organization,
|
||||
shareKey: data.shareKey,
|
||||
...(data.contextId ? { contextId: data.contextId } : {}),
|
||||
}
|
||||
: {}),
|
||||
} as PublishedContentWithCache;
|
||||
@@ -812,7 +748,7 @@ function getLookupResultForVisitorAuth(
|
||||
),
|
||||
options: {
|
||||
httpOnly: true,
|
||||
sameSite: process.env.NODE_ENV === 'production' ? 'none' : undefined,
|
||||
sameSite: 'none',
|
||||
secure: process.env.NODE_ENV === 'production',
|
||||
maxAge: 7 * 24 * 60 * 60,
|
||||
},
|
||||
|
||||
@@ -6,7 +6,7 @@ import plugin from 'tailwindcss/plugin';
|
||||
import { hexToRgb, shadesOfColor } from './src/lib/colors';
|
||||
|
||||
export const shades = [50, 100, 200, 300, 400, 500, 600, 700, 800, 900];
|
||||
export const opacities = [0, 4, 8, 12, 16, 24, 40, 64, 72, 88, 96, 100];
|
||||
export const opacities = [0, 4, 8, 12, 16, 24, 40, 64, 72, 88, 96];
|
||||
|
||||
/**
|
||||
* Generate a Tailwind color shades from a variable.
|
||||
@@ -72,8 +72,9 @@ const config: Config = {
|
||||
/** primary-color used to accent elements, these colors remain unchanged when toggling between the CustomizationBackground options**/
|
||||
primary: generateVarShades('primary-color'),
|
||||
'contrast-primary': generateVarShades('contrast-primary'),
|
||||
tint: generateVarShades('primary-color'),
|
||||
'contrast-tint': generateVarShades('contrast-primary'),
|
||||
|
||||
/** primary-base is an internal color that generates the same colors as primary-color. But it's shades will change into a grayscale if CustomizationBackground.Plain is selected. (globals.css) **/
|
||||
primarybase: generateVarShades('primary-base'),
|
||||
|
||||
'header-background': generateVarShades('header-background'),
|
||||
'header-link': generateVarShades('header-link'),
|
||||
@@ -208,10 +209,6 @@ const config: Config = {
|
||||
thintop: '0px -1px 0px rgba(0, 0, 0, 0.05)',
|
||||
'1xs': '0px 1px 1px rgba(0, 0, 0, 0.09), 0px 3.267px 2.754px rgb(0, 0, 0, 0.05), 0px 6.278px 6.63px rgb(0, 0, 0, 0.05), 0px 14px 22px rgb(0, 0, 0, 0.04)',
|
||||
},
|
||||
scale: {
|
||||
'98': '0.98',
|
||||
'102': '1.02',
|
||||
},
|
||||
},
|
||||
opacity: opacity(),
|
||||
},
|
||||
@@ -235,12 +232,7 @@ const config: Config = {
|
||||
/**
|
||||
* Variant when the space is configured with a theme matching background.
|
||||
*/
|
||||
addVariant('tint', 'html.tint &');
|
||||
|
||||
/**
|
||||
* Variant when the space is configured without a theme matching background.
|
||||
*/
|
||||
addVariant('no-tint', 'html.no-tint &');
|
||||
addVariant('plain-background', 'html.plain-background &');
|
||||
|
||||
/**
|
||||
* Variant when the page contains a block that will be rendered in full-width mode.
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
dist/
|
||||
@@ -1,7 +0,0 @@
|
||||
# @gitbook/proxy
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 53b9f10: First version
|
||||
@@ -1,28 +0,0 @@
|
||||
# `@gitbook/proxy`
|
||||
|
||||
Host a GitBook site on your own domain as a subpath.
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { proxyToGitBook } from '@gitbook/proxy';
|
||||
|
||||
const site = proxyToGitBook(event.request, {
|
||||
site: 'mycompany.gitbook.io/site/',
|
||||
basePath: '/docs',
|
||||
});
|
||||
|
||||
export default {
|
||||
async fetch(request) {
|
||||
// If the requst matches the basePath /docs, we serve from GitBook
|
||||
if (site.match(request)) {
|
||||
return site.fetch(request);
|
||||
}
|
||||
|
||||
// Otherwise we do something else.
|
||||
return new Response('Not found', {
|
||||
statusCode: 404,
|
||||
});
|
||||
},
|
||||
};
|
||||
```
|
||||
@@ -1,28 +0,0 @@
|
||||
{
|
||||
"name": "@gitbook/proxy",
|
||||
"description": "Host a GitBook site on your own domain as a subpath",
|
||||
"version": "0.1.0",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"development": "./src/index.ts",
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"typescript": "^5.5.3"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"clean": "rm -rf ./dist",
|
||||
"unit": "bun test"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"src",
|
||||
"README.md",
|
||||
"CHANGELOG.md"
|
||||
]
|
||||
}
|
||||
@@ -1,59 +0,0 @@
|
||||
import { describe, expect, it } from 'bun:test';
|
||||
import { proxyToGitBook } from '.';
|
||||
|
||||
describe('.match', () => {
|
||||
it('should return true if the request is below the base path', () => {
|
||||
const site = proxyToGitBook({ site: 'https://org.gitbook.io/example/', basePath: '/docs' });
|
||||
expect(site.match('/docs')).toBe(true);
|
||||
expect(site.match('/docs/')).toBe(true);
|
||||
expect(site.match('/docs/hello')).toBe(true);
|
||||
expect(site.match('/docs/hello/world')).toBe(true);
|
||||
|
||||
expect(site.match('/hello/world')).toBe(false);
|
||||
expect(site.match('/')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('.request', () => {
|
||||
it('should compute a proper request for a sub-path', () => {
|
||||
const site = proxyToGitBook({ site: 'https://org.gitbook.io/example/', basePath: '/docs' });
|
||||
const request = new Request('https://example.com/docs/hello/world');
|
||||
|
||||
const proxiedRequest = site.request(request);
|
||||
expect(proxiedRequest.url).toBe('https://hosting.gitbook.io/docs/hello/world');
|
||||
expect(proxiedRequest.headers.get('Host')).toBe('hosting.gitbook.io');
|
||||
expect(proxiedRequest.headers.get('X-Forwarded-Host')).toBe('example.com');
|
||||
expect(proxiedRequest.headers.get('X-GitBook-BasePath')).toBe('/docs');
|
||||
expect(proxiedRequest.headers.get('X-GitBook-Site-URL')).toBe(
|
||||
'https://org.gitbook.io/example/',
|
||||
);
|
||||
});
|
||||
|
||||
it('should compute a proper request on the root', () => {
|
||||
const site = proxyToGitBook({ site: 'https://org.gitbook.io/example/', basePath: '/docs' });
|
||||
const request = new Request('https://example.com/docs');
|
||||
|
||||
const proxiedRequest = site.request(request);
|
||||
expect(proxiedRequest.url).toBe('https://hosting.gitbook.io/docs');
|
||||
expect(proxiedRequest.headers.get('Host')).toBe('hosting.gitbook.io');
|
||||
expect(proxiedRequest.headers.get('X-Forwarded-Host')).toBe('example.com');
|
||||
expect(proxiedRequest.headers.get('X-GitBook-BasePath')).toBe('/docs');
|
||||
expect(proxiedRequest.headers.get('X-GitBook-Site-URL')).toBe(
|
||||
'https://org.gitbook.io/example/',
|
||||
);
|
||||
});
|
||||
|
||||
it('should normalize the basepath', () => {
|
||||
const site = proxyToGitBook({ site: 'https://org.gitbook.io/example/', basePath: 'docs/' });
|
||||
const request = new Request('https://example.com/docs/hello/world');
|
||||
|
||||
const proxiedRequest = site.request(request);
|
||||
expect(proxiedRequest.url).toBe('https://hosting.gitbook.io/docs/hello/world');
|
||||
expect(proxiedRequest.headers.get('Host')).toBe('hosting.gitbook.io');
|
||||
expect(proxiedRequest.headers.get('X-Forwarded-Host')).toBe('example.com');
|
||||
expect(proxiedRequest.headers.get('X-GitBook-BasePath')).toBe('/docs');
|
||||
expect(proxiedRequest.headers.get('X-GitBook-Site-URL')).toBe(
|
||||
'https://org.gitbook.io/example/',
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -1,97 +0,0 @@
|
||||
export interface ProxyToGitBookOptions {
|
||||
/**
|
||||
* The URL of the published site.
|
||||
* @example "https://mycompany.gitbook.io/docs"
|
||||
*/
|
||||
site: string;
|
||||
|
||||
/**
|
||||
* Base path to serve the site on.
|
||||
* @example "/docs"
|
||||
*/
|
||||
basePath: string;
|
||||
|
||||
/**
|
||||
* Hostname used by GitBook to serve content.
|
||||
* Do not set this option unless you know what you are doing.
|
||||
*/
|
||||
gitbookHost?: string;
|
||||
}
|
||||
|
||||
export interface ProxySite {
|
||||
/**
|
||||
* Test if the request should be proxied to this site.
|
||||
*/
|
||||
match(request: Request | string): boolean;
|
||||
|
||||
/**
|
||||
* Get the proxied request for a given request.
|
||||
*/
|
||||
request(request: Request): Request;
|
||||
|
||||
/**
|
||||
* Fetch the request from the site.
|
||||
*/
|
||||
fetch(request: Request): Promise<Response>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Proxies requests to a GitBook site.
|
||||
*/
|
||||
export function proxyToGitBook(options: ProxyToGitBookOptions): ProxySite {
|
||||
const { gitbookHost = 'hosting.gitbook.io' } = options;
|
||||
|
||||
const siteUrl = new URL(options.site);
|
||||
const rawSiteUrl = siteUrl.toString();
|
||||
|
||||
const basePath = normalizeBasePath(options.basePath);
|
||||
|
||||
const site: ProxySite = {
|
||||
match: (request) => {
|
||||
const pathname = typeof request === 'string' ? request : new URL(request.url).pathname;
|
||||
return pathname === basePath || pathname.startsWith(basePath + '/');
|
||||
},
|
||||
|
||||
request: (originRequest) => {
|
||||
const originUrl = new URL(originRequest.url);
|
||||
|
||||
const url = new URL(originUrl);
|
||||
url.hostname = gitbookHost;
|
||||
|
||||
const proxyRequest = new Request(url, originRequest);
|
||||
proxyRequest.headers.set('Host', gitbookHost);
|
||||
|
||||
// Pass the original host and protocol
|
||||
proxyRequest.headers.set('X-Forwarded-Host', originUrl.hostname);
|
||||
proxyRequest.headers.set('X-Forwarded-Proto', 'https');
|
||||
|
||||
// Pass the basepath on the original URL
|
||||
proxyRequest.headers.set('X-GitBook-BasePath', basePath);
|
||||
|
||||
// Pass the site URL
|
||||
proxyRequest.headers.set('X-GitBook-Site-URL', rawSiteUrl);
|
||||
|
||||
return proxyRequest;
|
||||
},
|
||||
|
||||
fetch: async (originRequest) => {
|
||||
return fetch(site.request(originRequest));
|
||||
},
|
||||
};
|
||||
|
||||
return site;
|
||||
}
|
||||
|
||||
function normalizeBasePath(basePath: string): string {
|
||||
let result = withLeadingSlash(basePath);
|
||||
result = withoutTrailingSlash(result);
|
||||
return result;
|
||||
}
|
||||
|
||||
function withLeadingSlash(path: string): string {
|
||||
return path.startsWith('/') ? path : '/' + path;
|
||||
}
|
||||
|
||||
function withoutTrailingSlash(path: string): string {
|
||||
return path.endsWith('/') ? path.slice(0, -1) : path;
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "esnext",
|
||||
"lib": ["dom", "dom.iterable", "esnext"],
|
||||
"allowJs": true,
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"noEmit": false,
|
||||
"declaration": true,
|
||||
"outDir": "dist",
|
||||
"esModuleInterop": true,
|
||||
"module": "esnext",
|
||||
"moduleResolution": "bundler",
|
||||
"resolveJsonModule": true,
|
||||
"isolatedModules": true,
|
||||
"incremental": true,
|
||||
"types": [
|
||||
"bun-types" // add Bun global
|
||||
]
|
||||
},
|
||||
"include": ["src/**/*.ts"],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
||||
@@ -1,15 +1,5 @@
|
||||
# @gitbook/react-openapi
|
||||
|
||||
## 0.7.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 4771c78: Fixed scalar api client routing
|
||||
- ff50ac2: Bump @scalar/api-client-react version
|
||||
- 867481c: Support Integers in Response example
|
||||
- 7ba67fd: bumped the scalar api client dependency
|
||||
- a78c1ec: Bumped scalar api client pacakge
|
||||
|
||||
## 0.7.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"version": "0.7.1",
|
||||
"version": "0.7.0",
|
||||
"dependencies": {
|
||||
"@scalar/api-client-react": "1.0.87",
|
||||
"classnames": "^2.5.1",
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://turbo.build/schema.json",
|
||||
"ui": "tui",
|
||||
"globalEnv": ["NODE_ENV", "CI", "ARGOS_*", "GITHUB_*", "GITBOOK_*", "SENTRY_*"],
|
||||
"globalEnv": ["NODE_ENV", "CI", "ARGOS_*", "GITHUB_*"],
|
||||
"tasks": {
|
||||
// Prepare the package for all other tasks
|
||||
"generate": {
|
||||
|
||||
Reference in New Issue
Block a user