@stacksee/analytics 0.4.2 → 0.4.3

package/dist/src/adapters/server/server-analytics.d.ts

@@ -4,20 +4,423 @@ export declare class ServerAnalytics<TEventMap extends DefaultEventMap = Default
     private providers;
     private config;
     private initialized;
+    /**
+     * Creates a new ServerAnalytics instance for server-side event tracking.
+     *
+     * The server analytics instance is designed for Node.js environments including
+     * long-running servers, serverless functions, and edge computing environments.
+     *
+     * @param config Analytics configuration including providers and default context
+     * @param config.providers Array of analytics provider instances (e.g., PostHogServerProvider)
+     * @param config.defaultContext Optional default context to include with all events
+     *
+     * @example
+     * ```typescript
+     * import { ServerAnalytics } from '@stacksee/analytics/server';
+     * import { PostHogServerProvider } from '@stacksee/analytics/providers/posthog';
+     *
+     * const analytics = new ServerAnalytics({
+     *   providers: [
+     *     new PostHogServerProvider({
+     *       apiKey: process.env.POSTHOG_API_KEY,
+     *       host: process.env.POSTHOG_HOST
+     *     })
+     *   ],
+     *   defaultContext: {
+     *     app: { version: '1.0.0', environment: 'production' }
+     *   }
+     * });
+     *
+     * analytics.initialize();
+     * ```
+     */
     constructor(config: AnalyticsConfig);
+    /**
+     * Initializes all analytics providers.
+     *
+     * This method must be called before tracking events. It initializes all configured
+     * providers synchronously. Unlike the browser version, server initialization is
+     * typically synchronous as providers don't need to load external scripts.
+     *
+     * The method is safe to call multiple times and will not re-initialize if already done.
+     *
+     * @example
+     * ```typescript
+     * const analytics = new ServerAnalytics({ providers: [] });
+     *
+     * // Initialize before tracking events
+     * analytics.initialize();
+     *
+     * // Now ready to track events
+     * await analytics.track('api_request', { endpoint: '/users' });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In a serverless function
+     * export async function handler(req, res) {
+     *   const analytics = new ServerAnalytics({ providers: [] });
+     *   analytics.initialize(); // Quick synchronous initialization
+     *
+     *   await analytics.track('function_invoked', {
+     *     path: req.path,
+     *     method: req.method
+     *   });
+     *
+     *   await analytics.shutdown(); // Important for serverless
+     * }
+     * ```
+     */
     initialize(): void;
+    /**
+     * Identifies a user with optional traits.
+     *
+     * Associates subsequent events with the specified user ID and optionally
+     * sets user properties. This method is typically called when processing
+     * authentication or when you have user context available on the server.
+     *
+     * @param userId Unique identifier for the user (e.g., database ID, email)
+     * @param traits Optional user properties and characteristics
+     *
+     * @example
+     * ```typescript
+     * // Basic user identification
+     * analytics.identify('user-123');
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Identify with user traits from database
+     * analytics.identify('user-123', {
+     *   email: 'john@example.com',
+     *   name: 'John Doe',
+     *   plan: 'enterprise',
+     *   company: 'Acme Corp',
+     *   createdAt: '2024-01-15T10:00:00Z',
+     *   lastSeenAt: new Date().toISOString()
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In an API authentication middleware
+     * async function authMiddleware(req, res, next) {
+     *   const user = await getUserFromToken(req.headers.authorization);
+     *
+     *   analytics.identify(user.id, {
+     *     email: user.email,
+     *     role: user.role,
+     *     organization: user.organization
+     *   });
+     *
+     *   req.user = user;
+     *   next();
+     * }
+     * ```
+     */
     identify(userId: string, traits?: Record<string, unknown>): void;
