@faststats/web 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -1,60 +1,40 @@
-import { FeatureFlagEvaluation } from "./feature-flags.js";
-import { n as ReplayTrackerOptions } from "./chunks/replay-DgodPHzA.js";
-
+import { a as ExtensionHook, i as ExtensionHandler, n as AnalyticsExtensionContext, o as ExtensionHooks, r as ExtensionCleanup, t as AnalyticsExtension } from "./chunks/extensions-DW7tJY0T.js";
 //#region src/analytics.d.ts
-type ConsentMode = "pending" | "granted" | "denied";
-type PendingBehavior = "anonymous" | "disabled";
+type ConsentMode = "anonymous" | "granted" | "denied";
 interface IdentifyOptions {
-  name?: string;
-  phone?: string;
-  avatarUrl?: string;
+  name?: string | null;
+  phone?: string | null;
+  avatarUrl?: string | null;
   traits?: Record<string, unknown>;
+  traitMode?: "merge" | "replace";
+  unsetTraits?: string[];
+  aliases?: string[];
+}
+interface IdentifyUser extends IdentifyOptions {
+  id: string;
+  email?: string | null;
 }
 interface WebAnalyticsOptions {
   siteKey: string;
   baseUrl?: string;
-  featureFlagsBaseUrl?: string;
   debug?: boolean;
-  autoTrack?: boolean;
   trackHash?: boolean;
   cookieless?: boolean;
-  consent?: {
-    mode?: ConsentMode;
-    pendingBehavior?: PendingBehavior;
-  };
-  webVitals?: {
-    enabled?: boolean;
-    attribution?: boolean;
-  };
-  sessionReplays?: {
-    enabled?: boolean;
-  };
-  errorTracking?: {
-    enabled?: boolean;
-  };
-  replayOptions?: Partial<ReplayTrackerOptions>;
+  consent?: ConsentMode;
+  extensions?: readonly AnalyticsExtension[];
   /** @internal */
   sdkName?: string;
   /** @internal */
   sdkVersion?: string;
 }
-declare function getInstance(): WebAnalytics | null;
-declare function trackEvent(eventName: string, properties?: Record<string, unknown>): void;
-declare function identify(externalId: string, email: string, options?: IdentifyOptions): Promise<boolean>;
-declare function logout(resetAnonymousIdentity?: boolean): void;
-declare function setConsentMode(mode: ConsentMode): void;
-declare function optIn(): void;
-declare function optOut(): void;
-declare function reportError(error: Error): void;
-declare function isTrackingDisabled(): boolean;
 declare class WebAnalytics {
   private readonly options;
   private readonly baseUrl;
   private readonly debug;
+  private readonly cleanup;
   private started;
-  private destroyed;
-  private epoch;
   private heartbeatTimer;
+  private extensions;
   private pageKey;
   private entry;
   private left;
@@ -62,51 +42,53 @@ declare class WebAnalytics {
   private visitStartedAt;
   private pendingPageviewTrigger;
   private consentMode;
-  private readonly pendingBehavior;
-  private readonly cleanup;
-  private readonly childTrackers;
-  private readonly outboundLinks;
   constructor(options: WebAnalyticsOptions);
-  private log;
-  private isTrackingBlocked;
-  private ensureActive;
-  private canTrack;
-  private canSendEvents;
-  private cookieless;
-  private touch;
-  private bind;
-  private stopHeartbeat;
-  private loadChild;
-  private loadOptionalTrackers;
-  private enterPage;
-  private beginTracking;
-  private readonly onLinkClick;
-  private readonly onVisibilityChange;
-  private readonly onPageHide;
-  private readonly onPageShow;
-  start(): Promise<void>;
+  start(): void;
   destroy(): void;
-  pageview(extra?: Record<string, unknown>): void;
-  track(name: string, extra?: Record<string, unknown>): void;
-  identify(externalId: string, email: string, options?: IdentifyOptions): Promise<boolean>;
+  pageview(properties?: Record<string, unknown>): void;
+  track(name: string, properties?: Record<string, unknown>): void;
+  identify(user: IdentifyUser): Promise<boolean>;
+  identify(externalId: string, email?: string, options?: IdentifyOptions): Promise<boolean>;
   logout(resetAnonymousIdentity?: boolean): void;
   setConsentMode(mode: ConsentMode): void;
-  getConsentMode(): ConsentMode;
   getAnonymousId(): string;
-  getSessionId(): string;
-  getWindowId(): string;
-  checkFeatureFlag(key: string, attributes?: Record<string, unknown>, opts?: {
-    externalId?: string;
-    signal?: AbortSignal;
-  }): Promise<FeatureFlagEvaluation>;
   reportError(error: Error): void;
-  private send;
+  private canTrack;
+  private isCookieless;
+  private ensureActive;
+  private activate;
+  private startExtensions;
+  private stopExtensions;
+  private installBrowserLifecycle;
+  private bind;
+  private readonly onNavigate;
+  private readonly onVisibilityChange;
+  private readonly onPageHide;
+  private readonly onPageShow;
+  private navigate;
+  private enterPage;
   private leavePage;
-  private startVisit;
   private pauseVisit;
   private resumeVisit;
+  private touch;
   private startHeartbeat;
-  private navigate;
+  private stopHeartbeat;
+  private send;
 }
 //#endregion
-export { type ConsentMode, type FeatureFlagEvaluation, type IdentifyOptions, type PendingBehavior, WebAnalytics, type WebAnalyticsOptions, getInstance, identify, isTrackingDisabled, logout, optIn, optOut, reportError, setConsentMode, trackEvent };
+//#region src/client.d.ts
+/** Creates an independent client. Call `start()` when it should begin tracking. */
+declare function createClient(options: WebAnalyticsOptions): WebAnalytics;
+/** Initializes and starts the shared client used by the convenience functions. */
+declare function init(options: WebAnalyticsOptions): WebAnalytics;
+/** Stops and forgets the shared client. Independent clients are unaffected. */
+declare function shutdown(): void;
+declare function pageview(properties?: Record<string, unknown>): void;
+declare function track(name: string, properties?: Record<string, unknown>): void;
+declare function identify(user: IdentifyUser): Promise<boolean>;
+declare function identify(externalId: string, email?: string, options?: IdentifyOptions): Promise<boolean>;
+declare function logout(resetAnonymousIdentity?: boolean): void;
+declare function setConsentMode(mode: ConsentMode): void;
+declare function reportError(error: Error): void;
+//#endregion
+export { type AnalyticsExtension, type AnalyticsExtensionContext, type ConsentMode, type ExtensionCleanup, type ExtensionHandler, type ExtensionHook, type ExtensionHooks, type IdentifyOptions, type IdentifyUser, WebAnalytics, type WebAnalyticsOptions, createClient, identify, init, logout, pageview, reportError, setConsentMode, shutdown, track };