@stacksee/analytics 0.5.0 → 0.8.0

package/dist/providers/proxy/types.d.ts

@@ -0,0 +1,64 @@
+import { BaseEvent, EventContext } from '../../core/events/types.js';
+/**
+ * Proxy event types for batching and sending to server
+ */
+export type ProxyTrackEvent = {
+    type: "track";
+    event: BaseEvent;
+    context?: EventContext;
+};
+export type ProxyIdentifyEvent = {
+    type: "identify";
+    userId: string;
+    traits?: Record<string, unknown>;
+};
+export type ProxyPageViewEvent = {
+    type: "pageView";
+    properties?: Record<string, unknown>;
+    context?: EventContext;
+};
+export type ProxyResetEvent = {
+    type: "reset";
+};
+export type ProxyEvent = ProxyTrackEvent | ProxyIdentifyEvent | ProxyPageViewEvent | ProxyResetEvent;
+/**
+ * Payload sent to the proxy endpoint
+ */
+export interface ProxyPayload {
+    events: ProxyEvent[];
+}
+/**
+ * Configuration for batching behavior
+ */
+export interface ProxyBatchConfig {
+    /**
+     * Maximum number of events before auto-flush
+     * @default 10
+     */
+    size?: number;
+    /**
+     * Maximum time in ms before auto-flush
+     * @default 5000
+     */
+    interval?: number;
+}
+/**
+ * Configuration for retry behavior
+ */
+export interface ProxyRetryConfig {
+    /**
+     * Maximum retry attempts
+     * @default 3
+     */
+    attempts?: number;
+    /**
+     * Backoff strategy
+     * @default 'exponential'
+     */
+    backoff?: "exponential" | "linear";
+    /**
+     * Initial delay in ms
+     * @default 1000
+     */
+    initialDelay?: number;
+}

package/dist/providers/server.d.ts

@@ -1,3 +1,9 @@
 export { BaseAnalyticsProvider } from './base.provider.js';
 export { PostHogServerProvider } from './posthog/server.js';
 export type { PostHogOptions } from 'posthog-node';
+export { BentoServerProvider } from './bento/server.js';
+export type { BentoServerConfig, BentoAnalyticsOptions } from './bento/server.js';
+export { PirschServerProvider } from './pirsch/server.js';
+export type { PirschServerConfig } from './pirsch/server.js';
+export { ingestProxyEvents, createProxyHandler } from './proxy/server.js';
+export type { IngestProxyEventsConfig } from './proxy/server.js';

package/dist/providers/server.js

