@heycatch/sdk 0.8.3 → 0.8.5-dev.2545

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-C0-GQTbz.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, T as TRACING_HEADERS, U as UNKNOWN_INSTALL_VALUE } from './shared-C0-GQTbz.cjs';
+import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-nNQmChFP.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, T as TRACING_HEADERS, U as UNKNOWN_INSTALL_VALUE } from './shared-nNQmChFP.cjs';
 
 /**
  * Starts capturing after `optOutCapturingByDefault` gated `init()` from
@@ -11,6 +11,10 @@ export { H as HeyCatchBeforeSend, a as HeyCatchCapturedEvent, c as HeyCatchPersi
  * Also releases the browser-storage half of the gate, since `init()` pairs
  * `opt_out_persistence_by_default` with the capture opt-out.
  *
+ * Also runs the catch-redirect utm cleanup that `init()` held back under the
+ * gate: `opt_in_capturing()` sends `$opt_in` and the initial `$pageview`
+ * synchronously, and those are posthog's first read of the landing URL.
+ *
  * Warns and does nothing before `init()` - see the note above.
  */
 declare function optInCapturing(): void;
@@ -56,6 +60,15 @@ declare function setIdentity(userId: string, properties?: HeyCatchPersonProperti
 declare function resetIdentity(): void;
 
 declare function init(config: HeyCatchConfig): void;
+/**
+ * Turns visitor IP collection off (`false`) or back on (`true`) from here on,
+ * for a consent banner answered after `init()` - the runtime half of
+ * `collectIp`. Not remembered across loads: pass the visitor's answer to
+ * `init()` as `collectIp` on every load too.
+ *
+ * Warns and does nothing before `init()` (see `./consent`).
+ */
+declare function setIpCollection(collect: boolean): void;
 
 /**
  * Record a product event.
@@ -106,6 +119,7 @@ declare const analytics: {
     readonly optOutCapturing: typeof optOutCapturing;
     readonly resetIdentity: typeof resetIdentity;
     readonly setIdentity: typeof setIdentity;
+    readonly setIpCollection: typeof setIpCollection;
     readonly setPersonProperties: typeof setPersonProperties;
     readonly trackEvent: typeof trackEvent;
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-C0-GQTbz.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, T as TRACING_HEADERS, U as UNKNOWN_INSTALL_VALUE } from './shared-C0-GQTbz.js';
+import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-nNQmChFP.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, T as TRACING_HEADERS, U as UNKNOWN_INSTALL_VALUE } from './shared-nNQmChFP.js';
 
 /**
  * Starts capturing after `optOutCapturingByDefault` gated `init()` from
@@ -11,6 +11,10 @@ export { H as HeyCatchBeforeSend, a as HeyCatchCapturedEvent, c as HeyCatchPersi
  * Also releases the browser-storage half of the gate, since `init()` pairs
  * `opt_out_persistence_by_default` with the capture opt-out.
  *
+ * Also runs the catch-redirect utm cleanup that `init()` held back under the
+ * gate: `opt_in_capturing()` sends `$opt_in` and the initial `$pageview`
+ * synchronously, and those are posthog's first read of the landing URL.
+ *
  * Warns and does nothing before `init()` - see the note above.
  */
 declare function optInCapturing(): void;
@@ -56,6 +60,15 @@ declare function setIdentity(userId: string, properties?: HeyCatchPersonProperti
 declare function resetIdentity(): void;
 
 declare function init(config: HeyCatchConfig): void;
+/**
+ * Turns visitor IP collection off (`false`) or back on (`true`) from here on,
+ * for a consent banner answered after `init()` - the runtime half of
+ * `collectIp`. Not remembered across loads: pass the visitor's answer to
+ * `init()` as `collectIp` on every load too.
+ *
+ * Warns and does nothing before `init()` (see `./consent`).
+ */
+declare function setIpCollection(collect: boolean): void;
 
 /**
  * Record a product event.
@@ -106,6 +119,7 @@ declare const analytics: {
     readonly optOutCapturing: typeof optOutCapturing;
     readonly resetIdentity: typeof resetIdentity;
     readonly setIdentity: typeof setIdentity;
+    readonly setIpCollection: typeof setIpCollection;
     readonly setPersonProperties: typeof setPersonProperties;
     readonly trackEvent: typeof trackEvent;
 };