+    /**
+     * Tracks a custom event with properties and optional context.
+     *
+     * This is the main method for tracking business events on the server side.
+     * The method sends the event to all configured providers and waits for completion.
+     * Failed providers don't prevent others from succeeding.
+     *
+     * Server-side tracking typically includes additional context like IP addresses,
+     * user agents, and server-specific metadata that isn't available on the client.
+     *
+     * @param eventName Name of the event to track (must match your event definitions)
+     * @param properties Event-specific properties and data
+     * @param options Optional configuration including user ID, session ID, and context
+     * @param options.userId User ID to associate with this event
+     * @param options.sessionId Session ID to associate with this event
+     * @param options.context Additional context for this event
+     * @returns Promise that resolves when tracking is complete for all providers
+     *
+     * @example
+     * ```typescript
+     * // Basic event tracking
+     * await analytics.track('api_request', {
+     *   endpoint: '/api/users',
+     *   method: 'GET',
+     *   responseTime: 150,
+     *   statusCode: 200
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Track with user context
+     * await analytics.track('purchase_completed', {
+     *   orderId: 'order-123',
+     *   amount: 99.99,
+     *   currency: 'USD',
+     *   itemCount: 3
+     * }, {
+     *   userId: 'user-456',
+     *   sessionId: 'session-789',
+     *   context: {
+     *     page: { path: '/checkout/complete' },
+     *     device: { userAgent: req.headers['user-agent'] },
+     *     ip: req.ip
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In an Express.js route handler
+     * app.post('/api/users', async (req, res) => {
+     *   const user = await createUser(req.body);
+     *
+     *   // Track user creation with server context
+     *   await analytics.track('user_created', {
+     *     userId: user.id,
+     *     email: user.email,
+     *     plan: user.plan
+     *   }, {
+     *     userId: user.id,
+     *     context: {
+     *       page: { path: req.path },
+     *       device: { userAgent: req.headers['user-agent'] },
+     *       ip: req.ip,
+     *       server: { version: process.env.APP_VERSION }
+     *     }
+     *   });
+     *
+     *   res.json(user);
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Error handling in tracking
+     * try {
+     *   await analytics.track('payment_processed', {
+     *     amount: 100,
+     *     currency: 'USD'
+     *   });
+     * } catch (error) {
+     *   // This only catches initialization errors
+     *   // Individual provider failures are logged but don't throw
+     *   console.error('Failed to track event:', error);
+     * }
+     * ```
+     */
     track<TEventName extends keyof TEventMap & string>(eventName: TEventName, properties: TEventMap[TEventName], options?: {
         userId?: string;
         sessionId?: string;
         context?: EventContext;
     }): Promise<void>;
+    /**
+     * Tracks a page view event from the server side.
+     *
+     * Server-side page view tracking is useful for server-rendered applications,
+     * SSR frameworks, or when you want to ensure page views are tracked even
+     * if client-side JavaScript fails.
+     *
+     * @param properties Optional properties to include with the page view
+     * @param options Optional configuration including context
+     * @param options.context Additional context for this page view
+     *
+     * @example
+     * ```typescript
+     * // Basic server-side page view
+     * analytics.pageView();
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Page view with server context
+     * analytics.pageView({
+     *   loadTime: 250,
+     *   template: 'product-detail',
+     *   ssr: true
+     * }, {
+     *   context: {
+     *     page: {
+     *       path: '/products/widget-123',
+     *       title: 'Amazing Widget - Product Details'
+     *     },
+     *     device: {
+     *       userAgent: req.headers['user-agent']
+     *     },
+     *     server: {
+     *       renderTime: 45,
+     *       cacheHit: false
+     *     }
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In a Next.js API route or middleware
+     * export async function middleware(req) {
+     *   if (req.nextUrl.pathname.startsWith('/product/')) {
+     *     analytics.pageView({
+     *       category: 'product',
+     *       productId: req.nextUrl.pathname.split('/').pop()
+     *     }, {
+     *       context: {
+     *         page: { path: req.nextUrl.pathname },
+     *         device: { userAgent: req.headers.get('user-agent') },
+     *         referrer: req.headers.get('referer')
+     *       }
+     *     });
+     *   }
+     * }
+     * ```
+     */
     pageView(properties?: Record<string, unknown>, options?: {
         context?: EventContext;
     }): void;