@@ -1,6 +1,307 @@
-import { B as e } from "../base.provider-AfFL5W_P.js";
-import { P as a } from "../server-DjEk1fUD.js";
+var f = Object.defineProperty;
+var y = (l, n, i) => n in l ? f(l, n, { enumerable: !0, configurable: !0, writable: !0, value: i }) : l[n] = i;
+var d = (l, n, i) => y(l, typeof n != "symbol" ? n + "" : n, i);
+import { B as p } from "../base.provider-AfFL5W_P.js";
+import { P as z } from "../server-DjEk1fUD.js";
+class v extends p {
+  constructor(i) {
+    super({ debug: i.debug, enabled: i.enabled });
+    d(this, "name", "Bento-Server");
+    d(this, "client");
+    d(this, "initialized", !1);
+    d(this, "config");
+    d(this, "currentUserEmail");
+    this.config = i;
+  }
+  async initialize() {
+    var i, e;
+    if (this.isEnabled() && !this.initialized) {
+      if (!this.config.siteUuid || typeof this.config.siteUuid != "string")
+        throw new Error("Bento requires a siteUuid");
+      if (!((i = this.config.authentication) != null && i.publishableKey) || typeof this.config.authentication.publishableKey != "string")
+        throw new Error("Bento requires authentication.publishableKey");
+      if (!((e = this.config.authentication) != null && e.secretKey) || typeof this.config.authentication.secretKey != "string")
+        throw new Error("Bento requires authentication.secretKey");
+      try {
+        const { Analytics: s } = await import("../bento-node-sdk.esm-C4HG7SVz.js"), { debug: a, enabled: t, ...o } = this.config;
+        this.client = new s(o), this.initialized = !0, this.log("Initialized successfully", {
+          siteUuid: this.config.siteUuid
+        });
+      } catch (s) {
+        throw console.error(
+          "[Bento-Server] Failed to initialize. Make sure @bentonow/bento-node-sdk is installed:",
+          s
+        ), s;
+      }
+    }
+  }
+  identify(i, e) {
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const s = (e == null ? void 0 : e.email) || i;
+    this.currentUserEmail = s;
+    const a = e ? { ...e } : {};
+    delete a.email, this.client.V1.addSubscriber({
+      email: s,
+      fields: a
+    }).catch((t) => {
+      console.error("[Bento-Server] Failed to identify user:", t);
+    }), this.log("Identified user", { userId: i, email: s, traits: e });
+  }
+  async track(i, e) {
+    var o, r, h;
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const s = ((o = e == null ? void 0 : e.user) == null ? void 0 : o.email) || this.currentUserEmail || ((r = e == null ? void 0 : e.user) == null ? void 0 : r.userId) || i.userId || "anonymous@unknown.com", a = {
+      ...i.properties,
+      category: i.category,
+      timestamp: i.timestamp || Date.now(),
+      ...i.sessionId && { sessionId: i.sessionId },
+      ...(e == null ? void 0 : e.page) && {
+        page: {
+          path: e.page.path,
+          title: e.page.title,
+          referrer: e.page.referrer
+        }
+      },
+      ...(e == null ? void 0 : e.device) && { device: e.device },
+      ...(e == null ? void 0 : e.utm) && { utm: e.utm }
+    }, t = ((h = e == null ? void 0 : e.user) == null ? void 0 : h.traits) || {};
+    try {
+      await this.client.V1.track({
+        email: s,
+        type: `$${i.action}`,
+        details: a,
+        fields: t
+      }), this.log("Tracked event", { event: i, context: e });
+    } catch (u) {
+      console.error("[Bento-Server] Failed to track event:", u);
+    }
+  }
+  pageView(i, e) {
+    var o, r;
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const s = ((o = e == null ? void 0 : e.user) == null ? void 0 : o.email) || this.currentUserEmail || "anonymous@unknown.com", a = {
+      ...i,
+      ...(e == null ? void 0 : e.page) && {
+        path: e.page.path,
+        title: e.page.title,
+        referrer: e.page.referrer
+      }
+    }, t = ((r = e == null ? void 0 : e.user) == null ? void 0 : r.traits) || {};
+    this.client.V1.track({
+      email: s,
+      type: "$pageview",
+      details: a,
+      fields: t
+    }).catch((h) => {
+      console.error("[Bento-Server] Failed to track page view:", h);
+    }), this.log("Tracked page view", { properties: i, context: e });
+  }
+  async reset() {
+    !this.isEnabled() || !this.initialized || !this.client || (this.currentUserEmail = void 0, this.log("Reset user session"));
+  }
+  async shutdown() {
+    this.client = void 0, this.initialized = !1, this.log("Shutdown complete");
+  }
+}
+class E extends p {
+  constructor(i) {
+    super({ debug: i.debug, enabled: i.enabled });
+    d(this, "name", "Pirsch-Server");
+    d(this, "client");
+    d(this, "initialized", !1);
+    d(this, "config");
+    this.config = i;
+  }
+  async initialize() {
+    if (this.isEnabled() && !this.initialized) {
+      if (!this.config.hostname || typeof this.config.hostname != "string")
+        throw new Error("Pirsch requires a hostname");
+      if (!this.config.clientSecret || typeof this.config.clientSecret != "string")
+        throw new Error("Pirsch requires a clientSecret (or access key)");
+      try {
+        const { Pirsch: i } = await import("../index-bgxxv-IJ.js").then((t) => t.i), { debug: e, enabled: s, ...a } = this.config;
+        this.client = new i(a), this.initialized = !0, this.log("Initialized successfully", {
+          hostname: this.config.hostname
+        });
+      } catch (i) {
+        throw console.error(
+          "[Pirsch-Server] Failed to initialize. Make sure pirsch-sdk is installed:",
+          i
+        ), i;
+      }
+    }
+  }
+  identify(i, e) {
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const s = {
+      url: "https://identify",
+      ip: "0.0.0.0",
+      user_agent: "analytics-library"
+    }, a = {
+      userId: i,
+      ...e && Object.fromEntries(
+        Object.entries(e).filter(
+          ([, t]) => typeof t == "string" || typeof t == "number" || typeof t == "boolean"
+        )
+      )
+    };
+    this.client.event("user_identified", s, 0, a).catch((t) => {
+      console.error("[Pirsch-Server] Failed to track identify event:", t);
+    }), this.log("Identified user via event", { userId: i, traits: e });
+  }
+  async track(i, e) {
+    var o, r, h, u;
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const s = {
+      url: ((o = e == null ? void 0 : e.page) == null ? void 0 : o.path) || "https://event",
+      ip: "0.0.0.0",
+      // Server-side should provide real IP if available
+      user_agent: "analytics-library",
+      // Server-side should provide real UA if available
+      ...((r = e == null ? void 0 : e.page) == null ? void 0 : r.title) && { title: e.page.title },
+      ...((h = e == null ? void 0 : e.page) == null ? void 0 : h.referrer) && { referrer: e.page.referrer }
+    }, t = {
+      ...Object.fromEntries(
+        Object.entries(i.properties).filter(
+          ([, c]) => typeof c == "string" || typeof c == "number" || typeof c == "boolean"
+        )
+      ),
+      category: i.category,
+      timestamp: String(i.timestamp || Date.now()),
+      ...i.userId && { userId: i.userId },
+      ...i.sessionId && { sessionId: i.sessionId },
+      ...((u = e == null ? void 0 : e.user) == null ? void 0 : u.email) && { user_email: e.user.email }
+    };
+    try {
+      await this.client.event(i.action, s, 0, t), this.log("Tracked event", { event: i, context: e });
+    } catch (c) {
+      console.error("[Pirsch-Server] Failed to track event:", c);
+    }
+  }
+  pageView(i, e) {
+    var a, t, o;
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const s = {
+      url: ((a = e == null ? void 0 : e.page) == null ? void 0 : a.path) || "https://pageview",
+      ip: "0.0.0.0",
+      // Server-side should provide real IP if available
+      user_agent: "analytics-library",
+      // Server-side should provide real UA if available
+      ...((t = e == null ? void 0 : e.page) == null ? void 0 : t.title) && { title: e.page.title },
+      ...((o = e == null ? void 0 : e.page) == null ? void 0 : o.referrer) && { referrer: e.page.referrer },
+      ...i && {
+        tags: Object.fromEntries(
+          Object.entries(i).filter(
+            ([, r]) => typeof r == "string" || typeof r == "number" || typeof r == "boolean"
+          )
+        )
+      }
+    };
+    this.client.hit(s).catch((r) => {
+      console.error("[Pirsch-Server] Failed to track page view:", r);
+    }), this.log("Tracked page view", { properties: i, context: e });
+  }
+  async reset() {
+    if (!this.isEnabled() || !this.initialized || !this.client) return;
+    const i = {
+      url: "https://session-reset",
+      ip: "0.0.0.0",
+      user_agent: "analytics-library"
+    };
+    await this.client.event("session_reset", i, 0, {}).catch((e) => {
+      console.error("[Pirsch-Server] Failed to track session reset:", e);
+    }), this.log("Reset user session");
+  }
+  async shutdown() {
+    this.client = void 0, this.initialized = !1, this.log("Shutdown complete");
+  }
+}
+async function g(l, n, i) {
+  var e, s;
+  try {
+    const a = await l.json();
+    if (!a.events || !Array.isArray(a.events))
+      throw new Error("Invalid payload: missing events array");
+    const t = i != null && i.extractIp ? i.extractIp(l) : m(l), o = i != null && i.enrichContext ? i.enrichContext(l) : {};
+    for (const r of a.events)
+      try {
+        switch (r.type) {
+          case "track": {
+            const h = {
+              ...r.context,
+              ...o,
+              device: {
+                ...(e = r.context) == null ? void 0 : e.device,
+                // Add IP (using type assertion for extended fields)
+                ...t ? { ip: t } : {}
+              }
+            };
+            await n.track(r.event.action, r.event.properties, {
+              userId: r.event.userId,
+              sessionId: r.event.sessionId,
+              context: h
+            });
+            break;
+          }
+          case "identify": {
+            n.identify(r.userId, r.traits);
+            break;
+          }
+          case "pageView": {
+            const h = {
+              ...r.context,
+              ...o,
+              device: {
+                ...(s = r.context) == null ? void 0 : s.device,
+                // Add IP (using type assertion for extended fields)
+                ...t ? { ip: t } : {}
+              }
+            };
+            n.pageView(r.properties, h);
+            break;
+          }
+          case "reset":
+            break;
+          default:
+            console.warn("[Proxy] Unknown event type:", r);
+        }
+      } catch (h) {
+        i != null && i.onError ? i.onError(h) : console.error("[Proxy] Failed to process event:", h);
+      }
+  } catch (a) {
+    throw i != null && i.onError ? i.onError(a) : console.error("[Proxy] Failed to ingest events:", a), a;
+  }
+}
+function m(l) {
+  var i;
+  const n = [
+    "x-forwarded-for",
+    "x-real-ip",
+    "cf-connecting-ip",
+    // Cloudflare
+    "x-client-ip",
+    "x-cluster-client-ip"
+  ];
+  for (const e of n) {
+    const s = l.headers.get(e);
+    if (s)
+      return (i = s.split(",")[0]) == null ? void 0 : i.trim();
+  }
+}
+function k(l, n) {
+  return async (i) => {
+    try {
+      return await g(i, l, n), new Response("OK", { status: 200 });
+    } catch (e) {
+      return console.error("[Proxy] Handler error:", e), new Response("Internal Server Error", { status: 500 });
+    }
+  };
+}
 export {
-  e as BaseAnalyticsProvider,
-  a as PostHogServerProvider
+  p as BaseAnalyticsProvider,
+  v as BentoServerProvider,
+  E as PirschServerProvider,
+  z as PostHogServerProvider,
+  k as createProxyHandler,
+  g as ingestProxyEvents
 };

