@heycatch/sdk 0.7.0 → 0.7.1-dev.1456

package/dist/index.d.cts

@@ -1,5 +1,27 @@
-import { a as HeyCatchPersonProperties, H as HeyCatchConfig, b as HeyCatchProperties, T as TrackOptions } from './shared-B8y8fJCD.cjs';
-export { P as PersonPropertyUpdate, S as SDK_VERSION, c as STAGE, d as ServerTrackOptions } from './shared-B8y8fJCD.cjs';
+import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, T as TrackOptions } from './shared-BFhHwsG8.cjs';
+export { H as HeyCatchBeforeSend, a as HeyCatchCapturedEvent, c as HeyCatchPersistence, f as HeyCatchSanitizeProperties, K as KNOWN_FRAMEWORKS, g as KNOWN_INSTALL_AGENTS, P as PersonPropertyUpdate, S as SDK_VERSION, h as STAGE, i as ServerTrackOptions, U as UNKNOWN_INSTALL_VALUE } from './shared-BFhHwsG8.cjs';
+
+/**
+ * Starts capturing after `optOutCapturingByDefault` gated `init()` from
+ * sending anything - the consent-gate alternative to skipping `init()`
+ * entirely (the "don't call init" workaround this replaces for customers
+ * under GDPR/CookieYes-style consent banners). Call once consent is
+ * granted.
+ *
+ * Also releases the browser-storage half of the gate, since `init()` pairs
+ * `opt_out_persistence_by_default` with the capture opt-out.
+ *
+ * Warns and does nothing before `init()` - see the note above.
+ */
+declare function optInCapturing(): void;
+/**
+ * Stops capturing again, for a visitor who WITHDRAWS consent - the other
+ * half of a consent banner, and the only one that can act on the current
+ * pageload (not loading the SDK next time cannot un-capture this one).
+ *
+ * Warns and does nothing before `init()` - see the note above.
+ */
+declare function optOutCapturing(): void;
 
 /**
  * Link the anonymous visitor to your authenticated user. Call once
@@ -76,6 +98,8 @@ declare function setPersonProperties(set?: HeyCatchPersonProperties, setOnce?: H
  */
 declare const analytics: {
     readonly init: typeof init;
+    readonly optInCapturing: typeof optInCapturing;
+    readonly optOutCapturing: typeof optOutCapturing;
     readonly resetIdentity: typeof resetIdentity;
     readonly setIdentity: typeof setIdentity;
     readonly setPersonProperties: typeof setPersonProperties;

package/dist/index.d.ts

@@ -1,5 +1,27 @@
-import { a as HeyCatchPersonProperties, H as HeyCatchConfig, b as HeyCatchProperties, T as TrackOptions } from './shared-B8y8fJCD.js';
-export { P as PersonPropertyUpdate, S as SDK_VERSION, c as STAGE, d as ServerTrackOptions } from './shared-B8y8fJCD.js';
+import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, T as TrackOptions } from './shared-BFhHwsG8.js';
+export { H as HeyCatchBeforeSend, a as HeyCatchCapturedEvent, c as HeyCatchPersistence, f as HeyCatchSanitizeProperties, K as KNOWN_FRAMEWORKS, g as KNOWN_INSTALL_AGENTS, P as PersonPropertyUpdate, S as SDK_VERSION, h as STAGE, i as ServerTrackOptions, U as UNKNOWN_INSTALL_VALUE } from './shared-BFhHwsG8.js';
+
+/**
+ * Starts capturing after `optOutCapturingByDefault` gated `init()` from
+ * sending anything - the consent-gate alternative to skipping `init()`
+ * entirely (the "don't call init" workaround this replaces for customers
+ * under GDPR/CookieYes-style consent banners). Call once consent is
+ * granted.
+ *
+ * Also releases the browser-storage half of the gate, since `init()` pairs
+ * `opt_out_persistence_by_default` with the capture opt-out.
+ *
+ * Warns and does nothing before `init()` - see the note above.
+ */
+declare function optInCapturing(): void;
+/**
+ * Stops capturing again, for a visitor who WITHDRAWS consent - the other
+ * half of a consent banner, and the only one that can act on the current
+ * pageload (not loading the SDK next time cannot un-capture this one).
+ *
+ * Warns and does nothing before `init()` - see the note above.
+ */
+declare function optOutCapturing(): void;
 
 /**
  * Link the anonymous visitor to your authenticated user. Call once
@@ -76,6 +98,8 @@ declare function setPersonProperties(set?: HeyCatchPersonProperties, setOnce?: H
  */
 declare const analytics: {
     readonly init: typeof init;
+    readonly optInCapturing: typeof optInCapturing;
+    readonly optOutCapturing: typeof optOutCapturing;
     readonly resetIdentity: typeof resetIdentity;
     readonly setIdentity: typeof setIdentity;
     readonly setPersonProperties: typeof setPersonProperties;