+    /**
+     * Tracks when a user leaves a page from the server side.
+     *
+     * Server-side page leave tracking is less common than client-side but can be
+     * useful in certain scenarios like tracking session timeouts, or when combined
+     * with server-side session management.
+     *
+     * Note: Not all analytics providers support page leave events. The method
+     * will only call providers that implement the pageLeave method.
+     *
+     * @param properties Optional properties to include with the page leave event
+     * @param options Optional configuration including context
+     * @param options.context Additional context for this page leave
+     *
+     * @example
+     * ```typescript
+     * // Basic page leave tracking
+     * analytics.pageLeave();
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Page leave with session context
+     * analytics.pageLeave({
+     *   sessionDuration: 45000, // 45 seconds
+     *   pagesViewed: 3,
+     *   exitReason: 'session_timeout'
+     * }, {
+     *   context: {
+     *     session: {
+     *       id: 'session-123',
+     *       startTime: sessionStartTime,
+     *       endTime: Date.now()
+     *     },
+     *     server: {
+     *       reason: 'inactivity_timeout'
+     *     }
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In a session cleanup job
+     * async function cleanupExpiredSessions() {
+     *   const expiredSessions = await getExpiredSessions();
+     *
+     *   for (const session of expiredSessions) {
+     *     analytics.pageLeave({
+     *       sessionId: session.id,
+     *       duration: session.duration,
+     *       reason: 'expired'
+     *     });
+     *
+     *     await removeSession(session.id);
+     *   }
+     * }
+     * ```
+     */
     pageLeave(properties?: Record<string, unknown>, options?: {
         context?: EventContext;
     }): void;
+    /**
+     * Shuts down all analytics providers and flushes pending events.
+     *
+     * This method is crucial for server environments, especially serverless functions,
+     * as it ensures all events are sent before the process terminates. Some providers
+     * batch events and need an explicit flush to send them.
+     *
+     * Always call this method before your server shuts down or before a serverless
+     * function completes execution.
+     *
+     * @returns Promise that resolves when all providers have been shut down
+     *
+     * @example
+     * ```typescript
+     * // Basic shutdown
+     * await analytics.shutdown();
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In a serverless function
+     * export async function handler(event, context) {
+     *   const analytics = new ServerAnalytics({ providers: [] });
+     *   analytics.initialize();
+     *
+     *   try {
+     *     // Process the event
+     *     await processEvent(event);
+     *
+     *     // Track completion
+     *     await analytics.track('function_completed', {
+     *       duration: Date.now() - startTime,
+     *       success: true
+     *     });
+     *   } catch (error) {
+     *     await analytics.track('function_failed', {
+     *       error: error.message,
+     *       duration: Date.now() - startTime
+     *     });
+     *   } finally {
+     *     // Always shutdown to flush events
+     *     await analytics.shutdown();
+     *   }
+     *
+     *   return { statusCode: 200 };
+     * }
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // In an Express.js server
+     * const server = app.listen(3000);
+     *
+     * // Graceful shutdown
+     * process.on('SIGTERM', async () => {
+     *   console.log('Shutting down gracefully...');
+     *
+     *   server.close(async () => {
+     *     // Flush analytics events before exit
+     *     await analytics.shutdown();
+     *     process.exit(0);
+     *   });
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // With Vercel's waitUntil
+     * import { waitUntil } from '@vercel/functions';
+     *
+     * export default async function handler(req, res) {
+     *   // Process request
+     *   const result = await processRequest(req);
+     *
+     *   // Track in background without blocking response
+     *   waitUntil(
+     *     analytics.track('api_request', { endpoint: req.url })
+     *       .then(() => analytics.shutdown())
+     *   );
+     *
+     *   return res.json(result);
+     * }
+     * ```
+     */
     shutdown(): Promise<void>;
     private getCategoryFromEventName;
 }

