feat: ahoy (#29)

oddcamp · Jan 23, 2023 · 4dca9ed · 4dca9ed
1 parent ea9a5b9
commit 4dca9ed
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,24 @@ A collection of analytics helper functions.
 ## Supported analytics services
 
 - Plausible
+- Ahoy
+
+### Plausible
+
+Make sure the API object is available at `window.plausible`. It usually is if the snippet was inserted via `<script>`.
+
+### Plausible
+
+Make sure the API object is available at `window.ahoy`. If you use it as NPM module you can expose the object like this:
+
+```js
+import ahoy from "ahoy.js"
+
+window.ahoy = ahoy
+```
+
+
+###
 
 ## Usage
 
@@ -47,7 +65,8 @@ JSX
 ## Development
 
 1. Create `.env` and set variables of analytics services you prefer to test:
-    - `PLAUSIBLE_DOMAIN`
+    - `PLAUSIBLE_DOMAIN=something.site`
+    - `AHOY_SCRIPT_URL=https://unpkg.com/[email protected]/dist/ahoy.js`
 2. `$ yarn install`
 3. `$ yarn dev`
 3. [localhost:1234](http://localhost:1234)
@@ -64,7 +83,7 @@ _Defaults:_
 enableAutoEventAnalytics({
   attributeName = `event-analytics`,
   sourceNode = document,
-  services = [`plausible`],
+  services = [`plausible`, `ahoy`],
   debug = false,
 })
 ```
@@ -111,7 +130,7 @@ _Defaults:_
 ```js
 analyticizeEvent({ 
   data, 
-  services = [`plausible`],
+  services = [`plausible`, `ahoy`],
   debug = false 
 })
 ```

diff --git a/examples/index.html b/examples/index.html
@@ -5,6 +5,10 @@
     <if condition="plausible_domain">
       <script defer data-domain="{{ plausible_domain }}" src="https://plausible.io/js/script.local.js"></script>
     </if>
+
+    <if condition="ahoy_script_url">
+      <script defer src="{{ ahoy_script_url }}"></script>
+    </if>
   </head>
 
   <body>

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@oddcamp/analytics",
   "description": "Odd Camp analytics helpers library",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "author": "Odd Camp <[email protected]>",
   "license": "MIT",
   "main": "src/index.js",

diff --git a/posthtml.config.js b/posthtml.config.js
@@ -3,7 +3,10 @@ require(`dotenv`).config({ path: `.env` })
 module.exports = {
   plugins: {
     "posthtml-expressions": {
-      locals: { plausible_domain: process.env.PLAUSIBLE_DOMAIN },
+      locals: {
+        plausible_domain: process.env.PLAUSIBLE_DOMAIN,
+        ahoy_script_url: process.env.AHOY_SCRIPT_URL,
+      },
     },
   },
 }
diff --git a/src/index.js b/src/index.js
@@ -1,6 +1,6 @@
 import { isPlainObject, get } from "lodash"
 
-const SERVICES = [`plausible`]
+const SERVICES = [`plausible`, `ahoy`]
 
 function enableAutoEventAnalytics({
   attributeName = `event-analytics`,
@@ -196,6 +196,22 @@ function analyticizeEvent({ data, services = SERVICES, debug = false } = {}) {
         }
         break
       }
+
+      case `ahoy`: {
+        if (window && window.ahoy) {
+          debugLog(debug, `Ahoy event analyzation has been requested`, data)
+
+          window.ahoy.track(data.name, { ...(data.props || {}) })
+
+          debugLog(debug, `Ahoy event has been analyzed`, data)
+        } else {
+          debugLog(
+            debug,
+            `Ahoy event analysation requested, but service is not available`
+          )
+        }
+        break
+      }
     }
   })
 }
@@ -206,6 +222,10 @@ function anyServicesAvailable(services) {
       case `plausible`: {
         return !!window.plausible
       }
+
+      case `ahoy`: {
+        return !!window.ahoy
+      }
     }
 
     return false