crexperium-sdk 1.1.0

package/dist/types/session-replay.d.ts

@@ -0,0 +1,213 @@
+/**
+ * Session Replay Type Definitions
+ */
+import { eventWithTime } from 'rrweb';
+/**
+ * Session replay configuration options
+ */
+export interface SessionReplayConfig {
+    /** Enable session replay recording (default: true) */
+    enabled?: boolean;
+    /** Sample rate for recording sessions (0-1, default: 1.0 = 100%) */
+    sampleRate?: number;
+    /** Recording options */
+    recording?: {
+        /** Mask all input fields (default: true) */
+        maskAllInputs?: boolean;
+        /** CSS selector for elements to mask */
+        maskTextSelector?: string;
+        /** CSS selector for elements to block completely */
+        blockSelector?: string;
+        /** Record canvas elements (default: false) */
+        recordCanvas?: boolean;
+        /** Collect fonts (default: false) */
+        collectFonts?: boolean;
+        /** Inline stylesheets (default: true) */
+        inlineStylesheet?: boolean;
+        /** Inline images (default: false) */
+        inlineImages?: boolean;
+    };
+    /** Buffering and flushing options */
+    buffering?: {
+        /** Flush interval in milliseconds (default: 5000) */
+        flushInterval?: number;
+        /** Maximum buffer size in events (default: 100) */
+        maxBufferSize?: number;
+        /** Maximum session duration in milliseconds (default: 3600000 = 1 hour) */
+        maxSessionDuration?: number;
+    };
+    /** Telemetry capture options */
+    telemetry?: {
+        /** Capture console logs (default: true) */
+        captureConsole?: boolean;
+        /** Capture network requests (default: true) */
+        captureNetwork?: boolean;
+        /** Capture JavaScript errors (default: true) */
+        captureErrors?: boolean;
+        /** Capture performance metrics (default: true) */
+        capturePerformance?: boolean;
+    };
+    /** Privacy configuration */
+    privacy?: {
+        /** Automatically mask email addresses (default: true) */
+        maskEmails?: boolean;
+        /** Automatically mask phone numbers (default: true) */
+        maskPhones?: boolean;
+        /** Automatically mask credit card numbers (default: true) */
+        maskCreditCards?: boolean;
+        /** Custom masking patterns (regex + replacement) */
+        customMaskPatterns?: Array<{
+            pattern: RegExp;
+            replacement: string;
+        }>;
+    };
+}
+/**
+ * Session replay session data
+ */
+export interface SessionReplaySession {
+    /** Unique session ID */
+    sessionId: string;
+    /** Start timestamp */
+    startTime: Date;
+    /** End timestamp (if session has ended) */
+    endTime?: Date;
+    /** Session duration in milliseconds */
+    duration?: number;
+    /** Initial URL */
+    initialUrl: string;
+    /** Referrer URL */
+    referrer?: string;
+    /** Visitor ID */
+    visitorId?: string;
+    /** Contact ID (if identified) */
+    contactId?: string;
+    /** Device type */
+    deviceType?: string;
+    /** Browser */
+    browser?: string;
+    /** Operating system */
+    os?: string;
+    /** Viewport dimensions */
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    /** Status */
+    status: 'ACTIVE' | 'ENDED' | 'PROCESSING' | 'ERROR';
+    /** Event counts */
+    eventCount?: number;
+    errorCount?: number;
+    consoleLogCount?: number;
+    networkRequestCount?: number;
+    pageCount?: number;
+}
+/**
+ * Session event types
+ */
+export declare enum SessionEventType {
+    CONSOLE = "CONSOLE",
+    ERROR = "ERROR",
+    NETWORK = "NETWORK",
+    CUSTOM = "CUSTOM",
+    PERFORMANCE = "PERFORMANCE",
+    PAGE_VIEW = "PAGE_VIEW"
+}
+/**
+ * Console log levels
+ */
+export declare enum ConsoleLevel {
+    LOG = "log",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error",
+    DEBUG = "debug"
+}
+/**
+ * Session telemetry event
+ */
+export interface SessionEvent {
+    /** Event type */
+    type: SessionEventType;
+    /** Timestamp */
+    timestamp: Date;
+    /** Offset from session start in milliseconds */
+    offsetMs: number;
+    /** Console log data */
+    console?: {
+        level: ConsoleLevel;
+        message: string;
+        args?: any[];
+    };
+    /** Error data */
+    error?: {
+        message: string;
+        stack?: string;
+        filename?: string;
+        lineno?: number;
+        colno?: number;
+    };
+    /** Network request data */
+    network?: {
+        method: string;
+        url: string;
+        statusCode?: number;
+        duration?: number;
+        requestSize?: number;
+        responseSize?: number;
+        requestHeaders?: Record<string, string>;
+        responseHeaders?: Record<string, string>;
+    };
+    /** Performance data */
+    performance?: {
+        metric: string;
+        value: number;
+        rating?: 'good' | 'needs-improvement' | 'poor';
+    };
+    /** Custom event data */
+    custom?: {
+        name: string;
+        data?: any;
+    };
+    /** Page view data */
+    pageView?: {
+        url: string;
+        title: string;
+        referrer?: string;
+    };
+}
+/**
+ * Batch ingest request
+ */
+export interface SessionReplayIngestRequest {
+    /** Session ID */
+    sessionId: string;
+    /** rrweb events */
+    events: eventWithTime[];
+    /** Telemetry events */
+    telemetryEvents?: SessionEvent[];
+}
+/**
+ * Session replay API responses
+ */
+export interface SessionReplayStartResponse {
+    sessionId: string;
+    status: string;
+}
+export interface SessionReplayIngestResponse {
+    success: boolean;
+    eventsProcessed: number;
+}
+export interface SessionReplayEndResponse {
+    success: boolean;
+    duration: number;
+}
+/**
+ * Custom event options
+ */
+export interface CustomEventOptions {
+    /** Event name */
+    name: string;
+    /** Event data */
+    data?: any;
+}

