@groundcover/browser 0.1.0 → 1.0.0

package/dist/index.d.mts

@@ -232,27 +232,52 @@ interface PrivacyOptions {
         maskInputFn?: (text: string, el: HTMLElement) => string;
     };
 }
+/** Distributed-tracing header propagation for outgoing network requests. */
+interface TracingOptions {
+    /** Request URLs (prefix match) that receive injected tracing headers. */
+    propagationUrls?: string[];
+    /** Inbound header names to read/propagate onto traced requests. */
+    propagationHeaders?: string[];
+    /** Header name carrying the trace id. */
+    traceIdHeaderName?: string;
+    /** Header name carrying the span id. */
+    spanIdHeaderName?: string;
+    /** Origin tag stamped on injected trace headers. */
+    origin?: {
+        name: string;
+        value: string;
+    };
+}
+/** Batching and delivery of outgoing event batches. */
+interface TransportOptions {
+    /** Max events buffered before a batch is flushed (default 10). */
+    batchSize?: number;
+    /** Max ms a batch waits before flushing regardless of size (default 10000). */
+    batchTimeout?: number;
+    /** Gzip-compress outgoing batches; offloaded to the Web Worker when available (default true). */
+    compression?: boolean;
+}
+/**
+ * Session-replay (rrweb) recording controls. This is NOT a privacy surface —
+ * to mask sensitive content use `privacy`.
+ */
+interface ReplayOptions {
+    /**
+     * CSS selectors whose matching elements (and their subtrees) are excluded
+     * from session recording. Matching elements appear in the replay as empty
+     * placeholders of their original size. Useful for skipping noisy DOM injected
+     * by browser extensions (e.g. Grammarly).
+     *
+     * NOTE: this is a noise-reduction control, NOT a privacy control. To mask
+     * sensitive content use `privacy` instead.
+     */
+    blockedSelectors?: string[];
+}
 interface SDKOptions {
-    batchSize: number;
-    batchTimeout: number;
     enabledEvents: Array<"dom" | "network" | "exceptions" | "logs" | "pageload" | "navigation" | "performance" | "replay">;
     eventSampleRate: number;
     sessionSampleRate: number;
-    environment: string;
     debug: boolean;
-    /** @deprecated Use `privacy.maskSelectors` / `privacy.sensitiveKeys`. Still honored. */
-    maskFields: string[];
-    /** @deprecated Use `privacy.level`. Still honored: `true` → `'mask-all'`, explicit `false` → `'allow'`. */
-    enableMasking: boolean;
-    tracePropagationUrls: string[];
-    tracePropagationHeaders: string[];
-    tracePropagationTraceIdHeaderName: string;
-    tracePropagationSpanIdHeaderName: string;
-    traceOrigin: {
-        name: string;
-        value: string;
-    };
-    enableCompression: boolean;
     excludedUrls?: Array<string | RegExp>;
     beforeSend?: (event: EventTypes[keyof EventTypes]) => boolean;
     enrichEvent?: (event: EventTypes[keyof EventTypes]) => EventTypes[keyof EventTypes];
@@ -261,18 +286,15 @@ interface SDKOptions {
      * ON by default (`level: 'mask-sensitive'`); see {@link PrivacyOptions}.
      */
     privacy?: PrivacyOptions;
-    sessionReplay?: {
-        /**
-         * CSS selectors whose matching elements (and their subtrees) are
-         * excluded from session recording. Matching elements appear in the
-         * replay as empty placeholders of their original size. Useful for
-         * skipping noisy DOM injected by browser extensions (e.g. Grammarly).
-         *
-         * NOTE: this is a noise-reduction control, NOT a privacy control. To mask
-         * sensitive content use `privacy` instead.
-         */
-        blockedSelectors?: string[];
-    };
+    /** Distributed-tracing header propagation; see {@link TracingOptions}. */
+    tracing?: TracingOptions;
+    /** Batching & delivery of outgoing events; see {@link TransportOptions}. */
+    transport?: TransportOptions;
+    /**
+     * Session-replay recording controls (noise reduction). For replay MASKING use
+     * `privacy` instead. See {@link ReplayOptions}.
+     */
+    replay?: ReplayOptions;
     /**
      * Target maximum wall-clock duration of a session, in milliseconds.
      *
@@ -320,7 +342,7 @@ interface SDKConfigInput {
     appId: string;
     namespace?: string;
     releaseId?: string;
-    userIdentifier?: Partial<UserIdentifiers>;
+    user?: Partial<UserIdentifiers>;
     options?: Partial<SDKOptions>;
     sessionId?: string;
 }
@@ -333,10 +355,13 @@ declare class SDKConfig {
     namespace?: string;
     releaseId?: string;
     apiKey: string;
-    userIdentifier: Partial<UserIdentifiers> | null;
+    user: Partial<UserIdentifiers> | null;
     options: Partial<SDKOptions>;
     providedOptions?: Partial<SDKOptions>;
     constructor(input?: SDKConfigInput);
+    private static readonly REMOVED_OPTION_KEYS;
+    private static stripRemovedOptions;
+    private static warnRemovedOptions;
     private static normalizeSessionMaxDuration;
     getEndpoint(): string;
     updateConfig(updates: Partial<SDKConfig>): void;
@@ -389,7 +414,7 @@ declare function init(params?: {
     namespace?: string;
     appId?: string;
     releaseId?: string;
-    userIdentifier?: Partial<UserIdentifiers>;
+    user?: Partial<UserIdentifiers>;
     dsn?: string;
     options?: Partial<SDKOptions>;
     apiKey?: string;

package/dist/index.d.ts

@@ -232,27 +232,52 @@ interface PrivacyOptions {
         maskInputFn?: (text: string, el: HTMLElement) => string;
     };
 }
+/** Distributed-tracing header propagation for outgoing network requests. */
+interface TracingOptions {
+    /** Request URLs (prefix match) that receive injected tracing headers. */
+    propagationUrls?: string[];
+    /** Inbound header names to read/propagate onto traced requests. */
+    propagationHeaders?: string[];
+    /** Header name carrying the trace id. */
+    traceIdHeaderName?: string;
+    /** Header name carrying the span id. */
+    spanIdHeaderName?: string;
+    /** Origin tag stamped on injected trace headers. */
+    origin?: {
+        name: string;
+        value: string;
+    };
+}
+/** Batching and delivery of outgoing event batches. */
+interface TransportOptions {
+    /** Max events buffered before a batch is flushed (default 10). */
+    batchSize?: number;
+    /** Max ms a batch waits before flushing regardless of size (default 10000). */
+    batchTimeout?: number;
+    /** Gzip-compress outgoing batches; offloaded to the Web Worker when available (default true). */
+    compression?: boolean;
+}
+/**
+ * Session-replay (rrweb) recording controls. This is NOT a privacy surface —
+ * to mask sensitive content use `privacy`.
+ */
+interface ReplayOptions {
+    /**
+     * CSS selectors whose matching elements (and their subtrees) are excluded
+     * from session recording. Matching elements appear in the replay as empty
+     * placeholders of their original size. Useful for skipping noisy DOM injected
+     * by browser extensions (e.g. Grammarly).
+     *
+     * NOTE: this is a noise-reduction control, NOT a privacy control. To mask
+     * sensitive content use `privacy` instead.
+     */
+    blockedSelectors?: string[];
+}
 interface SDKOptions {
-    batchSize: number;
-    batchTimeout: number;
     enabledEvents: Array<"dom" | "network" | "exceptions" | "logs" | "pageload" | "navigation" | "performance" | "replay">;
     eventSampleRate: number;
     sessionSampleRate: number;
-    environment: string;
     debug: boolean;
-    /** @deprecated Use `privacy.maskSelectors` / `privacy.sensitiveKeys`. Still honored. */
-    maskFields: string[];
-    /** @deprecated Use `privacy.level`. Still honored: `true` → `'mask-all'`, explicit `false` → `'allow'`. */
-    enableMasking: boolean;
-    tracePropagationUrls: string[];
-    tracePropagationHeaders: string[];
-    tracePropagationTraceIdHeaderName: string;
-    tracePropagationSpanIdHeaderName: string;
-    traceOrigin: {
-        name: string;
-        value: string;
-    };
-    enableCompression: boolean;
     excludedUrls?: Array<string | RegExp>;
     beforeSend?: (event: EventTypes[keyof EventTypes]) => boolean;
     enrichEvent?: (event: EventTypes[keyof EventTypes]) => EventTypes[keyof EventTypes];
@@ -261,18 +286,15 @@ interface SDKOptions {
      * ON by default (`level: 'mask-sensitive'`); see {@link PrivacyOptions}.
      */
     privacy?: PrivacyOptions;
-    sessionReplay?: {
-        /**
-         * CSS selectors whose matching elements (and their subtrees) are
-         * excluded from session recording. Matching elements appear in the
-         * replay as empty placeholders of their original size. Useful for
-         * skipping noisy DOM injected by browser extensions (e.g. Grammarly).
-         *
-         * NOTE: this is a noise-reduction control, NOT a privacy control. To mask
-         * sensitive content use `privacy` instead.
-         */
-        blockedSelectors?: string[];
-    };
+    /** Distributed-tracing header propagation; see {@link TracingOptions}. */
+    tracing?: TracingOptions;
+    /** Batching & delivery of outgoing events; see {@link TransportOptions}. */
+    transport?: TransportOptions;
+    /**
+     * Session-replay recording controls (noise reduction). For replay MASKING use
+     * `privacy` instead. See {@link ReplayOptions}.
+     */
+    replay?: ReplayOptions;
     /**
      * Target maximum wall-clock duration of a session, in milliseconds.
      *
@@ -320,7 +342,7 @@ interface SDKConfigInput {
     appId: string;
     namespace?: string;
     releaseId?: string;
-    userIdentifier?: Partial<UserIdentifiers>;
+    user?: Partial<UserIdentifiers>;
     options?: Partial<SDKOptions>;
     sessionId?: string;
 }
@@ -333,10 +355,13 @@ declare class SDKConfig {
     namespace?: string;
     releaseId?: string;
     apiKey: string;
-    userIdentifier: Partial<UserIdentifiers> | null;
+    user: Partial<UserIdentifiers> | null;
     options: Partial<SDKOptions>;
     providedOptions?: Partial<SDKOptions>;
     constructor(input?: SDKConfigInput);
+    private static readonly REMOVED_OPTION_KEYS;
+    private static stripRemovedOptions;
+    private static warnRemovedOptions;
     private static normalizeSessionMaxDuration;
     getEndpoint(): string;
     updateConfig(updates: Partial<SDKConfig>): void;
@@ -389,7 +414,7 @@ declare function init(params?: {
     namespace?: string;
     appId?: string;
     releaseId?: string;
-    userIdentifier?: Partial<UserIdentifiers>;
+    user?: Partial<UserIdentifiers>;
     dsn?: string;
     options?: Partial<SDKOptions>;
     apiKey?: string;