package/dist/src/index.d.ts

@@ -1,6 +1,5 @@
 export type { EventCategory, BaseEvent, EventContext, AnalyticsProvider, AnalyticsConfig, } from './core/events/types.js';
 export type { CreateEventDefinition, ExtractEventNames, ExtractEventPropertiesFromCollection, EventCollection, AnyEventName, AnyEventProperties, EventMapFromCollection, } from './core/events/index.js';
 export { createAnalytics as createClientAnalytics, getAnalytics, track as trackClient, identify as identifyClient, pageView as pageViewClient, pageLeave as pageLeaveClient, reset as resetClient, type ClientAnalyticsConfig, } from './client.js';
-export { createServerAnalytics, ServerAnalytics, type ServerAnalyticsConfig, } from './server.js';
-export { BaseAnalyticsProvider, PostHogClientProvider, PostHogServerProvider, type PostHogConfig, type PostHogOptions, } from './providers/index.js';
+export { BaseAnalyticsProvider, PostHogClientProvider, type PostHogConfig, } from './providers/client.js';
 export { BrowserAnalytics } from './adapters/client/browser-analytics.js';

package/dist/src/providers/client.d.ts

@@ -0,0 +1,3 @@
+export { BaseAnalyticsProvider } from './base.provider.js';
+export { PostHogClientProvider } from './posthog/client.js';
+export type { PostHogConfig } from 'posthog-js';