package/dist/utils/device.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Device detection utilities for browser environments
+ */
+export interface DeviceInfo {
+    userAgent: string;
+    deviceType: 'desktop' | 'mobile' | 'tablet';
+    browser: string;
+    os: string;
+}
+/**
+ * Detect device type from user agent
+ */
+export declare function detectDeviceType(userAgent: string): 'desktop' | 'mobile' | 'tablet';
+/**
+ * Detect browser from user agent
+ */
+export declare function detectBrowser(userAgent: string): string;
+/**
+ * Detect operating system from user agent
+ */
+export declare function detectOS(userAgent: string): string;
+/**
+ * Get complete device information
+ */
+export declare function getDeviceInfo(): DeviceInfo;

package/dist/utils/device.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../src/utils/device.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAenF;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CA6BvD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CA+BlD;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI,UAAU,CAkB1C"}

package/dist/utils/http.d.ts

@@ -0,0 +1,53 @@
+/**
+ * HTTP client with retry logic and error handling
+ */
+import { Config } from '../config';
+export declare class HTTPClient {
+    private config;
+    private headers;
+    constructor(config: Config);
+    /**
+     * Make an HTTP request with retry logic
+     */
+    request<T>(method: string, endpoint: string, data?: any, params?: Record<string, any>): Promise<T>;
+    /**
+     * GET request
+     */
+    get<T>(endpoint: string, params?: Record<string, any>): Promise<T>;
+    /**
+     * POST request
+     */
+    post<T>(endpoint: string, data?: any): Promise<T>;
+    /**
+     * PATCH request
+     */
+    patch<T>(endpoint: string, data?: any): Promise<T>;
+    /**
+     * PUT request
+     */
+    put<T>(endpoint: string, data?: any): Promise<T>;
+    /**
+     * DELETE request
+     */
+    delete<T>(endpoint: string): Promise<T>;
+    /**
+     * Build URL with query parameters
+     */
+    private buildUrl;
+    /**
+     * Make the actual HTTP request
+     */
+    private makeRequest;
+    /**
+     * Handle HTTP response and errors
+     */
+    private handleResponse;
+    /**
+     * Calculate retry delay with exponential backoff
+     */
+    private calculateRetryDelay;
+    /**
+     * Sleep utility
+     */
+    private sleep;
+}

package/dist/utils/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAmCnC,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAyB;gBAE5B,MAAM,EAAE,MAAM;IAS1B;;OAEG;IACG,OAAO,CAAC,CAAC,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,GAAG,EACV,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC3B,OAAO,CAAC,CAAC,CAAC;IAgCb;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAIxE;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAIvD;;OAEG;IACG,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAIxD;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAItD;;OAEG;IACG,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7C;;OAEG;IACH,OAAO,CAAC,QAAQ;IA0BhB;;OAEG;YACW,WAAW;IAqCzB;;OAEG;YACW,cAAc;IAuD5B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;OAEG;IACH,OAAO,CAAC,KAAK;CAGd"}

package/dist/utils/storage.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Storage utilities for browser localStorage/cookies
+ */
+/**
+ * Check if localStorage is available
+ */
+export declare function isLocalStorageAvailable(): boolean;
+/**
+ * Get item from localStorage
+ */
+export declare function getLocalStorageItem(key: string): string | null;
+/**
+ * Set item in localStorage
+ */
+export declare function setLocalStorageItem(key: string, value: string): boolean;
+/**
+ * Remove item from localStorage
+ */
+export declare function removeLocalStorageItem(key: string): boolean;
+/**
+ * Generate a UUID v4
+ */
+export declare function generateUUID(): string;

package/dist/utils/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/utils/storage.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,wBAAgB,uBAAuB,IAAI,OAAO,CAajD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAU9D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAWvE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAW3D;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAWrC"}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "crexperium-sdk",
+  "version": "1.1.0",
+  "description": "Official TypeScript/JavaScript SDK for Crexperium CRM",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "browser": "dist/browser.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "test": "jest",
+    "lint": "eslint src --ext .ts",
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "npm run build",
+    "dev": "rollup -c -w"
+  },
+  "keywords": [
+    "crm",
+    "analytics",
+    "events",
+    "tracking",
+    "crexperium",
+    "typescript",
+    "sdk",
+    "session-replay",
+    "rrweb"
+  ],
+  "author": "Crexperium",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/crexperium/crexperium-sdk.git"
+  },
+  "homepage": "https://github.com/crexperium/crexperium-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/crexperium/crexperium-sdk/issues"
+  },
+  "type": "module",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.0.0",
+    "prettier": "^3.0.0",
+    "rollup": "^4.0.0",
+    "ts-jest": "^29.0.0",
+    "tslib": "^2.6.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "node-fetch": "^3.3.0",
+    "rrweb": "^2.0.0-alpha.11",
+    "rrweb-player": "^2.0.0-alpha.11"
+  }
+}