Add Mouseflow integration

integrations/mouseflow/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": ["@gitbook/eslint-config/integration"]
+}

integrations/mouseflow/CHANGELOG.md

@@ -0,0 +1 @@
+# @gitbook/integration-mouseflow

integrations/mouseflow/gitbook-manifest.yaml

@@ -0,0 +1,41 @@
+name: mouseflow
+title: mouseflow
+icon: ./assets/icon.png
+previewImages:
+    - ./assets/mouseflow-preview.png
+description: Plug your GitBook site to your Mouseflow installation.
+externalLinks:
+    - label: Documentation
+      url: https://www.gitbook.com/integrations/mouseflow
+visibility: public
+script: ./src/index.ts
+# The following scope(s) are available only to GitBook Staff
+# See https://developer.gitbook.com/integrations/configurations#scopes
+scopes:
+    - space:script:inject
+organization: d8f63b60-89ae-11e7-8574-5927d48c4877
+contentSecurityPolicy:
+    script-src: cdn.mouseflow.com;
+summary: |
+    # Overview
+    This integration allows to add the Mouseflow tracker on your published GitBook site.
+
+    # How it works
+    The integration injects the Mouseflow script on your page, using the configured Website ID,
+    so that you can get analytics information from your GitBook site.
+
+    # Configure
+    Install the integration on the GitBook space of your choice.
+    Locate the Website ID you want to use from the settings page.
+
+categories:
+    - analytics
+configurations:
+    space:
+        properties:
+            website_id:
+                type: string
+                title: Mouseflow Website ID
+                description: Available in Mouseflow website settings page
+        required:
+            - website_id

integrations/mouseflow/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "@gitbook/integration-mouseflow",
+    "version": "0.0.1",
+    "private": true,
+    "dependencies": {
+        "@gitbook/api": "*",
+        "@gitbook/runtime": "*"
+    },
+    "devDependencies": {
+        "@gitbook/cli": "*"
+    },
+    "scripts": {
+        "lint": "eslint ./src/**/*.ts",
+        "typecheck": "tsc --noEmit",
+        "publish-integrations-staging": "gitbook publish .",
+        "publish-integrations": "gitbook publish ."
+    }
+}

integrations/mouseflow/src/index.ts

@@ -0,0 +1,40 @@
+import {
+    createIntegration,
+    FetchPublishScriptEventCallback,
+    RuntimeContext,
+    RuntimeEnvironment,
+} from '@gitbook/runtime';
+
+import script from './script.raw.js';
+
+type MouseflowRuntimeContext = RuntimeContext<
+    RuntimeEnvironment<
+        {},
+        {
+            website_id?: string;
+        }
+    >
+>;
+
+export const handleFetchEvent: FetchPublishScriptEventCallback = async (
+    event,
+    { environment }: MouseflowRuntimeContext
+) => {
+    const websiteId = environment.spaceInstallation.configuration.website_id;
+    if (!websiteId) {
+        throw new Error(
+            `The Mouseflow Website ID is missing from the configuration. (ID: ${event.spaceId}).`
+        );
+    }
+
+    return new Response(script.replace('<TO_REPLACE>', websiteId), {
+        headers: {
+            'Content-Type': 'application/javascript',
+            'Cache-Control': 'max-age=604800',
+        },
+    });
+};
+
+export default createIntegration<MouseflowRuntimeContext>({
+    fetch_published_script: handleFetchEvent,
+});

integrations/mouseflow/src/script.raw.js

@@ -0,0 +1,10 @@
+const websiteId = '<TO_REPLACE>';
+
+window._mfq = window._mfq || [];
+(function() {
+    var mf = document.createElement("script");
+    mf.type = "text/javascript";
+    mf.defer = true;
+    mf.src = "//cdn.mouseflow.com/projects/" + websiteId + ".js";
+    document.getElementsByTagName("head")[0].appendChild(mf);
+})();

integrations/mouseflow/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "@gitbook/tsconfig/integration.json"
+}