feat: add integration to support better integration with Wistia

integrations/wistia/gitbook-manifest.yaml

@@ -0,0 +1,28 @@
+name: wistia
+title: Wistia
+icon: ./assets/icon.svg
+previewImages:
+    - ./assets/wistia-preview.png
+description: Add Wistia video analytics to your GitBook site.
+visibility: public
+script: ./src/index.ts
+scopes:
+    - site:script:inject
+    - site:script:cookies
+organization: gitbook
+contentSecurityPolicy:
+    script-src: https://fast.wistia.com;
+summary: |
+    # Overview
+    This integration introduces support for collecting analytics on videos played by users. You can explore the full range of analytics offered by Wistia(https://wistia.com/product/analytics).
+    The videos are hosted on Wistia and embedded in GitBook using the built-in video embed feature. To enable tracking of these analytics—along with relevant information from the root page—Wistia's JavaScript libraries must be included on the root page.
+    This plugin facilitates that by injecting the required Wistia script into the page.
+
+    # How it works
+    The integration injects the Wistia script (https://fast.wistia.com/assets/external/E-v1.js)
+    on your page to enable video analytics tracking.
+    See example: https://docs.wistia.com/docs/iframe-embed-options#iframe-embed-options-and-bracket-notation
+
+categories:
+    - analytics
+target: site

integrations/wistia/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "@gitbook/integration-wistia",
+    "version": "1.0.0",
+    "private": true,
+    "dependencies": {
+        "@gitbook/api": "*",
+        "@gitbook/runtime": "*"
+    },
+    "devDependencies": {
+        "@gitbook/cli": "workspace:*",
+        "@gitbook/tsconfig": "workspace:*"
+    },
+    "scripts": {
+        "typecheck": "tsc --noEmit",
+        "publish-integrations-staging": "gitbook publish .",
+        "check": "gitbook check",
+        "publish-integrations": "gitbook publish ."
+    }
+}

integrations/wistia/src/index.ts

@@ -0,0 +1,23 @@
+import {
+    createIntegration,
+    FetchPublishScriptEventCallback,
+    RuntimeContext,
+    RuntimeEnvironment,
+} from '@gitbook/runtime';
+
+import script from './script.raw.js';
+
+type WistiaRuntimeContext = RuntimeContext<RuntimeEnvironment<{}, {}>>;
+
+export const handleFetchEvent: FetchPublishScriptEventCallback = async () => {
+    return new Response(script as string, {
+        headers: {
+            'Content-Type': 'application/javascript',
+            'Cache-Control': 'max-age=604800',
+        },
+    });
+};
+
+export default createIntegration<WistiaRuntimeContext>({
+    fetch_published_script: handleFetchEvent,
+});

integrations/wistia/src/script.raw.js

@@ -0,0 +1,24 @@
+const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+function getCookie(cname) {
+    const name = `${cname}=`;
+    const decodedCookie = decodeURIComponent(document.cookie);
+    const ca = decodedCookie.split(';');
+    for (let i = 0; i < ca.length; i++) {
+        let c = ca[i];
+        while (c.charAt(0) === ' ') {
+            c = c.substring(1);
+        }
+        if (c.indexOf(name) === 0) {
+            return c.substring(name.length, c.length);
+        }
+    }
+    return '';
+}
+
+if (getCookie(GRANTED_COOKIE) === 'yes') {
+    const script = document.createElement('script');
+    script.src = 'https://fast.wistia.com/assets/external/E-v1.js';
+    script.async = true;
+    document.head.appendChild(script);
+}

integrations/wistia/tsconfig.json

@@ -0,0 +1,7 @@
+{
+    "extends": "@gitbook/tsconfig/base.json",
+    "compilerOptions": {
+        "outDir": "./dist"
+    },
+    "include": ["src/**/*"]
+}