@visitor-analytics-sdk/utils 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,24 @@
+# @visitor-analytics-sdk/utils
+
+Shared utilities for the visitor-analytics SDK — ID generation, browser detection, idle callbacks, SDK versioning, and type definitions.
+
+```bash
+npm install @visitor-analytics-sdk/utils
+```
+
+## Utilities
+
+| Export | Description |
+|---|---|
+| `generateId()` | Unique ID generator (crypto-based) |
+| `isBrowser()` | Runtime environment detection |
+| `requestIdle(fn)` | `requestIdleCallback` wrapper |
+| `SDK_VERSION` | Current SDK version string |
+| `deepFreeze(obj)` | Recursive `Object.freeze` |
+| `EventBus` | Typed event emitter |
+| `AnalyticsEvent` | Event type definitions |
+| `StorageType` | Storage backend type union |
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+type AnalyticsEvent = "start" | "stop" | "flush" | "sync" | "record-collected" | "batch-uploaded" | "batch-failed" | "error" | "collector-registered" | "collector-removed" | "plugin-installed" | "plugin-uninstalled" | "storage-saved" | "storage-loaded" | "config-changed";
+type StorageType = "memory" | "localstorage" | "indexeddb";
+
 declare const SDK_VERSION = "1.0.0";
 declare function generateId(): string;
 declare function generateShortId(): string;
@@ -11,9 +14,17 @@ declare function safeCall<T>(fn: () => T, fallback: T): T;
 declare function safeCallAsync<T>(fn: () => Promise<T>, fallback: T): Promise<T>;
 declare function requestIdle(callback: () => void, timeout?: number): void;
 declare function deepFreeze<T extends object>(obj: T): Readonly<T>;
-declare function cloneRecord<T>(record: T): T;
 declare function isBrowser(): boolean;
-declare function noop(): void;
-declare function padZero(n: number): string;
 
-export { SDK_VERSION, cloneRecord, debounce, deepFreeze, generateId, generateShortId, isBrowser, noop, padZero, requestIdle, safeCall, safeCallAsync, throttle };
+type Handler = (...args: readonly unknown[]) => void;
+declare class EventBus {
+    private readonly listeners;
+    on(event: AnalyticsEvent, handler: Handler): void;
+    off(event: AnalyticsEvent, handler: Handler): void;
+    emit(event: AnalyticsEvent, ...args: readonly unknown[]): void;
+    removeAllListeners(event?: AnalyticsEvent): void;
+    listenerCount(event: AnalyticsEvent): number;
+}
+declare function detectBestStorage(): StorageType;
+
+export { type AnalyticsEvent, EventBus, SDK_VERSION, type StorageType, debounce, deepFreeze, detectBestStorage, generateId, generateShortId, isBrowser, requestIdle, safeCall, safeCallAsync, throttle };

package/dist/index.js

@@ -92,29 +92,59 @@ function deepFreeze(obj) {
   }
   return obj;
 }
-function cloneRecord(record) {
-  return JSON.parse(JSON.stringify(record));
-}
 function isBrowser() {
   return typeof window !== "undefined" && typeof document !== "undefined" && typeof navigator !== "undefined";
 }
-function noop() {
-}
-function padZero(n) {
-  return n < 10 ? `0${n}` : `${n}`;
-}
-export {
-  SDK_VERSION,
-  cloneRecord,
-  debounce,
-  deepFreeze,
-  generateId,
-  generateShortId,
-  isBrowser,
-  noop,
-  padZero,
-  requestIdle,
-  safeCall,
-  safeCallAsync,
-  throttle
+var EventBus = class {
+  listeners = /* @__PURE__ */ new Map();
+  on(event, handler) {
+    let set = this.listeners.get(event);
+    if (!set) {
+      set = /* @__PURE__ */ new Set();
+      this.listeners.set(event, set);
+    }
+    set.add(handler);
+  }
+  off(event, handler) {
+    this.listeners.get(event)?.delete(handler);
+  }
+  emit(event, ...args) {
+    const set = this.listeners.get(event);
+    if (!set) return;
+    for (const handler of set) {
+      try {
+        handler(...args);
+      } catch (_err) {
+      }
+    }
+  }
+  removeAllListeners(event) {
+    if (event) {
+      this.listeners.delete(event);
+    } else {
+      this.listeners.clear();
+    }
+  }
+  listenerCount(event) {
+    return this.listeners.get(event)?.size ?? 0;
+  }
 };
+function detectBestStorage() {
+  if (typeof window === "undefined") return "memory";
+  try {
+    if (typeof indexedDB !== "undefined") return "indexeddb";
+  } catch {
+  }
+  try {
+    if (typeof localStorage !== "undefined") {
+      const testKey = "__va_storage_test__";
+      localStorage.setItem(testKey, "1");
+      localStorage.removeItem(testKey);
+      return "localstorage";
+    }
+  } catch {
+  }
+  return "memory";
+}
+
+export { EventBus, SDK_VERSION, debounce, deepFreeze, detectBestStorage, generateId, generateShortId, isBrowser, requestIdle, safeCall, safeCallAsync, throttle };

package/package.json

@@ -1,10 +1,30 @@
 {
   "name": "@visitor-analytics-sdk/utils",
-  "version": "1.0.0",
+  "description": "Shared utilities for the visitor-analytics SDK — ID generation, browser detection, idle callbacks, SDK versioning, and type definitions.",
+  "license": "MIT",
+  "keywords": [
+    "visitor-analytics",
+    "utilities",
+    "helpers",
+    "typescript",
+    "sdk"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/instax-dutta/visitor-analytics.git"
+  },
+  "homepage": "https://github.com/instax-dutta/visitor-analytics#readme",
+  "bugs": {
+    "url": "https://github.com/instax-dutta/visitor-analytics/issues"
+  },
+  "version": "1.0.1",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -14,8 +34,12 @@
   "files": [
     "dist"
   ],
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "tsup": "^8.0.0"
+  },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts",
+    "build": "tsup src/index.ts --format esm --dts --treeshake",
     "typecheck": "tsc --noEmit"
   }
 }