Merge branch 'main' into front/fix-dark-light-mode

Author: addisonschultz

.changeset/deep-spoons-throw.md

@@ -11,6 +11,10 @@ jobs:
     release:
         name: Release
         runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            pull-requests: write
+            id-token: write
         steps:
             - name: Checkout
               uses: actions/checkout@v4
@@ -19,6 +23,15 @@ jobs:
                   fetch-depth: 0
                   # Using a PAT instead of the default token to ensure commits trigger CI
                   token: ${{ secrets.GH_PERSONAL_TOKEN }}
+            - name: Setup Node.js for npm trusted publishing
+              uses: actions/setup-node@v4
+              with:
+                  # npm trusted publishing requires npm 11.5.1+ (Node 22.14.0+)
+                  node-version: '24'
+                  registry-url: 'https://registry.npmjs.org'
+            # Ensure npm 11.5.1 or later is installed
+            - name: Update npm
+              run: npm install -g npm@latest
             - name: Setup bun
               uses: oven-sh/setup-bun@v2
               with:
@@ -34,7 +47,7 @@ jobs:
                   # Using a PAT instead of GITHUB_TOKEN because we need to run workflows when releases are created
                   # https://github.com/orgs/community/discussions/26875#discussioncomment-3253761
                   GITHUB_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
-                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+                  NPM_CONFIG_PROVENANCE: true
 
     publish-integrations-staging:
         name: Publish Integrations to Staging

.changeset/grumpy-chicken-report.md

@@ -1,5 +1,11 @@
 # @gitbook/integration-amplitude
 
+## 2.1.0
+
+### Minor Changes
+
+- a09e3b5: Add more configuration options to amplitude integration
+
 ## 2.0.0
 
 ### Major Changes

.github/workflows/release.yaml

@@ -18,6 +18,7 @@ contentSecurityPolicy:
         https://cdn.amplitude.com;
     connect-src: |
         cdn.amplitude.com;
+        api2.amplitude.com;
 summary: |
     # Overview
 
@@ -42,6 +43,61 @@ configurations:
                 type: string
                 title: Amplitude API Key
                 description: Your Amplitude API Key
+            server_url:
+                type: string
+                title: Server URL
+                description: URL where events are uploaded
+                default: https://api2.amplitude.com/2/httpapi
+            autocapture_attribution:
+                type: boolean
+                title: Attribution
+                description: Enable marketing attribution tracking
+                default: true
+            autocapture_page_views:
+                type: boolean
+                title: Page Views
+                description: Enable page view tracking
+                default: true
+            autocapture_sessions:
+                type: boolean
+                title: Sessions
+                description: Enable session tracking
+                default: true
+            autocapture_form_interactions:
+                type: boolean
+                title: Form Interactions
+                description: Enable form start and form submit tracking
+                default: true
+            autocapture_file_downloads:
+                type: boolean
+                title: File Downloads
+                description: Enable file download tracking
+                default: true
+            autocapture_element_interactions:
+                type: boolean
+                title: Element Interactions
+                description: Enable element click and form field interaction tracking
+                default: false
+            autocapture_frustration_interactions:
+                type: boolean
+                title: Frustration Interactions
+                description: Enable rage clicks and dead clicks tracking (SDK 2.24.0+)
+                default: false
+            autocapture_page_url_enrichment:
+                type: boolean
+                title: Page URL Enrichment
+                description: Add page URL-related properties to all events
+                default: true
+            autocapture_network_tracking:
+                type: boolean
+                title: Network Tracking
+                description: Enable XHR and Fetch network request tracking
+                default: false
+            autocapture_web_vitals:
+                type: boolean
+                title: Web Vitals
+                description: Enable Core Web Vitals tracking (SDK 2.27.0+)
+                default: false
         required:
             - amplitude_api_key
 target: site

bun.lock

