@tekibo/feedpulse-sdk 2.1.1 → 2.1.3

package/README.md

@@ -20,7 +20,7 @@ The SDK automatically tracks:
 - `hover`: when users hover an element for more than 500ms
 - `scroll_into_view`: when tagged elements enter viewport
 - `feedback`: explicit rating/message submissions from widget or manual API
-
+## Quick start (Nuxt)
 
 Import from `@tekibo/feedpulse-sdk/nuxt` and wrap your app:
 
@@ -31,16 +31,13 @@ import { FeedPulseProvider, FeedPulseWidget } from "@tekibo/feedpulse-sdk/nuxt";
 
 <template>
   <FeedPulseProvider api-key="fp_live_your_project_key">
-  <FeedPulseProvider
-    api-key="fp_live_your_project_key"
-    endpoint="https://feed-pulse.vercel.app/api/ingest"
-  >
+    <NuxtPage />
     <FeedPulseWidget id="global-feedback" position="bottom-right" />
   </FeedPulseProvider>
 </template>
 ```
 
-
+The SDK uses `https://feed-pulse.vercel.app/api/ingest` by default, so only `api-key` is required.
 Tag any interactive element with `data-fp-id`:
 
 ```vue
@@ -87,10 +84,7 @@ function SaveButton() {
 
 export default function App() {
   return (
-    <FeedPulseProvider
-      apiKey="fp_live_your_project_key"
-      endpoint="https://feed-pulse.vercel.app/api/ingest"
-    >
+    <FeedPulseProvider apiKey="fp_live_your_project_key">
       <button data-fp-id="hero-cta">Get Started</button>
       <SaveButton />
       <FeedPulseWidget id="global-feedback" position="bottom-right" />
@@ -128,6 +122,13 @@ Nuxt and React widgets support:
 - `placeholder?: string` prompt text
 - `position?: "bottom-right" | "bottom-left" | "inline"` default is `"bottom-right"`
 
+## Optional endpoint override
+
+You can override the default endpoint when needed:
+
+- Nuxt: `<FeedPulseProvider api-key="..." endpoint="https://your-domain.com/api/ingest">`
+- React: `<FeedPulseProvider apiKey="..." endpoint="https://your-domain.com/api/ingest">`
+
 ## Integration checklist for your app
 
 1. Create a project in FeedPulse dashboard and copy the project API key

package/dist/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class n{constructor(e){this.queue=[],this.flushInterval=null,this.observer=null,this.intersectionObserver=null,this.seenInView=new Set,this.config={endpoint:"https://feed-pulse.vercel.app/api/ingest",batchInterval:5e3,...e},this.visitorId=this.getOrCreateVisitorId(),this.sessionId=this.generateSessionId()}init(){this.startFlushInterval(),this.attachGlobalListeners(),this.observeDOM()}attachGlobalListeners(){document.addEventListener("click",i=>{const s=i.target.closest("[data-fp-id]");s&&this.track("click",s.getAttribute("data-fp-id"),{x:i.clientX,y:i.clientY})},{passive:!0});let e=0,t=null;document.addEventListener("mouseover",i=>{const s=i.target.closest("[data-fp-id]");s&&(e=Date.now(),t=s.getAttribute("data-fp-id"))},{passive:!0}),document.addEventListener("mouseout",i=>{if(!i.target.closest("[data-fp-id]")||!t)return;const r=Date.now()-e;r>500&&this.track("hover",t,{hoverDuration:r}),t=null},{passive:!0})}observeDOM(){this.intersectionObserver=new IntersectionObserver(t=>{for(const i of t){const s=i.target.dataset.fpId;!s||!i.isIntersecting||this.seenInView.has(s)||(this.seenInView.add(s),this.track("scroll_into_view",s,{scrollDepth:Math.round(window.scrollY/Math.max(1,document.body.scrollHeight)*100)}))}},{threshold:.5});const e=()=>{document.querySelectorAll("[data-fp-id]").forEach(t=>{this.intersectionObserver?.observe(t)})};e(),this.observer=new MutationObserver(()=>e()),this.observer.observe(document.body,{childList:!0,subtree:!0})}track(e,t,i){this.queue.push({projectApiKey:this.config.apiKey,elementId:t,eventType:e,sessionId:this.sessionId,visitorId:this.visitorId,page:window.location.pathname,referrer:document.referrer,device:this.getDeviceType(),browser:this.getBrowser(),os:this.getOS(),metadata:i,timestamp:new Date().toISOString()})}trackFeedback(e,t,i){!t&&!i||this.sendImmediate([{projectApiKey:this.config.apiKey,elementId:e??"__page__",eventType:"feedback",sessionId:this.sessionId,visitorId:this.visitorId,page:window.location.pathname,device:this.getDeviceType(),metadata:{rating:t,message:i},timestamp:new Date().toISOString()}])}async flush(){if(this.queue.length===0)return;const e=[...this.queue];this.queue=[],await this.sendImmediate(e)}async sendImmediate(e){try{await fetch(this.config.endpoint,{method:"POST",headers:{"content-type":"application/json"},body:JSON.stringify({events:e}),keepalive:!0})}catch{}}startFlushInterval(){this.flushInterval=setInterval(()=>this.flush(),this.config.batchInterval),window.addEventListener("beforeunload",()=>this.flush()),document.addEventListener("visibilitychange",()=>{document.visibilityState==="hidden"&&this.flush()})}getOrCreateVisitorId(){const e="__fp_vid";let t=localStorage.getItem(e);return t||(t=crypto.randomUUID(),localStorage.setItem(e,t)),t}generateSessionId(){return`${Date.now()}-${Math.random().toString(36).slice(2)}`}getDeviceType(){const e=navigator.userAgent;return/Mobi|Android/i.test(e)?"mobile":/Tablet|iPad/i.test(e)?"tablet":"desktop"}getBrowser(){const e=navigator.userAgent;return e.includes("Edg")?"Edge":e.includes("Chrome")?"Chrome":e.includes("Firefox")?"Firefox":e.includes("Safari")?"Safari":"Other"}getOS(){const e=navigator.userAgent;return e.includes("Windows")?"Windows":e.includes("Mac")?"macOS":e.includes("Linux")?"Linux":e.includes("Android")?"Android":/iPhone|iOS/.test(e)?"iOS":"Other"}destroy(){this.flushInterval&&clearInterval(this.flushInterval),this.observer?.disconnect(),this.intersectionObserver?.disconnect(),this.flush()}}exports.FeedPulseTracker=n;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class n{constructor(e){this.queue=[],this.flushInterval=null,this.observer=null,this.intersectionObserver=null,this.seenInView=new Set;const i="https://feed-pulse.vercel.app/api/ingest";this.config={apiKey:e.apiKey,endpoint:e.endpoint??i,batchInterval:e.batchInterval??5e3},this.visitorId="",this.sessionId=""}init(){this.isBrowser()&&(this.visitorId=this.getOrCreateVisitorId(),this.sessionId=this.generateSessionId(),this.startFlushInterval(),this.attachGlobalListeners(),this.observeDOM())}attachGlobalListeners(){document.addEventListener("click",t=>{const r=t.target.closest("[data-fp-id]");r&&this.track("click",r.getAttribute("data-fp-id"),{x:t.clientX,y:t.clientY})},{passive:!0});let e=0,i=null;document.addEventListener("mouseover",t=>{const r=t.target.closest("[data-fp-id]");r&&(e=Date.now(),i=r.getAttribute("data-fp-id"))},{passive:!0}),document.addEventListener("mouseout",t=>{if(!t.target.closest("[data-fp-id]")||!i)return;const s=Date.now()-e;s>500&&this.track("hover",i,{hoverDuration:s}),i=null},{passive:!0})}observeDOM(){this.intersectionObserver=new IntersectionObserver(i=>{for(const t of i){const r=t.target.dataset.fpId;!r||!t.isIntersecting||this.seenInView.has(r)||(this.seenInView.add(r),this.track("scroll_into_view",r,{scrollDepth:Math.round(window.scrollY/Math.max(1,document.body.scrollHeight)*100)}))}},{threshold:.5});const e=()=>{document.querySelectorAll("[data-fp-id]").forEach(i=>{this.intersectionObserver?.observe(i)})};e(),this.observer=new MutationObserver(()=>e()),this.observer.observe(document.body,{childList:!0,subtree:!0})}track(e,i,t){this.isBrowser()&&this.queue.push({projectApiKey:this.config.apiKey,elementId:i,eventType:e,sessionId:this.sessionId,visitorId:this.visitorId,page:window.location.pathname,referrer:document.referrer,device:this.getDeviceType(),browser:this.getBrowser(),os:this.getOS(),metadata:t,timestamp:new Date().toISOString()})}trackFeedback(e,i,t){this.isBrowser()&&(!i&&!t||this.sendImmediate([{projectApiKey:this.config.apiKey,elementId:e??"__page__",eventType:"feedback",sessionId:this.sessionId,visitorId:this.visitorId,page:window.location.pathname,device:this.getDeviceType(),metadata:{rating:i,message:t},timestamp:new Date().toISOString()}]))}async flush(){if(this.queue.length===0)return;const e=[...this.queue];this.queue=[],await this.sendImmediate(e)}async sendImmediate(e){try{await fetch(this.config.endpoint,{method:"POST",headers:{"content-type":"application/json"},body:JSON.stringify({events:e}),keepalive:!0})}catch{}}startFlushInterval(){this.flushInterval=setInterval(()=>this.flush(),this.config.batchInterval),window.addEventListener("beforeunload",()=>this.flush()),document.addEventListener("visibilitychange",()=>{document.visibilityState==="hidden"&&this.flush()})}getOrCreateVisitorId(){const e="__fp_vid",i=this.generateId();try{let t=localStorage.getItem(e);return t||(t=i,localStorage.setItem(e,t)),t}catch{return i}}generateId(){return typeof crypto<"u"&&typeof crypto.randomUUID=="function"?crypto.randomUUID():`${Date.now()}-${Math.random().toString(36).slice(2)}`}isBrowser(){return typeof window<"u"&&typeof document<"u"}generateSessionId(){return`${Date.now()}-${Math.random().toString(36).slice(2)}`}getDeviceType(){const e=navigator.userAgent;return/Mobi|Android/i.test(e)?"mobile":/Tablet|iPad/i.test(e)?"tablet":"desktop"}getBrowser(){const e=navigator.userAgent;return e.includes("Edg")?"Edge":e.includes("Chrome")?"Chrome":e.includes("Firefox")?"Firefox":e.includes("Safari")?"Safari":"Other"}getOS(){const e=navigator.userAgent;return e.includes("Windows")?"Windows":e.includes("Mac")?"macOS":e.includes("Linux")?"Linux":e.includes("Android")?"Android":/iPhone|iOS/.test(e)?"iOS":"Other"}destroy(){this.flushInterval&&clearInterval(this.flushInterval),this.observer?.disconnect(),this.intersectionObserver?.disconnect(),this.flush()}}exports.FeedPulseTracker=n;

package/dist/index.mjs

@@ -1,53 +1,55 @@
 class o {
   constructor(e) {
-    this.queue = [], this.flushInterval = null, this.observer = null, this.intersectionObserver = null, this.seenInView = /* @__PURE__ */ new Set(), this.config = {
-      endpoint: "https://feed-pulse.vercel.app/api/ingest",
-      batchInterval: 5e3,
-      ...e
-    }, this.visitorId = this.getOrCreateVisitorId(), this.sessionId = this.generateSessionId();
+    this.queue = [], this.flushInterval = null, this.observer = null, this.intersectionObserver = null, this.seenInView = /* @__PURE__ */ new Set();
+    const i = "https://feed-pulse.vercel.app/api/ingest";
+    this.config = {
+      apiKey: e.apiKey,
+      endpoint: e.endpoint ?? i,
+      batchInterval: e.batchInterval ?? 5e3
+    }, this.visitorId = "", this.sessionId = "";
   }
   init() {
-    this.startFlushInterval(), this.attachGlobalListeners(), this.observeDOM();
+    this.isBrowser() && (this.visitorId = this.getOrCreateVisitorId(), this.sessionId = this.generateSessionId(), this.startFlushInterval(), this.attachGlobalListeners(), this.observeDOM());
   }
   attachGlobalListeners() {
-    document.addEventListener("click", (i) => {
-      const s = i.target.closest("[data-fp-id]");
-      s && this.track("click", s.getAttribute("data-fp-id"), {
-        x: i.clientX,
-        y: i.clientY
+    document.addEventListener("click", (t) => {
+      const r = t.target.closest("[data-fp-id]");
+      r && this.track("click", r.getAttribute("data-fp-id"), {
+        x: t.clientX,
+        y: t.clientY
       });
     }, { passive: !0 });
-    let e = 0, t = null;
-    document.addEventListener("mouseover", (i) => {
-      const s = i.target.closest("[data-fp-id]");
-      s && (e = Date.now(), t = s.getAttribute("data-fp-id"));
-    }, { passive: !0 }), document.addEventListener("mouseout", (i) => {
-      if (!i.target.closest("[data-fp-id]") || !t)
+    let e = 0, i = null;
+    document.addEventListener("mouseover", (t) => {
+      const r = t.target.closest("[data-fp-id]");
+      r && (e = Date.now(), i = r.getAttribute("data-fp-id"));
+    }, { passive: !0 }), document.addEventListener("mouseout", (t) => {
+      if (!t.target.closest("[data-fp-id]") || !i)
         return;
-      const r = Date.now() - e;
-      r > 500 && this.track("hover", t, { hoverDuration: r }), t = null;
+      const s = Date.now() - e;
+      s > 500 && this.track("hover", i, { hoverDuration: s }), i = null;
     }, { passive: !0 });
   }
   observeDOM() {
-    this.intersectionObserver = new IntersectionObserver((t) => {
-      for (const i of t) {
-        const s = i.target.dataset.fpId;
-        !s || !i.isIntersecting || this.seenInView.has(s) || (this.seenInView.add(s), this.track("scroll_into_view", s, {
+    this.intersectionObserver = new IntersectionObserver((i) => {
+      for (const t of i) {
+        const r = t.target.dataset.fpId;
+        !r || !t.isIntersecting || this.seenInView.has(r) || (this.seenInView.add(r), this.track("scroll_into_view", r, {
           scrollDepth: Math.round(window.scrollY / Math.max(1, document.body.scrollHeight) * 100)
         }));
       }
     }, { threshold: 0.5 });
     const e = () => {
-      document.querySelectorAll("[data-fp-id]").forEach((t) => {
-        this.intersectionObserver?.observe(t);
+      document.querySelectorAll("[data-fp-id]").forEach((i) => {
+        this.intersectionObserver?.observe(i);
       });
     };
     e(), this.observer = new MutationObserver(() => e()), this.observer.observe(document.body, { childList: !0, subtree: !0 });
   }
-  track(e, t, i) {
-    this.queue.push({
+  track(e, i, t) {
+    this.isBrowser() && this.queue.push({
       projectApiKey: this.config.apiKey,
-      elementId: t,
+      elementId: i,
       eventType: e,
       sessionId: this.sessionId,
       visitorId: this.visitorId,
@@ -56,12 +58,12 @@ class o {
       device: this.getDeviceType(),
       browser: this.getBrowser(),
       os: this.getOS(),
-      metadata: i,
+      metadata: t,
       timestamp: (/* @__PURE__ */ new Date()).toISOString()
     });
   }
-  trackFeedback(e, t, i) {
-    !t && !i || this.sendImmediate([{
+  trackFeedback(e, i, t) {
+    this.isBrowser() && (!i && !t || this.sendImmediate([{
       projectApiKey: this.config.apiKey,
       elementId: e ?? "__page__",
       eventType: "feedback",
@@ -69,9 +71,9 @@ class o {
       visitorId: this.visitorId,
       page: window.location.pathname,
       device: this.getDeviceType(),
-      metadata: { rating: t, message: i },
+      metadata: { rating: i, message: t },
       timestamp: (/* @__PURE__ */ new Date()).toISOString()
-    }]);
+    }]));
   }
   async flush() {
     if (this.queue.length === 0)
@@ -96,9 +98,19 @@ class o {
     });
   }
   getOrCreateVisitorId() {
-    const e = "__fp_vid";
-    let t = localStorage.getItem(e);
-    return t || (t = crypto.randomUUID(), localStorage.setItem(e, t)), t;
+    const e = "__fp_vid", i = this.generateId();
+    try {
+      let t = localStorage.getItem(e);
+      return t || (t = i, localStorage.setItem(e, t)), t;
+    } catch {
+      return i;
+    }
+  }
+  generateId() {
+    return typeof crypto < "u" && typeof crypto.randomUUID == "function" ? crypto.randomUUID() : `${Date.now()}-${Math.random().toString(36).slice(2)}`;
+  }
+  isBrowser() {
+    return typeof window < "u" && typeof document < "u";
   }
   generateSessionId() {
     return `${Date.now()}-${Math.random().toString(36).slice(2)}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tekibo/feedpulse-sdk",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "Embeddable analytics and feedback SDK for FeedPulse",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",