@brillout/docpress 0.16.24 → 0.16.25

package/dist/types/Config.d.ts

@@ -28,6 +28,7 @@ type Config = {
         indexName: string;
     };
     googleAnalytics?: string;
+    umamiId?: string;
     i18n?: true;
     pressKit?: true;
     docsDir?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.16.24",
+  "version": "0.16.25",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",

package/renderer/onRenderClient.tsx

@@ -52,6 +52,7 @@ async function onRenderClient(pageContext: PageContextClient) {
   installSectionUrlHashs()
   setHydrationIsFinished()
   initGoogleAnalytics(pageContext)
+  initUmami(pageContext)
 
   globalObject.isNotFirstRender = true
 }
@@ -104,3 +105,46 @@ declare global {
     gtag: (...args: any[]) => void
   }
 }
+
+async function initUmami(pageContext: PageContextClient) {
+  // Only add script tag on first render
+  if (globalObject.isNotFirstRender) {
+    return
+  }
+
+  // Simple way to plug in umami
+  const umamiId = pageContext.config.docpress.umamiId;
+  if (!umamiId) {
+    return
+  }
+
+  try {
+    await addScript('https://cloud.umami.is/script.js', {
+      'data-website-id': umamiId,
+    })
+  } catch {
+    // Umami analytics unavailable
+  }
+}
+
+/** https://umami.is/docs/tracker-functions */
+type Umami = {
+  track: {
+    (): void
+    (eventName: string): void
+    (data: object): void
+    (eventName: string, data: object): void
+  }
+  identify: {
+    (uniqueId: string): void
+    (data: object): string
+    (uniqueId: string, data: object): void
+  }
+}
+
+declare global {
+  interface Window {
+    /** Script load is not guaranteed */
+    umami?: Umami;
+  }
+}

package/types/Config.ts

@@ -35,6 +35,7 @@ type Config = {
     indexName: string
   }
   googleAnalytics?: string
+  umamiId?: string
 
   i18n?: true
   pressKit?: true

package/utils/addScript.ts

@@ -2,12 +2,17 @@ export { addScript }
 
 import { genPromise } from './genPromise.js'
 
-async function addScript(src: string) {
+async function addScript(src: string, attributes?: Record<string, string>) {
   const { promise, resolve, reject } = genPromise()
   const script = document.createElement('script')
   script.onload = () => resolve()
   script.onerror = () => reject(new Error(`Failed to load script: ${src}`))
   script.src = src
+  if (attributes) {
+    for (const [name, value] of Object.entries(attributes)) {
+      script.setAttribute(name, value)
+    }
+  }
   document.head.appendChild(script)
   return promise
 }