@birdie-so/snippet 1.0.1 → 1.1.1

package/README.md

@@ -43,15 +43,44 @@ initBirdie({
 
   // Optional hook once Birdie is ready
   onReady(birdie) {
+    // you can register for the following events
+    birdie.on("recorderOpen", (data) => {
+      console.log("Recorder tab is opened", data);
+    });
     birdie.on("start", (data) => {
       console.log("Recording started", data);
       birdie.metadata = { dynamicKey: "value" };
     });
-
+    birdie.on("pause", (data) => {
+      console.log("Recording paused", data);
+    });
+    birdie.on("resume", (data) => {
+      console.log("Recording resumed", data);
+    });
     birdie.on("stop", (data) => {
       console.log("Recording stopped", data);
     });
-  },
+    birdie.on("restart", (data) => {
+      console.log("Recording restarted", data);
+    });
+    birdie.on("captureStarted", (data) => {
+      console.log("Capturing logs started", data);
+    });
+    birdie.on("captureStopped", (data) => {
+      console.log("Capturing logs stopped", data);
+    });
+    birdie.on("recordingSent", (data) => {
+      // data.link contains the link to the video
+      console.log("A new recording has been sent", data); 
+    });
+    birdie.on("recorderClose", (data) => {
+      console.log("Recorder tab was closed", data);
+    });
+    birdie.on("error", (error) => {
+      console.log("Something went wrong", error);
+    });
+  }
+
 });
 ```
 

package/package.json

@@ -1,14 +1,10 @@
 {
     "name": "@birdie-so/snippet",
-    "version": "1.0.1",
+    "version": "1.1.1",
     "description": "Helper for integrating the Birdie screen recording snippet into modern JavaScript apps. Requires a Birdie account.",
+    "type": "module",
     "main": "src/index.js",
-    "exports": {
-        ".": {
-            "require": "./src/index.js",
-            "import": "./src/index.js"
-        }
-    },
+    "exports": { ".": "./src/index.js" },
     "types": "src/index.d.ts",
     "keywords": [
         "birdie",

package/src/index.d.ts

@@ -17,11 +17,49 @@ export interface BirdieSettings {
      * Callback when Birdie is fully loaded and available as `window.birdie`.
      */
     onReady?: (birdie: BirdieAPI) => void;
+
+    /**
+     * If true (default), guarantees at most one active handler per event.
+     * Re-registering the same event replaces the previous handler (prevents double fires on remount/HMR).
+     */
+    singleHandlerPerEvent?: boolean;
 }
 
+// export interface BirdieAPI {
+//     metadata: BirdieMetadata;
+//     on(event: 'start' | 'stop' | 'captureStarted' | 'captureStopped' | 'pause' | 'restart' | 'resume' | 'recorderClose' | 'recorderOpen' | 'recordingSent' | 'error', callback: (data: any) => void): void;
+// }
+
 export interface BirdieAPI {
     metadata: BirdieMetadata;
-    on(event: 'start' | 'stop', callback: (data: any) => void): void;
+
+    on(
+      event:
+        | 'start' | 'stop' | 'captureStarted' | 'captureStopped'
+        | 'pause' | 'restart' | 'resume'
+        | 'recorderClose' | 'recorderOpen'
+        | 'recordingSent' | 'error',
+      callback: (data: any) => void
+    ): void;
+
+    off(
+      event:
+        | 'start' | 'stop' | 'captureStarted' | 'captureStopped'
+        | 'pause' | 'restart' | 'resume'
+        | 'recorderClose' | 'recorderOpen'
+        | 'recordingSent' | 'error',
+      callback: (data: any) => void
+    ): void;
+  
+    /** Auto-unsubscribes after the first event emission. */
+    onOnce(
+      event:
+        | 'start' | 'stop' | 'captureStarted' | 'captureStopped'
+        | 'pause' | 'restart' | 'resume'
+        | 'recorderClose' | 'recorderOpen'
+        | 'recordingSent' | 'error',
+      callback: (data: any) => void
+    ): void;
 }
 
 /**

package/src/index.js

@@ -1,6 +1,9 @@
 let _readyCallbacks = [];
 
-export function initBirdie({ clientId, metadata, onReady, ...otherSettings }) {
+export function initBirdie({ clientId, metadata, onReady, singleHandlerPerEvent = true, ...otherSettings }) {
+
+
+
     if (!clientId) {
         console.error('[Birdie] Missing required clientId in initBirdie()');
         return;
@@ -17,9 +20,13 @@ export function initBirdie({ clientId, metadata, onReady, ...otherSettings }) {
     window.birdieSettings.metadata = metadata;
     Object.assign(window.birdieSettings, otherSettings);
 
-    // Assign onBirdieReady BEFORE appending the script
     window.birdieSettings.onBirdieReady = () => {
-        _readyCallbacks.forEach(cb => cb(window.birdie));
+        try {
+            installBirdieGuards({ singleHandlerPerEvent });
+        } catch (e) {
+            console.error('[Birdie] guard install error', e);
+        }
+        _readyCallbacks.forEach(cb => { try { cb(window.birdie); } catch (e) { console.error('[Birdie] onReady error', e); } });
         _readyCallbacks = [];
     };
 
@@ -36,9 +43,17 @@ export function initBirdie({ clientId, metadata, onReady, ...otherSettings }) {
         script.id = 'birdie-snippet';
         document.body.appendChild(script);
     }
+    // if (!document.getElementById('birdie-snippet')) {
+    //     const script = document.createElement('script');
+    //     script.src = `https://birdie.eu.ngrok.io/snippet/index.local.min.js`;
+    //     script.async = true;
+    //     script.id = 'birdie-snippet';
+    //     document.body.appendChild(script);
+    // }
 }
 
 function registerBirdieReadyCallback(callback) {
+    if (typeof window === 'undefined') return;
     if (window.birdie) {
         callback(window.birdie);
     } else {
@@ -47,6 +62,7 @@ function registerBirdieReadyCallback(callback) {
 }
 
 export function getBirdieInstance(onReady) {
+    if (typeof window === 'undefined') return null;
     if (window.birdie) {
         onReady?.(window.birdie);
         return window.birdie;
@@ -55,3 +71,45 @@ export function getBirdieInstance(onReady) {
         return null;
     }
 }
+
+// ---- guards & helpers ----
+function installBirdieGuards({ singleHandlerPerEvent }) {
+    const b = window.birdie;
+    if (!b || b.__pkgGuardsInstalled) return;
+
+    // Keep originals
+    const originalOn = b.on?.bind(b);
+    const originalOff = b.off?.bind(b);
+
+    // Registry of the single active handler per event (for dedupe)
+    const singletons = new Map();
+
+    // Add onOnce
+    b.onOnce = (event, cb) => {
+        const wrapper = (data) => {
+            try { cb(data); } finally { b.off?.(event, wrapper); }
+        };
+        b.on(event, wrapper);
+    };
+
+    if (singleHandlerPerEvent && originalOn && originalOff) {
+        b.on = (event, cb) => {
+            // If there was a previous handler for this event installed via this layer, remove it
+            const prev = singletons.get(event);
+            if (prev) {
+                try { originalOff(event, prev); } catch { }
+            }
+            singletons.set(event, cb);
+            return originalOn(event, cb);
+        };
+
+        b.off = (event, cb) => {
+            // Clean our registry if the same cb is removed
+            const prev = singletons.get(event);
+            if (prev === cb) singletons.delete(event);
+            return originalOff(event, cb);
+        };
+    }
+
+    b.__pkgGuardsInstalled = true;
+}