Compare commits

..

20 Commits

Author SHA1 Message Date
Samy Pessé 903f962673 Version Packages (#2964)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-03-14 18:01:38 +01:00
Nolann B. 31d800e48b Changeset for OpenAPI schemas (#2982) 2025-03-14 17:08:21 +01:00
Nolann B. c1c58eb919 Render OpenAPISchemas block (#2959) 2025-03-14 16:24:09 +01:00
Zeno Kapitein eec3eed100 Support prominent search bar style (#2936)
Co-authored-by: Nolann Biron <biron.nolann@gmail.com>
2025-03-14 15:11:21 +01:00
Samy Pessé 99da8df3d1 Resize and optimize ogimage and favicons (#2980) 2025-03-13 18:45:14 +01:00
Steven H c9ea23919e Fix an issue where iframe aspect ratio was not respected. (#2979) 2025-03-13 14:23:50 +00:00
Zeno Kapitein 16292def79 Display sidebar on no-TOC pages (#2942) 2025-03-13 10:28:12 +01:00
Taran Vohra 9108c56ca1 Fix an issue where ContentKit webframes weren't sized properly (#2978) 2025-03-13 13:29:29 +05:30
Samy Pessé b011ea0af8 Simplify deferred codeblock highlighting and fix streaming (#2977) 2025-03-13 00:25:48 +01:00
spastorelli d33171b779 Fix getVisitorAuthCookieMaxAge returning 60s even when token expiry is much later (#2974) 2025-03-12 16:17:16 +01:00
Steven H 6aaeae269e Fix an issue where ContentKit iframes were not resizing. (#2967) 2025-03-12 14:52:27 +00:00
Samy Pessé e5f0cc8663 Respond with all tags of all cache used for page generation (#2973) 2025-03-12 10:30:47 +01:00
Nolann B. 9b5f971aa1 Transparent background for OpenAPI path block (#2963) 2025-03-11 13:32:35 +00:00
Nolann B. ff3b708ad3 Remove read-only properties from codesample (#2965) 2025-03-11 13:32:10 +00:00
Nolann B. e996904013 Update target in shiki javascript engine (#2968) 2025-03-11 14:21:07 +01:00
Samy Pessé f32bf1f15d Use API cache endpoint and service binding in Cloudflare (#2952) 2025-03-11 13:06:06 +01:00
Zeno Kapitein 6cda2dd57b Fix hint hover style (#2966) 2025-03-11 11:00:28 +00:00
Nolann B. c60e9ba27f Handle OpenAPI read-only properties (#2962) 2025-03-11 11:37:11 +01:00
Zeno Kapitein 9bc3d504c8 Info hint background and link color fixes (#2953) 2025-03-11 11:30:28 +01:00
Greg Bergé b5e4fd75e9 Upgrade shiki and bring back support to C/C++ (#2961) 2025-03-11 10:53:51 +01:00
89 changed files with 1843 additions and 1269 deletions
@@ -44,6 +44,7 @@ runs:
GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
@@ -49,6 +49,7 @@ runs:
GITBOOK_SECRET: ${{ inputs.opItem }}/GITBOOK_SECRET
GITBOOK_APP_URL: ${{ inputs.opItem }}/GITBOOK_APP_URL
GITBOOK_API_URL: ${{ inputs.opItem }}/GITBOOK_API_URL
GITBOOK_API_PUBLIC_URL: ${{ inputs.opItem }}/GITBOOK_API_PUBLIC_URL
GITBOOK_API_TOKEN: ${{ inputs.opItem }}/GITBOOK_API_TOKEN
GITBOOK_INTEGRATIONS_HOST: ${{ inputs.opItem }}/GITBOOK_INTEGRATIONS_HOST
GITBOOK_IMAGE_RESIZE_SIGNING_KEY: ${{ inputs.opItem }}/GITBOOK_IMAGE_RESIZE_SIGNING_KEY
-17
View File
@@ -1,17 +0,0 @@
.next
.vercel
.open-next
# Generated
packages/emoji-codepoints/index.ts
packages/gitbook/public/~gitbook/static/
packages/icons/src/data/*.json
# Build files
dist/
README.md
CHANGELOG.md
# v2
packages/gitbook-v2/public/~gitbook/static/
-5
View File
@@ -1,5 +0,0 @@
{
"printWidth": 100,
"singleQuote": true,
"tabWidth": 4
}
+3 -1
View File
@@ -18,7 +18,9 @@
"**/.vercel/**/*",
"**/.cache/**/*",
"**/.wrangler/**/*",
"packages/openapi-parser/src/fixtures/**/*"
"packages/openapi-parser/src/fixtures/**/*",
"packages/emoji-codepoints/index.ts",
"packages/icons/src/data/*.json"
]
},
"formatter": {
+36 -25
View File
@@ -26,7 +26,7 @@
"name": "@gitbook/cache-tags",
"version": "0.1.0",
"dependencies": {
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"assert-never": "^1.2.1",
},
"devDependencies": {
@@ -49,9 +49,9 @@
},
"packages/gitbook": {
"name": "gitbook",
"version": "0.7.2",
"version": "0.7.3",
"dependencies": {
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"@gitbook/cache-do": "workspace:*",
"@gitbook/cache-tags": "workspace:*",
"@gitbook/colors": "workspace:*",
@@ -96,7 +96,7 @@
"react-hotkeys-hook": "^4.4.1",
"rison": "^0.1.1",
"server-only": "^0.0.1",
"shiki": "^1.27.2",
"shiki": "^3.2.0",
"tailwind-merge": "^2.2.0",
"tailwind-shades": "^1.1.2",
"url-join": "^5.0.0",
@@ -134,7 +134,7 @@
"name": "gitbook-v2",
"version": "0.2.0",
"dependencies": {
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"@gitbook/cache-tags": "workspace:*",
"@sindresorhus/fnv1a": "^3.1.0",
"next": "^15.2.1",
@@ -144,7 +144,7 @@
"warn-once": "^0.1.1",
},
"devDependencies": {
"@opennextjs/cloudflare": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@236c84d",
"@opennextjs/cloudflare": "^0.5.10",
"gitbook": "*",
"postcss": "^8",
"tailwindcss": "^3.4.0",
@@ -152,7 +152,7 @@
},
"packages/icons": {
"name": "@gitbook/icons",
"version": "0.1.0",
"version": "0.2.0",
"bin": {
"gitbook-icons": "./bin/gitbook-icons.js",
},
@@ -194,9 +194,9 @@
},
"packages/react-contentkit": {
"name": "@gitbook/react-contentkit",
"version": "0.6.1",
"version": "0.6.2",
"dependencies": {
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"@gitbook/icons": "workspace:*",
"classnames": "^2.5.1",
},
@@ -226,7 +226,7 @@
},
"packages/react-openapi": {
"name": "@gitbook/react-openapi",
"version": "1.1.2",
"version": "1.1.3",
"dependencies": {
"@gitbook/openapi-parser": "workspace:*",
"@scalar/api-client-react": "^1.1.36",
@@ -254,6 +254,7 @@
},
"overrides": {
"@codemirror/state": "6.4.1",
"@gitbook/api": "0.99.0",
"react": "18.3.1",
"react-dom": "18.3.1",
},
@@ -626,7 +627,7 @@
"@fortawesome/fontawesome-svg-core": ["@fortawesome/fontawesome-svg-core@6.6.0", "", { "dependencies": { "@fortawesome/fontawesome-common-types": "6.6.0" } }, "sha512-KHwPkCk6oRT4HADE7smhfsKudt9N/9lm6EJ5BVg0tD1yPA5hht837fB87F8pn15D8JfTqQOjhKTktwmLMiD7Kg=="],
"@gitbook/api": ["@gitbook/api@0.96.1", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-E1hpaFNFoEyc8E4rIQyC6UD3kErGXAI0lKt04zYQQYOBLjRIQ57D4oNIIJBjWn4hHeSxRxWvW3NcxzvOGMmIqQ=="],
"@gitbook/api": ["@gitbook/api@0.99.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-qaHNCKul6rp0wqKRQ/2/2+X8mNEmy5ZK4vWuZoI9eL306TTqFBWD4DSTHz0WV6X24FVe3HF7qy/mVRd4ja2I2A=="],
"@gitbook/cache-do": ["@gitbook/cache-do@workspace:packages/cache-do"],
@@ -792,7 +793,7 @@
"@opennextjs/aws": ["@opennextjs/aws@https://pkg.pr.new/@opennextjs/aws@756", { "dependencies": { "@aws-sdk/client-cloudfront": "3.398.0", "@aws-sdk/client-dynamodb": "^3.398.0", "@aws-sdk/client-lambda": "^3.398.0", "@aws-sdk/client-s3": "^3.398.0", "@aws-sdk/client-sqs": "^3.398.0", "@node-minify/core": "^8.0.6", "@node-minify/terser": "^8.0.6", "@tsconfig/node18": "^1.0.1", "aws4fetch": "^1.0.18", "chalk": "^5.3.0", "esbuild": "0.19.2", "express": "5.0.1", "path-to-regexp": "^6.3.0", "urlpattern-polyfill": "^10.0.0" }, "bin": { "open-next": "./dist/index.js" } }],
"@opennextjs/cloudflare": ["@opennextjs/cloudflare@https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@236c84d", { "dependencies": { "@ast-grep/napi": "^0.34.1", "@dotenvx/dotenvx": "1.31.0", "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@756", "enquirer": "^2.4.1", "glob": "^11.0.0", "yaml": "^2.7.0" }, "peerDependencies": { "wrangler": "^3.111.0" }, "bin": { "opennextjs-cloudflare": "dist/cli/index.js" } }],
"@opennextjs/cloudflare": ["@opennextjs/cloudflare@0.5.10", "", { "dependencies": { "@ast-grep/napi": "^0.34.1", "@dotenvx/dotenvx": "1.31.0", "@opennextjs/aws": "https://pkg.pr.new/@opennextjs/aws@756", "enquirer": "^2.4.1", "glob": "^11.0.0", "yaml": "^2.7.0" }, "peerDependencies": { "wrangler": "^3.111.0" }, "bin": { "opennextjs-cloudflare": "dist/cli/index.js" } }, "sha512-L/D472YT5OW1LwpFtD/aVXHJYcVPbFVX7XdphlUjCR4+2osSQIDnsuNgfDRydHMDJZMKxeZDc251ZBzUVKpCqw=="],
"@opentelemetry/api": ["@opentelemetry/api@1.9.0", "", {}, "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg=="],
@@ -1224,19 +1225,19 @@
"@sentry/webpack-plugin": ["@sentry/webpack-plugin@2.22.3", "", { "dependencies": { "@sentry/bundler-plugin-core": "2.22.3", "unplugin": "1.0.1", "uuid": "^9.0.0" }, "peerDependencies": { "webpack": ">=4.40.0" } }, "sha512-Sq1S6bL3nuoTP5typkj+HPjQ13dqftIE8kACAq4tKkXOpWO9bf6HtqcruEQCxMekbWDTdljsrknQ17ZBx2q66Q=="],
"@shikijs/core": ["@shikijs/core@1.27.2", "", { "dependencies": { "@shikijs/engine-javascript": "1.27.2", "@shikijs/engine-oniguruma": "1.27.2", "@shikijs/types": "1.27.2", "@shikijs/vscode-textmate": "^10.0.1", "@types/hast": "^3.0.4", "hast-util-to-html": "^9.0.4" } }, "sha512-ns1dokDr0KE1lQ9mWd4rqaBkhSApk0qGCK1+lOqwnkQSkVZ08UGqXj1Ef8dAcTMZNFkN6PSNjkL5TYNX7pyPbQ=="],
"@shikijs/core": ["@shikijs/core@3.2.0", "", { "dependencies": { "@shikijs/types": "3.2.0", "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4", "hast-util-to-html": "^9.0.5" } }, "sha512-+5dPz8q6HgNqfQ28ycm/vA8dIVd2lNFOUqVRFCQLbs0KZ6emYI+1apLpX+wuL/aDSPLOkMgARwNjkA5UjGKS1Q=="],
"@shikijs/engine-javascript": ["@shikijs/engine-javascript@1.27.2", "", { "dependencies": { "@shikijs/types": "1.27.2", "@shikijs/vscode-textmate": "^10.0.1", "oniguruma-to-es": "^2.0.0" } }, "sha512-0JB7U5vJc16NShBdxv9hSSJYSKX79+32O7F4oXIxJLdYfomyFvx4B982ackUI9ftO9T3WwagkiiD3nOxOOLiGA=="],
"@shikijs/engine-javascript": ["@shikijs/engine-javascript@3.2.0", "", { "dependencies": { "@shikijs/types": "3.2.0", "@shikijs/vscode-textmate": "^10.0.2", "oniguruma-to-es": "^4.1.0" } }, "sha512-1WrYfaz5YT5aTAIMbYQhxlSHc8ArX+hCDNAIdKRqJHzfWQ3xDgh3PTvrAly+RWGuvi5Q4NlvPlTBdlSAXN6Stg=="],
"@shikijs/engine-oniguruma": ["@shikijs/engine-oniguruma@1.27.2", "", { "dependencies": { "@shikijs/types": "1.27.2", "@shikijs/vscode-textmate": "^10.0.1" } }, "sha512-FZYKD1KN7srvpkz4lbGLOYWlyDU4Rd+2RtuKfABTkafAPOFr+J6umfIwY/TzOQqfNtWjL7SAwPAO0dcOraRLaQ=="],
"@shikijs/engine-oniguruma": ["@shikijs/engine-oniguruma@3.2.0", "", { "dependencies": { "@shikijs/types": "3.2.0", "@shikijs/vscode-textmate": "^10.0.2" } }, "sha512-3V7ko+YUAP02I4rUbDjCgvyM/H85hUIZBQAS19FjDcJMKL5SbjWTiG7TRKxX1V4ddxLxt2RO64wZinElp/3ngQ=="],
"@shikijs/langs": ["@shikijs/langs@1.27.2", "", { "dependencies": { "@shikijs/types": "1.27.2" } }, "sha512-MSrknKL0DbeXvhtSigMLIzjPOOQfvK7fsbcRv2NUUB0EvuTTomY8/U+lAkczYrXY2+dygKOapJKk8ScFYbtoNw=="],
"@shikijs/langs": ["@shikijs/langs@3.2.0", "", { "dependencies": { "@shikijs/types": "3.2.0" } }, "sha512-Qze5YIsp223AmC69VZDQolcrcYPrVa9wV6cW2kVqsDrSWlwhW2EQZEn1Iw2oQU1tGYVg8Hj/xdp8mOv+9zI0vg=="],
"@shikijs/themes": ["@shikijs/themes@1.27.2", "", { "dependencies": { "@shikijs/types": "1.27.2" } }, "sha512-Yw/uV7EijjWavIIZLoWneTAohcbBqEKj6XMX1bfMqO3llqTKsyXukPp1evf8qPqzUHY7ibauqEaQchhfi857mg=="],
"@shikijs/themes": ["@shikijs/themes@3.2.0", "", { "dependencies": { "@shikijs/types": "3.2.0" } }, "sha512-XfzMSTu6iMl2FZIwKykld2OzFKDDlm4KbZrzW6sbKXEeJ1xq61HX4x4bE4+REBFqbbrvAQM8EAH11m/E3cxYDg=="],
"@shikijs/types": ["@shikijs/types@1.27.2", "", { "dependencies": { "@shikijs/vscode-textmate": "^10.0.1", "@types/hast": "^3.0.4" } }, "sha512-DM9OWUyjmdYdnKDpaGB/GEn9XkToyK1tqxuqbmc5PV+5K8WjjwfygL3+cIvbkSw2v1ySwHDgqATq/+98pJ4Kyg=="],
"@shikijs/types": ["@shikijs/types@3.2.0", "", { "dependencies": { "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4" } }, "sha512-1uOwfEO0vV+G8n/AO/6Yth7zshNdXvQ1pc4ygTrfE3cyuzVLukrZq72YkFUlsRijam7LvRTvnqL4aT5wx1X2Vw=="],
"@shikijs/vscode-textmate": ["@shikijs/vscode-textmate@10.0.1", "", {}, "sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg=="],
"@shikijs/vscode-textmate": ["@shikijs/vscode-textmate@10.0.2", "", {}, "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg=="],
"@sinclair/typebox": ["@sinclair/typebox@0.25.24", "", {}, "sha512-XJfwUVUKDHF5ugKwIcxEgc9k8b7HbznCp6eUfWgu710hMPNIO4aw4/zB5RogDQz8nd6gyCDpU9O/m6qYEWY6yQ=="],
@@ -2098,7 +2099,7 @@
"hast-util-sanitize": ["hast-util-sanitize@5.0.1", "", { "dependencies": { "@types/hast": "^3.0.0", "@ungap/structured-clone": "^1.2.0", "unist-util-position": "^5.0.0" } }, "sha512-IGrgWLuip4O2nq5CugXy4GI2V8kx4sFVy5Hd4vF7AR2gxS0N9s7nEAVUyeMtZKZvzrxVsHt73XdTsno1tClIkQ=="],
"hast-util-to-html": ["hast-util-to-html@9.0.4", "", { "dependencies": { "@types/hast": "^3.0.0", "@types/unist": "^3.0.0", "ccount": "^2.0.0", "comma-separated-tokens": "^2.0.0", "hast-util-whitespace": "^3.0.0", "html-void-elements": "^3.0.0", "mdast-util-to-hast": "^13.0.0", "property-information": "^6.0.0", "space-separated-tokens": "^2.0.0", "stringify-entities": "^4.0.0", "zwitch": "^2.0.4" } }, "sha512-wxQzXtdbhiwGAUKrnQJXlOPmHnEehzphwkK7aluUPQ+lEc1xefC8pblMgpp2w5ldBTEfveRIrADcrhGIWrlTDA=="],
"hast-util-to-html": ["hast-util-to-html@9.0.5", "", { "dependencies": { "@types/hast": "^3.0.0", "@types/unist": "^3.0.0", "ccount": "^2.0.0", "comma-separated-tokens": "^2.0.0", "hast-util-whitespace": "^3.0.0", "html-void-elements": "^3.0.0", "mdast-util-to-hast": "^13.0.0", "property-information": "^7.0.0", "space-separated-tokens": "^2.0.0", "stringify-entities": "^4.0.0", "zwitch": "^2.0.4" } }, "sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw=="],
"hast-util-to-parse5": ["hast-util-to-parse5@8.0.0", "", { "dependencies": { "@types/hast": "^3.0.0", "comma-separated-tokens": "^2.0.0", "devlop": "^1.0.0", "property-information": "^6.0.0", "space-separated-tokens": "^2.0.0", "web-namespaces": "^2.0.0", "zwitch": "^2.0.0" } }, "sha512-3KKrV5ZVI8if87DVSi1vDeByYrkGzg4mEfeu4alwgmmIeARiBLKCZS2uw5Gb6nU9x9Yufyj3iudm6i7nl52PFw=="],
@@ -2522,7 +2523,9 @@
"onetime": ["onetime@5.1.2", "", { "dependencies": { "mimic-fn": "^2.1.0" } }, "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg=="],
"oniguruma-to-es": ["oniguruma-to-es@2.0.0", "", { "dependencies": { "emoji-regex-xs": "^1.0.0", "regex": "^5.1.1", "regex-recursion": "^5.1.1" } }, "sha512-pE7+9jQgomy10aK6BJKRNHj1Nth0YLOzb3iRuhlz4gRzNSBSd7hga6U8BE6o0SoSuSkqv+PPtt511Msd1Hkl0w=="],
"oniguruma-parser": ["oniguruma-parser@0.5.4", "", {}, "sha512-yNxcQ8sKvURiTwP0mV6bLQCYE7NKfKRRWunhbZnXgxSmB1OXa1lHrN3o4DZd+0Si0kU5blidK7BcROO8qv5TZA=="],
"oniguruma-to-es": ["oniguruma-to-es@4.1.0", "", { "dependencies": { "emoji-regex-xs": "^1.0.0", "oniguruma-parser": "^0.5.4", "regex": "^6.0.1", "regex-recursion": "^6.0.2" } }, "sha512-SNwG909cSLo4vPyyPbU/VJkEc9WOXqu2ycBlfd1UCXLqk1IijcQktSBb2yRQ2UFPsDhpkaf+C1dtT3PkLK/yWA=="],
"openapi-fetch": ["openapi-fetch@0.13.4", "", { "dependencies": { "openapi-typescript-helpers": "^0.0.15" } }, "sha512-JHX7UYjLEiHuQGCPxa3CCCIqe/nc4bTIF9c4UYVC8BegAbWoS3g4gJxKX5XcG7UtYQs2060kY6DH64KkvNZahg=="],
@@ -2648,7 +2651,7 @@
"promisepipe": ["promisepipe@3.0.0", "", {}, "sha512-V6TbZDJ/ZswevgkDNpGt/YqNCiZP9ASfgU+p83uJE6NrGtvSGoOcHLiDCqkMs2+yg7F5qHdLV8d0aS8O26G/KA=="],
"property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="],
"property-information": ["property-information@7.0.0", "", {}, "sha512-7D/qOz/+Y4X/rzSB6jKxKUsQnphO046ei8qxG59mtM3RG3DHgTK81HrxrmoDVINJb8NKT5ZsRbwHvQ6B68Iyhg=="],
"proxy-addr": ["proxy-addr@2.0.7", "", { "dependencies": { "forwarded": "0.2.0", "ipaddr.js": "1.9.1" } }, "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg=="],
@@ -2712,9 +2715,9 @@
"regenerator-runtime": ["regenerator-runtime@0.14.1", "", {}, "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw=="],
"regex": ["regex@5.1.1", "", { "dependencies": { "regex-utilities": "^2.3.0" } }, "sha512-dN5I359AVGPnwzJm2jN1k0W9LPZ+ePvoOeVMMfqIMFz53sSwXkxaJoxr50ptnsC771lK95BnTrVSZxq0b9yCGw=="],
"regex": ["regex@6.0.1", "", { "dependencies": { "regex-utilities": "^2.3.0" } }, "sha512-uorlqlzAKjKQZ5P+kTJr3eeJGSVroLKoHmquUj4zHWuR+hEyNqlXsSKlYYF5F4NI6nl7tWCs0apKJ0lmfsXAPA=="],
"regex-recursion": ["regex-recursion@5.1.1", "", { "dependencies": { "regex": "^5.1.1", "regex-utilities": "^2.3.0" } }, "sha512-ae7SBCbzVNrIjgSbh7wMznPcQel1DNlDtzensnFxpiNpXt1U2ju/bHugH422r+4LAVS1FpW1YCwilmnNsjum9w=="],
"regex-recursion": ["regex-recursion@6.0.2", "", { "dependencies": { "regex-utilities": "^2.3.0" } }, "sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg=="],
"regex-utilities": ["regex-utilities@2.3.0", "", {}, "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng=="],
@@ -2808,7 +2811,7 @@
"shellac": ["shellac@0.8.0", "", { "dependencies": { "reghex": "^1.0.2" } }, "sha512-M3F2vzYIM7frKOs0+kgs/ITMlXhGpgtqs9HxDPciz3bckzAqqfd4LrBn+CCmSbICyJS+Jz5UDkmkR1jE+m+g+Q=="],
"shiki": ["shiki@1.27.2", "", { "dependencies": { "@shikijs/core": "1.27.2", "@shikijs/engine-javascript": "1.27.2", "@shikijs/engine-oniguruma": "1.27.2", "@shikijs/langs": "1.27.2", "@shikijs/themes": "1.27.2", "@shikijs/types": "1.27.2", "@shikijs/vscode-textmate": "^10.0.1", "@types/hast": "^3.0.4" } }, "sha512-QtA1C41oEVixKog+V8I3ia7jjGls7oCZ8Yul8vdHrVBga5uPoyTtMvFF4lMMXIyAZo5A5QbXq91bot2vA6Q+eQ=="],
"shiki": ["shiki@3.2.0", "", { "dependencies": { "@shikijs/core": "3.2.0", "@shikijs/engine-javascript": "3.2.0", "@shikijs/engine-oniguruma": "3.2.0", "@shikijs/langs": "3.2.0", "@shikijs/themes": "3.2.0", "@shikijs/types": "3.2.0", "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4" } }, "sha512-lOF6wkvZCRVQrdfGilyXclTKIjCWKujPAjD6fddLwtQ6eSmgj43pFDbjUmxivtElDRlsGO8G2dLeeRpwNY4wWg=="],
"shimmer": ["shimmer@1.2.1", "", {}, "sha512-sQTKC1Re/rM6XyFM6fIAGHRPVGvyXfgzIDvzoq608vM+jeyVD0Tu1E6Np0Kc2zAIFWIj963V2800iF/9LPieQw=="],
@@ -4276,6 +4279,12 @@
"gtoken/mime": ["mime@2.6.0", "", { "bin": { "mime": "cli.js" } }, "sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg=="],
"hast-util-from-parse5/property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="],
"hast-util-to-parse5/property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="],
"hastscript/property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="],
"http-errors/statuses": ["statuses@1.5.0", "", {}, "sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA=="],
"intl-messageformat/tslib": ["tslib@2.8.1", "", {}, "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w=="],
@@ -5208,6 +5217,8 @@
"read-yaml-file/js-yaml/argparse": ["argparse@1.0.10", "", { "dependencies": { "sprintf-js": "~1.0.2" } }, "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg=="],
"rehype-stringify/hast-util-to-html/property-information": ["property-information@6.5.0", "", {}, "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig=="],
"rimraf/glob/jackspeak": ["jackspeak@3.4.3", "", { "dependencies": { "@isaacs/cliui": "^8.0.2" }, "optionalDependencies": { "@pkgjs/parseargs": "^0.11.0" } }, "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw=="],
"rimraf/glob/minimatch": ["minimatch@9.0.5", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow=="],
+2 -1
View File
@@ -11,7 +11,8 @@
"overrides": {
"@codemirror/state": "6.4.1",
"react": "18.3.1",
"react-dom": "18.3.1"
"react-dom": "18.3.1",
"@gitbook/api": "0.99.0"
},
"private": true,
"scripts": {
+7 -1
View File
@@ -1,7 +1,13 @@
# @gitbook/cache-tags
## 0.2.0
### Minor Changes
- f32bf1f: Export function `getCacheTagForURL` to easily get the cache tag for a URL.
## 0.1.0
### Minor Changes
- 05ffd0e: Initial version of the package
- 05ffd0e: Initial version of the package
+2 -2
View File
@@ -8,9 +8,9 @@
"default": "./dist/index.js"
}
},
"version": "0.1.0",
"version": "0.2.0",
"dependencies": {
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"assert-never": "^1.2.1"
},
"devDependencies": {
+11
View File
@@ -111,6 +111,17 @@ export function getCacheTag(
}
}
/**
* Get the cache tag for a given URL.
*/
export function getCacheTagForURL(url: string | URL) {
const parsedURL = url instanceof URL ? url : new URL(url);
return getCacheTag({
tag: 'url',
hostname: parsedURL.hostname,
});
}
/**
* Get the tags for a computed content source.
*/
+13 -6
View File
@@ -1,27 +1,34 @@
# gitbook-v2
## 0.2.1
### Patch Changes
- Updated dependencies [f32bf1f]
- @gitbook/cache-tags@0.2.0
## 0.2.0
### Minor Changes
- 76c7974: Add route to revalidate cached data
- 76c7974: Add route to revalidate cached data
## 0.1.2
### Patch Changes
- 05ffd0e: Improving data cache management for computed content
- Updated dependencies [05ffd0e]
- @gitbook/cache-tags@0.1.0
- 05ffd0e: Improving data cache management for computed content
- Updated dependencies [05ffd0e]
- @gitbook/cache-tags@0.1.0
## 0.1.1
### Patch Changes
- 3e11678: fix: lost section groups
- 3e11678: fix: lost section groups
## 0.1.0
### Minor Changes
- cfccc44: Setup structure and deployment for new version
- cfccc44: Setup structure and deployment for new version
+5 -4
View File
@@ -1,12 +1,12 @@
{
"name": "gitbook-v2",
"version": "0.2.0",
"version": "0.2.1",
"private": true,
"dependencies": {
"next": "^15.2.1",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"@gitbook/cache-tags": "workspace:*",
"@sindresorhus/fnv1a": "^3.1.0",
"server-only": "^0.0.1",
@@ -14,7 +14,7 @@
},
"devDependencies": {
"gitbook": "*",
"@opennextjs/cloudflare": "https://pkg.pr.new/opennextjs/opennextjs-cloudflare/@opennextjs/cloudflare@236c84d",
"@opennextjs/cloudflare": "^0.5.10",
"tailwindcss": "^3.4.0",
"postcss": "^8"
},
@@ -26,6 +26,7 @@
"start": "next start",
"build:v2:cloudflare": "opennextjs-cloudflare",
"dev:v2:cloudflare": "wrangler dev --port 8771",
"unit": "bun test"
"unit": "bun test",
"typecheck": "tsc --noEmit"
}
}
+2
View File
@@ -1,6 +1,7 @@
import { type NextRequest, NextResponse } from 'next/server';
import {
GITBOOK_API_PUBLIC_URL,
GITBOOK_API_TOKEN,
GITBOOK_API_URL,
GITBOOK_APP_URL,
@@ -22,6 +23,7 @@ export async function GET(_req: NextRequest) {
GITBOOK_URL,
GITBOOK_APP_URL,
GITBOOK_API_URL,
GITBOOK_API_PUBLIC_URL,
GITBOOK_ASSETS_URL,
GITBOOK_ICONS_URL,
GITBOOK_USER_AGENT,
@@ -4,7 +4,6 @@ import {
fetchSpaceContextByIds,
} from '@v2/lib/context';
import { createDataFetcher } from '@v2/lib/data';
import { GITBOOK_API_URL } from '@v2/lib/env';
import { createLinker } from '@v2/lib/links';
import { getAPITokenFromMiddleware } from '@v2/lib/middleware';
@@ -26,7 +25,6 @@ export async function getSpacePDFContext(
});
const dataFetcher = createDataFetcher({
apiToken: apiToken,
apiEndpoint: GITBOOK_API_URL,
});
const baseContext: GitBookBaseContext = {
+2 -3
View File
@@ -16,7 +16,7 @@ import type {
import { type GitBookDataFetcher, createDataFetcher, throwIfDataError } from '@v2/lib/data';
import { redirect } from 'next/navigation';
import { assert } from 'ts-essentials';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_URL } from './env';
import { GITBOOK_URL } from './env';
import { type ImageResizer, createImageResizer } from './images';
import { type GitBookSpaceLinker, createLinker } from './links';
@@ -113,8 +113,7 @@ export function getBaseContext(input: {
const urlMode = input.urlMode;
const dataFetcher = createDataFetcher({
apiToken: input.apiToken ?? GITBOOK_API_TOKEN,
apiEndpoint: GITBOOK_API_URL,
apiToken: input.apiToken ?? null,
});
const linker = getLinkerForSiteURL({
+194 -138
View File
@@ -1,42 +1,40 @@
import { type ComputedContentSource, GitBookAPI } from '@gitbook/api';
import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
import { trace } from '@/lib/tracing';
import {
type ComputedContentSource,
GitBookAPI,
type GitBookAPIServiceBinding,
} from '@gitbook/api';
import {
getCacheTag,
getCacheTagForURL,
getComputedContentSourceCacheTags,
} from '@gitbook/cache-tags';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
import { unstable_cacheLife as cacheLife, unstable_cacheTag as cacheTag } from 'next/cache';
import { wrapDataFetcherError } from './errors';
import type { GitBookDataFetcher } from './types';
interface DataFetcherInput {
/**
* API host to use.
*/
apiEndpoint: string;
/**
* API token.
*/
apiToken: string | null;
}
const commonInput: DataFetcherInput = {
apiEndpoint: GITBOOK_API_URL,
apiToken: GITBOOK_API_TOKEN,
};
/**
* Create a data fetcher using an API token.
* The data are being cached by Next.js built-in cache.
*/
export function createDataFetcher(input: DataFetcherInput = commonInput): GitBookDataFetcher {
export function createDataFetcher(
input: DataFetcherInput = { apiToken: null }
): GitBookDataFetcher {
return {
apiEndpoint: input.apiEndpoint,
async api() {
return getAPI(input);
return apiClient(input);
},
withToken({ apiToken }) {
return createDataFetcher({
...input,
apiToken,
});
},
@@ -45,94 +43,120 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
// API that are tied to the token
//
getPublishedContentSite(params) {
return getPublishedContentSite(input, {
organizationId: params.organizationId,
siteId: params.siteId,
siteShareKey: params.siteShareKey,
});
return trace('getPublishedContentSite', () =>
getPublishedContentSite(input, {
organizationId: params.organizationId,
siteId: params.siteId,
siteShareKey: params.siteShareKey,
})
);
},
getSiteRedirectBySource(params) {
return getSiteRedirectBySource(input, {
organizationId: params.organizationId,
siteId: params.siteId,
siteShareKey: params.siteShareKey,
source: params.source,
});
return trace('getSiteRedirectBySource', () =>
getSiteRedirectBySource(input, {
organizationId: params.organizationId,
siteId: params.siteId,
siteShareKey: params.siteShareKey,
source: params.source,
})
);
},
getRevision(params) {
return getRevision(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
metadata: params.metadata,
});
return trace('getRevision', () =>
getRevision(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
metadata: params.metadata,
})
);
},
getRevisionPages(params) {
return getRevisionPages(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
metadata: params.metadata,
});
return trace('getRevisionPages', () =>
getRevisionPages(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
metadata: params.metadata,
})
);
},
getRevisionFile(params) {
return getRevisionFile(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
fileId: params.fileId,
});
return trace('getRevisionFile', () =>
getRevisionFile(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
fileId: params.fileId,
})
);
},
getRevisionPageByPath(params) {
return getRevisionPageByPath(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
path: params.path,
});
return trace('getRevisionPageByPath', () =>
getRevisionPageByPath(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
path: params.path,
})
);
},
getReusableContent(params) {
return getReusableContent(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
reusableContentId: params.reusableContentId,
});
return trace('getReusableContent', () =>
getReusableContent(input, {
spaceId: params.spaceId,
revisionId: params.revisionId,
reusableContentId: params.reusableContentId,
})
);
},
getLatestOpenAPISpecVersionContent(params) {
return getLatestOpenAPISpecVersionContent(input, {
organizationId: params.organizationId,
slug: params.slug,
});
return trace('getLatestOpenAPISpecVersionContent', () =>
getLatestOpenAPISpecVersionContent(input, {
organizationId: params.organizationId,
slug: params.slug,
})
);
},
getSpace(params) {
return getSpace(input, {
spaceId: params.spaceId,
shareKey: params.shareKey,
});
return trace('getSpace', () =>
getSpace(input, {
spaceId: params.spaceId,
shareKey: params.shareKey,
})
);
},
getChangeRequest(params) {
return getChangeRequest(input, {
spaceId: params.spaceId,
changeRequestId: params.changeRequestId,
});
return trace('getChangeRequest', () =>
getChangeRequest(input, {
spaceId: params.spaceId,
changeRequestId: params.changeRequestId,
})
);
},
getDocument(params) {
return getDocument(input, {
spaceId: params.spaceId,
documentId: params.documentId,
});
return trace('getDocument', () =>
getDocument(input, {
spaceId: params.spaceId,
documentId: params.documentId,
})
);
},
getComputedDocument(params) {
return getComputedDocument(input, {
organizationId: params.organizationId,
spaceId: params.spaceId,
source: params.source,
});
return trace('getComputedDocument', () =>
getComputedDocument(input, {
organizationId: params.organizationId,
spaceId: params.spaceId,
source: params.source,
})
);
},
getEmbedByUrl(params) {
return getEmbedByUrl(input, {
url: params.url,
spaceId: params.spaceId,
});
return trace('getEmbedByUrl', () =>
getEmbedByUrl(input, {
url: params.url,
spaceId: params.spaceId,
})
);
},
searchSiteContent(params) {
return searchSiteContent(input, params);
return trace('searchSiteContent', () => searchSiteContent(input, params));
},
//
@@ -140,25 +164,31 @@ export function createDataFetcher(input: DataFetcherInput = commonInput): GitBoo
// where the data is the same for all users
//
getUserById(userId) {
return getUserById(commonInput, userId);
return trace('getUserById', () => getUserById({ apiToken: null }, { userId }));
},
getPublishedContentByUrl(params) {
return getPublishedContentByUrl(commonInput, {
url: params.url,
visitorAuthToken: params.visitorAuthToken,
redirectOnError: params.redirectOnError,
});
return trace('getPublishedContentByUrl', () =>
getPublishedContentByUrl(
{ apiToken: null },
{
url: params.url,
visitorAuthToken: params.visitorAuthToken,
redirectOnError: params.redirectOnError,
}
)
);
},
};
}
async function getUserById(input: DataFetcherInput, userId: string) {
async function getUserById(input: DataFetcherInput, params: { userId: string }) {
'use cache';
cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).users.getUserById(userId);
const api = await apiClient(input);
const res = await api.users.getUserById(params.userId);
return res.data;
});
}
@@ -181,7 +211,8 @@ async function getSpace(
);
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getSpaceById(params.spaceId, {
const api = await apiClient(input);
const res = await api.spaces.getSpaceById(params.spaceId, {
shareKey: params.shareKey,
});
return res.data;
@@ -200,10 +231,8 @@ async function getChangeRequest(
cacheLife('minutes');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getChangeRequestById(
params.spaceId,
params.changeRequestId
);
const api = await apiClient(input);
const res = await api.spaces.getChangeRequestById(params.spaceId, params.changeRequestId);
cacheTag(
getCacheTag({
tag: 'change-request',
@@ -228,7 +257,8 @@ async function getRevision(
cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getRevisionById(params.spaceId, params.revisionId, {
const api = await apiClient(input);
const res = await api.spaces.getRevisionById(params.spaceId, params.revisionId, {
metadata: params.metadata,
});
return res.data;
@@ -248,13 +278,10 @@ async function getRevisionPages(
cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.listPagesInRevisionById(
params.spaceId,
params.revisionId,
{
metadata: params.metadata,
}
);
const api = await apiClient(input);
const res = await api.spaces.listPagesInRevisionById(params.spaceId, params.revisionId, {
metadata: params.metadata,
});
return res.data.pages;
});
}
@@ -272,10 +299,12 @@ async function getRevisionFile(
cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getFileInRevisionById(
const api = await apiClient(input);
const res = await api.spaces.getFileInRevisionById(
params.spaceId,
params.revisionId,
params.fileId
params.fileId,
{}
);
return res.data;
});
@@ -295,10 +324,12 @@ async function getRevisionPageByPath(
const encodedPath = encodeURIComponent(params.path);
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getPageInRevisionByPath(
const api = await apiClient(input);
const res = await api.spaces.getPageInRevisionByPath(
params.spaceId,
params.revisionId,
encodedPath
encodedPath,
{}
);
return res.data;
@@ -317,7 +348,8 @@ async function getDocument(
cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getDocumentById(params.spaceId, params.documentId);
const api = await apiClient(input);
const res = await api.spaces.getDocumentById(params.spaceId, params.documentId, {});
return res.data;
});
}
@@ -345,7 +377,8 @@ async function getComputedDocument(
);
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getComputedDocument(params.spaceId, {
const api = await apiClient(input);
const res = await api.spaces.getComputedDocument(params.spaceId, {
source: params.source,
});
return res.data;
@@ -365,7 +398,8 @@ async function getReusableContent(
cacheLife('max');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).spaces.getReusableContentInRevisionById(
const api = await apiClient(input);
const res = await api.spaces.getReusableContentInRevisionById(
params.spaceId,
params.revisionId,
params.reusableContentId
@@ -393,7 +427,8 @@ async function getLatestOpenAPISpecVersionContent(
cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.getLatestOpenApiSpecVersionContent(
const api = await apiClient(input);
const res = await api.orgs.getLatestOpenApiSpecVersionContent(
params.organizationId,
params.slug
);
@@ -413,17 +448,12 @@ async function getPublishedContentByUrl(
const { url, visitorAuthToken, redirectOnError } = params;
const hostname = new URL(url).hostname;
cacheTag(
getCacheTag({
tag: 'url',
hostname,
})
);
cacheTag(getCacheTagForURL(url));
cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).urls.getPublishedContentByUrl({
const api = await apiClient(input);
const res = await api.urls.getPublishedContentByUrl({
url,
visitorAuthToken: visitorAuthToken ?? undefined,
redirectOnError,
@@ -452,22 +482,19 @@ async function getPublishedContentSite(
) {
'use cache';
cacheLife('days');
cacheTag(
getCacheTag({
tag: 'site',
site: params.siteId,
})
);
cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.getPublishedContentSite(
params.organizationId,
params.siteId,
{
shareKey: params.siteShareKey,
}
);
const api = await apiClient(input);
const res = await api.orgs.getPublishedContentSite(params.organizationId, params.siteId, {
shareKey: params.siteShareKey,
});
return res.data;
});
}
@@ -492,14 +519,11 @@ async function getSiteRedirectBySource(
cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.getSiteRedirectBySource(
params.organizationId,
params.siteId,
{
shareKey: params.siteShareKey,
source: params.source,
}
);
const api = await apiClient(input);
const res = await api.orgs.getSiteRedirectBySource(params.organizationId, params.siteId, {
shareKey: params.siteShareKey,
source: params.source,
});
return res.data;
});
@@ -517,7 +541,7 @@ async function getEmbedByUrl(
cacheLife('weeks');
return wrapDataFetcherError(async () => {
const api = getAPI(input);
const api = await apiClient(input);
const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, { url: params.url });
return res.data;
});
@@ -534,7 +558,8 @@ async function searchSiteContent(
cacheLife('days');
return wrapDataFetcherError(async () => {
const res = await getAPI(input).orgs.searchSiteContent(organizationId, siteId, {
const api = await apiClient(input);
const res = await api.orgs.searchSiteContent(organizationId, siteId, {
query,
...scope,
});
@@ -542,12 +567,43 @@ async function searchSiteContent(
});
}
function getAPI(input: DataFetcherInput) {
const { apiEndpoint, apiToken } = input;
let loggedServiceBinding = false;
/**
* Create a new API client.
*/
export async function apiClient(input: DataFetcherInput = { apiToken: null }) {
const { apiToken } = input;
let serviceBinding: GitBookAPIServiceBinding | undefined;
try {
// HACK: This is a workaround to avoid webpack trying to bundle this cloudflare only module
// @ts-ignore
const { env } = await import(
/* webpackIgnore: true */ `${'__cloudflare:workers'.replaceAll('_', '')}`
);
serviceBinding = env.GITBOOK_API;
if (!loggedServiceBinding) {
loggedServiceBinding = true;
if (serviceBinding) {
// biome-ignore lint/suspicious/noConsole: we want to log here
console.log(`using service binding for the API (${GITBOOK_API_URL})`);
} else {
// biome-ignore lint/suspicious/noConsole: we want to log here
console.warn(`no service binding for the API (${GITBOOK_API_URL})`);
}
}
} catch (error) {
if (process.env.NODE_ENV === 'production' && !process.env.VERCEL) {
throw error;
}
}
const api = new GitBookAPI({
authToken: apiToken ?? undefined,
endpoint: apiEndpoint,
authToken: apiToken || GITBOOK_API_TOKEN || undefined,
endpoint: GITBOOK_API_URL,
userAgent: GITBOOK_USER_AGENT,
serviceBinding,
});
return api;
+22 -29
View File
@@ -1,7 +1,8 @@
import { race, tryCatch } from '@/lib/async';
import { joinPath } from '@/lib/paths';
import { GitBookAPI, type PublishedSiteContentLookup } from '@gitbook/api';
import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@v2/lib/env';
import { trace } from '@/lib/tracing';
import type { PublishedSiteContentLookup } from '@gitbook/api';
import { apiClient } from './api';
import { getExposableError } from './errors';
import type { DataFetcherResponse } from './types';
import { getURLLookupAlternatives, stripURLSearch } from './urls';
@@ -20,34 +21,26 @@ export async function getPublishedContentByURL(input: {
const lookup = getURLLookupAlternatives(url);
const result = await race(lookup.urls, async (alternative, { signal }) => {
const api = new GitBookAPI({
authToken: GITBOOK_API_TOKEN ?? undefined,
endpoint: GITBOOK_API_URL,
userAgent: GITBOOK_USER_AGENT,
});
const api = await apiClient();
const startTime = performance.now();
const callResult = await tryCatch(
api.urls.getPublishedContentByUrl(
{
url: alternative.url,
visitorAuthToken: input.visitorAuthToken ?? undefined,
redirectOnError: input.redirectOnError,
cache: true,
},
{
signal,
headers: {
'x-gitbook-force-cache': 'true',
},
}
)
);
const endTime = performance.now();
// biome-ignore lint/suspicious/noConsole: we want to log performance data
console.log(
`getPublishedContentByURL(${alternative.url}) Time taken: ${endTime - startTime}ms`
const callResult = await trace(
{
operation: 'getPublishedContentByURL',
name: alternative.url,
},
() =>
tryCatch(
api.urls.getPublishedContentByUrl(
{
url: alternative.url,
visitorAuthToken: input.visitorAuthToken ?? undefined,
redirectOnError: input.redirectOnError,
},
{
signal,
}
)
)
);
if (callResult.error) {
@@ -20,11 +20,6 @@ export type DataFetcherResponse<T> =
* It is used between v1 and v2.
*/
export interface GitBookDataFetcher {
/**
* Endpoint of the API.
*/
apiEndpoint: string;
/**
* Get an API client for the current context.
*/
+5
View File
@@ -34,6 +34,11 @@ export const GITBOOK_APP_URL = process.env.GITBOOK_APP_URL || 'https://app.gitbo
*/
export const GITBOOK_API_URL = process.env.GITBOOK_API_URL || 'https://api.gitbook.com';
/**
* Default GitBook API URL endpoint, to be shared with the client.
*/
export const GITBOOK_API_PUBLIC_URL = process.env.GITBOOK_API_PUBLIC_URL || GITBOOK_API_URL;
/**
* Default GitBook API token.
* It can be use to avoid rate-limiting.
+14 -2
View File
@@ -1,7 +1,7 @@
main = ".open-next/worker.js"
name = "gitbook-open-v2"
compatibility_date = "2024-09-23"
compatibility_flags = ["nodejs_compat"]
compatibility_date = "2025-03-11"
compatibility_flags = ["nodejs_compat", "allow_importable_env"]
assets = { directory = ".open-next/assets", binding = "ASSETS" }
observability = { enabled = true }
@@ -12,6 +12,10 @@ kv_namespaces = [
d1_databases = [
{ binding = "NEXT_CACHE_D1", database_id = "f59ddb40-ad72-4312-9395-0ac6a129af8e", database_name = "gitbook-open-v2-tags-preview" }
]
services = [
{ binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-preview" },
{ binding = "GITBOOK_API", service = "gitbook-x-prod-api-cache" }
]
[env.staging]
routes = [
@@ -24,6 +28,10 @@ kv_namespaces = [
d1_databases = [
{ binding = "NEXT_CACHE_D1", database_id = "9df62e39-1f35-4066-83aa-e9b8ed3ac8d5", database_name = "gitbook-open-v2-tags-staging" }
]
services = [
{ binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-staging" },
{ binding = "GITBOOK_API", service = "gitbook-x-staging-api-cache" }
]
[env.production]
routes = [
@@ -36,3 +44,7 @@ kv_namespaces = [
d1_databases = [
{ binding = "NEXT_CACHE_D1", database_id = "a6f16fce-5f45-43a9-89a4-7b83ddf25b77", database_name = "gitbook-open-v2-tags-production" }
]
services = [
{ binding = "NEXT_CACHE_REVALIDATION_WORKER", service = "gitbook-open-v2-production" },
{ binding = "GITBOOK_API", service = "gitbook-x-prod-api-cache" }
]
+381 -356
View File
@@ -1,461 +1,486 @@
# gitbook
## 0.8.0
### Minor Changes
- eec3eed: Add styling for prominent search bar option
### Patch Changes
- 16292de: Display sidebar on no-TOC pages
- 9b5f971: Transparent background for OpenAPI path block
- 99da8df: Optimize favicons and og:image using the image resizer
- b011ea0: Fix rendering of code blocks in Ask AI when being streamed
- 9bc3d50: Info hint background and link color fixes
- 31d800e: Render OpenAPISchemas block
- Updated dependencies [6aaeae2]
- Updated dependencies [c60e9ba]
- Updated dependencies [9108c56]
- Updated dependencies [31d800e]
- Updated dependencies [ff3b708]
- Updated dependencies [f32bf1f]
- Updated dependencies [c9ea239]
- @gitbook/react-contentkit@0.7.0
- @gitbook/react-openapi@1.1.4
- @gitbook/cache-tags@0.2.0
## 0.7.3
### Patch Changes
- eaf2d68: OpenAPI operation title fallback in sections
- Updated dependencies [844059f]
- Updated dependencies [88f64b0]
- @gitbook/react-openapi@1.1.3
- @gitbook/icons@0.2.0
- @gitbook/react-contentkit@0.6.2
- eaf2d68: OpenAPI operation title fallback in sections
- Updated dependencies [844059f]
- Updated dependencies [88f64b0]
- @gitbook/react-openapi@1.1.3
- @gitbook/icons@0.2.0
- @gitbook/react-contentkit@0.6.2
## 0.7.2
### Patch Changes
- f127d28: Rename OpenAPIModels to OpenAPISchemas
- Updated dependencies [f127d28]
- @gitbook/react-openapi@1.1.2
- f127d28: Rename OpenAPIModels to OpenAPISchemas
- Updated dependencies [f127d28]
- @gitbook/react-openapi@1.1.2
## 0.7.1
### Patch Changes
- Updated dependencies [f574858]
- @gitbook/react-openapi@1.1.1
- Updated dependencies [f574858]
- @gitbook/react-openapi@1.1.1
## 0.7.0
### Minor Changes
- bb3ca9c: Implement OpenAPI models blocks
- bb3ca9c: Implement OpenAPI models blocks
### Patch Changes
- 5907bd9: Adjust hint block spacing
- 9ffc3b6: Fix content overflowing out of its container in tabs
- Updated dependencies [0278a14]
- Updated dependencies [bb3ca9c]
- Updated dependencies [3173d8e]
- Updated dependencies [052e07a]
- @gitbook/openapi-parser@2.1.0
- @gitbook/react-openapi@1.1.0
- 5907bd9: Adjust hint block spacing
- 9ffc3b6: Fix content overflowing out of its container in tabs
- Updated dependencies [0278a14]
- Updated dependencies [bb3ca9c]
- Updated dependencies [3173d8e]
- Updated dependencies [052e07a]
- @gitbook/openapi-parser@2.1.0
- @gitbook/react-openapi@1.1.0
## 0.6.5
### Patch Changes
- 05ffd0e: Improving data cache management for computed content
- 8beb5d6: Add input elements to ContentKit
- Updated dependencies [53f5dbe]
- Updated dependencies [05ffd0e]
- Updated dependencies [8beb5d6]
- @gitbook/openapi-parser@2.0.2
- @gitbook/cache-tags@0.1.0
- @gitbook/react-contentkit@0.6.1
- @gitbook/react-openapi@1.0.5
- 05ffd0e: Improving data cache management for computed content
- 8beb5d6: Add input elements to ContentKit
- Updated dependencies [53f5dbe]
- Updated dependencies [05ffd0e]
- Updated dependencies [8beb5d6]
- @gitbook/openapi-parser@2.0.2
- @gitbook/cache-tags@0.1.0
- @gitbook/react-contentkit@0.6.1
- @gitbook/react-openapi@1.0.5
## 0.6.4
### Patch Changes
- 9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
- 2ae76f9: Change how a site in proxy mode is resolved
- 027a859: Add support for links style customization option
- 3e11678: fix: lost section groups
- 3319375: Support OpenAPI operation block
- Updated dependencies [722f02e]
- Updated dependencies [0924259]
- @gitbook/react-openapi@1.0.4
- @gitbook/openapi-parser@2.0.1
- 9b914d1: Fix getProxyModeBasePath that was computing incorrect base path in some scenarios
- 2ae76f9: Change how a site in proxy mode is resolved
- 027a859: Add support for links style customization option
- 3e11678: fix: lost section groups
- 3319375: Support OpenAPI operation block
- Updated dependencies [722f02e]
- Updated dependencies [0924259]
- @gitbook/react-openapi@1.0.4
- @gitbook/openapi-parser@2.0.1
## 0.6.3
### Patch Changes
- a820739: Remove unused search api method from gitbook/api/lib
- a054554: Implement a trusted mode to speed up OpenAPI spec validation
- 66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
- 9f0de74: Add support for new OpenAPI ref
- da55fac: Render GitBook blocks in OpenAPI operation description
- Updated dependencies [c808bb1]
- Updated dependencies [dc2dbc5]
- Updated dependencies [f1d1d2f]
- Updated dependencies [e24206e]
- Updated dependencies [a054554]
- Updated dependencies [05e1d8c]
- Updated dependencies [b4a12d6]
- Updated dependencies [9f0de74]
- Updated dependencies [da55fac]
- @gitbook/openapi-parser@2.0.0
- @gitbook/react-openapi@1.0.3
- a820739: Remove unused search api method from gitbook/api/lib
- a054554: Implement a trusted mode to speed up OpenAPI spec validation
- 66d0fc0: Update design for hint block: use semantic colors (info, warning, danger, success) and add alternative styling for hints with headings
- 9f0de74: Add support for new OpenAPI ref
- da55fac: Render GitBook blocks in OpenAPI operation description
- Updated dependencies [c808bb1]
- Updated dependencies [dc2dbc5]
- Updated dependencies [f1d1d2f]
- Updated dependencies [e24206e]
- Updated dependencies [a054554]
- Updated dependencies [05e1d8c]
- Updated dependencies [b4a12d6]
- Updated dependencies [9f0de74]
- Updated dependencies [da55fac]
- @gitbook/openapi-parser@2.0.0
- @gitbook/react-openapi@1.0.3
## 0.6.2
### Patch Changes
- 359bb97: Fix opening external links when the GitBook page is embedded in an iframe
- 6157583: Improve Markdown parsing
- 82cd9f2: Add support for anchor links in OpenAPI blocks
- Updated dependencies [445baaa]
- Updated dependencies [bb5c6a4]
- Updated dependencies [a3f1fea]
- Updated dependencies [6157583]
- Updated dependencies [7419ee7]
- Updated dependencies [82cd9f2]
- @gitbook/colors@0.2.0
- @gitbook/react-openapi@1.0.2
- @gitbook/openapi-parser@1.0.1
- 359bb97: Fix opening external links when the GitBook page is embedded in an iframe
- 6157583: Improve Markdown parsing
- 82cd9f2: Add support for anchor links in OpenAPI blocks
- Updated dependencies [445baaa]
- Updated dependencies [bb5c6a4]
- Updated dependencies [a3f1fea]
- Updated dependencies [6157583]
- Updated dependencies [7419ee7]
- Updated dependencies [82cd9f2]
- @gitbook/colors@0.2.0
- @gitbook/react-openapi@1.0.2
- @gitbook/openapi-parser@1.0.1
## 0.6.1
### Patch Changes
- dddb4ec: Fix long tab group description
- Updated dependencies [f8d4c76]
- Updated dependencies [dddb4ec]
- Updated dependencies [f8d4c76]
- @gitbook/react-openapi@1.0.1
- dddb4ec: Fix long tab group description
- Updated dependencies [f8d4c76]
- Updated dependencies [dddb4ec]
- Updated dependencies [f8d4c76]
- @gitbook/react-openapi@1.0.1
## 0.6.0
### Minor Changes
- 98245e5: Adapt code to pull token from customer backend generated custom cookies
- af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
- 95f2aa4: Track new events for site insights when ads are being clicked
- 08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
- 1138d59: Add support for sidebar background styles
- 9e18ae6: Overhaul colour scale & Tailwind colour classes
- e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
- 7059c2b: Add support for computed content by fetching computed documents for pages.
- c71d159: Track events for site insights using the new dedicated API.
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
- 7ee9158: Restyle PageAside to use sidebar list styles
- dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
- 1417279: Track clicks on links (header, footer, content) for site insights.
- 9eca010: Improve the display of recommended questions by streaming them.
- 160fca1: new OpenAPI blocks design
- 71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
- 1823101: Fix internal properties appearing in OpenAPI docs.
- 6a073e1: Add antialiasing for text rendering
- 8126a83: Improve readability of tables with hover style and vertical dividers
- db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
- 99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
- e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
- 98245e5: Adapt code to pull token from customer backend generated custom cookies
- af3c6a9: Reintroduce a safety check around search whilst we continue investigating caching.
- 95f2aa4: Track new events for site insights when ads are being clicked
- 08acea6: Investigate an issue causing caches to return empty objects instead of null/undefined.
- 1138d59: Add support for sidebar background styles
- 9e18ae6: Overhaul colour scale & Tailwind colour classes
- e86e51f: Fix an issue where the redirects of potentially malicious images were not going through.
- 7059c2b: Add support for computed content by fetching computed documents for pages.
- c71d159: Track events for site insights using the new dedicated API.
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
- 7ee9158: Restyle PageAside to use sidebar list styles
- dbba50c: Fix an issue where search and Ask AI triggers unnecessary renders when in a Visitor Authenticated site.
- 1417279: Track clicks on links (header, footer, content) for site insights.
- 9eca010: Improve the display of recommended questions by streaming them.
- 160fca1: new OpenAPI blocks design
- 71688a8: Introduction of new themes: Clean, Muted, Bold, and Gradient
- 1823101: Fix internal properties appearing in OpenAPI docs.
- 6a073e1: Add antialiasing for text rendering
- 8126a83: Improve readability of tables with hover style and vertical dividers
- db74ea3: Image optimization endpoint redirects to underlying image URL if the signature is not the latest.
- 99579ac: Fix a vulnerability issue for images using an older version of the image signing parameter.
- e4e2f52: Track an event into site insights when visitor is opening the Scalar API client.
### Patch Changes
- d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
- c30bc24: Fix empty sitemap
- e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
- 5b4e710: Support llms.txt
- b6c3870: Add support for keyboard marks
- 6059efe: Fix search no results error showing while there are results
- c77142a: Log component stack in Sentry
- 1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
- 32aa1f9: Handle security issue with cookies on Safari
- d935fb1: Don't add extra page scroll when footer is not present
- 53de5b1: Fix site section URL resolution in Ask AI sources
- 24f5249: Fix vertical section overflow color
- 1762f85: Reduce gap between subsequent header buttons
- c1e27cc: Fix pass Sentry release properly
- 5ae1b88: Fix shrinking page icons
- 8f046a9: Start using tint in more places, TOC and PageAside
- 665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
- d876399: Fix UI search without ask AI enabled and fix error with questions not returned from API
- c30bc24: Fix empty sitemap
- e90c96f: page outline on the right remains visible when scrolling, move mode toggler to PageAside
- 5b4e710: Support llms.txt
- b6c3870: Add support for keyboard marks
- 6059efe: Fix search no results error showing while there are results
- c77142a: Log component stack in Sentry
- 1de9d1a: Apply antialiasing on any text that are not code inline/blocks to avoid contrast issues
- 32aa1f9: Handle security issue with cookies on Safari
- d935fb1: Don't add extra page scroll when footer is not present
- 53de5b1: Fix site section URL resolution in Ask AI sources
- 24f5249: Fix vertical section overflow color
- 1762f85: Reduce gap between subsequent header buttons
- c1e27cc: Fix pass Sentry release properly
- 5ae1b88: Fix shrinking page icons
- 8f046a9: Start using tint in more places, TOC and PageAside
- 665b6be: Ignore invalid API calls to `getSiteRedirectFromSource` API
To reduce the load on the API and also avoid errors.
To reduce the load on the API and also avoid errors.
- 26e6401: Remove KV cache backend and only rely on DO as an external cache backend
- 8cfa67c: Fix default outline list styling
- d66c184: Ignore errors from event flushing
- 6088fa5: Simplify search results logic to investigate a bug
- 68287d3: Cache API spec for 24 hours, revalidated every 2 hours
- 09c7c30: Try to fix error on og image generation
- ae99f87: Improve emoji setup, align with GitBook app
- 2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
- 3a7210d: Fix zoom image view transition on Safari
- 718a8a5: Position the variant picker in the ToC
- e5dc05e: Update footer styling and allow for more than 4 footer groups
- 8276ba0: Make cookies access safer
- 1b8a456: Fix Image blocks zoomable behaviour
- 56c52e0: Handle Firefox security error on localStorage
- 0510b6f: Add section description to SectionGroupTile
- 1fcc807: Fix errors from customization not found
- 46edde9: Improve the OpenAPI package API
- 8af1abc: Improve contrast of search box placeholder
- 92b7668: Improve header offset
- d9c8d57: Do not dereference before caching OpenAPI spec.
- 94876e3: Fix regression issue with page icons for multi-line titles
- 47971dc: Fix OG image generation for non-latin characters
- 82dc9c4: Simplify the `useHash` algo used.
- 128ad20: Ignore cache invalidation error from local backend
- ff05e20: Improvements to inline images in headings
- cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
- d5aaccd: Remove use of deprecatd API createSitesPageFeedback
- 48ab59f: Improve colour contrast of list item decoration
- d2bc567: Set Sentry release
- 37d13d8: Avoid error on fetch by passing a string URL
- d3e573c: Generate sitemap for all sections and spaces
- f7b801b: Add feedback form to page rating control
- d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
- 46f63cb: Fix code format overriding inline link styles
- 5950657: Fix emojis display
- 528a053: Fix server actions stability leading to no results found sometimes on search
- eac1314: Lazy load iframely script to make page more responsive
- ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
- 6f54826: New highlight colors
- 5c87ec7: Implement a safer way to interact with localStorage.
- 26e6401: Remove KV cache backend and only rely on DO as an external cache backend
- 8cfa67c: Fix default outline list styling
- d66c184: Ignore errors from event flushing
- 6088fa5: Simplify search results logic to investigate a bug
- 68287d3: Cache API spec for 24 hours, revalidated every 2 hours
- 09c7c30: Try to fix error on og image generation
- ae99f87: Improve emoji setup, align with GitBook app
- 2906e60: Downgrade to Next.js v14 to fix incompatibilities with next-on-pages causing multiple bugs.
- 3a7210d: Fix zoom image view transition on Safari
- 718a8a5: Position the variant picker in the ToC
- e5dc05e: Update footer styling and allow for more than 4 footer groups
- 8276ba0: Make cookies access safer
- 1b8a456: Fix Image blocks zoomable behaviour
- 56c52e0: Handle Firefox security error on localStorage
- 0510b6f: Add section description to SectionGroupTile
- 1fcc807: Fix errors from customization not found
- 46edde9: Improve the OpenAPI package API
- 8af1abc: Improve contrast of search box placeholder
- 92b7668: Improve header offset
- d9c8d57: Do not dereference before caching OpenAPI spec.
- 94876e3: Fix regression issue with page icons for multi-line titles
- 47971dc: Fix OG image generation for non-latin characters
- 82dc9c4: Simplify the `useHash` algo used.
- 128ad20: Ignore cache invalidation error from local backend
- ff05e20: Improvements to inline images in headings
- cb100d5: Allow only good values for theme query parameter. Avoid having a 500 error when we pass an invalid value.
- d5aaccd: Remove use of deprecatd API createSitesPageFeedback
- 48ab59f: Improve colour contrast of list item decoration
- d2bc567: Set Sentry release
- 37d13d8: Avoid error on fetch by passing a string URL
- d3e573c: Generate sitemap for all sections and spaces
- f7b801b: Add feedback form to page rating control
- d370a3f: Update the routes for changes/revisions in multi-id mode to match the normal mode
- 46f63cb: Fix code format overriding inline link styles
- 5950657: Fix emojis display
- 528a053: Fix server actions stability leading to no results found sometimes on search
- eac1314: Lazy load iframely script to make page more responsive
- ad19060: Cards stand out slighly more on tinted and dark mode sites, and have better support for headings inside them
- 6f54826: New highlight colors
- 5c87ec7: Implement a safer way to interact with localStorage.
If it's disabled on the browser it should not throw error.
If it's disabled on the browser it should not throw error.
- 02d876e: Fix search UI behaviour
- f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
- 5576906: Fix table of content displaying arrow next to page with only hidden pages
- aaab157: Visual fix for section group in Safari
- cbe6139: Fix dynamic tabs infinite loop
- 65cc4af: Fix error when accessing a change request not found
- 727bde2: Improve and split OpenAPI parser into its own package
- 0b6ddca: Fix variant selector contrast for non-default themes
- 87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
- fde32e2: Force route handler to be dynamic to avoid errors
- a025118: Change card layout depending on cover aspect ratio
- 300f7bf: Fix search loading state
- 29d5979: Disable C/C++ highlight temporarily
- 18953b2: Subtler tint color when based on the primary color, by mixing in some gray
- 1c97536: Fix Sentry instrumentation
- b0bd871: Even safer localStorage
- b950a64: Avoid errors on legacy browsers
- 38061bd: Add section groups to section tabs
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
- 0e601e2: Improve styling of header buttons with shadows and high-contrast styles
- 6691492: Fix viewing PDF from space
- e8e64bf: Fix bullet list display on full size blocks
- 16194c5: Vertical orientation for sections list on sites without header
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
- 1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
- 1429384: Fix error when accessing some not found pages.
- 21cbd9e: Change link color to primary-subtle
- 5dab70f: Fix "Parser" language syntax highlighting
- deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
- 56331d2: Fix breadcrumbs emoji display + add contrast styles
- a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
- 44a20fe: Improve smoothness of scroll listener
- 5664e5a: Fix variant dropdown styling in header
- 6b50360: Fix view transition error on Safari
- 741dd49: Bump `heading-3` font size to offset it from paragraphs
- 5112e3e: Fix Sentry instrumentation server-side
- 1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
- Updated dependencies [d9029c7]
- Updated dependencies [6e54a06]
- Updated dependencies [162b4b7]
- Updated dependencies [e4e2f52]
- Updated dependencies [0c03676]
- Updated dependencies [3e5e458]
- Updated dependencies [46edde9]
- Updated dependencies [d9c8d57]
- Updated dependencies [ccf2cff]
- Updated dependencies [dda0cc6]
- Updated dependencies [eb7c22f]
- Updated dependencies [ea1468c]
- Updated dependencies [648f0e9]
- Updated dependencies [160fca1]
- Updated dependencies [f92e906]
- Updated dependencies [e721f17]
- Updated dependencies [727bde2]
- Updated dependencies [dff08ae]
- Updated dependencies [fc7b16f]
- Updated dependencies [fe8acc9]
- Updated dependencies [1823101]
- Updated dependencies [a652958]
- Updated dependencies [2f73db7]
- Updated dependencies [160fca1]
- Updated dependencies [12c7862]
- Updated dependencies [b41d425]
- @gitbook/react-openapi@1.0.0
- @gitbook/openapi-parser@1.0.0
- @gitbook/react-contentkit@0.6.0
- 02d876e: Fix search UI behaviour
- f4a90de: Fix two issues where pages would crash due Recoil not behaving correctly in RSC.
- 5576906: Fix table of content displaying arrow next to page with only hidden pages
- aaab157: Visual fix for section group in Safari
- cbe6139: Fix dynamic tabs infinite loop
- 65cc4af: Fix error when accessing a change request not found
- 727bde2: Improve and split OpenAPI parser into its own package
- 0b6ddca: Fix variant selector contrast for non-default themes
- 87b8ea8: Fix issue leading to increase the storage write and the stability of the platform
- fde32e2: Force route handler to be dynamic to avoid errors
- a025118: Change card layout depending on cover aspect ratio
- 300f7bf: Fix search loading state
- 29d5979: Disable C/C++ highlight temporarily
- 18953b2: Subtler tint color when based on the primary color, by mixing in some gray
- 1c97536: Fix Sentry instrumentation
- b0bd871: Even safer localStorage
- b950a64: Avoid errors on legacy browsers
- 38061bd: Add section groups to section tabs
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
- 0e601e2: Improve styling of header buttons with shadows and high-contrast styles
- 6691492: Fix viewing PDF from space
- e8e64bf: Fix bullet list display on full size blocks
- 16194c5: Vertical orientation for sections list on sites without header
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
- 1f8e416: Improve performances by highlighting code client-side if the code block is offscreen
- 1429384: Fix error when accessing some not found pages.
- 21cbd9e: Change link color to primary-subtle
- 5dab70f: Fix "Parser" language syntax highlighting
- deb8c54: Upgrade Next.js to v15, upgrade Shiki and use JS RegExp engine
- 56331d2: Fix breadcrumbs emoji display + add contrast styles
- a6f6591: Fix server actions cache compromised. Leading to some bugs on frontend.
- 44a20fe: Improve smoothness of scroll listener
- 5664e5a: Fix variant dropdown styling in header
- 6b50360: Fix view transition error on Safari
- 741dd49: Bump `heading-3` font size to offset it from paragraphs
- 5112e3e: Fix Sentry instrumentation server-side
- 1de338c: Remove animation on section tabs. Page is reloaded (for technical reasons), so the animation is not accurate here.
- Updated dependencies [d9029c7]
- Updated dependencies [6e54a06]
- Updated dependencies [162b4b7]
- Updated dependencies [e4e2f52]
- Updated dependencies [0c03676]
- Updated dependencies [3e5e458]
- Updated dependencies [46edde9]
- Updated dependencies [d9c8d57]
- Updated dependencies [ccf2cff]
- Updated dependencies [dda0cc6]
- Updated dependencies [eb7c22f]
- Updated dependencies [ea1468c]
- Updated dependencies [648f0e9]
- Updated dependencies [160fca1]
- Updated dependencies [f92e906]
- Updated dependencies [e721f17]
- Updated dependencies [727bde2]
- Updated dependencies [dff08ae]
- Updated dependencies [fc7b16f]
- Updated dependencies [fe8acc9]
- Updated dependencies [1823101]
- Updated dependencies [a652958]
- Updated dependencies [2f73db7]
- Updated dependencies [160fca1]
- Updated dependencies [12c7862]
- Updated dependencies [b41d425]
- @gitbook/react-openapi@1.0.0
- @gitbook/openapi-parser@1.0.0
- @gitbook/react-contentkit@0.6.0
## 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.
- 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
- 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
- e09f747: Revalidate change request cached content when pressing refresh button
- 2fa0851: Add navigation tabs for sections
- a4b63b8: Support resolution of new site URLs with sections
- 5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
- e9b31a5: Unify section tab styles with page item styles
- f12a215: Add support for Norwegian language
- f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
- 1f24fe4: Add support for page icons
- cda08a9: Add support for searching results in a sections site
- b32e40c: Persist state of tabs and dynamically sync them based on title
- 15d2ee3: Show the caption for file blocks
- f885e88: Improve the toolbar for change-requests and revisions to show more actions
- 07ea45b: Remove deprecated synced block from GitBook Open
- c3675fd: Added support for new Reusable Content block.
- 1f24fe4: Add support for icons style customization for sites
- 4c19014: Prevent search indexation for pages where it's configured as disabled
- 3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
- 1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
- 2c437f7: Fix linking to a tab itself
- e09f747: Revalidate change request cached content when pressing refresh button
- 2fa0851: Add navigation tabs for sections
- a4b63b8: Support resolution of new site URLs with sections
- 5c35f36: Replace all icons, previously imported from Geist, by new package `@gitbook/icons`
- e9b31a5: Unify section tab styles with page item styles
- f12a215: Add support for Norwegian language
- f4c9536: Optimize layout shift while transitioning between pages with full width blocks (ex: OpenAPI blocks)
- 1f24fe4: Add support for page icons
- cda08a9: Add support for searching results in a sections site
- b32e40c: Persist state of tabs and dynamically sync them based on title
- 15d2ee3: Show the caption for file blocks
- f885e88: Improve the toolbar for change-requests and revisions to show more actions
- 07ea45b: Remove deprecated synced block from GitBook Open
- c3675fd: Added support for new Reusable Content block.
- 1f24fe4: Add support for icons style customization for sites
- 4c19014: Prevent search indexation for pages where it's configured as disabled
- 3422ad4: Update rendering of community ads to match new API response, and make it possible to preview ads.
- 1152445: Changed the alternative URL resolution criteria in order to support site URLs without /v/ prefix
- 2c437f7: Fix linking to a tab itself
### Patch Changes
- aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
- a7066cc: Fix scroll position when navigating pages on mobile
- c754fc9: Add automatic color contrast in site header, restyle search button
- 5fe7adb: RND-3532: drop down menu for hidden links at small screen size
- 6295881: Change dark mode shadow for multi-space search toolbar
- f89b31c: Upgrade the scalar api client package
- 13c7534: Use ellipsis and fix icon color for more links in the header on small screen
- f885e88: Improve consistency of change request preview by removing cache-control on response
- 16e6171: Improve performances of loading pages with embeds by caching them
- 34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
- af9e66e: Only display spaces dropdown in compact header when site is multi-variants
- e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
- 042b850: Automatically scroll to active item in TOC
- d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
- bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
- fe9e6c1: Update ogimage with new design
- 17f71ba: Use url hash to open Expandable and scroll to anchor
- 3c07e65: Fix margin for paragraphs in quote blocks
- 636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
- f16560c: Include offset in calculations of whether scrollable element is in view
- 689f553: Fix inconsistent click area in table because of scroll indicator
- 6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
- e914903: Synchronize response and response example tabs
- 0f990c7: Show definition title when visible in cards
- e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
- 3996110: Optimize images rendered in community ads
- 133c3e7: Update design of Checkbox to be more consistent and readable
- 5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
- 0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
- 2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
- b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
- cb782a7: Fix "ip" being passed to BSA for community ads
- a7af3ca: Improving the look and feel of new section tabs
- 0bf985a: Don't show hidden pages in the empty state of a page
- d6c28a0: Update header styling of sections, variant selector, and button links
- aa32198: Avoid multiple <h1> in the page by using a <div> for the title in the header
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
- a7066cc: Fix scroll position when navigating pages on mobile
- c754fc9: Add automatic color contrast in site header, restyle search button
- 5fe7adb: RND-3532: drop down menu for hidden links at small screen size
- 6295881: Change dark mode shadow for multi-space search toolbar
- f89b31c: Upgrade the scalar api client package
- 13c7534: Use ellipsis and fix icon color for more links in the header on small screen
- f885e88: Improve consistency of change request preview by removing cache-control on response
- 16e6171: Improve performances of loading pages with embeds by caching them
- 34d36c6: Fix GitBook specific static assets not being served correctly when deployed on Cloudflare
- af9e66e: Only display spaces dropdown in compact header when site is multi-variants
- e3a3d6a: Improve perception of fast loading by not rendering skeletons for individual blocks in the top part of the viewport
- 042b850: Automatically scroll to active item in TOC
- d43202f: Optimize bundle size of the server output by reducing bundle size of shiki (skipping themes)
- bfbed1a: Ensure "Sponsored via GitBook" can be translated in all languages
- fe9e6c1: Update ogimage with new design
- 17f71ba: Use url hash to open Expandable and scroll to anchor
- 3c07e65: Fix margin for paragraphs in quote blocks
- 636b868: Use new cache backend, powered by Durable Objects, alongside the existing ones (KV, etc).
- f16560c: Include offset in calculations of whether scrollable element is in view
- 689f553: Fix inconsistent click area in table because of scroll indicator
- 6ce3cea: Stop using KV cache backend for now, but also improves it for higher performances
- e914903: Synchronize response and response example tabs
- 0f990c7: Show definition title when visible in cards
- e3a3d6a: Fix flickering when displaying an "Ask" answer with code blocks
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
- 3996110: Optimize images rendered in community ads
- 133c3e7: Update design of Checkbox to be more consistent and readable
- 5096f7f: Disable KV cache for docs.gitbook.com as a test, also disable it for change-request to improve consistency
- 0f1565c: Add optional env `GITBOOK_INTEGRATIONS_HOST` to configure the host serving the integrations
- 2ff7ed1: Fix table of contents being visible on mobile when disabled at the page level
- b075f0f: Fix accessibility of the table of contents by using `aria-current` instead of `aria-selected`
- cb782a7: Fix "ip" being passed to BSA for community ads
- a7af3ca: Improving the look and feel of new section tabs
- 0bf985a: Don't show hidden pages in the empty state of a page
- d6c28a0: Update header styling of sections, variant selector, and button links
- Change position of variant selector depending on context (next to logo or in table of contents)
- Update section tab styling and animation
- Make header buttons smaller with a new `medium` button size
- Change position of variant selector depending on context (next to logo or in table of contents)
- Update section tab styling and animation
- Make header buttons smaller with a new `medium` button size
- Updated dependencies [51fa3ab]
- Updated dependencies [9b8d519]
- Updated dependencies [cf3045a]
- Updated dependencies [f89b31c]
- Updated dependencies [d0f4860]
- Updated dependencies [ef9d012]
- Updated dependencies [094e9cd]
- Updated dependencies [636b868]
- Updated dependencies [56f5fa1]
- Updated dependencies [5c35f36]
- Updated dependencies [4247361]
- Updated dependencies [aa8c49e]
- Updated dependencies [e914903]
- Updated dependencies [4cbcc5b]
- Updated dependencies [0f1565c]
- Updated dependencies [237b703]
- Updated dependencies [51955da]
- Updated dependencies [a679e72]
- Updated dependencies [c079c3c]
- Updated dependencies [5c35f36]
- Updated dependencies [776bc31]
- @gitbook/react-openapi@0.7.0
- @gitbook/cache-do@0.1.0
- @gitbook/icons@0.1.0
- @gitbook/react-contentkit@0.5.1
- @gitbook/react-math@0.6.0
- Updated dependencies [51fa3ab]
- Updated dependencies [9b8d519]
- Updated dependencies [cf3045a]
- Updated dependencies [f89b31c]
- Updated dependencies [d0f4860]
- Updated dependencies [ef9d012]
- Updated dependencies [094e9cd]
- Updated dependencies [636b868]
- Updated dependencies [56f5fa1]
- Updated dependencies [5c35f36]
- Updated dependencies [4247361]
- Updated dependencies [aa8c49e]
- Updated dependencies [e914903]
- Updated dependencies [4cbcc5b]
- Updated dependencies [0f1565c]
- Updated dependencies [237b703]
- Updated dependencies [51955da]
- Updated dependencies [a679e72]
- Updated dependencies [c079c3c]
- Updated dependencies [5c35f36]
- Updated dependencies [776bc31]
- @gitbook/react-openapi@0.7.0
- @gitbook/cache-do@0.1.0
- @gitbook/icons@0.1.0
- @gitbook/react-contentkit@0.5.1
- @gitbook/react-math@0.6.0
## 0.3.0
### Minor Changes
- 24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
- 24b785c: Update shiki for code block syntax highlighting, with support for more languages and fixes for diffs. It also patches the deployment on Cloudflare to support edge functions larger than 4MB.
### Patch Changes
- acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
- Updated dependencies [709f1a1]
- Updated dependencies [ede2335]
- Updated dependencies [0426312]
- @gitbook/react-openapi@0.6.0
- acc3f2f: Fix error with the "Try it" of OpenAPI block because of the Scalar proxy failing on Cloudflare with the `cache` option
- Updated dependencies [709f1a1]
- Updated dependencies [ede2335]
- Updated dependencies [0426312]
- @gitbook/react-openapi@0.6.0
## 0.2.2
### Patch Changes
- Updated dependencies [3445db4]
- @gitbook/react-contentkit@0.5.0
- @gitbook/react-openapi@0.5.0
- @gitbook/react-math@0.5.0
- Updated dependencies [3445db4]
- @gitbook/react-contentkit@0.5.0
- @gitbook/react-openapi@0.5.0
- @gitbook/react-math@0.5.0
## 0.2.1
### Patch Changes
- Updated dependencies [24cd72e]
- @gitbook/react-contentkit@0.4.0
- @gitbook/react-math@0.4.0
- @gitbook/react-openapi@0.4.0
- Updated dependencies [24cd72e]
- @gitbook/react-contentkit@0.4.0
- @gitbook/react-math@0.4.0
- @gitbook/react-openapi@0.4.0
## 0.2.0
### Minor Changes
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
### Patch Changes
- Updated dependencies [de747b7]
- Updated dependencies [de747b7]
- @gitbook/react-contentkit@0.3.0
- @gitbook/react-openapi@0.3.0
- @gitbook/react-math@0.3.0
- Updated dependencies [de747b7]
- Updated dependencies [de747b7]
- @gitbook/react-contentkit@0.3.0
- @gitbook/react-openapi@0.3.0
- @gitbook/react-math@0.3.0
+18
View File
@@ -19,6 +19,7 @@ import {
type TestsCase,
allDeprecatedThemePresets,
allLocales,
allSearchStyles,
allSidebarBackgroundStyles,
allThemeModes,
allThemes,
@@ -647,6 +648,23 @@ const testCases: TestsCase[] = [
run: waitForCookiesDialog,
})),
]),
...allSearchStyles.flatMap((searchStyle) => ({
name: `Theme ${theme} Search ${searchStyle} Mode ${themeMode}`,
url: getCustomizationURL({
styling: {
theme,
search: searchStyle,
},
header: {
links: headerLinks,
},
themes: {
default: themeMode,
toggeable: false,
},
}),
run: waitForCookiesDialog,
})),
]),
// Deprecated header themes
...allDeprecatedThemePresets.flatMap((preset) => [
+9 -2
View File
@@ -2,12 +2,13 @@ import { argosScreenshot } from '@argos-ci/playwright';
import {
CustomizationBackground,
CustomizationCorners,
CustomizationFont,
CustomizationDefaultFont,
type CustomizationHeaderItem,
CustomizationHeaderPreset,
CustomizationIconsStyle,
CustomizationLinksStyle,
CustomizationLocale,
CustomizationSearchStyle,
CustomizationSidebarBackgroundStyle,
CustomizationSidebarListStyle,
CustomizationTheme,
@@ -109,6 +110,11 @@ export const allSidebarBackgroundStyles: CustomizationSidebarBackgroundStyle[] =
CustomizationSidebarBackgroundStyle.Filled,
];
export const allSearchStyles: CustomizationSearchStyle[] = [
CustomizationSearchStyle.Prominent,
CustomizationSearchStyle.Subtle,
];
// Common customization settings
export const headerLinks: CustomizationHeaderItem[] = [
@@ -249,7 +255,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
dangerColor: { light: '#FB2C36', dark: '#FB2C36' },
successColor: { light: '#00C950', dark: '#00C950' },
corners: CustomizationCorners.Rounded,
font: CustomizationFont.Inter,
font: CustomizationDefaultFont.Inter,
background: CustomizationBackground.Plain,
icons: CustomizationIconsStyle.Regular,
links: CustomizationLinksStyle.Default,
@@ -257,6 +263,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
background: CustomizationSidebarBackgroundStyle.Default,
list: CustomizationSidebarListStyle.Default,
},
search: CustomizationSearchStyle.Subtle,
},
internationalization: {
locale: CustomizationLocale.En,
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "gitbook",
"version": "0.7.3",
"version": "0.8.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/icons && rm -rf ./public/~gitbook/static/math"
},
"dependencies": {
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"@gitbook/cache-do": "workspace:*",
"@gitbook/cache-tags": "workspace:*",
"@gitbook/colors": "workspace:*",
@@ -59,7 +59,7 @@
"react-hotkeys-hook": "^4.4.1",
"rison": "^0.1.1",
"server-only": "^0.0.1",
"shiki": "^1.27.2",
"shiki": "^3.2.0",
"tailwind-merge": "^2.2.0",
"tailwind-shades": "^1.1.2",
"url-join": "^5.0.0",
@@ -1,6 +1,7 @@
// @ts-ignore
import nextOnPagesHandler from '@cloudflare/next-on-pages/fetch-handler';
import { withResponseCacheTags } from './lib/cache/response';
import { withMiddlewareHeadersStorage } from './lib/middleware';
/**
@@ -9,8 +10,8 @@ import { withMiddlewareHeadersStorage } from './lib/middleware';
*/
export default {
async fetch(request, env, ctx) {
const response = await withMiddlewareHeadersStorage(() =>
nextOnPagesHandler.fetch(request, env, ctx)
const response = await withResponseCacheTags(() =>
withMiddlewareHeadersStorage(() => nextOnPagesHandler.fetch(request, env, ctx))
);
return response;
@@ -25,7 +25,7 @@ import { IntegrationBlock } from './Integration';
import { List } from './List';
import { ListItem } from './ListItem';
import { BlockMath } from './Math';
import { OpenAPI } from './OpenAPI';
import { OpenAPIOperation, OpenAPISchemas } from './OpenAPI';
import { Paragraph } from './Paragraph';
import { Quote } from './Quote';
import { ReusableContent } from './ReusableContent';
@@ -82,7 +82,9 @@ export function Block<T extends DocumentBlock>(props: BlockProps<T>) {
return <Table {...props} block={block} />;
case 'swagger':
case 'openapi-operation':
return <OpenAPI {...props} block={block} />;
return <OpenAPIOperation {...props} block={block} />;
case 'openapi-schemas':
return <OpenAPISchemas {...props} block={block} />;
case 'embed':
return <Embed {...props} block={block} />;
case 'blockquote':
@@ -156,6 +158,7 @@ export function BlockSkeleton(props: { block: DocumentBlock; style: ClassValue }
case 'table':
case 'swagger':
case 'openapi-operation':
case 'openapi-schemas':
case 'math':
case 'divider':
case 'content-ref':
@@ -1,11 +1,11 @@
'use client';
import type { DocumentBlockCode } from '@gitbook/api';
import { useEffect, useRef, useState } from 'react';
import { useEffect, useMemo, useRef, useState } from 'react';
import { useInViewportListener } from '@/components/hooks/useInViewportListener';
import { useScrollListener } from '@/components/hooks/useScrollListener';
import { useDebounceCallback, useEventCallback } from 'usehooks-ts';
import { useDebounceCallback } from 'usehooks-ts';
import type { BlockProps } from '../Block';
import { CodeBlockRenderer } from './CodeBlockRenderer';
import type { HighlightLine, RenderedInline } from './highlight';
@@ -22,53 +22,82 @@ type ClientBlockProps = Pick<BlockProps<DocumentBlockCode>, 'block' | 'style'> &
export function ClientCodeBlock(props: ClientBlockProps) {
const { block, style, inlines } = props;
const blockRef = useRef<HTMLDivElement>(null);
const processedRef = useRef(false);
const isInViewportRef = useRef<boolean | null>(null);
const [lines, setLines] = useState<HighlightLine[]>(() => plainHighlight(block, []));
const isInViewportRef = useRef(false);
const [isInViewport, setIsInViewport] = useState(false);
const plainLines = useMemo(() => plainHighlight(block, []), [block]);
const [lines, setLines] = useState<null | HighlightLine[]>(null);
// Preload the highlighter when the block is mounted.
useEffect(() => {
import('./highlight').then(({ preloadHighlight }) => preloadHighlight(block));
}, [block]);
const runHighlight = useEventCallback(() => {
if (processedRef.current) {
return;
}
if (typeof window !== 'undefined') {
import('./highlight').then(({ highlight }) => {
highlight(block, inlines).then((lines) => {
setLines(lines);
processedRef.current = true;
});
});
}
});
const debouncedRunHighlight = useDebounceCallback(runHighlight, 1000);
// When user scrolls, we need to wait for the scroll to finish before running the highlight
const isScrollingRef = useRef(false);
const onFinishScrolling = useDebounceCallback(() => {
isScrollingRef.current = false;
// If the block is in the viewport after the scroll, we need to run the highlight
if (isInViewportRef.current) {
setIsInViewport(true);
}
}, 100);
useScrollListener(
() => {
isScrollingRef.current = true;
onFinishScrolling();
},
useRef(typeof window !== 'undefined' ? window : null)
);
// Detect when the block is in viewport
useInViewportListener(
blockRef,
(isInViewport, disconnect) => {
// Disconnect once in viewport
if (isInViewport) {
disconnect();
// If it's initially in viewport, we need to run the highlight
if (isInViewportRef.current === null) {
runHighlight();
}
}
isInViewportRef.current = isInViewport;
if (isScrollingRef.current) {
// If the user is scrolling, we don't want to run the highlight
// because it will be run when the scroll is finished
return;
}
if (isInViewport) {
// Disconnect once in viewport
disconnect();
setIsInViewport(true);
}
},
{ rootMargin: '200px' }
);
const handleScroll = useDebounceCallback(() => {
if (isInViewportRef.current) {
debouncedRunHighlight();
// When the block is visible or updated, we need to re-run the highlight
useEffect(() => {
if (isInViewport) {
// If the block is in viewport, we need to run the highlight
let cancelled = false;
if (typeof window !== 'undefined') {
import('./highlight').then(({ highlight }) => {
highlight(block, inlines).then((lines) => {
if (cancelled) {
return;
}
setLines(lines);
});
});
}
return () => {
cancelled = true;
};
}
}, 80);
useScrollListener(handleScroll, useRef(typeof window !== 'undefined' ? window : null));
// Otherwise if the block is not in viewport, we reset to the plain lines
setLines(null);
}, [isInViewport, block, inlines]);
return <CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines} />;
return (
<CodeBlockRenderer ref={blockRef} block={block} style={style} lines={lines ?? plainLines} />
);
}
@@ -46,7 +46,7 @@ it('should parse plain code', async () => {
it('should parse different code in parallel', async () => {
await Promise.all(
['shell', 'scss', 'markdown', 'less', 'scss', 'css', 'scss', 'yaml'].map(async (syntax) =>
['shell', 'scss', 'scss', 'css', 'scss', 'yaml'].map(async (syntax) =>
highlight(
{
object: 'block',
@@ -35,14 +35,11 @@ export type RenderedInline = {
const theme = createCssVariablesTheme();
const highlighter = createSingletonShorthands(
const { getSingletonHighlighter } = createSingletonShorthands(
createdBundledHighlighter<any, any>({
langs: bundledLanguages,
themes: {},
engine: () =>
createJavaScriptRegexEngine({
forgiving: true,
}),
engine: () => createJavaScriptRegexEngine({ forgiving: true, target: 'ES2018' }),
})
);
@@ -52,7 +49,7 @@ const highlighter = createSingletonShorthands(
export async function preloadHighlight(block: DocumentBlockCode) {
const langName = getBlockLang(block);
if (langName) {
await highlighter.getSingletonHighlighter({
await getSingletonHighlighter({
langs: [langName],
themes: [theme],
});
@@ -74,7 +71,12 @@ export async function highlight(
const code = getPlainCodeBlock(block);
const lines = await highlighter.codeToTokensBase(code, {
const highlighter = await getSingletonHighlighter({
langs: [langName],
themes: [theme],
});
const lines = highlighter.codeToTokensBase(code, {
lang: langName,
theme,
tokenizeMaxLineLength: 400,
@@ -132,12 +134,6 @@ function getLanguageForSyntax(syntax: string): BundledLanguage | null {
// Normalize the syntax to lowercase.
syntax = syntax.toLowerCase();
// Temporary disable highlighting for C/C++ code blocks
// @see https://github.com/shikijs/shiki/issues/893
if (syntax === 'cpp' || syntax === 'c') {
return null;
}
// Check if the syntax is a bundled language.
if (checkIsBundledLanguage(syntax)) {
return syntax;
@@ -104,8 +104,8 @@ const HINT_STYLES: {
'[&_.can-override-text]:text-neutral-strong',
],
container:
'bg-neutral theme-muted:bg-neutral-base theme-bold-tint:bg-neutral-base theme-gradient:bg-neutral-12/1 border-neutral',
containerWithHeader: 'border-info-solid bg-neutral-subtle theme-gradient:bg-neutral-12/1',
'bg-info border-info theme-muted-tint:bg-info-solid/2 theme-bold-tint:bg-info-solid/2',
containerWithHeader: 'border-info-solid bg-info-subtle',
},
warning: {
icon: 'circle-exclamation',
@@ -113,11 +113,13 @@ const HINT_STYLES: {
header: 'bg-warning-active',
body: [
'text-neutral-strong',
'[&_a]:text-warning',
'[&_a:hover]:text-warning-strong',
'links-default:[&_a]:text-warning',
'links-default:[&_a:hover]:text-warning-strong',
'links-default:[&_a]:decoration-warning/6',
'links-accent:[&_a]:decoration-warning',
'decoration-warning/6',
'[&_.can-override-bg]:bg-warning-active',
'[&_.can-override-text]:text-warning-strong',
'decoration-warning/6',
],
container: 'bg-warning border-warning',
containerWithHeader: 'border-warning-solid bg-warning-subtle',
@@ -128,11 +130,13 @@ const HINT_STYLES: {
header: 'bg-danger-active',
body: [
'text-neutral-strong',
'[&_a]:text-danger',
'[&_a:hover]:text-danger-strong',
'links-default:[&_a]:text-danger',
'links-default:[&_a:hover]:text-danger-strong',
'links-default:[&_a]:decoration-danger/6',
'links-accent:[&_a]:decoration-danger',
'decoration-danger/6',
'[&_.can-override-bg]:bg-danger-active',
'[&_.can-override-text]:text-danger-strong',
'decoration-danger/6',
],
container: 'bg-danger border-danger',
containerWithHeader: 'border-danger-solid bg-danger-subtle',
@@ -143,11 +147,13 @@ const HINT_STYLES: {
header: 'bg-success-active',
body: [
'text-neutral-strong',
'[&_a]:text-success',
'[&_a:hover]:text-success-strong',
'links-default:[&_a]:text-success',
'links-default:[&_a:hover]:text-success-strong',
'links-default:[&_a]:decoration-success/6',
'links-accent:[&_a]:decoration-success',
'decoration-success/6',
'[&_.can-override-bg]:bg-success-active',
'[&_.can-override-text]:text-success-strong',
'decoration-success/6',
],
container: 'bg-success border-success',
containerWithHeader: 'border-success-solid bg-success-subtle',
@@ -1,6 +1,6 @@
import type { JSONDocument } from '@gitbook/api';
import { Icon } from '@gitbook/icons';
import { OpenAPIOperation } from '@gitbook/react-openapi';
import { OpenAPIOperation as BaseOpenAPIOperation } from '@gitbook/react-openapi';
import { resolveOpenAPIOperationBlock } from '@/lib/openapi/resolveOpenAPIOperationBlock';
import { tcls } from '@/lib/tailwind';
@@ -12,21 +12,21 @@ import { Heading } from '../Heading';
import './scalar.css';
import './style.css';
import type { AnyOpenAPIBlock } from '@/lib/openapi/types';
import type { AnyOpenAPIOperationsBlock } from '@/lib/openapi/types';
/**
* Render an openapi block or an openapi-operation block.
*/
export async function OpenAPI(props: BlockProps<AnyOpenAPIBlock>) {
export async function OpenAPIOperation(props: BlockProps<AnyOpenAPIOperationsBlock>) {
const { style } = props;
return (
<div className={tcls('flex w-full', style, 'max-w-full')}>
<OpenAPIBody {...props} />
<OpenAPIOperationBody {...props} />
</div>
);
}
async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
async function OpenAPIOperationBody(props: BlockProps<AnyOpenAPIOperationsBlock>) {
const { block, context } = props;
if (!context.contentContext) {
@@ -53,7 +53,7 @@ async function OpenAPIBody(props: BlockProps<AnyOpenAPIBlock>) {
}
return (
<OpenAPIOperation
<BaseOpenAPIOperation
data={data}
context={{
specUrl,
@@ -0,0 +1,67 @@
import { resolveOpenAPISchemasBlock } from '@/lib/openapi/resolveOpenAPISchemasBlock';
import { tcls } from '@/lib/tailwind';
import { Icon } from '@gitbook/icons';
import { OpenAPISchemas as BaseOpenAPISchemas } from '@gitbook/react-openapi';
import type { BlockProps } from '../Block';
import './scalar.css';
import './style.css';
import type { OpenAPISchemasBlock } from '@/lib/openapi/types';
/**
* Render an openapi-schemas block.
*/
export async function OpenAPISchemas(props: BlockProps<OpenAPISchemasBlock>) {
const { style } = props;
return (
<div className={tcls('flex w-full', style, 'max-w-full')}>
<OpenAPISchemasBody {...props} />
</div>
);
}
async function OpenAPISchemasBody(props: BlockProps<OpenAPISchemasBlock>) {
const { block, context } = props;
if (!context.contentContext) {
return null;
}
const { data, specUrl, error } = await resolveOpenAPISchemasBlock({
block,
context: context.contentContext,
});
if (error) {
return (
<div className="hidden">
<p>
Error with {specUrl}: {error.message}
</p>
</div>
);
}
if (!data || !specUrl) {
return null;
}
return (
<BaseOpenAPISchemas
data={data}
context={{
specUrl,
icons: {
chevronDown: <Icon icon="chevron-down" />,
chevronRight: <Icon icon="chevron-right" />,
plus: <Icon icon="plus" />,
},
defaultInteractiveOpened: context.mode === 'print',
id: block.meta?.id,
blockKey: block.key,
}}
className="openapi-block"
/>
);
}
@@ -1 +1,2 @@
export * from './OpenAPI';
export * from './OpenAPIOperation';
export * from './OpenAPISchemas';
@@ -122,7 +122,7 @@
}
.openapi-column-preview-body {
@apply flex flex-col gap-4 sticky top-4 site-header:top-20 site-header-sections:top-32 page-api-block:xl:max-2xl:top-32 print-mode:static;
@apply flex flex-col gap-4 sticky top-4 site-header:top-20 site-header-sections:page-has-toc:top-32 page-api-block:xl:max-2xl:top-32 print-mode:static;
}
.openapi-column-preview pre {
@@ -198,7 +198,11 @@
}
.openapi-schema-required {
@apply text-amber-600 text-[0.813rem];
@apply text-warning-subtle text-[0.813rem];
}
.openapi-schema-readonly {
@apply text-primary-subtle/9 text-[0.813rem];
}
.openapi-schema-type {
@@ -389,7 +393,7 @@
/* Path */
.openapi-path {
@apply flex items-center bg-tint-base text-sm gap-2 p-2 border rounded-md border-tint-subtle;
@apply flex items-center bg-transparent text-sm gap-2 p-2 border rounded-md border-tint-subtle;
}
.openapi-path .openapi-method {
@@ -16,25 +16,20 @@ export function Footer(props: { context: GitBookSiteContext }) {
const { customization } = context;
return (
<>
<hr className="border-tint-subtle border-t" />
<footer
className={tcls(
'border-tint-subtle border-t',
// If the footer only contains a mode toggle, we only show it on smaller screens
customization.themes.toggeable &&
!customization.footer.copyright &&
!customization.footer.logo &&
customization.footer.groups?.length === 0
? 'xl:hidden'
: null
)}
>
<div className="scroll-nojump">
<footer
className={tcls(
CONTAINER_STYLE,
'px-4',
'mx-auto',
'flex',
'gap-12',
// If the footer only contains a mode toggle, we only show it on smaller screens
customization.themes.toggeable &&
!customization.footer.copyright &&
!customization.footer.logo &&
customization.footer.groups?.length === 0
? 'xl:hidden'
: null
)}
>
<div className={tcls(CONTAINER_STYLE, 'px-4', 'mx-auto', 'flex', 'gap-12')}>
<div className="hidden page-no-toc:hidden basis-72 lg:block" />
<div
className={tcls(
@@ -137,8 +132,8 @@ export function Footer(props: { context: GitBookSiteContext }) {
</div>
</div>
<div className="hidden page-no-toc:hidden lg:block xl:basis-56" />
</footer>
</div>
</div>
</>
</footer>
);
}
@@ -44,7 +44,6 @@ export function Dropdown<E extends HTMLElement>(props: {
'absolute',
'top-full',
'left-0',
'z-20',
'origin-top-left',
'invisible',
'transition-opacity',
@@ -54,22 +53,24 @@ export function Dropdown<E extends HTMLElement>(props: {
className
)}
>
<div
className={tcls(
'mt-2',
'w-full',
'bg-tint-base',
'rounded-lg',
'straight-corners:rounded-sm',
'p-2',
'shadow-1xs',
'overflow-auto',
'ring-1',
'ring-tint-subtle',
'focus:outline-none'
)}
>
{children}
<div className="fixed z-50 w-52">
<div
className={tcls(
'mt-2',
'w-full',
'bg-tint-base',
'rounded-lg',
'straight-corners:rounded-sm',
'p-2',
'shadow-1xs',
'overflow-auto',
'ring-1',
'ring-tint-subtle',
'focus:outline-none'
)}
>
{children}
</div>
</div>
</div>
</div>
@@ -20,7 +20,6 @@ import { SpacesDropdown } from './SpacesDropdown';
export function Header(props: { context: GitBookSiteContext; withTopHeader?: boolean }) {
const { context, withTopHeader } = props;
const { siteSpace, siteSpaces, sections, customization } = context;
const isMultiVariants = siteSpaces.length > 1;
return (
<header
@@ -31,7 +30,7 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
`h-[${HEADER_HEIGHT_DESKTOP}px]`,
'sticky',
'top-0',
'z-10',
'z-30',
'w-full',
'flex-none',
'shadow-[0px_1px_0px]',
@@ -56,11 +55,11 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
'theme-bold:shadow-tint-12/2'
)}
>
<div className={tcls('scroll-nojump')}>
<div className="scroll-nojump">
<div
className={tcls(
'gap-4',
'lg:gap-8',
'lg:gap-6',
'flex',
'items-center',
'justify-between',
@@ -68,14 +67,12 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
'py-3',
'min-h-16',
'sm:h-16',
isMultiVariants && 'page-no-toc:max-[400px]:flex-wrap',
CONTAINER_STYLE
)}
>
<div
className={tcls(
'flex max-w-full',
isMultiVariants && 'page-no-toc:max-[400px]:w-full',
'flex max-w-full lg:basis-72',
'min-w-0 shrink items-center justify-start gap-2 lg:gap-4'
)}
>
@@ -86,44 +83,35 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
'text-tint-strong',
'theme-bold:text-header-link',
'hover:bg-tint-hover',
'theme-bold:hover:bg-header-link/3'
'theme-bold:hover:bg-header-link/3',
'page-no-toc:hidden'
)}
/>
<HeaderLogo context={context} />
</div>
{isMultiVariants && (
<div className="mr-auto page-no-toc:flex hidden">
<SpacesDropdown
context={context}
siteSpace={siteSpace}
siteSpaces={siteSpaces}
className={
'theme-bold:bg-header-link/2 theme-bold:text-header-link theme-bold:ring-header-link/4 theme-bold:group-focus-within/dropdown:bg-header-link/3 theme-bold:group-focus-within/dropdown:text-header-link theme-bold:group-focus-within/dropdown:ring-header-link/6 theme-bold:group-hover/dropdown:bg-header-link/3 theme-bold:group-hover/dropdown:text-header-link theme-bold:group-hover/dropdown:ring-header-link/6 theme-bold:contrast-more:bg-header-background theme-bold:contrast-more:text-header-link theme-bold:contrast-more:ring-header-link theme-bold:contrast-more:group-hover/dropdown:text-header-link theme-bold:contrast-more:group-hover/dropdown:ring-header-link theme-bold:contrast-more:group-focus-within/dropdown:text-header-link theme-bold:contrast-more:group-focus-within/dropdown:ring-header-link theme-bold:dark:bg-header-link/2 theme-bold:dark:text-header-link theme-bold:dark:ring-header-link/4 theme-bold:dark:group-hover/dropdown:bg-header-link/3 theme-bold:dark:group-hover/dropdown:text-header-link theme-bold:dark:group-hover/dropdown:ring-header-link/6 theme-bold:contrast-more:dark:group-hover/dropdown:text-header-link theme-bold:contrast-more:dark:group-hover/dropdown:ring-header-link theme-bold:dark:group-focus-within/dropdown:bg-header-link/3 theme-bold:dark:group-focus-within/dropdown:text-header-link theme-bold:dark:group-focus-within/dropdown:ring-header-link/6 theme-bold:contrast-more:dark:group-focus-within/dropdown:text-header-link theme-bold:contrast-more:dark:group-focus-within/dropdown:ring-header-link'
}
/>
</div>
)}
{customization.header.links.length > 0 && (
<HeaderLinks>
{customization.header.links.map((link, index) => {
return <HeaderLink key={index} link={link} context={context} />;
})}
<HeaderLinkMore
label={t(getSpaceLanguage(customization), 'more')}
links={customization.header.links}
context={context}
/>
</HeaderLinks>
)}
<div
className={tcls(
'flex',
'md:min-w-56',
'grow-0',
'shrink-0',
'justify-self-end'
'md:basis-56',
'justify-self-end',
'search' in customization.styling &&
customization.styling.search === 'prominent'
? [
'md:grow-[0.8]',
'lg:basis-40',
'max-w-lg',
'lg:ml-[max(calc((100%-18rem-48rem-3rem)/2),1.5rem)]', // container (100%) - sidebar (18rem) - content (48rem) - margin (3rem)
'xl:ml-[max(calc((100%-18rem-48rem-14rem-3rem)/2),1.5rem)]', // container (100%) - sidebar (18rem) - content (48rem) - outline (14rem) - margin (3rem)
'page-no-toc:lg:ml-[max(calc((100%-18rem-48rem-18rem-3rem)/2),0rem)]',
'page-full-width:lg:ml-6',
'lg:mr-auto',
'order-last',
'md:order-[unset]',
]
: ['order-last']
)}
>
<Suspense fallback={null}>
@@ -152,6 +140,7 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
'theme-bold:shadow-none',
'theme-bold:hover:shadow-none',
'whitespace-nowrap',
]}
>
<span className={tcls('flex-1')}>
@@ -166,11 +155,70 @@ export function Header(props: { context: GitBookSiteContext; withTopHeader?: boo
</SearchButton>
</Suspense>
</div>
{customization.header.links.length > 0 && (
<HeaderLinks>
{customization.header.links.map((link) => {
return (
<HeaderLink
key={link.title}
link={link}
context={context}
/>
);
})}
<HeaderLinkMore
label={t(getSpaceLanguage(customization), 'more')}
links={customization.header.links}
context={context}
/>
</HeaderLinks>
)}
</div>
</div>
</div>
{sections ? (
<SiteSectionTabs sections={encodeClientSiteSections(context, sections)} />
{sections || siteSpaces.length > 1 ? (
<div
className={tcls(
'w-full',
'overflow-x-scroll',
'overflow-y-hidden',
'hide-scroll',
'-mb-4 pb-4', // Positive padding / negative margin allows the navigation menu indicator to show in a scroll viewƒ
!sections ? ['hidden', 'page-no-toc:flex'] : 'flex'
)}
>
<div
className={tcls(
CONTAINER_STYLE,
'page-default-width:max-w-[unset]',
'grow',
'flex',
'items-end',
'page-default-width:2xl:px-[calc((100%-1536px+4rem)/2)]'
)}
>
{siteSpaces.length > 1 && (
<div
id="variants"
className="my-2 mr-5 page-no-toc:flex hidden grow border-tint border-r pr-5 *:grow only:mr-0 only:border-none only:pr-0 sm:max-w-64"
>
<SpacesDropdown
context={context}
siteSpace={siteSpace}
siteSpaces={siteSpaces}
className="w-full grow py-1"
/>
</div>
)}
{sections && (
<SiteSectionTabs
sections={encodeClientSiteSections(context, sections)}
/>
)}
</div>
</div>
) : null}
</header>
);
@@ -34,7 +34,7 @@ export async function HeaderLink(props: {
if (link.links && link.links.length > 0) {
return (
<Dropdown
className="shrink"
className={`shrink ${customization.styling.search === 'prominent' ? 'right-0 left-auto' : null}`}
button={(buttonProps) => {
if (!target || !link.to) {
return (
@@ -151,8 +151,8 @@ function HeaderItemButton(
function getHeaderLinkClassName(_props: { headerPreset: CustomizationHeaderPreset }) {
return tcls(
'flex items-center shrink',
'min-w-0',
'flex items-center',
'shrink',
'contrast-more:underline',
'truncate',
@@ -45,7 +45,13 @@ export function HeaderLinkMore(props: {
return (
<div className={`${styles.linkEllipsis} z-20 items-center`}>
<Dropdown button={renderButton} className="-translate-x-48 md:translate-x-0">
<Dropdown
button={renderButton}
className={tcls(
'max-md:right-0 max-md:left-auto',
context.customization.styling.search === 'prominent' && 'right-0 left-auto'
)}
>
<DropdownMenu>
{links.map((link, index) => (
<MoreMenuLink key={index} link={link} context={context} />
@@ -1,19 +1,21 @@
import type React from 'react';
import { tcls } from '@/lib/tailwind';
import { type ClassValue, tcls } from '@/lib/tailwind';
import styles from './headerLinks.module.css';
interface HeaderLinksProps {
children: React.ReactNode;
style?: ClassValue;
}
export async function HeaderLinks({ children }: HeaderLinksProps) {
export async function HeaderLinks({ children, style }: HeaderLinksProps) {
return (
<div
className={tcls(
styles.containerHeaderlinks,
'lg:[&>.button+.button]:-ml-2 z-20 flex min-w-9 shrink grow items-center justify-end gap-x-4 lg:gap-x-6'
'lg:[&>.button+.button]:-ml-2 z-20 ml-auto flex min-w-9 shrink grow items-center justify-end gap-x-4 lg:gap-x-6 xl:grow-0',
style
)}
>
{children}
@@ -55,6 +55,7 @@ export async function HeaderLogo(props: HeaderLogoProps) {
'min-w-0',
'max-w-40',
'lg:max-w-64',
'site-header-none:page-no-toc:lg:max-w-56',
'max-h-10',
'lg:max-h-12',
'h-full',
@@ -84,7 +85,7 @@ function LogoFallback(props: HeaderLogoProps) {
<div
className={tcls(
'text-pretty',
'line-clamp-3',
'line-clamp-2',
'tracking-tight',
'max-w-[18ch]',
'lg:max-w-[24ch]',
@@ -54,7 +54,6 @@ export function HeaderMobileMenu(props: Partial<React.ButtonHTMLAttributes<HTMLB
'px-2',
'rounded',
'straight-corners:rounded-sm',
'page-no-toc:hidden',
props.className
)}
>
@@ -63,7 +63,7 @@ export function SpacesDropdown(props: {
className
)}
>
<span className={tcls('line-clamp-2', 'grow')}>{siteSpace.title}</span>
<span className={tcls('truncate', 'grow')}>{siteSpace.title}</span>
<DropdownChevron />
</div>
)}
@@ -1,6 +1,8 @@
.containerHeaderlinks {
container-type: inline-size;
container-name: headerlinks;
@media (max-width: 1279px) {
.containerHeaderlinks {
container-type: inline-size;
container-name: headerlinks;
}
}
.linkEllipsis {
@@ -43,7 +45,7 @@
}
}
}
@container headerlinks (width < 600px) {
@container headerlinks (width < 550px) {
.containerHeaderlinks > :nth-child(n + 4) {
display: none;
}
@@ -54,7 +56,7 @@
}
}
}
@container headerlinks (width < 750px) {
@container headerlinks (width < 650px) {
.containerHeaderlinks > :nth-child(n + 5) {
display: none;
}
@@ -65,7 +67,7 @@
}
}
}
@container headerlinks (width < 850px) {
@container headerlinks (width < 750px) {
.containerHeaderlinks > :nth-child(n + 6) {
display: none;
}
@@ -48,8 +48,11 @@ export function PageAside(props: {
'group/aside',
'hidden',
'xl:flex',
// 'page-no-toc:lg:flex',
'flex-col',
'basis-56',
// 'page-no-toc:basis-40',
// 'page-no-toc:xl:basis-56',
'grow-0',
'shrink-0',
'break-anywhere', // To prevent long words in headings from breaking the layout
@@ -47,12 +47,12 @@ export function PageBody(props: {
'page-api-block:xl:max-2xl:pr-0',
// Max size to ensure one column in api is aligned with rest of content (2 x 3xl) + (gap-3 + 2) * px-12
'page-api-block:max-w-[1654px]',
'page-api-block:mx-auto',
'page-api-block:mx-auto'
page.layout.tableOfContents ? null : 'xl:ml-56'
// page.layout.tableOfContents ? null : 'xl:ml-56'
) +
(asFullWidth ? ' page-full-width' : '') +
(!page.layout.tableOfContents ? ' page-no-toc' : '')
(asFullWidth ? ' page-full-width' : ' page-default-width') +
(!page.layout.tableOfContents ? ' page-no-toc' : ' page-has-toc')
}
>
<PreservePageLayout asFullWidth={asFullWidth} />
@@ -32,7 +32,11 @@ export async function PageCover(props: {
'sm:-mx-6',
'md:-mx-8',
'-lg:mr-8',
page.layout.tableOfContents ? 'lg:ml-0' : null,
'lg:ml-0',
!page.layout.tableOfContents &&
context.customization.header.preset !== 'none'
? 'lg:-ml-64'
: null,
]
: ['sm:mx-auto', 'max-w-3xl', 'sm:rounded-md', 'mb-8']
)}
@@ -55,7 +55,7 @@ export async function CustomizationRootLayout(props: {
lang={customization.internationalization.locale}
className={tcls(
customization.header.preset === CustomizationHeaderPreset.None
? null
? 'site-header-none'
: 'scroll-pt-[76px]', // Take the sticky header in consideration for the scrolling
customization.styling.corners === CustomizationCorners.Straight
? ' straight-corners'
@@ -43,8 +43,8 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
'justify-center',
'items-center',
'w-full',
'px-3',
'py-2',
'px-3',
'gap-2',
'bg-tint-base',
@@ -81,10 +81,11 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
'contrast-more:focus:ring-tint-12',
'active:shadow-sm',
'active:scale-98',
'active:scale-100',
'md:justify-start',
'md:w-full',
'text-sm',
style
)}
>
@@ -99,7 +100,7 @@ export function SearchButton(props: { children?: React.ReactNode; style?: ClassV
}
const Shortcut = () => {
const [operatingSystem, setOperatingSystem] = useState('win');
const [operatingSystem, setOperatingSystem] = useState<string | null>(null);
useEffect(() => {
function getOperatingSystem() {
@@ -114,21 +115,31 @@ const Shortcut = () => {
setOperatingSystem(getOperatingSystem());
}, []);
return (
return operatingSystem ? (
<div
className={tcls(
'shortcut',
'hidden',
'md:inline',
'md:flex',
'gap-0.5',
'-mr-1',
'justify-end',
'text-xs',
'text-tint',
'contrast-more:text-tint-strong',
'whitespace-nowrap',
`[font-feature-settings:"calt",_"case"]`
`[font-feature-settings:"calt",_"case"]`,
'animate-fadeIn'
)}
>
{operatingSystem === 'mac' ? '⌘' : 'Ctrl +'}K
<kbd
className={`flex h-5 min-w-5 items-center justify-center rounded border border-tint-subtle theme-bold:border-header-link/5 bg-tint-base theme-bold:bg-header-background px-1 ${operatingSystem === 'mac' ? 'text-sm' : ''}`}
>
{operatingSystem === 'mac' ? '⌘' : 'Ctrl'}
</kbd>
<kbd className="flex size-5 items-center justify-center rounded border border-tint-subtle theme-bold:border-header-link/5 bg-tint-base theme-bold:bg-header-background">
K
</kbd>
</div>
);
) : null;
};
@@ -84,7 +84,7 @@ export function SearchModal(props: SearchModalProps) {
'bg-tint-12/4',
'dark:bg-tint-1/6',
'backdrop-blur-2xl',
'z-30',
'z-50',
'px-4',
'pt-4',
'md:pt-[min(8vh,6rem)]'
@@ -12,7 +12,8 @@ import { SpaceLayout } from '@/components/SpaceLayout';
import { buildVersion } from '@/lib/build';
import { isSiteIndexable } from '@/lib/seo';
import { GITBOOK_API_URL, GITBOOK_ASSETS_URL } from '@v2/lib/env';
import { GITBOOK_API_PUBLIC_URL, GITBOOK_ASSETS_URL, GITBOOK_ICONS_URL } from '@v2/lib/env';
import { getResizedImageURL } from '@v2/lib/images';
import { ClientContexts } from './ClientContexts';
import { RocketLoaderDetector } from './RocketLoaderDetector';
@@ -31,7 +32,8 @@ export async function SiteLayout(props: {
const { scripts, customization } = context;
ReactDOM.preconnect(GITBOOK_API_URL);
ReactDOM.preconnect(GITBOOK_API_PUBLIC_URL);
ReactDOM.preconnect(GITBOOK_ICONS_URL);
if (GITBOOK_ASSETS_URL) {
ReactDOM.preconnect(GITBOOK_ASSETS_URL);
}
@@ -95,33 +97,43 @@ export async function generateSiteLayoutViewport(context: GitBookSiteContext): P
}
export async function generateSiteLayoutMetadata(context: GitBookSiteContext): Promise<Metadata> {
const { site, customization, linker } = context;
const { site, customization, linker, imageResizer } = context;
const customIcon = 'icon' in customization.favicon ? customization.favicon.icon : null;
const faviconSize = 48;
const icons = [
{
url: customIcon?.light
? await getResizedImageURL(imageResizer, customIcon.light, {
width: faviconSize,
height: faviconSize,
})
: linker.toAbsoluteURL(
linker.toPathInContent('~gitbook/icon?size=small&theme=light')
),
type: 'image/png',
media: '(prefers-color-scheme: light)',
},
{
url: customIcon?.dark
? await getResizedImageURL(imageResizer, customIcon.dark, {
width: faviconSize,
height: faviconSize,
})
: linker.toAbsoluteURL(
linker.toPathInContent('~gitbook/icon?size=small&theme=dark')
),
type: 'image/png',
media: '(prefers-color-scheme: dark)',
},
];
return {
title: site.title,
generator: `GitBook (${buildVersion()})`,
icons: {
icon: [
{
url:
customIcon?.light ??
linker.toAbsoluteURL(
linker.toPathInContent('~gitbook/icon?size=small&theme=light')
),
type: 'image/png',
media: '(prefers-color-scheme: light)',
},
{
url:
customIcon?.dark ??
linker.toAbsoluteURL(
linker.toPathInContent('~gitbook/icon?size=small&theme=dark')
),
type: 'image/png',
media: '(prefers-color-scheme: dark)',
},
],
icon: icons,
apple: icons,
},
robots: (await isSiteIndexable(context)) ? 'index, follow' : 'noindex, nofollow',
};
@@ -10,6 +10,7 @@ import { PageBody, PageCover } from '@/components/PageBody';
import { getPagePath } from '@/lib/pages';
import { isPageIndexable, isSiteIndexable } from '@/lib/seo';
import { getResizedImageURL } from '@v2/lib/images';
import { PageClientLayout } from './PageClientLayout';
import { type PagePathParams, fetchPageData, getPathnameParam, normalizePathname } from './fetch';
@@ -118,7 +119,7 @@ export async function generateSitePageMetadata(props: SitePageProps): Promise<Me
}
const { page, ancestors } = pageTarget;
const { site, customization, pages, linker } = context;
const { site, customization, pages, linker, imageResizer } = context;
return {
title: [page.title, site.title].filter(Boolean).join(' | '),
@@ -131,8 +132,12 @@ export async function generateSitePageMetadata(props: SitePageProps): Promise<Me
},
openGraph: {
images: [
customization.socialPreview.url ??
linker.toAbsoluteURL(linker.toPathInContent(`~gitbook/ogimage/${page.id}`)),
customization.socialPreview.url
? await getResizedImageURL(imageResizer, customization.socialPreview.url, {
width: 1200,
height: 630,
})
: linker.toAbsoluteURL(linker.toPathInContent(`~gitbook/ogimage/${page.id}`)),
],
},
robots:
@@ -137,12 +137,13 @@ export function SiteSectionGroupItem(props: {
return (
<>
<button
type="button"
onClick={(event) => {
event.preventDefault();
event.stopPropagation();
setIsVisible((prev) => !prev);
}}
className={`group/section-link flex w-full flex-row items-center gap-3 rounded-md straight-corners:rounded-none px-3 py-2 transition-all hover:bg-tint-hover hover:text-tint-strong contrast-more:hover:ring-1 contrast-more:hover:ring-tint ${
className={`group/section-link flex w-full flex-row items-center gap-3 rounded-md straight-corners:rounded-none px-3 py-2 text-left transition-all hover:bg-tint-hover hover:text-tint-strong contrast-more:hover:ring-1 contrast-more:hover:ring-tint ${
isActiveGroup
? 'font-semibold text-primary hover:bg-primary-hover hover:text-primary-strong contrast-more:text-primary-strong contrast-more:hover:ring-1 contrast-more:hover:ring-primary-hover'
: null
@@ -6,7 +6,6 @@ import React from 'react';
import { Link } from '@/components/primitives';
import { tcls } from '@/lib/tailwind';
import { SectionIcon } from './SectionIcon';
import type { ClientSiteSection, ClientSiteSections } from './encodeClientSiteSections';
@@ -21,26 +20,27 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
} = props;
const [value, setValue] = React.useState<string | null>();
const [offset, setOffset] = React.useState<number | null>(null);
const scrollableViewRef = React.useRef<HTMLDivElement>(null);
const menuContainerRef = React.useRef<HTMLDivElement>(null);
const onNodeUpdate = (trigger: HTMLButtonElement | null, itemValue: string, size = 0) => {
const padding = 16;
const margin = -12; // Offsetting the menu container's negative margin
const windowWidth = document.documentElement.clientWidth;
const windowBuffer = 16; // constrain to within the window with some buffer on the left and right we don't want the menu to enter
const viewportWidth =
size < MIN_ITEMS_FOR_COLS
? VIEWPORT_ITEM_WIDTH + padding
: VIEWPORT_ITEM_WIDTH * 2 + padding;
const minOffset = 0 - (menuContainerRef.current?.offsetLeft ?? 0) + margin;
const maxOffset = minOffset + windowWidth - viewportWidth;
if (windowWidth < 768) {
// if the screen is small don't offset the menu
setOffset(0);
setOffset(minOffset + windowBuffer);
} else if (trigger && value === itemValue) {
const padding = 16;
const viewportWidth =
size < MIN_ITEMS_FOR_COLS
? VIEWPORT_ITEM_WIDTH + padding
: VIEWPORT_ITEM_WIDTH * 2 + padding;
const scrollLeft = scrollableViewRef.current?.scrollLeft ?? 0;
const triggerOffset = trigger.offsetLeft - scrollLeft; // offset of the trigger from the left edge including scrolling
const bufferLeft = 2; // offset the menu viewport should not pass on the left side of window
const bufferRight = windowWidth - (16 + viewportWidth); // offset the menu viewport should not pass on the right side of the window
const position = minOffset + trigger?.getBoundingClientRect().left;
setOffset(
// constrain to within the window with some buffer on the left and right we don't want the menu to enter
Math.min(bufferRight, Math.max(bufferLeft, Math.round(triggerOffset)))
Math.min(maxOffset - windowBuffer, Math.max(minOffset + windowBuffer, position))
);
} else if (!value) {
setOffset(null);
@@ -50,14 +50,16 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
return sectionsAndGroups.length > 0 ? (
<NavigationMenu.Root
aria-label="Sections"
id="sections"
onValueChange={setValue}
className="relative z-10 mx-auto flex w-full max-w-screen-2xl page-full-width:max-w-full flex-nowrap items-center"
className="z-10 flex w-full flex-nowrap items-center"
>
<div
ref={scrollableViewRef}
className="hide-scroll -mb-4 w-full overflow-y-hidden overflow-x-scroll pb-4" /* Positive padding / negative margin allows the navigation menu indicator to show in a scroll view */
ref={menuContainerRef}
className="-mx-3"
// className="-mb-4 pb-4" /* Positive padding / negative margin allows the navigation menu indicator to show in a scroll view */
>
<NavigationMenu.List className="center m-0 flex list-none gap-2 bg-transparent px-1 sm:px-3 md:px-5">
<NavigationMenu.List className="center m-0 flex list-none gap-2 bg-transparent">
{sectionsAndGroups.map((sectionOrGroup) => {
const { id, title, icon } = sectionOrGroup;
const isGroup = sectionOrGroup.object === 'site-section-group';
@@ -121,11 +123,11 @@ export function SiteSectionTabs(props: { sections: ClientSiteSections }) {
className="absolute top-full flex transition-transform duration-200 ease-in-out"
style={{
display: offset === null ? 'none' : undefined,
transform: offset ? `translateX(${offset}px)` : undefined,
transform: offset ? `translateX(${offset}px) translateZ(0)` : 'translateZ(0)', // TranslateZ is needed to force a stacking context, fixing a rendering bug on Safari
}}
>
<NavigationMenu.Viewport
className="relative mt-3 ml-4 h-[var(--radix-navigation-menu-viewport-height)] w-[calc(100vw_-_2rem)] origin-[top_center] overflow-hidden rounded straight-corners:rounded-none bg-tint shadow-1xs shadow-dark/1 duration-250 data-[state=closed]:duration-150 motion-safe:transition-[width,_height,_transform] data-[state=closed]:motion-safe:animate-scaleOut data-[state=open]:motion-safe:animate-scaleIn md:mx-0 md:w-[var(--radix-navigation-menu-viewport-width)] dark:shadow-dark/4"
className="relative mt-3 h-[var(--radix-navigation-menu-viewport-height)] w-[calc(100vw_-_2rem)] origin-[top_center] overflow-hidden rounded straight-corners:rounded-none bg-tint shadow-1xs shadow-dark/1 duration-250 data-[state=closed]:duration-150 motion-safe:transition-[width,_height,_transform] data-[state=closed]:motion-safe:animate-scaleOut data-[state=open]:motion-safe:animate-scaleIn md:mx-0 md:w-[var(--radix-navigation-menu-viewport-width)] dark:shadow-dark/4"
style={{
translate:
undefined /* don't move this to a Tailwind class as Radix renders viewport incorrectly for a few frames */,
@@ -11,7 +11,7 @@ import { getSpaceLanguage } from '@/intl/server';
import { t } from '@/intl/translate';
import { tcls } from '@/lib/tailwind';
import { GITBOOK_APP_URL } from '@v2/lib/env';
import { GITBOOK_API_PUBLIC_URL, GITBOOK_APP_URL } from '@v2/lib/env';
import { SpacesDropdown } from '../Header/SpacesDropdown';
import { InsightsProvider } from '../Insights';
import { SiteSectionList, encodeClientSiteSections } from '../SiteSections';
@@ -51,7 +51,7 @@ export function SpaceLayout(props: {
<InsightsProvider
enabled={withTracking}
appURL={GITBOOK_APP_URL}
apiHost={context.dataFetcher.apiEndpoint}
apiHost={GITBOOK_API_PUBLIC_URL}
visitorAuthToken={visitorAuthToken}
organizationId={context.organizationId}
siteId={context.site.id}
@@ -85,7 +85,8 @@ export function SpaceLayout(props: {
'lg:flex',
'grow-0',
'flex-wrap',
'dark:shadow-light/1'
'dark:shadow-light/1',
'text-base/tight'
)}
>
<HeaderLogo context={context} />
@@ -106,6 +107,7 @@ export function SpaceLayout(props: {
? 'search_or_ask'
: 'search'
)}
...
</span>
</SearchButton>
</React.Suspense>
@@ -122,7 +124,11 @@ export function SpaceLayout(props: {
context={context}
siteSpace={siteSpace}
siteSpaces={siteSpaces}
className={tcls('w-full')}
className={tcls(
'w-full',
'page-no-toc:hidden',
'site-header-none:page-no-toc:flex'
)}
/>
)}
</>
@@ -21,12 +21,13 @@ export function TableOfContents(props: {
data-testid="table-of-contents"
className={tcls(
'group',
'page-no-toc:hidden',
'text-sm',
'grow-0',
'shrink-0',
'basis-full',
'lg:basis-72',
'page-no-toc:lg:basis-56',
'relative',
'z-[1]',
@@ -46,10 +47,14 @@ export function TableOfContents(props: {
'pt-6',
'pb-4',
'sidebar-filled:lg:pr-6',
'page-no-toc:lg:pr-0',
'hidden',
'navigation-open:flex',
'navigation-open:!flex',
'lg:flex',
'page-no-toc:lg:hidden',
'page-no-toc:xl:flex',
'site-header-none:page-no-toc:lg:flex',
'flex-col',
'gap-4',
@@ -73,6 +78,7 @@ export function TableOfContents(props: {
'theme-bold-tint:bg-tint-subtle',
'[html.sidebar-filled.theme-muted_&]:bg-tint-base',
'[html.sidebar-filled.theme-bold.tint_&]:bg-tint-base',
'page-no-toc:!bg-transparent',
'sidebar-filled:rounded-xl',
'straight-corners:rounded-none'
@@ -101,7 +107,11 @@ export function TableOfContents(props: {
rootPages={pages}
pages={pages}
context={context}
style={tcls('sidebar-list-line:border-l', 'border-tint-subtle')}
style={tcls(
'page-no-toc:hidden',
'sidebar-list-line:border-l',
'border-tint-subtle'
)}
/>
{customization.trademark.enabled ? (
<Trademark
@@ -25,7 +25,6 @@ export function Trademark(props: {
'relative',
'z-[2]',
'lg:absolute',
'mt-6',
'left-0',
'right-2',
@@ -34,6 +33,7 @@ export function Trademark(props: {
'pointer-events-none',
'sidebar-filled:pl-2',
'sidebar-filled:pb-2',
'sidebar-filled:page-no-toc:p-0',
'bg-tint-base',
'sidebar-filled:bg-tint-subtle',
@@ -55,7 +55,8 @@ export function Trademark(props: {
'theme-muted:before:to-tint-subtle',
'theme-bold-tint:before:to-tint-subtle',
'[html.sidebar-filled.theme-muted_&]:before:to-tint-base',
'[html.sidebar-filled.theme-bold.tint_&]:before:to-tint-base'
'[html.sidebar-filled.theme-bold.tint_&]:before:to-tint-base',
'page-no-toc:before:!to-transparent'
)}
>
<TrademarkLink {...props} />
@@ -85,6 +86,9 @@ export function TrademarkLink(props: {
href={url.toString()}
className={tcls(
'text-sm',
// 'page-no-toc:lg:max-xl:text-xs',
// 'page-no-toc:lg:max-xl:px-3',
// 'page-no-toc:lg:max-xl:py-3',
'font-semibold',
'text-tint',
@@ -93,7 +97,9 @@ export function TrademarkLink(props: {
'items-center',
'px-5',
'py-4',
'sidebar-filled:px-3',
'sidebar-filled:page-no-toc:lg:px-5',
'rounded-lg',
'straight-corners:rounded-none',
@@ -114,8 +120,22 @@ export function TrademarkLink(props: {
placement,
}}
>
<Icon icon="gitbook" className={tcls('size-5', 'mr-3')} />
{t(language, 'powered_by_gitbook')}
<Icon
icon="gitbook"
className={tcls(
'size-5',
// 'page-no-toc:lg:max-xl:size-4',
'shrink-0'
)}
/>
<span
className={tcls(
'ml-3'
// 'page-no-toc:lg:max-xl:ml-2'
)}
>
{t(language, 'powered_by_gitbook')}
</span>
</Link>
);
}
@@ -13,13 +13,13 @@ export function StyledLink(props: Omit<LinkProps, 'style'> & { style?: ClassValu
{...rest}
className={tcls(
'underline',
'decoration-from-font',
'decoration-[max(0.07em,1px)]', // Set the underline to be proportional to the font size, with a minimum. The default is too thin.
'underline-offset-2',
'links-accent:underline-offset-4',
'links-default:decoration-primary/6',
'links-default:text-primary-subtle',
'links-default:hover:text-primary',
'links-default:hover:text-primary-strong',
'links-default:contrast-more:text-primary',
'links-default:contrast-more:hover:text-primary-strong',
+17 -17
View File
@@ -1,4 +1,4 @@
import { CustomizationFont } from '@gitbook/api';
import { CustomizationDefaultFont } from '@gitbook/api';
import {
Fira_Sans_Extra_Condensed,
IBM_Plex_Mono,
@@ -188,20 +188,20 @@ const abcFavorit = localFont({
/**
* Font definitions.
*/
export const fonts: { [fontName in CustomizationFont]: { variable: string } } = {
[CustomizationFont.Inter]: inter,
[CustomizationFont.FiraSans]: firaSans,
[CustomizationFont.IBMPlexSerif]: ibmPlexSerif,
[CustomizationFont.Lato]: lato,
[CustomizationFont.Merriweather]: merriweather,
[CustomizationFont.NotoSans]: notoSans,
[CustomizationFont.OpenSans]: openSans,
[CustomizationFont.Overpass]: overpass,
[CustomizationFont.Poppins]: poppins,
[CustomizationFont.Raleway]: raleway,
[CustomizationFont.Roboto]: roboto,
[CustomizationFont.RobotoSlab]: robotoSlab,
[CustomizationFont.SourceSansPro]: sourceSansPro,
[CustomizationFont.Ubuntu]: ubuntu,
[CustomizationFont.ABCFavorit]: abcFavorit,
export const fonts: { [fontName in CustomizationDefaultFont]: { variable: string } } = {
[CustomizationDefaultFont.Inter]: inter,
[CustomizationDefaultFont.FiraSans]: firaSans,
[CustomizationDefaultFont.IBMPlexSerif]: ibmPlexSerif,
[CustomizationDefaultFont.Lato]: lato,
[CustomizationDefaultFont.Merriweather]: merriweather,
[CustomizationDefaultFont.NotoSans]: notoSans,
[CustomizationDefaultFont.OpenSans]: openSans,
[CustomizationDefaultFont.Overpass]: overpass,
[CustomizationDefaultFont.Poppins]: poppins,
[CustomizationDefaultFont.Raleway]: raleway,
[CustomizationDefaultFont.Roboto]: roboto,
[CustomizationDefaultFont.RobotoSlab]: robotoSlab,
[CustomizationDefaultFont.SourceSansPro]: sourceSansPro,
[CustomizationDefaultFont.Ubuntu]: ubuntu,
[CustomizationDefaultFont.ABCFavorit]: abcFavorit,
};
+14 -6
View File
@@ -1,5 +1,9 @@
import { AsyncLocalStorage } from 'node:async_hooks';
import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
import {
getCacheTag,
getCacheTagForURL,
getComputedContentSourceCacheTags,
} from '@gitbook/cache-tags';
import 'server-only';
import {
@@ -174,6 +178,7 @@ export const getUserById = cache({
tag: 'user',
user: userId,
}),
tagImmutable: true,
get: async (userId: string, options: CacheFunctionOptions) => {
try {
const apiCtx = await api();
@@ -238,11 +243,7 @@ export const getLatestOpenAPISpecVersionContent = cache({
*/
export const getPublishedContentByUrl = cache({
name: 'api.getPublishedContentByUrl.v4',
tag: (url) =>
getCacheTag({
tag: 'url',
hostname: new URL(url).hostname,
}),
tag: (url) => getCacheTagForURL(url),
get: async (
url: string,
visitorAuthToken: string | undefined,
@@ -379,6 +380,7 @@ export const getRevision = cache({
name: 'api.getRevision.v2',
tag: (spaceId, revisionId) =>
getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
tagImmutable: true,
getKeySuffix: getAPIContextId,
get: async (
spaceId: string,
@@ -411,6 +413,7 @@ export const getRevisionPages = cache({
name: 'api.getRevisionPages.v4',
tag: (spaceId, revisionId) =>
getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
tagImmutable: true,
getKeySuffix: getAPIContextId,
get: async (
spaceId: string,
@@ -446,6 +449,7 @@ export const getRevisionPageByPath = cache({
name: 'api.getRevisionPageByPath.v3',
tag: (spaceId, revisionId) =>
getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
tagImmutable: true,
getKeySuffix: getAPIContextId,
get: async (
spaceId: string,
@@ -492,6 +496,7 @@ const getRevisionFileById = cache({
name: 'api.getRevisionFile.v3',
tag: (spaceId, revisionId) =>
getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
tagImmutable: true,
get: async (
spaceId: string,
revisionId: string,
@@ -528,6 +533,7 @@ const getRevisionReusableContentById = cache({
name: 'api.getRevisionReusableContentById.v1',
tag: (spaceId, revisionId) =>
getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
tagImmutable: true,
getKeySuffix: getAPIContextId,
get: async (
spaceId: string,
@@ -569,6 +575,7 @@ const getRevisionAllFiles = cache({
name: 'api.getRevisionAllFiles.v2',
tag: (spaceId, revisionId) =>
getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
tagImmutable: true,
get: async (spaceId: string, revisionId: string, options: CacheFunctionOptions) => {
const response = await getAll(
async (params) => {
@@ -684,6 +691,7 @@ export const getDocument = cache({
name: 'api.getDocument.v2',
tag: (spaceId, documentId) =>
getCacheTag({ tag: 'document', space: spaceId, document: documentId }),
tagImmutable: true,
getKeySuffix: getAPIContextId,
get: async (spaceId: string, documentId: string, options: CacheFunctionOptions) => {
const apiCtx = await api();
+1 -86
View File
@@ -1,6 +1,6 @@
import { describe, expect, it } from 'bun:test';
import { asyncMutexFunction, race } from './async';
import { race } from './async';
import { flushWaitUntil } from './waitUntil';
describe('race', () => {
@@ -380,88 +380,3 @@ describe('race', () => {
});
});
});
describe('asyncMutexFunction', () => {
describe('self', () => {
it('should run only once', async () => {
let running = 0;
const fn = async () => {
running += 1;
await new Promise((resolve) => setTimeout(resolve, 10));
};
const mutexFn = asyncMutexFunction();
await Promise.all([
mutexFn(fn),
mutexFn(fn),
mutexFn(fn),
mutexFn(fn),
mutexFn(fn),
mutexFn(fn),
]);
expect(running).toBe(1);
});
});
describe('runBlocking', () => {
it('should run only one function at a time', async () => {
let running = 0;
let maxRunning = 0;
const fn = async () => {
running += 1;
maxRunning = Math.max(running, maxRunning);
await new Promise((resolve) => setTimeout(resolve, 10));
running -= 1;
};
const mutexFn = asyncMutexFunction();
await Promise.all([
mutexFn.runBlocking(fn),
mutexFn.runBlocking(fn),
mutexFn.runBlocking(fn),
mutexFn.runBlocking(fn),
mutexFn.runBlocking(fn),
mutexFn.runBlocking(fn),
]);
expect(maxRunning).toBe(1);
});
});
describe('runAfter', () => {
it('should run only one function at a time', async () => {
let running = 0;
let maxRunning = 0;
const fn = async () => {
running += 1;
maxRunning = Math.max(running, maxRunning);
await new Promise((resolve) => setTimeout(resolve, 10));
running -= 1;
};
const mutexFn = asyncMutexFunction();
await Promise.all([
mutexFn.runAfter(fn),
mutexFn.runAfter(fn),
mutexFn.runAfter(fn),
mutexFn.runAfter(fn),
mutexFn.runAfter(fn),
mutexFn.runAfter(fn),
]);
expect(maxRunning).toBe(1);
});
});
});
-81
View File
@@ -388,87 +388,6 @@ export type AsyncMutexFunction<T> = ((fn: () => Promise<T>) => Promise<T>) & {
) => Promise<ReturnType>;
};
/**
* Creates a function that will only call the given function once at a time.
*/
export function asyncMutexFunction<T>(): AsyncMutexFunction<T> {
let pending:
| undefined
| { kind: 'value'; promise: Promise<T> }
| { kind: 'blocking'; promise: Promise<unknown> };
const mutex: AsyncMutexFunction<T> = async (fn) => {
if (pending?.kind === 'value') {
return pending.promise;
}
while (pending) {
await pending.promise;
}
const promise = fn();
pending = { kind: 'value', promise };
try {
const result = await promise;
return result;
} finally {
pending = undefined;
}
};
mutex.wait = async () => {
return pending?.promise;
};
mutex.runBlocking = async (fn, options) => {
const failOnMutexError = options?.failOnMutexError ?? true;
while (pending) {
try {
await pending.promise;
} catch (err) {
if (failOnMutexError) {
throw err;
}
}
}
const promise = fn();
pending = { kind: 'blocking', promise };
try {
const result = await promise;
return result;
} finally {
pending = undefined;
}
};
mutex.runAfter = async (fn, options) => {
const failOnMutexError = options?.failOnMutexError ?? true;
while (pending) {
try {
await pending.promise;
} catch (err) {
if (failOnMutexError) {
throw err;
}
}
}
const promise = fn();
pending = { kind: 'value', promise };
try {
const result = await pending.promise;
return result;
} finally {
pending = undefined;
}
};
return mutex;
}
/**
* Try catch a promise and return the result or the error.
*/
+9
View File
@@ -7,6 +7,7 @@ import { assertIsNotV2 } from '../v2';
import { waitUntil } from '../waitUntil';
import { cacheBackends } from './backends';
import { memoryCache } from './memory';
import { addResponseCacheTag } from './response';
import type { CacheBackend, CacheEntry } from './types';
export type CacheFunctionOptions = {
@@ -54,6 +55,9 @@ export interface CacheDefinition<Args extends any[], Result> {
/** Tag to associate to the entry */
tag?: (...args: Args) => string;
/** If true, the tag will not be sent to the HTTP response, as we consider it immutable */
tagImmutable?: boolean;
/** Filter the arguments that should be taken into consideration for the cache key */
getKeyArgs?: (args: Args) => any[];
@@ -134,6 +138,11 @@ export function cache<Args extends any[], Result>(
let result: readonly [CacheEntry, string] | null = null;
const tag = cacheDef.tag?.(...args);
// Add the cache tag to the HTTP response
if (tag && !cacheDef.tagImmutable) {
addResponseCacheTag(tag);
}
// Try the memory backend, independently of the other backends as it doesn't have a network cost
const memoryEntry = await memoryCache.get({ key, tag });
if (memoryEntry) {
+44
View File
@@ -0,0 +1,44 @@
import { AsyncLocalStorage } from 'node:async_hooks';
const symbolResponseCacheTagsLocalStorage = Symbol.for('__gitbook-response-cache-tags__');
/**
* Wrap a response handler with a storage to store cache tags and write them as header to the response.
*/
export async function withResponseCacheTags(handler: () => Promise<Response>): Promise<Response> {
const responseCacheTagsLocalStorage =
// @ts-ignore
(globalThis[symbolResponseCacheTagsLocalStorage] as AsyncLocalStorage<Set<string>>) ??
new AsyncLocalStorage<Set<string>>();
// @ts-ignore
globalThis[symbolResponseCacheTagsLocalStorage] = responseCacheTagsLocalStorage;
const responseCacheTags = new Set<string>();
const response = await responseCacheTagsLocalStorage.run(responseCacheTags, handler);
if (responseCacheTags.size > 0) {
const headerCacheTag = Array.from(responseCacheTags).join(',');
response.headers.set('cache-tag', headerCacheTag);
response.headers.set('x-gitbook-cache-tag', headerCacheTag);
}
return response;
}
/**
* Add a cache tag to the HTTP response.
* This is a hack for v1, for v2, we use ISR and do not cache the whole response.
*/
export function addResponseCacheTag(...tags: string[]) {
const responseCacheTagsLocalStorage =
// @ts-ignore
(globalThis[symbolResponseCacheTagsLocalStorage] as AsyncLocalStorage<Set<string>>) ??
new AsyncLocalStorage<Set<string>>();
// @ts-ignore
globalThis[symbolResponseCacheTagsLocalStorage] = responseCacheTagsLocalStorage;
const store = responseCacheTagsLocalStorage.getStore();
tags.forEach((tag) => {
store?.add(tag);
});
}
+4
View File
@@ -1,5 +1,9 @@
import { AsyncLocalStorage } from 'node:async_hooks';
/*
* This code is ONLY for v1.
*/
/**
* Set a header on the middleware response.
* We do this because of https://github.com/opennextjs/opennextjs-cloudflare/issues/92
+8 -2
View File
@@ -1,18 +1,24 @@
import { parseOpenAPI } from '@gitbook/openapi-parser';
import { type CacheFunctionOptions, cache, noCacheFetchOptions } from '@/lib/cache';
import type { ResolveOpenAPIBlockArgs } from '@/lib/openapi/types';
import type {
AnyOpenAPIOperationsBlock,
OpenAPISchemasBlock,
ResolveOpenAPIBlockArgs,
} from '@/lib/openapi/types';
import { assert } from 'ts-essentials';
import { resolveContentRef } from '../references';
import { isV2 } from '../v2';
import { enrichFilesystem } from './enrich';
import type { FetchOpenAPIFilesystemResult } from './types';
type AnyOpenAPIBlock = AnyOpenAPIOperationsBlock | OpenAPISchemasBlock;
/**
* Fetch OpenAPI block.
*/
export async function fetchOpenAPIFilesystem(
args: ResolveOpenAPIBlockArgs
args: ResolveOpenAPIBlockArgs<AnyOpenAPIBlock>
): Promise<FetchOpenAPIFilesystemResult> {
const { context, block } = args;
@@ -1,18 +1,25 @@
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
import { OpenAPIParseError } from '@gitbook/openapi-parser';
import { type OpenAPIOperationData, resolveOpenAPIOperation } from '@gitbook/react-openapi';
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs, ResolveOpenAPIBlockResult } from './types';
import type {
AnyOpenAPIOperationsBlock,
ResolveOpenAPIBlockArgs,
ResolveOpenAPIBlockResult,
} from './types';
type ResolveOpenAPIOperationBlockResult = ResolveOpenAPIBlockResult<OpenAPIOperationData>;
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPIOperationBlockResult>>();
const weakmap = new WeakMap<
AnyOpenAPIOperationsBlock,
Promise<ResolveOpenAPIOperationBlockResult>
>();
/**
* Cache the result of resolving an OpenAPI block.
* It is important because the resolve is called in sections and in the block itself.
*/
export function resolveOpenAPIOperationBlock(
args: ResolveOpenAPIBlockArgs
args: ResolveOpenAPIBlockArgs<AnyOpenAPIOperationsBlock>
): Promise<ResolveOpenAPIOperationBlockResult> {
if (weakmap.has(args.block)) {
return weakmap.get(args.block)!;
@@ -27,7 +34,7 @@ export function resolveOpenAPIOperationBlock(
* Resolve OpenAPI operation block.
*/
async function baseResolveOpenAPIOperationBlock(
args: ResolveOpenAPIBlockArgs
args: ResolveOpenAPIBlockArgs<AnyOpenAPIOperationsBlock>
): Promise<ResolveOpenAPIOperationBlockResult> {
const { context, block } = args;
if (!block.data.path || !block.data.method) {
@@ -1,19 +1,22 @@
import { fetchOpenAPIFilesystem } from '@/lib/openapi/fetch';
import type { ResolveOpenAPIBlockResult } from '@/lib/openapi/types';
import { OpenAPIParseError } from '@gitbook/openapi-parser';
import { type OpenAPISchemasData, resolveOpenAPISchemas } from '@gitbook/react-openapi';
import type { AnyOpenAPIBlock, ResolveOpenAPIBlockArgs } from './types';
import { fetchOpenAPIFilesystem } from './fetch';
import type {
OpenAPISchemasBlock,
ResolveOpenAPIBlockArgs,
ResolveOpenAPIBlockResult,
} from './types';
type ResolveOpenAPISchemasBlockResult = ResolveOpenAPIBlockResult<OpenAPISchemasData>;
const weakmap = new WeakMap<AnyOpenAPIBlock, Promise<ResolveOpenAPISchemasBlockResult>>();
const weakmap = new WeakMap<OpenAPISchemasBlock, Promise<ResolveOpenAPISchemasBlockResult>>();
/**
* Cache the result of resolving an OpenAPI block.
* It is important because the resolve is called in sections and in the block itself.
*/
export function resolveOpenAPISchemasBlock(
args: ResolveOpenAPIBlockArgs
args: ResolveOpenAPIBlockArgs<OpenAPISchemasBlock>
): Promise<ResolveOpenAPISchemasBlockResult> {
if (weakmap.has(args.block)) {
return weakmap.get(args.block)!;
@@ -28,10 +31,10 @@ export function resolveOpenAPISchemasBlock(
* Resolve OpenAPI schemas block.
*/
async function baseResolveOpenAPISchemasBlock(
args: ResolveOpenAPIBlockArgs
args: ResolveOpenAPIBlockArgs<OpenAPISchemasBlock>
): Promise<ResolveOpenAPISchemasBlockResult> {
const { context, block } = args;
if (!block.data.path || !block.data.method) {
if (!block.data.schemas || !block.data.schemas.length) {
return { data: null, specUrl: null };
}
@@ -42,7 +45,9 @@ async function baseResolveOpenAPISchemasBlock(
return { data: null, specUrl: null };
}
const data = await resolveOpenAPISchemas(filesystem);
const data = await resolveOpenAPISchemas(filesystem, {
schemas: block.data.schemas,
});
return { data, specUrl };
} catch (error) {
+16 -5
View File
@@ -1,15 +1,26 @@
import type { DocumentBlockOpenAPI, DocumentBlockOpenAPIOperation } from '@gitbook/api';
import type {
DocumentBlockOpenAPI,
DocumentBlockOpenAPIOperation,
DocumentBlockOpenAPISchemas,
} from '@gitbook/api';
import type { Filesystem, OpenAPIParseError, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
import type { GitBookAnyContext } from '@v2/lib/context';
//!!TODO: Add DocumentBlockOpenAPISchemas when available in @gitbook/api
export type AnyOpenAPIBlock = DocumentBlockOpenAPI | DocumentBlockOpenAPIOperation;
/**
* Type for both OpenAPI & OpenAPIOperation block
*/
export type AnyOpenAPIOperationsBlock = DocumentBlockOpenAPI | DocumentBlockOpenAPIOperation;
/**
* Type for OpenAPI Schemas block
*/
export type OpenAPISchemasBlock = DocumentBlockOpenAPISchemas;
/**
* Arguments for resolving OpenAPI block.
*/
export type ResolveOpenAPIBlockArgs = {
block: AnyOpenAPIBlock;
export type ResolveOpenAPIBlockArgs<T> = {
block: T;
context: GitBookAnyContext;
};
+17 -28
View File
@@ -1,5 +1,3 @@
import { startSpan } from '@sentry/nextjs';
export interface TraceSpan {
setAttribute: (label: string, value: boolean | string | number) => void;
}
@@ -22,35 +20,26 @@ export async function trace<T>(
typeof name === 'string' ? { operation: name, name: undefined } : name;
const completeName = executionName ? `${operation}(${executionName})` : operation;
return await startSpan(
{
name: completeName,
op: operation,
const attributes: Record<string, boolean | string | number> = {};
const span: TraceSpan = {
setAttribute(label, value) {
attributes[label] = value;
},
async (sentrySpan) => {
const attributes: Record<string, boolean | string | number> = {};
const span: TraceSpan = {
setAttribute(label, value) {
attributes[label] = value;
sentrySpan?.setAttribute(label, value);
},
};
};
const start = now();
try {
return await fn(span);
} catch (error) {
span.setAttribute('error', true);
throw error;
} finally {
if (process.env.SILENT !== 'true') {
const end = now();
// biome-ignore lint/suspicious/noConsole: we want to log performance data
console.log(`trace ${completeName} ${end - start}ms`, attributes);
}
}
const start = now();
try {
return await fn(span);
} catch (error) {
span.setAttribute('error', true);
throw error;
} finally {
if (process.env.SILENT !== 'true') {
const end = now();
// biome-ignore lint/suspicious/noConsole: we want to log performance data
console.log(`trace ${completeName} ${end - start}ms`, attributes);
}
);
}
}
/**
+1 -1
View File
@@ -15,7 +15,7 @@ export function defaultCustomizationForSpace(): api.CustomizationSettings {
light: '#346DDB',
},
corners: api.CustomizationCorners.Rounded,
font: api.CustomizationFont.Inter,
font: api.CustomizationDefaultFont.Inter,
background: api.CustomizationBackground.Plain,
},
favicon: {},
@@ -1,7 +1,9 @@
import { describe, expect, it } from 'bun:test';
import type { NextRequest } from 'next/server';
import type { JwtPayload } from 'jwt-decode';
import {
getVisitorAuthCookieMaxAge,
getVisitorAuthCookieName,
getVisitorAuthCookieValue,
getVisitorToken,
@@ -74,6 +76,47 @@ describe('getVisitorAuthToken', () => {
});
});
describe('getVisitorAuthCookieMaxAge', () => {
const ONE_MINUTE_IN_SECONDS = 60;
it('returns the max age of 7 days if token expires in 7 days', () => {
const SEVEN_DAYS_IN_SECONDS = 7 * 24 * 60 * 60;
const now = Math.floor(Date.now() / 1000);
const decoded: JwtPayload = { exp: now + SEVEN_DAYS_IN_SECONDS };
expect(getVisitorAuthCookieMaxAge(decoded)).toBe(SEVEN_DAYS_IN_SECONDS);
});
it('returns the max age of 30 days if token expires in 30 days', () => {
const THIRTY_DAYS_IN_SECONDS = 30 * 24 * 60 * 60;
const now = Math.floor(Date.now() / 1000);
const decoded: JwtPayload = { exp: now + THIRTY_DAYS_IN_SECONDS };
expect(getVisitorAuthCookieMaxAge(decoded)).toBe(THIRTY_DAYS_IN_SECONDS);
});
it('returns the minimum max age of 60 seconds if token has already expired', () => {
const now = Math.floor(Date.now() / 1000);
const decoded: JwtPayload = { exp: now - 1000 };
expect(getVisitorAuthCookieMaxAge(decoded)).toBe(ONE_MINUTE_IN_SECONDS);
});
it('returns the minimum max age of 60 seconds if token expires in less than 60 seconds', () => {
const now = Math.floor(Date.now() / 1000);
const decoded: JwtPayload = { exp: now + 30 }; // Expires in 30 seconds
expect(getVisitorAuthCookieMaxAge(decoded)).toBe(ONE_MINUTE_IN_SECONDS);
});
it('returns the correct value if expiry is in the future but more than 60 seconds', () => {
const now = Math.floor(Date.now() / 1000);
const decoded: JwtPayload = { exp: now + 300 }; // Expires in 5 minutes
expect(getVisitorAuthCookieMaxAge(decoded)).toBe(300);
});
});
function assertVisitorAuthCookieValue(
value: unknown
): asserts value is { source: 'visitor-auth-cookie'; basePath: string; token: string } {
+2 -2
View File
@@ -238,13 +238,13 @@ function findVisitorAuthCookieForBasePath(
* We want to store the token for as long as it's valid, but at least 1 minute.
* If an invalid token is passed to the API, the API will return a redirect to the auth flow.
*/
function getVisitorAuthCookieMaxAge(decoded: JwtPayload): number {
export function getVisitorAuthCookieMaxAge(decoded: JwtPayload): number {
const defaultMaxAge = 7 * 24 * 60 * 60; // 7 days
const minMaxAge = 60; // 1 min
const exp = decoded.exp;
if (typeof exp === 'number') {
const now = new Date().getTime();
const now = Math.floor(new Date().getTime() / 1000);
return Math.max(exp - now, minMaxAge);
}
+3 -4
View File
@@ -33,6 +33,7 @@ import {
import { joinPath, normalizePathname } from '@/lib/paths';
import { getProxyModeBasePath } from '@/lib/proxy';
import { MiddlewareHeaders } from '@v2/lib/middleware';
import { addResponseCacheTag } from './lib/cache/response';
export const config = {
matcher:
@@ -287,10 +288,8 @@ export async function middleware(request: NextRequest) {
}
}
if (resolved.cacheTags && resolved.cacheTags.length > 0) {
const headerCacheTag = resolved.cacheTags.join(',');
setMiddlewareHeader(response, 'cache-tag', headerCacheTag);
setMiddlewareHeader(response, 'x-gitbook-cache-tag', headerCacheTag);
if (resolved.cacheTags) {
addResponseCacheTag(...resolved.cacheTags);
}
return response;
+16 -2
View File
@@ -1,9 +1,10 @@
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';
import { ImageResponse } from 'next/og';
import { getEmojiForCode } from '@/lib/emojis';
import { tcls } from '@/lib/tailwind';
import type { GitBookSiteContext } from '@v2/lib/context';
import { getResizedImageURL } from '@v2/lib/images';
const SIZES = {
/** Size for a favicon */
@@ -25,11 +26,24 @@ const SIZES = {
/**
* Generate an icon for a site content.
*/
export function serveIcon(context: GitBookSiteContext, req: Request) {
export async function serveIcon(context: GitBookSiteContext, req: Request) {
const options = getOptions(req.url);
const size = SIZES[options.size];
const { site, customization } = context;
const customIcon = 'icon' in customization.favicon ? customization.favicon.icon : null;
// If the site has a custom icon, redirect to it
if (customIcon) {
const iconUrl = options.theme === 'light' ? customIcon.light : customIcon.dark;
redirect(
await getResizedImageURL(context.imageResizer, iconUrl, {
width: size.width,
height: size.height,
})
);
}
const contentTitle = site.title;
return new ImageResponse(
+25 -19
View File
@@ -1,4 +1,4 @@
import { CustomizationFont, CustomizationHeaderPreset } from '@gitbook/api';
import { CustomizationDefaultFont, CustomizationHeaderPreset } from '@gitbook/api';
import { colorContrast } from '@gitbook/colors';
import { redirect } from 'next/navigation';
import { ImageResponse } from 'next/og';
@@ -7,23 +7,24 @@ import { type PageParams, fetchPageData } from '@/components/SitePage';
import { getAssetURL } from '@/lib/assets';
import { filterOutNullable } from '@/lib/typescript';
import type { GitBookSiteContext } from '@v2/lib/context';
import { getResizedImageURL } from '@v2/lib/images';
const googleFontsMap: { [fontName in CustomizationFont]: string } = {
[CustomizationFont.Inter]: 'Inter',
[CustomizationFont.FiraSans]: 'Fira Sans Extra Condensed',
[CustomizationFont.IBMPlexSerif]: 'IBM Plex Serif',
[CustomizationFont.Lato]: 'Lato',
[CustomizationFont.Merriweather]: 'Merriweather',
[CustomizationFont.NotoSans]: 'Noto Sans',
[CustomizationFont.OpenSans]: 'Open Sans',
[CustomizationFont.Overpass]: 'Overpass',
[CustomizationFont.Poppins]: 'Poppins',
[CustomizationFont.Raleway]: 'Raleway',
[CustomizationFont.Roboto]: 'Roboto',
[CustomizationFont.RobotoSlab]: 'Roboto Slab',
[CustomizationFont.SourceSansPro]: 'Source Sans 3',
[CustomizationFont.Ubuntu]: 'Ubuntu',
[CustomizationFont.ABCFavorit]: 'Inter',
const googleFontsMap: { [fontName in CustomizationDefaultFont]: string } = {
[CustomizationDefaultFont.Inter]: 'Inter',
[CustomizationDefaultFont.FiraSans]: 'Fira Sans Extra Condensed',
[CustomizationDefaultFont.IBMPlexSerif]: 'IBM Plex Serif',
[CustomizationDefaultFont.Lato]: 'Lato',
[CustomizationDefaultFont.Merriweather]: 'Merriweather',
[CustomizationDefaultFont.NotoSans]: 'Noto Sans',
[CustomizationDefaultFont.OpenSans]: 'Open Sans',
[CustomizationDefaultFont.Overpass]: 'Overpass',
[CustomizationDefaultFont.Poppins]: 'Poppins',
[CustomizationDefaultFont.Raleway]: 'Raleway',
[CustomizationDefaultFont.Roboto]: 'Roboto',
[CustomizationDefaultFont.RobotoSlab]: 'Roboto Slab',
[CustomizationDefaultFont.SourceSansPro]: 'Source Sans 3',
[CustomizationDefaultFont.Ubuntu]: 'Ubuntu',
[CustomizationDefaultFont.ABCFavorit]: 'Inter',
};
/**
@@ -31,12 +32,17 @@ const googleFontsMap: { [fontName in CustomizationFont]: string } = {
*/
export async function serveOGImage(baseContext: GitBookSiteContext, params: PageParams) {
const { context, pageTarget } = await fetchPageData(baseContext, params);
const { customization, site, linker } = context;
const { customization, site, linker, imageResizer } = context;
const page = pageTarget?.page;
// If user configured a custom social preview, we redirect to it.
if (customization.socialPreview.url) {
redirect(customization.socialPreview.url);
redirect(
await getResizedImageURL(imageResizer, customization.socialPreview.url, {
width: 1200,
height: 630,
})
);
}
// Compute all text to load only the necessary fonts
+7 -1
View File
@@ -456,8 +456,12 @@ const config: Config = {
/**
* Variant when a header is displayed.
*/
addVariant('site-header-none', 'html.site-header-none &');
addVariant('site-header', 'body:has(#site-header:not(.mobile-only)) &');
addVariant('site-header-sections', 'body:has(#site-header:not(.mobile-only) > nav) &');
addVariant('site-header-sections', [
'body:has(#site-header:not(.mobile-only) #sections) &',
'body:has(.page-no-toc):has(#site-header:not(.mobile-only) #variants) &',
]);
const customisationVariants = {
// Sidebar styles
@@ -502,12 +506,14 @@ const config: Config = {
* Variant when the page contains a block that will be rendered in full-width mode.
*/
addVariant('page-full-width', 'body:has(.page-full-width) &');
addVariant('page-default-width', 'body:has(.page-default-width) &');
/**
* Variant when the page is configured to hide the table of content.
* `page.layout.tableOfContents` is set to false.
*/
addVariant('page-no-toc', 'body:has(.page-no-toc) &');
addVariant('page-has-toc', 'body:has(.page-has-toc) &');
/**
* Variant when the page contains an OpenAPI block.
+6 -12
View File
@@ -49,18 +49,12 @@ export function getTestURL(urlRest: string): string {
* Get an API token for a site by its URL.
*/
export async function getSiteAPIToken(url: string) {
const api = new GitBookAPI();
const { data } = await api.urls.getPublishedContentByUrl(
{
url,
cache: true,
},
{
headers: {
'x-gitbook-force-cache': 'true',
},
}
);
const api = new GitBookAPI({
endpoint: 'https://api.gitbook.com/cache',
});
const { data } = await api.urls.getPublishedContentByUrl({
url,
});
if ('redirect' in data) {
throw new Error(`Invalid site URL, it resulted in a redirect: ${data.redirect}`);
+22 -11
View File
@@ -1,60 +1,71 @@
# @gitbook/react-contentkit
## 0.7.0
### Minor Changes
- 6aaeae2: Fix an issue where ContentKit iframes were not resizing.
### Patch Changes
- 9108c56: Fix an issue where contentkit webframes weren't resized properly
- c9ea239: Fix an issue where iframe aspect ratio was not respected.
## 0.6.2
### Patch Changes
- Updated dependencies [88f64b0]
- @gitbook/icons@0.2.0
- Updated dependencies [88f64b0]
- @gitbook/icons@0.2.0
## 0.6.1
### Patch Changes
- 8beb5d6: Add input elements to ContentKit
- 8beb5d6: Add input elements to ContentKit
## 0.6.0
### Minor Changes
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
- ea1468c: Send redirectOnError param to getPublishedContent when token is pulled from cookie
### Patch Changes
- 648f0e9: Fix potential invalid URL error in react-contentkit
- 648f0e9: Fix potential invalid URL error in react-contentkit
## 0.5.1
### Patch Changes
- 0f1565c: Fix rendering of webframe with SSR causing wrong communication between frame and renderer
- 0f1565c: Fix rendering of webframe with SSR causing wrong communication between frame and renderer
## 0.5.0
### Minor Changes
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
## 0.4.0
### Minor Changes
- 24cd72e: Fix changeset CI workflow
- 24cd72e: Fix changeset CI workflow
## 0.3.0
### Minor Changes
- de747b7: Publish to NPM with JS files and TypeScript declaration files
- de747b7: Publish to NPM with JS files and TypeScript declaration files
## 0.2.0
### Minor Changes
- 57adb3e: Second release to fix publishing with changeset
- 57adb3e: Second release to fix publishing with changeset
## 0.1.0
### Minor Changes
- 5f8a8fe: Initial release
- 5f8a8fe: Initial release
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@gitbook/react-contentkit",
"version": "0.6.2",
"version": "0.7.0",
"exports": {
".": {
"types": "./dist/index.d.ts",
@@ -10,7 +10,7 @@
},
"dependencies": {
"classnames": "^2.5.1",
"@gitbook/api": "0.96.1",
"@gitbook/api": "*",
"@gitbook/icons": "workspace:*"
},
"peerDependencies": {
@@ -14,8 +14,7 @@ export function ElementWebframe(props: ContentKitClientElementProps<ContentKitWe
const renderer = useContentKitClientContext();
const iframeRef = React.useRef<HTMLIFrameElement>(null);
const [size, setSize] = React.useState<{
maxWidth?: number;
maxHeight?: number;
height?: number;
aspectRatio?: number;
}>({});
@@ -88,9 +87,8 @@ export function ElementWebframe(props: ContentKitClientElementProps<ContentKitWe
const height = parsed.height;
setSize({
maxWidth: width,
aspectRatio: width / height,
maxHeight: height,
height: height,
});
}
} catch (_err) {
@@ -108,11 +106,25 @@ export function ElementWebframe(props: ContentKitClientElementProps<ContentKitWe
messagesQueueRef.current = [];
break;
case '@webframe.resize':
setSize({
maxWidth: Number(message.action.size.maxWidth),
maxHeight: Number(message.action.size.maxHeight),
aspectRatio: Number(message.action.size.aspectRatio),
});
setSize((size) => ({
aspectRatio:
typeof message.action.size.aspectRatio !== 'undefined'
? Number(message.action.size.aspectRatio)
: size.aspectRatio,
height: (() => {
if (typeof message.action.size.height !== 'undefined') {
return Number(message.action.size.height);
}
// maxHeight was used prior to moving to height, maintain it for backward compatibility.
if (typeof message.action.size.maxHeight !== 'undefined') {
return Number(message.action.size.maxHeight);
}
return size.height;
})(),
}));
break;
default:
renderer.update({
@@ -149,33 +161,27 @@ export function ElementWebframe(props: ContentKitClientElementProps<ContentKitWe
return sendMessage({ state });
}, [element.data, renderer.state, sendMessage]);
if (!mounted) {
return null;
}
const aspectRatio = size.aspectRatio || element.aspectRatio;
return (
<div
className={'contentkit-webframe'}
<iframe
ref={iframeRef}
src={element.source.url}
title={element.source.url}
allowFullScreen
allow="clipboard-write"
className="contentkit-webframe"
style={{
aspectRatio: size.aspectRatio || element.aspectRatio || undefined,
maxWidth: size.maxWidth || undefined,
maxHeight: size.maxHeight || undefined,
width: '100%',
maxWidth: '100%',
aspectRatio,
height: size.height ? Math.max(size.height, 32) : '100%',
border: 'none',
}}
>
{mounted ? (
<iframe
ref={iframeRef}
src={element.source.url}
allowFullScreen
allow="clipboard-write"
style={{
position: 'absolute',
top: 0,
left: 0,
bottom: 0,
right: 0,
width: '100%',
height: '100%',
border: 'none',
}}
/>
) : null}
</div>
/>
);
}
+99 -91
View File
@@ -1,203 +1,211 @@
# @gitbook/react-openapi
## 1.1.4
### Patch Changes
- c60e9ba: Handle read-only in OpenAPISchemaName
- 31d800e: Render OpenAPISchemas block
- ff3b708: Remove read-only properties from codesample
## 1.1.3
### Patch Changes
- 844059f: Fix spacing in OpenAPISecurities
- 844059f: Fix spacing in OpenAPISecurities
## 1.1.2
### Patch Changes
- f127d28: Rename OpenAPIModels to OpenAPISchemas
- f127d28: Rename OpenAPIModels to OpenAPISchemas
## 1.1.1
### Patch Changes
- f574858: Fix OpenAPI example display error
- f574858: Fix OpenAPI example display error
## 1.1.0
### Minor Changes
- bb3ca9c: Implement OpenAPI models blocks
- bb3ca9c: Implement OpenAPI models blocks
### Patch Changes
- 0278a14: Upgrade Scalar dependencies
- 3173d8e: Remove top level circular refs in alternatives
- Updated dependencies [0278a14]
- Updated dependencies [bb3ca9c]
- Updated dependencies [052e07a]
- @gitbook/openapi-parser@2.1.0
- 0278a14: Upgrade Scalar dependencies
- 3173d8e: Remove top level circular refs in alternatives
- Updated dependencies [0278a14]
- Updated dependencies [bb3ca9c]
- Updated dependencies [052e07a]
- @gitbook/openapi-parser@2.1.0
## 1.0.5
### Patch Changes
- Updated dependencies [53f5dbe]
- @gitbook/openapi-parser@2.0.2
- Updated dependencies [53f5dbe]
- @gitbook/openapi-parser@2.0.2
## 1.0.4
### Patch Changes
- 722f02e: Fix recursion in OpenAPISchemaAlternative
- Updated dependencies [0924259]
- @gitbook/openapi-parser@2.0.1
- 722f02e: Fix recursion in OpenAPISchemaAlternative
- Updated dependencies [0924259]
- @gitbook/openapi-parser@2.0.1
## 1.0.3
### Patch Changes
- dc2dbc5: Update OpenAPI code examples to support multiple content-type
- f1d1d2f: Return empty string if no server provided
- 05e1d8c: Hide x-gitbook-\* symbols in OpenAPI blocks
- b4a12d6: Fix circularRef in schema + examples OpenAPI
- 9f0de74: Fix ID not set when there is no operation summary
- da55fac: Render GitBook blocks in OpenAPI operation description
- Updated dependencies [c808bb1]
- Updated dependencies [e24206e]
- Updated dependencies [a054554]
- Updated dependencies [da55fac]
- @gitbook/openapi-parser@2.0.0
- dc2dbc5: Update OpenAPI code examples to support multiple content-type
- f1d1d2f: Return empty string if no server provided
- 05e1d8c: Hide x-gitbook-\* symbols in OpenAPI blocks
- b4a12d6: Fix circularRef in schema + examples OpenAPI
- 9f0de74: Fix ID not set when there is no operation summary
- da55fac: Render GitBook blocks in OpenAPI operation description
- Updated dependencies [c808bb1]
- Updated dependencies [e24206e]
- Updated dependencies [a054554]
- Updated dependencies [da55fac]
- @gitbook/openapi-parser@2.0.0
## 1.0.2
### Patch Changes
- bb5c6a4: Support multiple response media types and examples
- a3f1fea: Fix display of OpenAPI header description
- 6157583: Improve Markdown parsing
- 7419ee7: Show additional fields in OpenAPI block
- 82cd9f2: Add support for anchor links in OpenAPI blocks
- Updated dependencies [6157583]
- @gitbook/openapi-parser@1.0.1
- bb5c6a4: Support multiple response media types and examples
- a3f1fea: Fix display of OpenAPI header description
- 6157583: Improve Markdown parsing
- 7419ee7: Show additional fields in OpenAPI block
- 82cd9f2: Add support for anchor links in OpenAPI blocks
- Updated dependencies [6157583]
- @gitbook/openapi-parser@1.0.1
## 1.0.1
### Patch Changes
- f8d4c76: Sync tabs across all OpenAPI blocks
- dddb4ec: Fix long tab group description
- f8d4c76: Support for OpenAPI references
- f8d4c76: Sync tabs across all OpenAPI blocks
- dddb4ec: Fix long tab group description
- f8d4c76: Support for OpenAPI references
## 1.0.0
### Major Changes
- 727bde2: Improve and split OpenAPI parser into its own package
- 12c7862: Use `@scalar/openapi-parser` to be more resilient and perf on OpenAPI spec parsing:
- 727bde2: Improve and split OpenAPI parser into its own package
- 12c7862: Use `@scalar/openapi-parser` to be more resilient and perf on OpenAPI spec parsing:
- `fetcher.fetch` must now returns a valid OpenAPI document
- `parseOpenAPIV3` has been replaced by `parseOpenAPI`
- `fetcher.fetch` must now returns a valid OpenAPI document
- `parseOpenAPIV3` has been replaced by `parseOpenAPI`
### Minor Changes
- 162b4b7: Add in HTTP example code blocks
- e4e2f52: Add an optional client context to get a callback called when the Scalar client is opened for a block.
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
- 160fca1: new OpenAPI blocks design
- e721f17: Use `@scalar/oas-utils` getExampleFromSchema to generate OpenAPI examples
- fe8acc9: Fix an issue where a missing OpenAPI example would crash the page.
- 1823101: Fix internal properties appearing in OpenAPI docs.
- 162b4b7: Add in HTTP example code blocks
- e4e2f52: Add an optional client context to get a callback called when the Scalar client is opened for a block.
- eb7c22f: Revert scalar to 1.0.87 to mitigate an issue with ApiClientModalProvider
- 160fca1: new OpenAPI blocks design
- e721f17: Use `@scalar/oas-utils` getExampleFromSchema to generate OpenAPI examples
- fe8acc9: Fix an issue where a missing OpenAPI example would crash the page.
- 1823101: Fix internal properties appearing in OpenAPI docs.
### Patch Changes
- d9029c7: Support apiKey in CodeSample security headers
- 6e54a06: Support response examples
- 0c03676: Better securities sample and headers
- 3e5e458: Handle isArray schema type
- 46edde9: Improve the OpenAPI package API
- d9c8d57: Do not dereference before caching OpenAPI spec.
- ccf2cff: Fix an issue where a response object using a special ref would crash the page.
- dda0cc6: Flatten OpenAPI security object
- f92e906: Prevent codemirror from loading multiple versions in scalar
- dff08ae: Improve performances by loading Scalar API Client only when the button is clicked
- fc7b16f: Updated scalar depdenency
- a652958: Fix error on unresolvable refs by replacing with property name and any type
- 2f73db7: Support non primitive examples in OpenAPI block
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
- Updated dependencies [46edde9]
- Updated dependencies [727bde2]
- @gitbook/openapi-parser@1.0.0
- d9029c7: Support apiKey in CodeSample security headers
- 6e54a06: Support response examples
- 0c03676: Better securities sample and headers
- 3e5e458: Handle isArray schema type
- 46edde9: Improve the OpenAPI package API
- d9c8d57: Do not dereference before caching OpenAPI spec.
- ccf2cff: Fix an issue where a response object using a special ref would crash the page.
- dda0cc6: Flatten OpenAPI security object
- f92e906: Prevent codemirror from loading multiple versions in scalar
- dff08ae: Improve performances by loading Scalar API Client only when the button is clicked
- fc7b16f: Updated scalar depdenency
- a652958: Fix error on unresolvable refs by replacing with property name and any type
- 2f73db7: Support non primitive examples in OpenAPI block
- 160fca1: Support deprecated and x-deprecated-sunset in OpenAPI spec
- b41d425: Improve OpenAPI rendering performances by caching markdown parsing
- Updated dependencies [46edde9]
- Updated dependencies [727bde2]
- @gitbook/openapi-parser@1.0.0
## 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
- 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
- cf3045a: Add Python support in Code Samples
- 4247361: Add required query parameters to the code sample
- aa8c49e: Display pattern if available in parmas in OpenAPI block
- e914903: Synchronize response and response example tabs
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
- cf3045a: Add Python support in Code Samples
- 4247361: Add required query parameters to the code sample
- aa8c49e: Display pattern if available in parmas in OpenAPI block
- e914903: Synchronize response and response example tabs
- 4cbcc5b: Rollback of scalar modal while fixing perf issue
### Patch Changes
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
- f89b31c: Upgrade the scalar api client package
- 094e9cd: bump: scalar from 1.0.5 to 1.0.7
- 237b703: Fix crash when `example` is undefined for a response
- 51955da: Adds tabs to Response Example section e.g. for status code examples
- a679e72: Render mandatory headers in code sample
- c079c3c: Update Scalar client to latest version
- 51fa3ab: Adds content-visibility css property to OpenAPI Operation for better render performance
- f89b31c: Upgrade the scalar api client package
- 094e9cd: bump: scalar from 1.0.5 to 1.0.7
- 237b703: Fix crash when `example` is undefined for a response
- 51955da: Adds tabs to Response Example section e.g. for status code examples
- a679e72: Render mandatory headers in code sample
- c079c3c: Update Scalar client to latest version
## 0.6.0
### Minor Changes
- 709f1a1: Update Scalar to the latest version, with faster performances and an improved experience
- 709f1a1: Update Scalar to the latest version, with faster performances and an improved experience
### Patch Changes
- ede2335: Fix x-codeSamples: false not working at the single operation level
- 0426312: Fix tabs being empty for code samples when they are updated dynamically
- ede2335: Fix x-codeSamples: false not working at the single operation level
- 0426312: Fix tabs being empty for code samples when they are updated dynamically
## 0.5.0
### Minor Changes
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
- 3445db4: Fix files published in the NPM packages by defining "files" in "package.json"
## 0.4.0
### Minor Changes
- 24cd72e: Fix changeset CI workflow
- 24cd72e: Fix changeset CI workflow
## 0.3.0
### Minor Changes
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
- de747b7: Refactor the repository to be a proper monorepo and publish JS files on NPM instead of TypeScript files.
## 0.3.0
### Minor Changes
- bd0ca5b: Fix missing react imports
- bd0ca5b: Fix missing react imports
## 0.2.0
### Minor Changes
- 57adb3e: Second release to fix publishing with changeset
- 57adb3e: Second release to fix publishing with changeset
## 0.1.0
### Minor Changes
- 5f8a8fe: Initial release
- 5f8a8fe: Initial release
+1 -1
View File
@@ -8,7 +8,7 @@
"default": "./dist/index.js"
}
},
"version": "1.1.3",
"version": "1.1.4",
"sideEffects": false,
"dependencies": {
"@gitbook/openapi-parser": "workspace:*",
@@ -26,13 +26,17 @@ export function OpenAPICodeSample(props: {
}
if (param.in === 'header' && param.required) {
const example = param.schema ? generateSchemaExample(param.schema) : undefined;
const example = param.schema
? generateSchemaExample(param.schema, { mode: 'write' })
: undefined;
if (example !== undefined && param.name) {
headersObject[param.name] =
typeof example !== 'string' ? stringifyOpenAPI(example) : example;
}
} else if (param.in === 'query' && param.required) {
const example = param.schema ? generateSchemaExample(param.schema) : undefined;
const example = param.schema
? generateSchemaExample(param.schema, { mode: 'write' })
: undefined;
if (example !== undefined && param.name) {
searchParams.append(
param.name,
@@ -30,6 +30,7 @@ export function OpenAPISchemaName(props: OpenAPISchemaNameProps) {
<span className="openapi-schema-type">{additionalItems}</span>
) : null}
</span>
{schema?.readOnly ? <span className="openapi-schema-readonly">read-only</span> : null}
{required ? <span className="openapi-schema-required">required</span> : null}
{schema?.deprecated ? <span className="openapi-deprecated">Deprecated</span> : null}
</div>
@@ -4,13 +4,18 @@ import { OpenAPIRootSchema } from '../OpenAPISchema';
import { Section, SectionBody } from '../StaticSection';
import type { OpenAPIClientContext, OpenAPIContextProps, OpenAPISchemasData } from '../types';
type OpenAPISchemasContextProps = Omit<
OpenAPIContextProps,
'renderCodeBlock' | 'renderHeading' | 'renderDocument'
>;
/**
* Display OpenAPI Schemas.
*/
export function OpenAPISchemas(props: {
className?: string;
data: OpenAPISchemasData;
context: OpenAPIContextProps;
context: OpenAPISchemasContextProps;
}) {
const { className, data, context } = props;
const { schemas } = data;
@@ -0,0 +1,174 @@
import { describe, expect, it } from 'bun:test';
import { parseOpenAPI, traverse } from '@gitbook/openapi-parser';
import { resolveOpenAPISchemas } from './resolveOpenAPISchemas';
async function fetchFilesystem(url: string) {
const response = await fetch(url);
const text = await response.text();
const filesystem = await parseOpenAPI({ value: text, rootURL: url });
const transformedFs = await traverse(filesystem, async (node) => {
if ('description' in node && typeof node.description === 'string' && node.description) {
node['x-gitbook-description-html'] = node.description;
}
return node;
});
return transformedFs;
}
describe('#resolveOpenAPISchemas', () => {
it('should resolve refs', async () => {
const filesystem = await fetchFilesystem(
'https://petstore3.swagger.io/api/v3/openapi.json'
);
const resolved = await resolveOpenAPISchemas(filesystem, { schemas: ['Pet', 'Tag'] });
expect(resolved).toMatchObject({
schemas: [
{
name: 'Pet',
schema: {
properties: {
tags: {
type: 'array',
items: {
type: 'object',
properties: {
id: {
format: 'int64',
type: 'integer',
},
name: {
type: 'string',
},
},
},
},
},
},
},
{
name: 'Tag',
schema: {
type: 'object',
properties: {
id: {
type: 'integer',
format: 'int64',
},
name: {
type: 'string',
},
},
xml: {
name: 'tag',
},
},
},
],
});
});
it('should support yaml', async () => {
const filesystem = await fetchFilesystem(
'https://petstore3.swagger.io/api/v3/openapi.yaml'
);
const resolved = await resolveOpenAPISchemas(filesystem, { schemas: ['Pet'] });
expect(resolved).toMatchObject({
schemas: [
{
name: 'Pet',
schema: {
properties: {
tags: {
type: 'array',
items: {
properties: {
id: {
format: 'int64',
type: 'integer',
},
name: {
type: 'string',
},
},
type: 'object',
},
},
},
},
},
],
});
});
it('should resolve circular refs', async () => {
const filesystem = await fetchFilesystem('https://api.gitbook.com/openapi.json');
const resolved = await resolveOpenAPISchemas(filesystem, {
schemas: ['DocumentBlockTabs'],
});
expect(resolved).toMatchObject({
schemas: [
{
name: 'DocumentBlockTabs',
schema: {
type: 'object',
properties: {
object: {
type: 'string',
enum: ['block'],
},
},
},
},
],
});
});
it('should resolve to null if the schema does not exist', async () => {
const filesystem = await fetchFilesystem(
'https://petstore3.swagger.io/api/v3/openapi.json'
);
const resolved = await resolveOpenAPISchemas(filesystem, {
schemas: ['NonExistentSchema'],
});
expect(resolved).toBe(null);
});
it('should parse Swagger 2.0', async () => {
const filesystem = await fetchFilesystem('https://petstore.swagger.io/v2/swagger.json');
const resolved = await resolveOpenAPISchemas(filesystem, {
schemas: ['Pet'],
});
expect(resolved).toMatchObject({
schemas: [
{
name: 'Pet',
schema: {
properties: {
tags: {
type: 'array',
items: {
properties: {
id: {
format: 'int64',
type: 'integer',
},
name: {
type: 'string',
},
},
type: 'object',
},
},
},
},
},
],
});
});
});
@@ -15,21 +15,43 @@ import type { OpenAPISchema, OpenAPISchemasData } from '../types';
* Schemas are extracted from the OpenAPI components.schemas
*/
export async function resolveOpenAPISchemas(
filesystem: Filesystem<OpenAPIV3xDocument>
filesystem: Filesystem<OpenAPIV3xDocument>,
options: {
schemas: string[];
}
): Promise<OpenAPISchemasData | null> {
const { schemas: selectedSchemas } = options;
const schema = await dereferenceFilesystem(filesystem);
const schemas = getOpenAPIComponents(schema);
const schemas = filterSelectedOpenAPISchemas(schema, selectedSchemas);
if (schemas.length === 0) {
return null;
}
return { schemas };
}
/**
* Get OpenAPI components.schemas that are not ignored.
* Extract selected schemas from the OpenAPI document.
*/
function getOpenAPIComponents(schema: OpenAPIV3.Document | OpenAPIV3_1.Document): OpenAPISchema[] {
const schemas = schema.components?.schemas ?? {};
return Object.entries(schemas)
.filter(([, schema]) => !shouldIgnoreEntity(schema))
.map(([key, schema]) => ({ name: key, schema }));
export function filterSelectedOpenAPISchemas(
schema: OpenAPIV3.Document | OpenAPIV3_1.Document,
selectedSchemas: string[]
): OpenAPISchema[] {
const componentsSchemas = schema.components?.schemas ?? {};
// Preserve the order of the selected schemas
return selectedSchemas
.map((name) => {
const schema = componentsSchemas[name];
if (schema && !shouldIgnoreEntity(schema)) {
return {
name,
schema,
};
}
return null;
})
.filter((schema): schema is OpenAPISchema => !!schema);
}
+1 -1
View File
@@ -37,7 +37,7 @@
},
// Check the package for type errors
"typecheck": {
"dependsOn": ["^typecheck", "build", "generate"]
"dependsOn": ["^typecheck", "build"]
},
// Lint the package for style errors
"lint": {