package/dist/test/providers.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/server.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacksee/analytics",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "A highly typed, provider-agnostic analytics library for TypeScript applications",
   "type": "module",
   "exports": {

package/dist/client-CyxgEISv.js

@@ -1,184 +0,0 @@
-var c = Object.defineProperty;
-var u = (t, e, i) => e in t ? c(t, e, { enumerable: !0, configurable: !0, writable: !0, value: i }) : t[e] = i;
-var s = (t, e, i) => u(t, typeof e != "symbol" ? e + "" : e, i);
-import { i as h } from "./environment-Bnc8FqHv.js";
-class p {
-  constructor(e) {
-    s(this, "providers", []);
-    s(this, "context", {});
-    s(this, "userId");
-    s(this, "sessionId");
-    s(this, "initialized", !1);
-    s(this, "initializePromise");
-    this.providers = e.providers, e.defaultContext && (this.context = { ...e.defaultContext }), this.sessionId = this.generateSessionId();
-  }
-  async initialize() {
-    if (h() && !this.initialized)
-      return this.initializePromise ? this.initializePromise : (this.initializePromise = this._doInitialize(), this.initializePromise);
-  }
-  async _doInitialize() {
-    const e = this.providers.map(
-      (i) => i.initialize()
-    );
-    await Promise.all(e), this.initialized = !0, this.updateContext({
-      page: {
-        path: window.location.pathname,
-        title: document.title,
-        referrer: document.referrer
-      },
-      device: {
-        type: this.getDeviceType(),
-        os: this.getOS(),
-        browser: this.getBrowser()
-      }
-    });
-  }
-  async ensureInitialized() {
-    !this.initialized && !this.initializePromise ? await this.initialize() : this.initializePromise && await this.initializePromise;
-  }
-  identify(e, i) {
-    this.userId = e, this.ensureInitialized().catch((r) => {
-      console.error("[Analytics] Failed to initialize during identify:", r);
-    });
-    for (const r of this.providers)
-      r.identify(e, i);
-  }
-  async track(e, i) {
-    await this.ensureInitialized();
-    const r = {
-      action: e,
-      category: this.getCategoryFromEventName(e),
-      properties: i,
-      timestamp: Date.now(),
-      userId: this.userId,
-      sessionId: this.sessionId
-    }, o = this.providers.map(async (d) => {
-      try {
-        await d.track(r, this.context);
-      } catch (l) {
-        console.error(
-          `[Analytics] Provider ${d.name} failed to track event:`,
-          l
-        );
-      }
-    });
-    await Promise.all(o);
-  }
-  pageView(e) {
-    this.ensureInitialized().catch((i) => {
-      console.error("[Analytics] Failed to initialize during pageView:", i);
-    }), this.updateContext({
-      page: {
-        path: window.location.pathname,
-        title: document.title,
-        referrer: document.referrer
-      }
-    });
-    for (const i of this.providers)
-      i.pageView(e, this.context);
-  }
-  pageLeave(e) {
-    this.ensureInitialized().catch((i) => {
-      console.error("[Analytics] Failed to initialize during pageLeave:", i);
-    });
-    for (const i of this.providers)
-      i.pageLeave && i.pageLeave(e, this.context);
-  }
-  reset() {
-    this.userId = void 0, this.sessionId = this.generateSessionId();
-    for (const e of this.providers)
-      e.reset();
-  }
-  updateContext(e) {
-    var i, r, o;
-    this.context = {
-      ...this.context,
-      ...e,
-      page: e.page ? {
-        path: e.page.path || ((i = this.context.page) == null ? void 0 : i.path) || window.location.pathname,
-        title: e.page.title || ((r = this.context.page) == null ? void 0 : r.title),
-        referrer: e.page.referrer || ((o = this.context.page) == null ? void 0 : o.referrer)
-      } : this.context.page,
-      device: {
-        ...this.context.device,
-        ...e.device
-      },
-      utm: {
-        ...this.context.utm,
-        ...e.utm
-      }
-    };
-  }
-  getCategoryFromEventName(e) {
-    const i = e.split("_");
-    return i.length > 1 && i[0] ? i[0] : "engagement";
-  }
-  generateSessionId() {
-    return `${Date.now()}-${Math.random().toString(36).substr(2, 9)}`;
-  }
-  getDeviceType() {
-    const e = navigator.userAgent;
-    return /tablet|ipad|playbook|silk/i.test(e) ? "tablet" : /mobile|iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i.test(
-      e
-    ) ? "mobile" : "desktop";
-  }
-  getOS() {
-    const e = navigator.userAgent;
-    return e.indexOf("Win") !== -1 ? "Windows" : e.indexOf("Mac") !== -1 ? "macOS" : e.indexOf("Linux") !== -1 ? "Linux" : e.indexOf("Android") !== -1 ? "Android" : e.indexOf("iOS") !== -1 ? "iOS" : "Unknown";
-  }
-  getBrowser() {
-    const e = navigator.userAgent;
-    return e.indexOf("Chrome") !== -1 ? "Chrome" : e.indexOf("Safari") !== -1 ? "Safari" : e.indexOf("Firefox") !== -1 ? "Firefox" : e.indexOf("Edge") !== -1 ? "Edge" : "Unknown";
-  }
-}
-let n = null;
-function m(t) {
-  if (n)
-    return console.warn("[Analytics] Already initialized"), n;
-  const e = {
-    providers: t.providers || [],
-    debug: t.debug,
-    enabled: t.enabled
-  };
-  return n = new p(
-    e
-  ), n.initialize().catch((i) => {
-    console.error("[Analytics] Failed to initialize:", i);
-  }), n;
-}
-function a() {
-  if (!n)
-    throw new Error(
-      "[Analytics] Not initialized. Call createAnalytics() first."
-    );
-  return n;
-}
-function v(t, e) {
-  return a().track(t, e);
-}
-function y(t, e) {
-  a().identify(t, e);
-}
-function w(t) {
-  a().pageView(t);
-}
-function z(t) {
-  a().pageLeave(t);
-}
-function x() {
-  a().reset();
-}
-function A() {
-  n = null;
-}
-export {
-  p as B,
-  z as a,
-  A as b,
-  m as c,
-  a as g,
-  y as i,
-  w as p,
-  x as r,
-  v as t
-};