@@ -1,6 +1,6 @@
 {
     "name": "@gitbook/integration-amplitude",
-    "version": "2.0.0",
+    "version": "2.1.0",
     "private": true,
     "dependencies": {
         "@gitbook/api": "*",

integrations/amplitude/CHANGELOG.md

@@ -1,4 +1,4 @@
-(function (w, d, s, apiKey) {
+(function (w, d, s, apiKey, initConfigJson) {
     const GRANTED_COOKIE = '__gitbook_cookie_granted';
 
     function getCookie(cname) {
@@ -30,10 +30,8 @@
     j.referrerPolicy = 'no-referrer-when-downgrade';
     j.onload = function () {
         window.amplitude.add(window.sessionReplay.plugin({ sampleRate: 1 }));
-        window.amplitude.init(apiKey, {
-            fetchRemoteConfig: true,
-            autocapture: true,
-        });
+        const initConfig = JSON.parse(initConfigJson || '{}');
+        window.amplitude.init(apiKey, initConfig);
     };
     f.parentNode.insertBefore(j, f);
-})(window, document, 'script', '<TO_REPLACE>');
+})(window, document, 'script', '<TO_REPLACE>', '<TO_REPLACE_INIT_CONFIG>');

integrations/amplitude/gitbook-manifest.yaml

@@ -7,11 +7,24 @@ import {
 
 import script from './amplitudeScript.raw.js';
 
+const DEFAULT_SERVER_URL = 'https://api2.amplitude.com/2/httpapi';
+
 type AmplitudeRuntimeContext = RuntimeContext<
     RuntimeEnvironment<
         {},
         {
             amplitude_api_key?: string;
+            server_url?: string;
+            autocapture_attribution?: boolean;
+            autocapture_page_views?: boolean;
+            autocapture_sessions?: boolean;
+            autocapture_form_interactions?: boolean;
+            autocapture_file_downloads?: boolean;
+            autocapture_element_interactions?: boolean;
+            autocapture_frustration_interactions?: boolean;
+            autocapture_page_url_enrichment?: boolean;
+            autocapture_network_tracking?: boolean;
+            autocapture_web_vitals?: boolean;
         }
     >
 >;
@@ -20,13 +33,37 @@ export const handleFetchEvent: FetchPublishScriptEventCallback = async (
     _event,
     { environment }: AmplitudeRuntimeContext,
 ) => {
-    const amplitudeApiKey = environment.siteInstallation?.configuration?.amplitude_api_key;
+    const config = environment.siteInstallation?.configuration;
+    const amplitudeApiKey = config?.amplitude_api_key;
 
     if (!amplitudeApiKey) {
         return;
     }
 
-    return new Response((script as string).replace(/<TO_REPLACE>/g, amplitudeApiKey), {
+    const serverUrl = config?.server_url ?? DEFAULT_SERVER_URL;
+    const initConfig = {
+        ...(serverUrl !== DEFAULT_SERVER_URL ? { serverUrl } : {}),
+        fetchRemoteConfig: true,
+        autocapture: {
+            attribution: config?.autocapture_attribution ?? true,
+            pageViews: config?.autocapture_page_views ?? true,
+            sessions: config?.autocapture_sessions ?? true,
+            formInteractions: config?.autocapture_form_interactions ?? true,
+            fileDownloads: config?.autocapture_file_downloads ?? true,
+            elementInteractions: config?.autocapture_element_interactions ?? false,
+            frustrationInteractions: config?.autocapture_frustration_interactions ?? false,
+            pageUrlEnrichment: config?.autocapture_page_url_enrichment ?? true,
+            networkTracking: config?.autocapture_network_tracking ?? false,
+            webVitals: config?.autocapture_web_vitals ?? false,
+        },
+    };
+
+    const initConfigJson = JSON.stringify(initConfig).replace(/\\/g, '\\\\').replace(/'/g, "\\'");
+
+    let scriptContent = (script as string).replace(/<TO_REPLACE>/g, amplitudeApiKey);
+    scriptContent = scriptContent.replace('<TO_REPLACE_INIT_CONFIG>', initConfigJson);
+
+    return new Response(scriptContent, {
         headers: {
             'Content-Type': 'application/javascript',
             'Cache-Control': 'max-age=604800',

integrations/amplitude/package.json

@@ -1,5 +1,11 @@
 # @gitbook/integration-arcade
 
+## 0.3.0
+
+### Minor Changes
+
+- 76e1a39: Add query param for language
+
 ## 0.2.2
 
 ### Patch Changes