@datalyr/api 1.0.0

package/README.md

@@ -0,0 +1,144 @@
+# @datalyr/node
+
+Official Node.js SDK for Datalyr server-side tracking.
+
+## Installation
+
+```bash
+npm install @datalyr/node
+# or
+yarn add @datalyr/node
+# or
+pnpm add @datalyr/node
+```
+
+## Quick Start
+
+```javascript
+const Datalyr = require('@datalyr/api');
+// or
+import Datalyr from '@datalyr/node';
+
+// Initialize with your API key
+const datalyr = new Datalyr('your_api_key_here');
+
+// Track an event
+await datalyr.track('user_123', 'Purchase Completed', {
+  amount: 99.99,
+  currency: 'USD',
+  products: ['item_1', 'item_2']
+});
+
+// Identify a user
+await datalyr.identify('user_123', {
+  email: 'user@example.com',
+  name: 'John Doe',
+  plan: 'premium'
+});
+
+// Track a pageview
+await datalyr.page('user_123', 'Homepage', {
+  url: 'https://example.com',
+  referrer: 'https://google.com'
+});
+
+// Group a user
+await datalyr.group('user_123', 'company_456', {
+  name: 'Acme Corp',
+  industry: 'Technology'
+});
+
+// Clean up when done
+await datalyr.close();
+```
+
+## Configuration
+
+```javascript
+const datalyr = new Datalyr({
+  apiKey: 'your_api_key_here',
+  host: 'https://api.datalyr.com',  // Optional: custom host
+  flushAt: 20,                      // Optional: batch size (default: 20)
+  flushInterval: 10000,             // Optional: batch interval in ms (default: 10000)
+  debug: true,                      // Optional: enable debug logging (default: false)
+  timeout: 10000,                   // Optional: request timeout in ms (default: 10000)
+  retryLimit: 3,                    // Optional: max retries (default: 3)
+  maxQueueSize: 1000                // Optional: max events in queue (default: 1000)
+});
+```
+
+## Stripe Webhook Example
+
+```javascript
+const Datalyr = require('@datalyr/api');
+const stripe = require('stripe')(process.env.STRIPE_SECRET_KEY);
+
+const datalyr = new Datalyr(process.env.DATALYR_API_KEY);
+
+app.post('/webhooks/stripe', async (req, res) => {
+  const sig = req.headers['stripe-signature'];
+  const event = stripe.webhooks.constructEvent(req.body, sig, endpointSecret);
+  
+  switch (event.type) {
+    case 'checkout.session.completed':
+      await datalyr.track(
+        event.data.object.client_reference_id,
+        'Purchase Completed',
+        {
+          amount: event.data.object.amount_total / 100,
+          currency: event.data.object.currency,
+          stripeSessionId: event.data.object.id
+        }
+      );
+      break;
+      
+    case 'customer.subscription.created':
+      await datalyr.track(
+        event.data.object.metadata.userId,
+        'Subscription Started',
+        {
+          plan: event.data.object.items.data[0].price.nickname,
+          mrr: event.data.object.items.data[0].price.unit_amount / 100,
+          interval: event.data.object.items.data[0].price.recurring.interval
+        }
+      );
+      break;
+  }
+  
+  res.json({ received: true });
+});
+```
+
+## API Reference
+
+### `new Datalyr(config)`
+
+Creates a new Datalyr instance.
+
+### `track(userId, event, properties?)`
+
+Track a custom event.
+
+### `identify(userId, traits?)`
+
+Identify a user with traits.
+
+### `page(userId, name?, properties?)`
+
+Track a pageview.
+
+### `group(userId, groupId, traits?)`
+
+Associate a user with a group.
+
+### `flush()`
+
+Manually flush the event queue.
+
+### `close()`
+
+Flush remaining events and clean up resources.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,45 @@
+interface DatalyrConfig {
+    apiKey: string;
+    host?: string;
+    flushAt?: number;
+    flushInterval?: number;
+    debug?: boolean;
+    timeout?: number;
+    retryLimit?: number;
+    maxQueueSize?: number;
+}
+interface TrackEvent {
+    userId?: string;
+    anonymousId?: string;
+    event: string;
+    properties?: Record<string, any>;
+    context?: Record<string, any>;
+    timestamp?: string;
+}
+declare class Datalyr {
+    private apiKey;
+    private host;
+    private debug;
+    private queue;
+    private flushAt;
+    private flushInterval;
+    private timeout;
+    private retryLimit;
+    private maxQueueSize;
+    private timer?;
+    private isFlushing;
+    private isClosing;
+    constructor(config: DatalyrConfig | string);
+    track(userId: string | null, event: string, properties?: any): Promise<void>;
+    identify(userId: string, traits?: any): Promise<void>;
+    page(userId: string, name?: string, properties?: any): Promise<void>;
+    group(userId: string, groupId: string, traits?: any): Promise<void>;
+    private enqueue;
+    flush(): Promise<void>;
+    private sendEvent;
+    private startFlushTimer;
+    private generateAnonymousId;
+    close(): Promise<void>;
+}
+
+export { Datalyr, type DatalyrConfig, type TrackEvent, Datalyr as default };

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+interface DatalyrConfig {
+    apiKey: string;
+    host?: string;
+    flushAt?: number;
+    flushInterval?: number;
+    debug?: boolean;
+    timeout?: number;
+    retryLimit?: number;
+    maxQueueSize?: number;
+}
+interface TrackEvent {
+    userId?: string;
+    anonymousId?: string;
+    event: string;
+    properties?: Record<string, any>;
+    context?: Record<string, any>;
+    timestamp?: string;
+}
+declare class Datalyr {
+    private apiKey;
+    private host;
+    private debug;
+    private queue;
+    private flushAt;
+    private flushInterval;
+    private timeout;
+    private retryLimit;
+    private maxQueueSize;
+    private timer?;
+    private isFlushing;
+    private isClosing;
+    constructor(config: DatalyrConfig | string);
+    track(userId: string | null, event: string, properties?: any): Promise<void>;
+    identify(userId: string, traits?: any): Promise<void>;
+    page(userId: string, name?: string, properties?: any): Promise<void>;
+    group(userId: string, groupId: string, traits?: any): Promise<void>;
+    private enqueue;
+    flush(): Promise<void>;
+    private sendEvent;
+    private startFlushTimer;
+    private generateAnonymousId;
+    close(): Promise<void>;
+}
+
+export { Datalyr, type DatalyrConfig, type TrackEvent, Datalyr as default };

