@outlit/browser 0.1.0

package/dist/tracker-CocH64L9.d.ts

@@ -0,0 +1,107 @@
+import { TrackerConfig, BrowserTrackOptions, BrowserIdentifyOptions } from '@outlit/core';
+
+interface TrackerOptions extends TrackerConfig {
+    /**
+     * Automatically start tracking on init.
+     * Set to false if you need to wait for user consent before tracking.
+     * Call enableTracking() to start tracking after consent is obtained.
+     * @default true
+     */
+    autoTrack?: boolean;
+    trackPageviews?: boolean;
+    trackForms?: boolean;
+    formFieldDenylist?: string[];
+    flushInterval?: number;
+    /**
+     * Automatically identify users when they submit forms with email fields.
+     * Extracts email and name (first/last) from form fields using heuristics.
+     * @default true
+     */
+    autoIdentify?: boolean;
+}
+declare class Tracker {
+    private publicKey;
+    private apiHost;
+    private visitorId;
+    private eventQueue;
+    private flushTimer;
+    private flushInterval;
+    private isInitialized;
+    private isTrackingEnabled;
+    private options;
+    constructor(options: TrackerOptions);
+    /**
+     * Enable tracking. Call this after obtaining user consent.
+     * This will:
+     * - Generate/retrieve the visitor ID
+     * - Start automatic pageview and form tracking (if configured)
+     * - Begin sending events to the server
+     *
+     * If autoTrack is true (default), this is called automatically on init.
+     */
+    enableTracking(): void;
+    /**
+     * Check if tracking is currently enabled.
+     */
+    isEnabled(): boolean;
+    /**
+     * Track a custom event.
+     */
+    track(eventName: string, properties?: BrowserTrackOptions["properties"]): void;
+    /**
+     * Identify the current visitor.
+     * Links the anonymous visitor to a known user.
+     */
+    identify(options: BrowserIdentifyOptions): void;
+    /**
+     * Get the current visitor ID.
+     * Returns null if tracking is not enabled.
+     */
+    getVisitorId(): string | null;
+    /**
+     * Manually flush the event queue.
+     */
+    flush(): Promise<void>;
+    /**
+     * Shutdown the tracker.
+     */
+    shutdown(): Promise<void>;
+    private initPageviewTracking;
+    private initFormTracking;
+    private enqueue;
+    private startFlushTimer;
+    private sendEvents;
+}
+/**
+ * Initialize the Outlit tracker.
+ * Should be called once at app startup.
+ */
+declare function init(options: TrackerOptions): Tracker;
+/**
+ * Get the tracker instance.
+ * Throws if not initialized.
+ */
+declare function getInstance(): Tracker;
+/**
+ * Track a custom event.
+ * Convenience method that uses the singleton instance.
+ */
+declare function track(eventName: string, properties?: BrowserTrackOptions["properties"]): void;
+/**
+ * Identify the current visitor.
+ * Convenience method that uses the singleton instance.
+ */
+declare function identify(options: BrowserIdentifyOptions): void;
+/**
+ * Enable tracking after consent is obtained.
+ * Call this in your consent management tool's callback.
+ * Convenience method that uses the singleton instance.
+ */
+declare function enableTracking(): void;
+/**
+ * Check if tracking is currently enabled.
+ * Convenience method that uses the singleton instance.
+ */
+declare function isTrackingEnabled(): boolean;
+
+export { Tracker as T, identify as a, isTrackingEnabled as b, type TrackerOptions as c, enableTracking as e, getInstance as g, init as i, track as t };

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@outlit/browser",
+  "version": "0.1.0",
+  "description": "Outlit browser tracking SDK with React bindings",
+  "license": "Apache-2.0",
+  "author": "Outlit AI",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OutlitAI/outlit-sdk.git",
+    "directory": "packages/browser"
+  },
+  "bugs": {
+    "url": "https://github.com/OutlitAI/outlit-sdk/issues"
+  },
+  "homepage": "https://github.com/OutlitAI/outlit-sdk#readme",
+  "keywords": [
+    "outlit",
+    "analytics",
+    "tracking",
+    "sdk",
+    "browser",
+    "react"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.mjs",
+      "require": "./dist/react/index.js",
+      "default": "./dist/react/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@outlit/core": "0.1.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.48.0",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.2.0",
+    "react": "^18.2.0",
+    "tsup": "^8.0.1",
+    "tsx": "^4.0.0",
+    "typescript": "^5.3.3",
+    "@outlit/typescript-config": "0.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist .turbo node_modules",
+    "lint": "biome check . --write",
+    "format": "biome format --write .",
+    "typecheck": "tsc --noEmit",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui",
+    "test:headed": "playwright test --headed",
+    "serve:test": "tsx ./__tests__/e2e/serve.ts",
+    "deploy:canary": "pnpm build && tsx ./scripts/deploy.ts canary",
+    "deploy:stable": "pnpm build && tsx ./scripts/deploy.ts stable",
+    "deploy:version": "pnpm build && tsx ./scripts/deploy.ts version"
+  }
+}