@reopt-ai/data-sdk-client 0.1.4 → 0.1.6

package/dist/{client-CW9DfTlm.d.ts → client-BCd2fgmx.d.ts}

@@ -9,11 +9,11 @@ import { ReoptBootstrap, DeviceCookieState, ConsentCookieState } from '@reopt-ai
 type ConsentCategory = "analytics" | "marketing" | "functional" | "performance";
 interface ConsentConfig {
     /** Default decision for every configured category. Default: `true` (opt-out model). */
-    defaultConsent?: boolean;
+    defaultConsent?: boolean | undefined;
     /** Categories the integration recognises. Default: `["analytics"]`. */
-    categories?: ConsentCategory[];
+    categories?: ConsentCategory[] | undefined;
     /** Persist decisions through the runtime's storage. Default: `true`. */
-    persist?: boolean;
+    persist?: boolean | undefined;
 }
 /** Minimal synchronous key/value store — `localStorage`-shaped on purpose. */
 interface StorageBackend {
@@ -23,31 +23,31 @@ interface StorageBackend {
 }
 interface RetryConfig {
     /** Attempts after the first. Default: 3. */
-    maxRetries?: number;
+    maxRetries?: number | undefined;
     /** First back-off, milliseconds. Default: 1000. */
-    baseDelay?: number;
+    baseDelay?: number | undefined;
     /** Back-off ceiling, milliseconds. Default: 30000. */
-    maxDelay?: number;
+    maxDelay?: number | undefined;
     /** ± fraction of the delay. Default: 0.1. */
-    jitter?: number;
+    jitter?: number | undefined;
 }
 interface CircuitBreakerConfig {
     /** Consecutive transient failures before the circuit opens. Default: 5. */
-    failureThreshold?: number;
+    failureThreshold?: number | undefined;
     /** How long the circuit stays open before one probe is allowed. Default: 60000. */
-    recoveryTimeout?: number;
+    recoveryTimeout?: number | undefined;
 }
 interface BatchConfig {
     /** Events per request. Default: 100. */
-    size?: number;
+    size?: number | undefined;
     /** Milliseconds to wait for a batch to fill before sending. Default: 1000. */
-    intervalMs?: number;
+    intervalMs?: number | undefined;
     /**
      * Serialized bytes per request. Default: 400 000, under the server's
      * 512 000 hard cap with room for the JSON envelope. A 413 is a 4xx, and 4xx
      * drops the batch — so overshooting the cap loses every event in it.
      */
-    maxBytes?: number;
+    maxBytes?: number | undefined;
 }
 /** Browser credentials — public, ships in the page. */
 interface WriteKeyAuth {
@@ -64,7 +64,7 @@ interface FetchInit {
     method: string;
     headers: Record<string, string>;
     body: string;
-    keepalive?: boolean;
+    keepalive?: boolean | undefined;
 }
 interface FetchResponseLike {
     ok: boolean;
@@ -76,13 +76,13 @@ interface FetchResponseLike {
 }
 /** Context the runtime fills in for a `$pageview` when the caller does not. */
 interface PageContext {
-    path?: string;
-    origin?: string;
-    title?: string;
-    referrer?: string;
-    utm?: UTMParams;
+    path?: string | undefined;
+    origin?: string | undefined;
+    title?: string | undefined;
+    referrer?: string | undefined;
+    utm?: UTMParams | undefined;
     /** Extra properties the runtime derived from the page, e.g. a `normalizePath` hook's output. */
-    properties?: Record<string, unknown>;
+    properties?: Record<string, unknown> | undefined;
 }
 /**
  * Everything the engine needs from the world around it. The browser package
@@ -97,58 +97,58 @@ interface ReoptRuntime {
      * ingest handed back, if the runtime kept it. Unsigned values are ignored
      * by ingest, so only send what came from `onSession`.
      */
-    getSessionId?: () => string | null | undefined;
+    getSessionId?: (() => string | null | undefined) | undefined;
     /** Ingest assigned (or confirmed) a session for this batch. The runtime persists it. */
-    onSession?: (credential: {
+    onSession?: ((credential: {
         id: string;
         token: string;
-    }) => void;
+    }) => void) | undefined | undefined;
     /** Durable store for the offline queue and consent. Absent = memory only. */
-    storage?: StorageBackend;
+    storage?: StorageBackend | undefined;
     /** Clock. Defaults to `Date.now`; the browser package corrects for server skew. */
-    now?: () => number;
+    now?: (() => number) | undefined | undefined;
     /** Id generator. Defaults to monotonic UUIDv7. */
-    createId?: () => string;
+    createId?: (() => string) | undefined | undefined;
     /** `fetch` implementation. Defaults to `globalThis.fetch`. */
-    fetch?: FetchLike;
+    fetch?: FetchLike | undefined;
     /**
      * Subscribe to "the process is about to go away" signals (pagehide,
      * visibilitychange, SIGTERM). The engine flushes on each signal. Returns
      * the unsubscribe function.
      */
-    onFlushSignal?: (flush: () => void) => () => void;
+    onFlushSignal?: (flush: () => void) => () => void | undefined | undefined;
     /**
      * Last-chance delivery used when a flush signal fires, e.g. `sendBeacon`.
      * Return `true` if the runtime accepted the payload; `false` falls back to
      * keepalive fetch.
      */
-    sendLastChance?: (url: string, body: string, headers: Record<string, string>) => boolean;
+    sendLastChance?: ((url: string, body: string, headers: Record<string, string>) => boolean) | undefined | undefined;
     /** Defaults for `$pageview` properties. */
-    getPageContext?: () => PageContext;
+    getPageContext?: (() => PageContext) | undefined | undefined;
     /**
      * Mint and persist a fresh device id. Called by `reset()`; without it a
      * reset keeps the old device, which is wrong on a shared machine.
      */
-    regenerateDeviceId?: () => string;
+    regenerateDeviceId?: (() => string) | undefined | undefined;
 }
 interface ReoptCoreConfig {
     auth: ReoptAuth;
     /** Origin of the reopt-data deployment, or a same-origin proxy prefix like `/ingest`. */
     baseUrl: string;
     runtime: ReoptRuntime;
-    debug?: boolean;
-    batch?: BatchConfig;
+    debug?: boolean | undefined;
+    batch?: BatchConfig | undefined;
     /** Upper bound on queued events; the oldest are dropped past it. Default: 10000. */
-    maxQueueSize?: number;
-    retry?: RetryConfig;
-    circuitBreaker?: CircuitBreakerConfig;
-    consent?: ConsentConfig;
+    maxQueueSize?: number | undefined;
+    retry?: RetryConfig | undefined;
+    circuitBreaker?: CircuitBreakerConfig | undefined;
+    consent?: ConsentConfig | undefined;
     /** Prefix for storage keys. Default: `reopt_`. */
-    storagePrefix?: string;
+    storagePrefix?: string | undefined;
     /** Persist the queue through `runtime.storage`. Default: `true` when storage exists. */
-    enableOfflineBuffer?: boolean;
+    enableOfflineBuffer?: boolean | undefined;
     /** Flush on runtime flush signals. Default: `true` when the runtime provides them. */
-    autoFlushOnUnload?: boolean;
+    autoFlushOnUnload?: boolean | undefined;
 }
 /**
  * Identity a single event was recorded under, when it differs from the
@@ -157,63 +157,63 @@ interface ReoptCoreConfig {
  * becomes that batch's `reopt-device-id`.
  */
 interface EventIdentity {
-    deviceId?: string;
-    sessionId?: string | null;
+    deviceId?: string | undefined;
+    sessionId?: string | null | undefined;
 }
 interface TrackEventOptions {
     /** File this event under another visitor than the runtime's. Server SDK use. */
-    identity?: EventIdentity;
+    identity?: EventIdentity | undefined;
     name: string;
-    properties?: Record<string, unknown>;
-    profileId?: string | number;
+    properties?: Record<string, unknown> | undefined;
+    profileId?: string | number | undefined;
     /** Consent category this event belongs to. Default: `analytics`. */
-    consentCategory?: ConsentCategory;
+    consentCategory?: ConsentCategory | undefined;
 }
 interface IdentifyOptions {
     /** File this event under another visitor than the runtime's. Server SDK use. */
-    identity?: EventIdentity;
+    identity?: EventIdentity | undefined;
     profileId: string | number;
-    firstName?: string;
-    lastName?: string;
-    email?: string;
-    avatar?: string;
-    properties?: Record<string, unknown>;
-    consentCategory?: ConsentCategory;
+    firstName?: string | undefined;
+    lastName?: string | undefined;
+    email?: string | undefined;
+    avatar?: string | undefined;
+    properties?: Record<string, unknown> | undefined;
+    consentCategory?: ConsentCategory | undefined;
 }
 interface IncrementOptions {
     /** File this event under another visitor than the runtime's. Server SDK use. */
-    identity?: EventIdentity;
+    identity?: EventIdentity | undefined;
     profileId: string | number;
     property: string;
-    value?: number;
-    consentCategory?: ConsentCategory;
+    value?: number | undefined;
+    consentCategory?: ConsentCategory | undefined;
 }
 interface DecrementOptions {
     /** File this event under another visitor than the runtime's. Server SDK use. */
-    identity?: EventIdentity;
+    identity?: EventIdentity | undefined;
     profileId: string | number;
     property: string;
-    value?: number;
-    consentCategory?: ConsentCategory;
+    value?: number | undefined;
+    consentCategory?: ConsentCategory | undefined;
 }
 interface UTMParams {
-    utm_source?: string;
-    utm_medium?: string;
-    utm_campaign?: string;
-    utm_term?: string;
-    utm_content?: string;
+    utm_source?: string | undefined;
+    utm_medium?: string | undefined;
+    utm_campaign?: string | undefined;
+    utm_term?: string | undefined;
+    utm_content?: string | undefined;
 }
 interface PageViewOptions {
     /** File this event under another visitor than the runtime's. Server SDK use. */
-    identity?: EventIdentity;
-    path?: string;
+    identity?: EventIdentity | undefined;
+    path?: string | undefined;
     /** Scheme + host. */
-    origin?: string;
-    title?: string;
-    referrer?: string;
-    properties?: Record<string, unknown>;
-    utm?: UTMParams;
-    consentCategory?: ConsentCategory;
+    origin?: string | undefined;
+    title?: string | undefined;
+    referrer?: string | undefined;
+    properties?: Record<string, unknown> | undefined;
+    utm?: UTMParams | undefined;
+    consentCategory?: ConsentCategory | undefined;
 }
 type EventPayload = {
     type: "track";
@@ -221,8 +221,8 @@ type EventPayload = {
     timestamp: number;
     payload: {
         name: string;
-        properties?: Record<string, unknown>;
-        profileId?: string | number;
+        properties?: Record<string, unknown> | undefined;
+        profileId?: string | number | undefined;
     };
 } | {
     type: "identify";
@@ -230,11 +230,11 @@ type EventPayload = {
     timestamp: number;
     payload: {
         profileId: string | number;
-        firstName?: string;
-        lastName?: string;
-        email?: string;
-        avatar?: string;
-        properties?: Record<string, unknown>;
+        firstName?: string | undefined;
+        lastName?: string | undefined;
+        email?: string | undefined;
+        avatar?: string | undefined;
+        properties?: Record<string, unknown> | undefined;
     };
 } | {
     type: "increment";
@@ -259,11 +259,11 @@ type QueueDropReason = "tracking_paused" | "consent_denied" | "validation_failed
 interface QueueResult {
     eventId: string;
     queued: boolean;
-    reason?: QueueDropReason;
+    reason?: QueueDropReason | undefined;
     errors?: Array<{
         field: string;
         message: string;
-    }>;
+    }> | undefined;
 }
 interface FlushResult {
     status: "idle" | "success" | "failed" | "skipped";
@@ -273,9 +273,9 @@ interface FlushResult {
 }
 interface FlushOptions {
     /** Ask the transport to outlive the page (keepalive fetch / beacon). */
-    keepalive?: boolean;
+    keepalive?: boolean | undefined;
     /** Keep sending until the queue is empty or no progress is made. */
-    drain?: boolean;
+    drain?: boolean | undefined;
 }
 
 type ConsentState = Record<string, boolean>;
@@ -287,12 +287,12 @@ interface BatchDelivery {
     session?: {
         id: string;
         token: string;
-    };
+    } | undefined;
 }
 interface SendOptions {
-    keepalive?: boolean;
+    keepalive?: boolean | undefined;
     /** Overrides the runtime's device/session for this request only. */
-    identity?: EventIdentity;
+    identity?: EventIdentity | undefined;
 }
 interface Transport {
     readonly url: string;
@@ -400,17 +400,17 @@ interface WebVitalMetric {
     id: string;
     name: string;
     value: number;
-    delta?: number;
-    rating?: "good" | "needs-improvement" | "poor";
-    navigationType?: string;
+    delta?: number | undefined;
+    rating?: "good" | "needs-improvement" | "poor" | undefined;
+    navigationType?: string | undefined;
 }
 type WebVitalProperties = {
     metric_name: string;
     metric_id: string;
     value: number;
-    delta?: number;
-    rating?: string;
-    navigation_type?: string;
+    delta?: number | undefined;
+    rating?: string | undefined;
+    navigation_type?: string | undefined;
     path: string;
 };
 
@@ -440,11 +440,11 @@ interface IdentityConfig {
      * server also reads survives that, and lets server-side events join the
      * same device.
      */
-    storage?: IdentityStorageKind;
+    storage?: IdentityStorageKind | undefined;
     /** Cookie `Domain`; omit for host-only. Set to share across subdomains. */
-    cookieDomain?: string;
+    cookieDomain?: string | undefined;
     /** Cookie lifetime. Default 400 days (the longest Chrome honours). */
-    cookieMaxAgeSeconds?: number;
+    cookieMaxAgeSeconds?: number | undefined;
 }
 interface CaptureConfig {
     /**
@@ -452,22 +452,22 @@ interface CaptureConfig {
      * The Next entry sets it to `false` because `<ReoptPageView />` owns page
      * views there — including the first one.
      */
-    pageview?: boolean;
+    pageview?: boolean | undefined;
     /** Send `$pageleave` with time-on-page when the page is hidden or the route changes. Default `true`. */
-    pageleave?: boolean;
+    pageleave?: boolean | undefined;
     /** Attach max scroll depth to `$pageleave`. Default `true`. */
-    scrollDepth?: boolean;
+    scrollDepth?: boolean | undefined;
     /** Send `$exception` for uncaught errors and unhandled rejections. Default `false`. */
-    exceptions?: boolean;
+    exceptions?: boolean | undefined;
 }
 interface ReoptClientConfig {
     writeKey: string;
     /** reopt-data origin, or the same-origin proxy prefix (e.g. `/ingest`) the Next.js proxy rewrites. */
     baseUrl: string;
     /** What the server already knows about this visitor. `null` = nothing. */
-    bootstrap?: ReoptBootstrap | null;
-    identity?: IdentityConfig;
-    capture?: CaptureConfig;
+    bootstrap?: ReoptBootstrap | null | undefined;
+    identity?: IdentityConfig | undefined;
+    capture?: CaptureConfig | undefined;
     /**
      * Hosts that receive the `reopt-device-id` header on outgoing `fetch`/XHR,
      * so a server-side `track()` lands on the same device. `true` = the page's
@@ -475,9 +475,9 @@ interface ReoptClientConfig {
      * `getDeviceId()` to your server call explicitly; this patches `fetch`
      * and loads as a separate chunk only when enabled.
      */
-    tracingHeaders?: boolean | string[];
+    tracingHeaders?: boolean | string[] | undefined;
     /** See {@link NormalizePath}. */
-    normalizePath?: NormalizePath;
+    normalizePath?: NormalizePath | undefined;
     /**
      * Properties attached to every event from the very first one. Same as
      * calling `register()` right after `init()`, except that nothing can
@@ -486,25 +486,25 @@ interface ReoptClientConfig {
      * Pass the page context the server already knows here; update it on
      * client-side navigation with `register()`.
      */
-    properties?: Record<string, unknown>;
-    consent?: ConsentConfig;
-    batch?: BatchConfig;
-    retry?: RetryConfig;
-    circuitBreaker?: CircuitBreakerConfig;
+    properties?: Record<string, unknown> | undefined;
+    consent?: ConsentConfig | undefined;
+    batch?: BatchConfig | undefined;
+    retry?: RetryConfig | undefined;
+    circuitBreaker?: CircuitBreakerConfig | undefined;
     /** Upper bound on queued events. Default 10 000. */
-    maxQueueSize?: number;
+    maxQueueSize?: number | undefined;
     /** Overrides the store for the offline queue. Default `localStorage`. */
-    queueStorage?: StorageBackend;
+    queueStorage?: StorageBackend | undefined;
     /** Prefix for storage keys. Default `reopt_`. */
-    storagePrefix?: string;
+    storagePrefix?: string | undefined;
     /**
      * Transport override. Tests hand in a recording function so a Playwright
      * spec can assert on the exact payload the SDK built, without intercepting
      * the network. Defaults to the page's `fetch` (captured at init, before the
      * tracing patch, so the SDK's own requests are never tagged twice).
      */
-    fetch?: FetchLike;
-    debug?: boolean;
+    fetch?: FetchLike | undefined;
+    debug?: boolean | undefined;
 }
 interface ResolvedCaptureConfig {
     pageview: boolean;
@@ -543,6 +543,7 @@ declare class ReoptClient extends ReoptCore {
     private readonly uninstallers;
     private torndown;
     private readonly session;
+    private readonly optedOut;
     private readonly normalize;
     /** True when `writeKey` or `baseUrl` was missing: every call is a silent no-op. */
     readonly disabled: boolean;
@@ -550,6 +551,15 @@ declare class ReoptClient extends ReoptCore {
     /** Which store identity ended up in — `cookie`, `localStorage` or `memory`. */
     get identityStorage(): IdentityStore["kind"];
     pageView(options?: PageViewOptions): QueueResult;
+    setConsent(category: ConsentCategory, allowed: boolean): void;
+    setAllConsent(allowed: boolean): void;
+    replaceConsentState(state: Record<string, boolean>): void;
+    /**
+     * Refusing `analytics` removes the stored identity (the proxy does the
+     * same on its side); granting it again writes the current device through
+     * so the visit is attributable from that point on.
+     */
+    private syncOptOut;
     identify(options: IdentifyOptions): QueueResult;
     /** Feed a Web Vitals metric (from `next/web-vitals` or the `web-vitals` package). */
     captureWebVital(metric: WebVitalMetric): QueueResult;

package/dist/index.cjs

@@ -1564,6 +1564,7 @@ var ReoptClient = class extends ReoptCore {
   uninstallers = [];
   torndown = false;
   session;
+  optedOut;
   normalize;
   /** True when `writeKey` or `baseUrl` was missing: every call is a silent no-op. */
   disabled;
@@ -1574,7 +1575,16 @@ var ReoptClient = class extends ReoptCore {
     }
     const writeKey = config.writeKey || "disabled";
     const storagePrefix = config.storagePrefix ?? DEFAULT_STORAGE_PREFIX;
-    const store = createIdentityStore(writeKey, { ...config.identity, ...disabled ? { storage: "memory" } : {} });
+    const rawStore = createIdentityStore(writeKey, { ...config.identity, ...disabled ? { storage: "memory" } : {} });
+    const optedOut = {
+      value: (0, import_identity5.isOptedOut)(rawStore.readConsent() ?? config.bootstrap?.consent ?? null) || config.consent?.defaultConsent === false
+    };
+    const store = {
+      ...rawStore,
+      writeDevice: (state) => {
+        if (!optedOut.value) rawStore.writeDevice(state);
+      }
+    };
     const identity = resolveDeviceId(store, config.bootstrap?.deviceId, storagePrefix);
     const now = correctedClock(config.bootstrap);
     const queueStorage = disabled ? memoryStorage() : config.queueStorage ?? localStorageBackend() ?? memoryStorage();
@@ -1627,6 +1637,7 @@ var ReoptClient = class extends ReoptCore {
     this.writeKey = config.writeKey;
     this.disabled = disabled;
     this.session = session;
+    this.optedOut = optedOut;
     this.normalize = config.normalizePath;
     this.store = store;
     this.capture = resolveCapture(config.capture, defaults.pageview);
@@ -1685,6 +1696,34 @@ var ReoptClient = class extends ReoptCore {
     this.scroll?.reset();
     return super.pageView(options);
   }
+  setConsent(category, allowed) {
+    super.setConsent(category, allowed);
+    this.syncOptOut();
+  }
+  setAllConsent(allowed) {
+    super.setAllConsent(allowed);
+    this.syncOptOut();
+  }
+  replaceConsentState(state) {
+    super.replaceConsentState(state);
+    this.syncOptOut();
+  }
+  /**
+   * Refusing `analytics` removes the stored identity (the proxy does the
+   * same on its side); granting it again writes the current device through
+   * so the visit is attributable from that point on.
+   */
+  syncOptOut() {
+    const now = (0, import_identity5.isOptedOut)(this.getConsentState());
+    if (now === this.optedOut.value) return;
+    this.optedOut.value = now;
+    if (now) {
+      this.store.clearDevice();
+      this.session.header = null;
+    } else {
+      this.store.writeDevice({ deviceId: this.getDeviceId() });
+    }
+  }
   identify(options) {
     const result = super.identify(options);
     if (!options.identity && result.queued) {