package/dist/index.js

@@ -0,0 +1,241 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Datalyr: () => Datalyr,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var Datalyr = class {
+  constructor(config) {
+    this.queue = [];
+    this.isFlushing = false;
+    this.isClosing = false;
+    if (typeof config === "string") {
+      this.apiKey = config;
+      this.host = "https://api.datalyr.com";
+      this.debug = false;
+      this.flushAt = 20;
+      this.flushInterval = 1e4;
+      this.timeout = 1e4;
+      this.retryLimit = 3;
+      this.maxQueueSize = 1e3;
+    } else {
+      this.apiKey = config.apiKey;
+      this.host = config.host || "https://api.datalyr.com";
+      this.debug = config.debug || false;
+      this.flushAt = config.flushAt || 20;
+      this.flushInterval = config.flushInterval || 1e4;
+      this.timeout = config.timeout || 1e4;
+      this.retryLimit = config.retryLimit || 3;
+      this.maxQueueSize = config.maxQueueSize || 1e3;
+    }
+    if (!this.apiKey) {
+      throw new Error("Datalyr API key is required");
+    }
+    if (!this.apiKey.startsWith("dk_")) {
+      console.warn('[Datalyr] API key should start with "dk_"');
+    }
+    if (this.flushAt < 1) this.flushAt = 1;
+    if (this.flushAt > 100) this.flushAt = 100;
+    if (this.timeout < 1e3) this.timeout = 1e3;
+    if (this.timeout > 6e4) this.timeout = 6e4;
+    if (this.maxQueueSize < 100) this.maxQueueSize = 100;
+    if (this.maxQueueSize > 1e4) this.maxQueueSize = 1e4;
+    this.startFlushTimer();
+  }
+  async track(userId, event, properties) {
+    if (this.isClosing) {
+      if (this.debug) {
+        console.warn("[Datalyr] SDK is closing, event dropped:", event);
+      }
+      return;
+    }
+    if (!event || typeof event !== "string") {
+      throw new Error("Event name is required and must be a string");
+    }
+    const trackEvent = {
+      userId: userId || void 0,
+      anonymousId: userId ? void 0 : this.generateAnonymousId(),
+      event,
+      properties: properties || {},
+      context: {
+        library: "@datalyr/api",
+        version: "1.0.0"
+      },
+      timestamp: (/* @__PURE__ */ new Date()).toISOString()
+    };
+    this.enqueue(trackEvent);
+  }
+  async identify(userId, traits) {
+    if (!userId) {
+      throw new Error("userId is required for identify");
+    }
+    return this.track(userId, "$identify", { $set: traits });
+  }
+  async page(userId, name, properties) {
+    return this.track(userId, "$pageview", { name, ...properties });
+  }
+  async group(userId, groupId, traits) {
+    if (!groupId) {
+      throw new Error("groupId is required for group");
+    }
+    return this.track(userId, "$group", { groupId, traits });
+  }
+  enqueue(event) {
+    if (this.queue.length >= this.maxQueueSize) {
+      if (this.debug) {
+        console.warn(`[Datalyr] Queue full (${this.maxQueueSize}), dropping oldest event`);
+      }
+      this.queue.shift();
+    }
+    this.queue.push(event);
+    if (this.debug) {
+      console.log("[Datalyr] Event queued:", event.event);
+    }
+    if (this.queue.length >= this.flushAt) {
+      this.flush().catch((err) => {
+        if (this.debug) {
+          console.error("[Datalyr] Auto-flush error:", err);
+        }
+      });
+    }
+  }
+  async flush() {
+    if (this.isFlushing || this.queue.length === 0) {
+      return;
+    }
+    this.isFlushing = true;
+    try {
+      const events = [...this.queue];
+      this.queue = [];
+      if (this.debug) {
+        console.log(`[Datalyr] Flushing ${events.length} events`);
+      }
+      const batchSize = 10;
+      const errors = [];
+      for (let i = 0; i < events.length; i += batchSize) {
+        const batch = events.slice(i, i + batchSize);
+        const promises = batch.map(
+          (event) => this.sendEvent(event).catch((err) => {
+            errors.push(err);
+            this.queue.unshift(event);
+          })
+        );
+        await Promise.allSettled(promises);
+      }
+      if (errors.length > 0 && this.debug) {
+        console.error(`[Datalyr] ${errors.length} events failed to send`);
+      }
+    } finally {
+      this.isFlushing = false;
+    }
+  }
+  async sendEvent(event, retryCount = 0) {
+    try {
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+      const response = await fetch(this.host, {
+        method: "POST",
+        headers: {
+          "X-API-Key": this.apiKey,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(event),
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      if (!response.ok) {
+        let errorText = "";
+        try {
+          errorText = await response.text();
+        } catch {
+        }
+        if (response.status >= 400 && response.status < 500) {
+          throw new Error(`Client error: ${response.status} ${response.statusText} - ${errorText}`);
+        }
+        throw new Error(`Server error: ${response.status} ${response.statusText} - ${errorText}`);
+      }
+      if (this.debug) {
+        try {
+          const result = await response.json();
+          console.log("[Datalyr] Event sent successfully:", result);
+        } catch {
+          console.log("[Datalyr] Event sent successfully");
+        }
+      }
+    } catch (error) {
+      if (error.message?.startsWith("Client error:")) {
+        if (this.debug) {
+          console.error("[Datalyr] Permanent error, not retrying:", error.message);
+        }
+        throw error;
+      }
+      if (retryCount < this.retryLimit) {
+        if (this.debug) {
+          console.log(`[Datalyr] Retrying event (attempt ${retryCount + 1}/${this.retryLimit})`);
+        }
+        const backoffMs = Math.min(Math.pow(2, retryCount) * 1e3, 1e4);
+        await new Promise((resolve) => setTimeout(resolve, backoffMs));
+        return this.sendEvent(event, retryCount + 1);
+      }
+      throw error;
+    }
+  }
+  startFlushTimer() {
+    this.timer = setInterval(() => {
+      if (!this.isClosing) {
+        this.flush().catch((err) => {
+          if (this.debug) {
+            console.error("[Datalyr] Timer flush error:", err);
+          }
+        });
+      }
+    }, this.flushInterval);
+    if (this.timer.unref) {
+      this.timer.unref();
+    }
+  }
+  generateAnonymousId() {
+    return "anon_" + Math.random().toString(36).substring(2) + Date.now().toString(36);
+  }
+  // Cleanup
+  async close() {
+    this.isClosing = true;
+    if (this.timer) {
+      clearInterval(this.timer);
+      this.timer = void 0;
+    }
+    const flushPromise = this.flush();
+    const timeoutPromise = new Promise(
+      (resolve) => setTimeout(() => resolve(), 5e3)
+    );
+    await Promise.race([flushPromise, timeoutPromise]);
+    if (this.debug && this.queue.length > 0) {
+      console.warn(`[Datalyr] Closing with ${this.queue.length} events still queued`);
+    }
+  }
+};
+var index_default = Datalyr;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Datalyr
+});

package/dist/index.mjs

@@ -0,0 +1,216 @@
+// src/index.ts
+var Datalyr = class {
+  constructor(config) {
+    this.queue = [];
+    this.isFlushing = false;
+    this.isClosing = false;
+    if (typeof config === "string") {
+      this.apiKey = config;
+      this.host = "https://api.datalyr.com";
+      this.debug = false;
+      this.flushAt = 20;
+      this.flushInterval = 1e4;
+      this.timeout = 1e4;
+      this.retryLimit = 3;
+      this.maxQueueSize = 1e3;
+    } else {
+      this.apiKey = config.apiKey;
+      this.host = config.host || "https://api.datalyr.com";
+      this.debug = config.debug || false;
+      this.flushAt = config.flushAt || 20;
+      this.flushInterval = config.flushInterval || 1e4;
+      this.timeout = config.timeout || 1e4;
+      this.retryLimit = config.retryLimit || 3;
+      this.maxQueueSize = config.maxQueueSize || 1e3;
+    }
+    if (!this.apiKey) {
+      throw new Error("Datalyr API key is required");
+    }
+    if (!this.apiKey.startsWith("dk_")) {
+      console.warn('[Datalyr] API key should start with "dk_"');
+    }
+    if (this.flushAt < 1) this.flushAt = 1;
+    if (this.flushAt > 100) this.flushAt = 100;
+    if (this.timeout < 1e3) this.timeout = 1e3;
+    if (this.timeout > 6e4) this.timeout = 6e4;
+    if (this.maxQueueSize < 100) this.maxQueueSize = 100;
+    if (this.maxQueueSize > 1e4) this.maxQueueSize = 1e4;
+    this.startFlushTimer();
+  }
+  async track(userId, event, properties) {
+    if (this.isClosing) {
+      if (this.debug) {
+        console.warn("[Datalyr] SDK is closing, event dropped:", event);
+      }
+      return;
+    }
+    if (!event || typeof event !== "string") {
+      throw new Error("Event name is required and must be a string");
+    }
+    const trackEvent = {
+      userId: userId || void 0,
+      anonymousId: userId ? void 0 : this.generateAnonymousId(),
+      event,
+      properties: properties || {},
+      context: {
+        library: "@datalyr/api",
+        version: "1.0.0"
+      },
+      timestamp: (/* @__PURE__ */ new Date()).toISOString()
+    };
+    this.enqueue(trackEvent);
+  }
+  async identify(userId, traits) {
+    if (!userId) {
+      throw new Error("userId is required for identify");
+    }
+    return this.track(userId, "$identify", { $set: traits });
+  }
+  async page(userId, name, properties) {
+    return this.track(userId, "$pageview", { name, ...properties });
+  }
+  async group(userId, groupId, traits) {
+    if (!groupId) {
+      throw new Error("groupId is required for group");
+    }
+    return this.track(userId, "$group", { groupId, traits });
+  }
+  enqueue(event) {
+    if (this.queue.length >= this.maxQueueSize) {
+      if (this.debug) {
+        console.warn(`[Datalyr] Queue full (${this.maxQueueSize}), dropping oldest event`);
+      }
+      this.queue.shift();
+    }
+    this.queue.push(event);
+    if (this.debug) {
+      console.log("[Datalyr] Event queued:", event.event);
+    }
+    if (this.queue.length >= this.flushAt) {
+      this.flush().catch((err) => {
+        if (this.debug) {
+          console.error("[Datalyr] Auto-flush error:", err);
+        }
+      });
+    }
+  }
+  async flush() {
+    if (this.isFlushing || this.queue.length === 0) {
+      return;
+    }
+    this.isFlushing = true;
+    try {
+      const events = [...this.queue];
+      this.queue = [];
+      if (this.debug) {
+        console.log(`[Datalyr] Flushing ${events.length} events`);
+      }
+      const batchSize = 10;
+      const errors = [];
+      for (let i = 0; i < events.length; i += batchSize) {
+        const batch = events.slice(i, i + batchSize);
+        const promises = batch.map(
+          (event) => this.sendEvent(event).catch((err) => {
+            errors.push(err);
+            this.queue.unshift(event);
+          })
+        );
+        await Promise.allSettled(promises);
+      }
+      if (errors.length > 0 && this.debug) {
+        console.error(`[Datalyr] ${errors.length} events failed to send`);
+      }
+    } finally {
+      this.isFlushing = false;
+    }
+  }
+  async sendEvent(event, retryCount = 0) {
+    try {
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+      const response = await fetch(this.host, {
+        method: "POST",
+        headers: {
+          "X-API-Key": this.apiKey,
+          "Content-Type": "application/json"
+        },
+        body: JSON.stringify(event),
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      if (!response.ok) {
+        let errorText = "";
+        try {
+          errorText = await response.text();
+        } catch {
+        }
+        if (response.status >= 400 && response.status < 500) {
+          throw new Error(`Client error: ${response.status} ${response.statusText} - ${errorText}`);
+        }
+        throw new Error(`Server error: ${response.status} ${response.statusText} - ${errorText}`);
+      }
+      if (this.debug) {
+        try {
+          const result = await response.json();
+          console.log("[Datalyr] Event sent successfully:", result);
+        } catch {
+          console.log("[Datalyr] Event sent successfully");
+        }
+      }
+    } catch (error) {
+      if (error.message?.startsWith("Client error:")) {
+        if (this.debug) {
+          console.error("[Datalyr] Permanent error, not retrying:", error.message);
+        }
+        throw error;
+      }
+      if (retryCount < this.retryLimit) {
+        if (this.debug) {
+          console.log(`[Datalyr] Retrying event (attempt ${retryCount + 1}/${this.retryLimit})`);
+        }
+        const backoffMs = Math.min(Math.pow(2, retryCount) * 1e3, 1e4);
+        await new Promise((resolve) => setTimeout(resolve, backoffMs));
+        return this.sendEvent(event, retryCount + 1);
+      }
+      throw error;
+    }
+  }
+  startFlushTimer() {
+    this.timer = setInterval(() => {
+      if (!this.isClosing) {
+        this.flush().catch((err) => {
+          if (this.debug) {
+            console.error("[Datalyr] Timer flush error:", err);
+          }
+        });
+      }
+    }, this.flushInterval);
+    if (this.timer.unref) {
+      this.timer.unref();
+    }
+  }
+  generateAnonymousId() {
+    return "anon_" + Math.random().toString(36).substring(2) + Date.now().toString(36);
+  }
+  // Cleanup
+  async close() {
+    this.isClosing = true;
+    if (this.timer) {
+      clearInterval(this.timer);
+      this.timer = void 0;
+    }
+    const flushPromise = this.flush();
+    const timeoutPromise = new Promise(
+      (resolve) => setTimeout(() => resolve(), 5e3)
+    );
+    await Promise.race([flushPromise, timeoutPromise]);
+    if (this.debug && this.queue.length > 0) {
+      console.warn(`[Datalyr] Closing with ${this.queue.length} events still queued`);
+    }
+  }
+};
+var index_default = Datalyr;
+export {
+  Datalyr,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@datalyr/api",
+  "version": "1.0.0",
+  "description": "Datalyr API SDK for server-side tracking",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "node tests/test.js",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "datalyr",
+    "analytics",
+    "tracking",
+    "attribution",
+    "server-side",
+    "node"
+  ],
+  "author": "Datalyr",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/datalyr/node-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/datalyr/node-sdk/issues"
+  },
+  "homepage": "https://datalyr.com",
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}