@sylphx/sdk 0.3.0 → 0.3.2

package/dist/web-analytics.d.cts

@@ -0,0 +1,90 @@
+/**
+ * Web Analytics Tracker
+ *
+ * Lightweight page-view analytics tracker for Sylphx Platform SDK.
+ * Automatically tracks page views, bounce rate, and session data.
+ *
+ * @example
+ * ```typescript
+ * import { SDK_API_PATH } from "../../constants";
+import { WebAnalyticsTracker } from '@sylphx/platform-sdk/web-analytics'
+ *
+ * const tracker = new WebAnalyticsTracker()
+ * tracker.init({
+ *   appKey: 'app_prod_xxx',
+ *   endpoint: 'https://your-app.com',
+ * })
+ * ```
+ */
+interface WebAnalyticsOptions {
+    /** App key for authentication */
+    appKey: string;
+    /** Base endpoint URL (without trailing slash) */
+    endpoint: string;
+    /** Auto-track page views (default: true) */
+    trackPageViews?: boolean;
+    /** Track bounce rate (sessions with only 1 page view) (default: true) */
+    trackBounce?: boolean;
+    /** SPA hash routing mode (tracks hash changes) (default: false) */
+    hashMode?: boolean;
+    /** Debug logging (default: false) */
+    debug?: boolean;
+}
+interface PageViewPayload {
+    /** URL path (e.g. /about) */
+    path: string;
+    /** Document referrer */
+    referrer: string;
+    /** Navigator user agent */
+    userAgent: string;
+    /** Screen width in pixels */
+    screenWidth: number;
+    /** Session ID (UUID stored in sessionStorage) */
+    sessionId: string;
+    /** Unix timestamp (ms) */
+    timestamp: number;
+}
+interface IdentifyPayload {
+    /** User ID */
+    userId: string;
+    /** User traits/properties */
+    traits?: Record<string, unknown>;
+    /** Session ID */
+    sessionId: string;
+}
+declare class WebAnalyticsTracker {
+    private options;
+    private initialized;
+    private lastPath;
+    private pageViewCount;
+    private cleanupFns;
+    /**
+     * Initialize the tracker and start auto-tracking page views
+     */
+    init(options: WebAnalyticsOptions): void;
+    /**
+     * Manually track a page view
+     */
+    trackPageView(path?: string): void;
+    /**
+     * Identify a user
+     */
+    identify(userId: string, traits?: Record<string, unknown>): void;
+    /**
+     * Destroy the tracker and remove event listeners
+     */
+    destroy(): void;
+    private _send;
+    private _hookHistoryApi;
+    private _hookNextRouter;
+}
+/**
+ * Get or create the global WebAnalyticsTracker singleton
+ */
+declare function getWebAnalyticsTracker(): WebAnalyticsTracker;
+/**
+ * Initialize global web analytics tracker
+ */
+declare function initWebAnalytics(options: WebAnalyticsOptions): void;
+
+export { type IdentifyPayload, type PageViewPayload, type WebAnalyticsOptions, WebAnalyticsTracker, getWebAnalyticsTracker, initWebAnalytics };

package/dist/web-analytics.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Web Analytics Tracker
+ *
+ * Lightweight page-view analytics tracker for Sylphx Platform SDK.
+ * Automatically tracks page views, bounce rate, and session data.
+ *
+ * @example
+ * ```typescript
+ * import { SDK_API_PATH } from "../../constants";
+import { WebAnalyticsTracker } from '@sylphx/platform-sdk/web-analytics'
+ *
+ * const tracker = new WebAnalyticsTracker()
+ * tracker.init({
+ *   appKey: 'app_prod_xxx',
+ *   endpoint: 'https://your-app.com',
+ * })
+ * ```
+ */
+interface WebAnalyticsOptions {
+    /** App key for authentication */
+    appKey: string;
+    /** Base endpoint URL (without trailing slash) */
+    endpoint: string;
+    /** Auto-track page views (default: true) */
+    trackPageViews?: boolean;
+    /** Track bounce rate (sessions with only 1 page view) (default: true) */
+    trackBounce?: boolean;
+    /** SPA hash routing mode (tracks hash changes) (default: false) */
+    hashMode?: boolean;
+    /** Debug logging (default: false) */
+    debug?: boolean;
+}
+interface PageViewPayload {
+    /** URL path (e.g. /about) */
+    path: string;
+    /** Document referrer */
+    referrer: string;
+    /** Navigator user agent */
+    userAgent: string;
+    /** Screen width in pixels */
+    screenWidth: number;
+    /** Session ID (UUID stored in sessionStorage) */
+    sessionId: string;
+    /** Unix timestamp (ms) */
+    timestamp: number;
+}
+interface IdentifyPayload {
+    /** User ID */
+    userId: string;
+    /** User traits/properties */
+    traits?: Record<string, unknown>;
+    /** Session ID */
+    sessionId: string;
+}
+declare class WebAnalyticsTracker {
+    private options;
+    private initialized;
+    private lastPath;
+    private pageViewCount;
+    private cleanupFns;
+    /**
+     * Initialize the tracker and start auto-tracking page views
+     */
+    init(options: WebAnalyticsOptions): void;
+    /**
+     * Manually track a page view
+     */
+    trackPageView(path?: string): void;
+    /**
+     * Identify a user
+     */
+    identify(userId: string, traits?: Record<string, unknown>): void;
+    /**
+     * Destroy the tracker and remove event listeners
+     */
+    destroy(): void;
+    private _send;
+    private _hookHistoryApi;
+    private _hookNextRouter;
+}
+/**
+ * Get or create the global WebAnalyticsTracker singleton
+ */
+declare function getWebAnalyticsTracker(): WebAnalyticsTracker;
+/**
+ * Initialize global web analytics tracker
+ */
+declare function initWebAnalytics(options: WebAnalyticsOptions): void;
+
+export { type IdentifyPayload, type PageViewPayload, type WebAnalyticsOptions, WebAnalyticsTracker, getWebAnalyticsTracker, initWebAnalytics };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sylphx/sdk",
-	"version": "0.3.0",
+	"version": "0.3.2",
 	"description": "Sylphx SDK - State-of-the-art platform SDK with pure functions",
 	"type": "module",
 	"sideEffects": false,
@@ -45,8 +45,6 @@
 		"test": "bun test",
 		"test:watch": "bun test --watch",
 		"test:coverage": "bun test --coverage",
-		"prepare": "tsup --no-dts",
-		"prepublishOnly": "tsup",
 		"generate:types": "openapi-typescript https://sylphx.com/api/openapi.json -o src/generated/api.d.ts",
 		"generate:types:local": "openapi-typescript http://localhost:3002/api/openapi.json -o src/generated/api.d.ts",
 		"build:docker": "tsup --no-dts"