package/dist/web-CvEQewPd.js

@@ -0,0 +1,220 @@
+import { r as O, a as P, b as E } from "./axios-gULqh8dv.js";
+function j(f, p) {
+  for (var d = 0; d < p.length; d++) {
+    const o = p[d];
+    if (typeof o != "string" && !Array.isArray(o)) {
+      for (const a in o)
+        if (a !== "default" && !(a in f)) {
+          const u = Object.getOwnPropertyDescriptor(o, a);
+          u && Object.defineProperty(f, a, u.get ? u : {
+            enumerable: !0,
+            get: () => o[a]
+          });
+        }
+    }
+  }
+  return Object.freeze(Object.defineProperty(f, Symbol.toStringTag, { value: "Module" }));
+}
+var r = {}, w;
+function C() {
+  if (w) return r;
+  w = 1;
+  var f = r && r.__createBinding || (Object.create ? function(c, e, t, n) {
+    n === void 0 && (n = t);
+    var i = Object.getOwnPropertyDescriptor(e, t);
+    (!i || ("get" in i ? !e.__esModule : i.writable || i.configurable)) && (i = { enumerable: !0, get: function() {
+      return e[t];
+    } }), Object.defineProperty(c, n, i);
+  } : function(c, e, t, n) {
+    n === void 0 && (n = t), c[n] = e[t];
+  }), p = r && r.__setModuleDefault || (Object.create ? function(c, e) {
+    Object.defineProperty(c, "default", { enumerable: !0, value: e });
+  } : function(c, e) {
+    c.default = e;
+  }), d = r && r.__importStar || /* @__PURE__ */ function() {
+    var c = function(e) {
+      return c = Object.getOwnPropertyNames || function(t) {
+        var n = [];
+        for (var i in t) Object.prototype.hasOwnProperty.call(t, i) && (n[n.length] = i);
+        return n;
+      }, c(e);
+    };
+    return function(e) {
+      if (e && e.__esModule) return e;
+      var t = {};
+      if (e != null) for (var n = c(e), i = 0; i < n.length; i++) n[i] !== "default" && f(t, e, n[i]);
+      return p(t, e), t;
+    };
+  }(), o = r && r.__awaiter || function(c, e, t, n) {
+    function i(s) {
+      return s instanceof t ? s : new t(function(l) {
+        l(s);
+      });
+    }
+    return new (t || (t = Promise))(function(s, l) {
+      function g(h) {
+        try {
+          b(n.next(h));
+        } catch (v) {
+          l(v);
+        }
+      }
+      function y(h) {
+        try {
+          b(n.throw(h));
+        } catch (v) {
+          l(v);
+        }
+      }
+      function b(h) {
+        h.done ? s(h.value) : i(h.value).then(g, y);
+      }
+      b((n = n.apply(c, e || [])).next());
+    });
+  };
+  Object.defineProperty(r, "__esModule", { value: !0 }), r.Client = r.Pirsch = r.PirschWebClient = void 0;
+  const a = O(), u = P(), m = d(/* @__PURE__ */ E());
+  class _ extends a.PirschCommon {
+    /**
+     * The constructor creates a new client.
+     *
+     * @param {object} configuration You need to pass in the **Identification Code** you have configured on the Pirsch dashboard.
+     * It's also recommended to set the proper protocol for your website, else it will be set to `https` by default.
+     * All other configuration parameters can be left to their defaults.
+     * @param {string} configuration.baseUrl The base URL for the pirsch API
+     * @param {number} configuration.timeout The default HTTP timeout in milliseconds
+     * @param {string} configuration.identificationCode The identification code
+     * @param {string} configuration.hostname The hostname to rewrite the URL. Usually only required for testing
+     *
+     */
+    constructor(e) {
+      if (super(), "clientId" in e || "clientSecret" in e)
+        throw new Error("Do not pass OAuth secrets such as 'clientId' or 'clientSecret' to the web client!");
+      if ("accessToken" in e)
+        throw new Error("Do not pass secrets such as 'accessToken' to the web client!");
+      const { baseUrl: t = u.PIRSCH_DEFAULT_BASE_URL, timeout: n = u.PIRSCH_DEFAULT_TIMEOUT, identificationCode: i, hostname: s } = e;
+      this.assertIdentificationCodeCredentials({ identificationCode: i }), this.baseUrl = t, this.timeout = n, this.identificationCode = i, this.hostname = s, this.httpClient = m.default.create({ baseURL: this.baseUrl, timeout: this.timeout });
+    }
+    /**
+     * hit sends a hit to Pirsch.
+     *
+     * @param hit optional override data for the request.
+     */
+    hit(e) {
+      return o(this, void 0, void 0, function* () {
+        const t = Object.assign(Object.assign({}, this.hitFromBrowser()), e), n = this.browserHitToGetParameters(t);
+        yield this.get(u.PirschEndpoint.HIT, { parameters: n });
+      });
+    }
+    /**
+     * event sends an event to Pirsch.
+     *
+     * @param name the name for the event
+     * @param duration optional duration for the event
+     * @param meta optional object containing metadata (only scalar values, like strings, numbers, and booleans)
+     * @param hit optional override data for the request
+     */
+    event(e) {
+      return o(this, arguments, void 0, function* (t, n = 0, i, s) {
+        const l = Object.assign(Object.assign({}, this.hitFromBrowser()), s);
+        return this.beacon(u.PirschEndpoint.EVENT, Object.assign({ identification_code: this.identificationCode, event_name: t, event_duration: n, event_meta: this.prepareScalarObject(i) }, l)), Promise.resolve();
+      });
+    }
+    /**
+     * customHit sends a hit to Pirsch.
+     *
+     * @param hit data for the request.
+     */
+    customHit(e) {
+      return o(this, void 0, void 0, function* () {
+        const t = this.browserHitToGetParameters(e);
+        yield this.get(u.PirschEndpoint.HIT, { parameters: t });
+      });
+    }
+    /**
+     * customEvent sends an event to Pirsch.
+     *
+     * @param name the name for the event
+     * @param duration optional duration for the event
+     * @param hit data for the request
+     * @param meta optional object containing metadata (only scalar values, like strings, numbers, and booleans)
+     */
+    customEvent(e) {
+      return o(this, arguments, void 0, function* (t, n = 0, i, s) {
+        return this.beacon(u.PirschEndpoint.EVENT, Object.assign({ identification_code: this.identificationCode, event_name: t, event_duration: n, event_meta: this.prepareScalarObject(s) }, i)), Promise.resolve();
+      });
+    }
+    /**
+     * hitFromBrowser returns the required data to send a hit to Pirsch.
+     *
+     * @returns Hit object containing all necessary fields.
+     */
+    hitFromBrowser() {
+      return {
+        url: this.generateUrl(),
+        title: document.title,
+        referrer: document.referrer,
+        screen_width: screen.width,
+        screen_height: screen.height
+      };
+    }
+    browserHitToGetParameters(e) {
+      const t = {
+        nc: Date.now(),
+        code: this.identificationCode,
+        url: e.url
+      };
+      if (e.title && (t.t = e.title), e.referrer && (t.ref = e.referrer), e.screen_width && (t.w = e.screen_width), e.screen_height && (t.h = e.screen_height), e.tags)
+        for (const [n, i] of Object.entries(e.tags))
+          t[`tag_${n.replaceAll("-", " ")}`] = i || 1;
+      return t;
+    }
+    generateUrl() {
+      return (this.hostname ? location.href.replace(location.hostname, this.hostname) : location.href).slice(0, u.PIRSCH_URL_LENGTH_LIMIT);
+    }
+    get(e, t) {
+      return o(this, void 0, void 0, function* () {
+        try {
+          return (yield this.httpClient.get(e, this.createOptions(Object.assign({}, t)))).data;
+        } catch (n) {
+          throw yield this.toApiError(n);
+        }
+      });
+    }
+    post(e, t, n) {
+      return o(this, void 0, void 0, function* () {
+        try {
+          return (yield this.httpClient.post(e, t, this.createOptions(n ?? {}))).data;
+        } catch (i) {
+          throw yield this.toApiError(i);
+        }
+      });
+    }
+    beacon(e, t) {
+      return o(this, void 0, void 0, function* () {
+        if (!navigator.sendBeacon([this.baseUrl, e].join("/"), JSON.stringify(t)))
+          throw yield this.toApiError("sendBeacon failed");
+      });
+    }
+    toApiError(e) {
+      return o(this, void 0, void 0, function* () {
+        var t, n, i, s, l;
+        return e instanceof a.PirschApiError ? e : e instanceof m.AxiosError ? new a.PirschApiError((n = (t = e.response) === null || t === void 0 ? void 0 : t.status) !== null && n !== void 0 ? n : 400, (i = e.response) === null || i === void 0 ? void 0 : i.data) : typeof e == "object" && e !== null && "response" in e && typeof e.response == "object" && e.response !== null && "status" in e.response && "data" in e.response ? new a.PirschApiError((s = e.response.status) !== null && s !== void 0 ? s : 400, (l = e.response) === null || l === void 0 ? void 0 : l.data) : e instanceof Error ? new a.PirschUnknownApiError(e.message) : typeof e == "object" && e !== null && "message" in e && typeof e.message == "string" ? new a.PirschUnknownApiError(e.message) : new a.PirschUnknownApiError(JSON.stringify(e));
+      });
+    }
+    createOptions({ headers: e, parameters: t }) {
+      return {
+        headers: e,
+        params: t
+      };
+    }
+  }
+  return r.PirschWebClient = _, r.Pirsch = _, r.Client = _, r;
+}
+var A = C();
+const U = /* @__PURE__ */ j({
+  __proto__: null
+}, [A]);
+export {
+  U as w
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacksee/analytics",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "description": "A highly typed, provider-agnostic analytics library for TypeScript applications",
   "type": "module",
   "exports": {
@@ -61,6 +61,8 @@
     "vitest": "^2.0.3"
   },
   "optionalDependencies": {
+    "@bentonow/bento-node-sdk": "^0.2.1",
+    "pirsch-sdk": "^2.9.1",
     "posthog-js": "^1.268.2",
     "posthog-node": "^5.9.0"
   },